@xdevplatform/xdk
Version:
A modern TypeScript/JavaScript SDK for the X API
2,041 lines (2,040 loc) • 378 kB
TypeScript
/**
* Environment-aware HTTP client for the X API SDK.
*
* This module provides a universal HTTP client that works in both Node.js and browser environments
* without requiring manual polyfills.
*/
interface RequestOptions$1 {
method?: string;
headers?: Record<string, string> | Headers;
body?: string | Buffer | ArrayBuffer | ArrayBufferView;
signal?: AbortSignal;
timeout?: number;
}
interface HttpResponse {
ok: boolean;
status: number;
statusText: string;
headers: Headers;
url: string;
json(): Promise<any>;
text(): Promise<string>;
arrayBuffer(): Promise<ArrayBuffer>;
}
/**
* Universal HTTP client that works in both Node.js and browser environments
*/
declare class HttpClient {
private fetch;
private HeadersClass;
constructor();
private initializeEnvironment;
private initializeNodeEnvironment;
/**
* Create a new Headers instance
*/
createHeaders(init?: Record<string, string> | Headers): Headers;
/**
* Make an HTTP request
*/
request(url: string, options?: RequestOptions$1): Promise<HttpResponse>;
/**
* Make a GET request
*/
get(url: string, headers?: Record<string, string>): Promise<HttpResponse>;
/**
* Make a POST request
*/
post(url: string, body?: string, headers?: Record<string, string>): Promise<HttpResponse>;
/**
* Make a PUT request
*/
put(url: string, body?: string, headers?: Record<string, string>): Promise<HttpResponse>;
/**
* Make a DELETE request
*/
delete(url: string, headers?: Record<string, string>): Promise<HttpResponse>;
/**
* Make a PATCH request
*/
patch(url: string, body?: string, headers?: Record<string, string>): Promise<HttpResponse>;
}
declare const httpClient: HttpClient;
/**
* OpenAPI Schema Types
* Auto-generated from OpenAPI components/schemas
*
* @internal
*/
/**
The unique identifier of an Activity event.
*
* @public
*/
type ActivityEventId = string; /**
An activity event or error that can be returned by the x activity streaming API.
*
* @public
*/
interface ActivityStreamingResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
}
/**
Schema type for ActivityStreamingResponsePayload
*
* @public
*/
type ActivityStreamingResponsePayload = any; /**
An XActivity subscription.
*
* @public
*/
interface ActivitySubscription {
createdAt: string; /** none */
eventType: string;
filter: ActivitySubscriptionFilter;
subscriptionId: ActivitySubscriptionId; /** none */
tag?: string; /** none */
updatedAt: string;
webhookId?: WebhookConfigId;
} /**
Schema type for ActivitySubscriptionCreateRequest
*
* @public
*/
interface ActivitySubscriptionCreateRequest {
eventType: "ProfileBioUpdate" | "ProfilePictureUpdate" | "ProfileBannerPictureUpdate" | "ProfileScreennameUpdate" | "ProfileGeoUpdate" | "ProfileUrlUpdate" | "ProfileVerifiedBadgeUpdate" | "TrendsNew";
filter: ActivitySubscriptionFilter; /** none */
tag?: string;
webhookId?: WebhookConfigId;
} /**
Schema type for ActivitySubscriptionCreateResponse
*
* @public
*/
interface ActivitySubscriptionCreateResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for ActivitySubscriptionDeleteResponse
*
* @public
*/
interface ActivitySubscriptionDeleteResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
An XAA subscription.
*
* @public
*/
interface ActivitySubscriptionFilter {
keyword?: Keyword;
userId?: UserId;
} /**
Schema type for ActivitySubscriptionGetResponse
*
* @public
*/
interface ActivitySubscriptionGetResponse {
data?: Array<ActivitySubscription>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
The unique identifier of this subscription.
*
* @public
*/
type ActivitySubscriptionId = string; /**
Schema type for ActivitySubscriptionUpdateRequest
*
* @public
*/
interface ActivitySubscriptionUpdateRequest {
tag?: string;
webhookId?: WebhookConfigId;
} /**
Schema type for ActivitySubscriptionUpdateResponse
*
* @public
*/
interface ActivitySubscriptionUpdateResponse {
data?: Record<string, any>;
}
/**
Schema type for AddOrDeleteRulesRequest
*
* @public
*/
type AddOrDeleteRulesRequest = any; /**
A response from modifying user-specified stream filtering rules.
*
* @public
*/
interface AddOrDeleteRulesResponse {
data?: Array<Rule>; /** none */
errors?: Array<Problem>;
meta: RulesResponseMetadata;
} /**
A request to add a user-specified stream filtering rule.
*
* @public
*/
interface AddRulesRequest {
add: Array<RuleNoId>;
} /**
The sum of results returned in this response.
*
* @public
*/
type Aggregate = number; /**
Unique identifier of ai trend.
*
* @public
*/
type AiTrendId = string; /**
Schema type for AllowDownloadStatus
*
* @public
*/
interface AllowDownloadStatus {
allowDownload?: boolean;
} /**
Client App Rule Counts for all applications in the project
*
* @public
*/
type AllProjectClientApps = Array<AppRulesCount>; /**
Schema type for AltText
*
* @public
*/
interface AltText {
text: string;
} /**
Schema type for Analytics
*
* @public
*/
interface Analytics {
data?: Array<Record<string, any>>; /** none */
errors?: Array<Problem>;
}
/**
Schema type for AnimatedGif
*
* @public
*/
type AnimatedGif = any; /**
A count of user-provided stream filtering rules at the client application level.
*
* @public
*/
interface AppRulesCount {
clientAppId?: ClientAppId; /** Number of rules for client application */
ruleCount?: number;
} /**
Schema type for AudiencePolicy
*
* @public
*/
interface AudiencePolicy {
creatorSubscriptions?: Array<"Any">; /** none */
xSubscriptions?: Array<"Any">;
} /**
Schema type for BookmarkAddRequest
*
* @public
*/
interface BookmarkAddRequest {
tweetId: TweetId;
} /**
The unique identifier of this Bookmark folder.
*
* @public
*/
type BookmarkFolderId = string; /**
Schema type for BookmarkFolderPostsResponse
*
* @public
*/
interface BookmarkFolderPostsResponse {
data?: Array<Record<string, any>>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for BookmarkFoldersResponse
*
* @public
*/
interface BookmarkFoldersResponse {
data?: Array<Record<string, any>>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for BookmarkMutationResponse
*
* @public
*/
interface BookmarkMutationResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
}
/**
Schema type for CashtagEntity
*
* @public
*/
type CashtagEntity = any; /**
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
*
* @public
*/
interface CashtagFields {
tag: string;
} /**
The ID of the client application
*
* @public
*/
type ClientAppId = string; /**
Usage per client app
*
* @public
*/
interface ClientAppUsage {
clientAppId?: string; /** The usage value */
usage?: Array<UsageFields>; /** The number of results returned */
usageResultCount?: number;
}
/**
Your client has gone away.
*
* @public
*/
type ClientDisconnectedProblem = any;
/**
A problem that indicates your client is forbidden from making this request.
*
* @public
*/
type ClientForbiddenProblem = any; /**
A X Community is a curated group of Posts.
*
* @public
*/
interface Community {
createdAt?: string;
id: CommunityId; /** The name of this Community. */
name: string;
} /**
The unique identifier of this Community.
*
* @public
*/
type CommunityId = string; /**
Schema type for ComplianceJob
*
* @public
*/
interface ComplianceJob {
createdAt: CreatedAt;
downloadExpiresAt: DownloadExpiration;
downloadUrl: DownloadUrl;
id: JobId;
name?: ComplianceJobName;
status: ComplianceJobStatus;
type: ComplianceJobType;
uploadExpiresAt: UploadExpiration;
uploadUrl: UploadUrl;
} /**
User-provided name for a compliance job.
*
* @public
*/
type ComplianceJobName = string; /**
Status of a compliance job.
*
* @public
*/
type ComplianceJobStatus = "created" | "in_progress" | "failed" | "complete" | "expired"; /**
Type of compliance job to list.
*
* @public
*/
type ComplianceJobType = "tweets" | "users";
/**
You cannot create a new job if one is already in progress.
*
* @public
*/
type ConflictProblem = any;
/**
A problem that indicates something is wrong with the connection.
*
* @public
*/
type ConnectionExceptionProblem = any; /**
Schema type for ContentExpiration
*
* @public
*/
interface ContentExpiration {
timestampSec: number;
} /**
Annotation inferred from the Tweet text.
*
* @public
*/
interface ContextAnnotation {
domain: ContextAnnotationDomainFields;
entity: ContextAnnotationEntityFields;
} /**
Represents the data for the context annotation domain.
*
* @public
*/
interface ContextAnnotationDomainFields {
description?: string; /** The unique id for a context annotation domain. */
id: string; /** Name of the context annotation domain. */
name?: string;
} /**
Represents the data for the context annotation entity.
*
* @public
*/
interface ContextAnnotationEntityFields {
description?: string; /** The unique id for a context annotation entity. */
id: string; /** Name of the context annotation entity. */
name?: string;
} /**
A two-letter ISO 3166-1 alpha-2 country code.
*
* @public
*/
type CountryCode = string; /**
Schema type for CreateAttachmentsMessageRequest
*
* @public
*/
interface CreateAttachmentsMessageRequest {
attachments: DmAttachments; /** Text of the message. */
text?: string;
} /**
A request to create a new batch compliance job.
*
* @public
*/
interface CreateComplianceJobRequest {
name?: ComplianceJobName; /** If true, this endpoint will return a pre-signed URL with resumable uploads enabled. */
resumable?: boolean; /** Type of compliance job to list. */
type: "tweets" | "users";
} /**
Schema type for CreateComplianceJobResponse
*
* @public
*/
interface CreateComplianceJobResponse {
data?: ComplianceJob; /** none */
errors?: Array<Problem>;
} /**
Creation time of the compliance job.
*
* @public
*/
type CreatedAt = string; /**
Schema type for CreateDmConversationRequest
*
* @public
*/
interface CreateDmConversationRequest {
conversationType: "Group";
message: CreateMessageRequest;
participantIds: DmParticipants;
} /**
Schema type for CreateDmEventResponse
*
* @public
*/
interface CreateDmEventResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
}
/**
Schema type for CreateMessageRequest
*
* @public
*/
type CreateMessageRequest = any; /**
Schema type for CreateNoteRequest
*
* @public
*/
interface CreateNoteRequest {
info: NoteInfo;
postId: TweetId; /** If true, the note being submitted is only for testing the capability of the bot, and won't be publicly visible. If false, the note being submitted will be a new proposed note on the product. */
testMode: boolean;
} /**
Schema type for CreateNoteResponse
*
* @public
*/
interface CreateNoteResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for CreateTextMessageRequest
*
* @public
*/
interface CreateTextMessageRequest {
attachments?: DmAttachments; /** Text of the message. */
text: string;
} /**
Schema type for DeleteDmResponse
*
* @public
*/
interface DeleteDmResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for DeleteNoteResponse
*
* @public
*/
interface DeleteNoteResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
A response from deleting user-specified stream filtering rules.
*
* @public
*/
interface DeleteRulesRequest {
delete: Record<string, any>;
}
/**
A problem that indicates that the resource requested violates the precepts of this API.
*
* @public
*/
type DisallowedResourceProblem = any; /**
Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. `start` must be smaller than `end`. The start index is inclusive, the end index is exclusive.
*
* @public
*/
type DisplayTextRange = Array<number>; /**
Attachments to a DM Event.
*
* @public
*/
type DmAttachments = Array<DmMediaAttachment>; /**
Unique identifier of a DM conversation. This can either be a numeric string, or a pair of numeric strings separated by a '-' character in the case of one-on-one DM Conversations.
*
* @public
*/
type DmConversationId = string; /**
Schema type for DmEvent
*
* @public
*/
interface DmEvent {
attachments?: Record<string, any>; /** none */
cashtags?: Array<CashtagEntity>; /** none */
createdAt?: string;
dmConversationId?: DmConversationId; /** none */
eventType: string; /** none */
hashtags?: Array<HashtagEntity>;
id: DmEventId; /** none */
mentions?: Array<MentionEntity>; /** A list of participants for a ParticipantsJoin or ParticipantsLeave event_type. */
participantIds?: Array<UserId>; /** A list of Posts this DM refers to. */
referencedTweets?: Array<Record<string, any>>;
senderId?: UserId; /** none */
text?: string; /** none */
urls?: Array<UrlEntityDm>;
} /**
Unique identifier of a DM Event.
*
* @public
*/
type DmEventId = string; /**
Schema type for DmMediaAttachment
*
* @public
*/
interface DmMediaAttachment {
mediaId: MediaId;
} /**
Participants for the DM Conversation.
*
* @public
*/
type DmParticipants = Array<UserId>; /**
Schema type for DomainRestrictions
*
* @public
*/
interface DomainRestrictions {
whitelist: Array<string>;
} /**
Expiration time of the download URL.
*
* @public
*/
type DownloadExpiration = string; /**
URL from which the user will retrieve their compliance results.
*
* @public
*/
type DownloadUrl = string;
/**
The rule you have submitted is a duplicate.
*
* @public
*/
type DuplicateRuleProblem = any; /**
The end time of the bucket.
*
* @public
*/
type End = string; /**
An Engagement Api Response.
*
* @public
*/
interface Engagement {
errors?: Array<Record<string, any>>; /** none */
measurement?: Record<string, any>;
} /**
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). `start` must be smaller than `end`. The start index is inclusive, the end index is exclusive.
*
* @public
*/
interface EntityIndicesInclusiveExclusive {
end: number; /** Index (zero-based) at which position this entity starts. The index is inclusive. */
start: number;
} /**
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). `start` must be smaller than `end`. The start index is inclusive, the end index is inclusive.
*
* @public
*/
interface EntityIndicesInclusiveInclusive {
end: number; /** Index (zero-based) at which position this entity starts. The index is inclusive. */
start: number;
} /**
Schema type for Error
*
* @public
*/
interface Error$1 {
code: number; /** none */
message: string;
} /**
Schema type for EvaluateNoteRequest
*
* @public
*/
interface EvaluateNoteRequest {
noteText: string;
postId: TweetId;
} /**
Schema type for EvaluateNoteResponse
*
* @public
*/
interface EvaluateNoteResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Expansions
*
* @public
*/
interface Expansions {
media?: Array<Media>; /** none */
places?: Array<Place>; /** none */
polls?: Array<Poll>; /** none */
topics?: Array<Topic>; /** none */
tweets?: Array<Tweet>; /** none */
users?: Array<User>;
}
/**
A problem that indicates that you are not allowed to see a particular field on a Tweet, User, etc.
*
* @public
*/
type FieldUnauthorizedProblem = any; /**
A Tweet or error that can be returned by the streaming Tweet API. The values returned with a successful streamed Tweet includes the user provided rules that the Tweet matched.
*
* @public
*/
interface FilteredStreamingTweetResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** The list of rules which matched the Tweet */
matchingRules?: Array<Record<string, any>>;
} /**
Schema type for FoundMediaOrigin
*
* @public
*/
interface FoundMediaOrigin {
id: string; /** The media provider (e.g., 'giphy') that sourced the media ( <= 8 Characters ) */
provider: string;
} /**
Schema type for FullTextEntities
*
* @public
*/
interface FullTextEntities {
annotations?: Array<any>; /** none */
cashtags?: Array<CashtagEntity>; /** none */
hashtags?: Array<HashtagEntity>; /** none */
mentions?: Array<MentionEntity>; /** none */
urls?: Array<UrlEntity>;
}
/**
A generic problem with no additional information beyond that provided by the HTTP status code.
*
* @public
*/
type GenericProblem = any; /**
Schema type for Geo
*
* @public
*/
interface Geo {
bbox: Array<number>;
geometry?: Point; /** none */
properties: Record<string, any>; /** none */
type: "Feature";
}
/**
Schema type for GeoRestrictions
*
* @public
*/
type GeoRestrictions = any; /**
Schema type for Get2AiTrendsIdResponse
*
* @public
*/
interface Get2AiTrendsIdResponse {
data?: News; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2CommunitiesIdResponse
*
* @public
*/
interface Get2CommunitiesIdResponse {
data?: Community; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2CommunitiesSearchResponse
*
* @public
*/
interface Get2CommunitiesSearchResponse {
data?: Array<Community>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2ComplianceJobsIdResponse
*
* @public
*/
interface Get2ComplianceJobsIdResponse {
data?: ComplianceJob; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2ComplianceJobsResponse
*
* @public
*/
interface Get2ComplianceJobsResponse {
data?: Array<ComplianceJob>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2DmConversationsIdDmEventsResponse
*
* @public
*/
interface Get2DmConversationsIdDmEventsResponse {
data?: Array<DmEvent>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2DmConversationsWithParticipantIdDmEventsResponse
*
* @public
*/
interface Get2DmConversationsWithParticipantIdDmEventsResponse {
data?: Array<DmEvent>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2DmEventsEventIdResponse
*
* @public
*/
interface Get2DmEventsEventIdResponse {
data?: DmEvent; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2DmEventsResponse
*
* @public
*/
interface Get2DmEventsResponse {
data?: Array<DmEvent>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2FdxAccountsAccountidContactResponse
*
* @public
*/
interface Get2FdxAccountsAccountidContactResponse {
data?: PlaidAccountContact; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2FdxAccountsAccountidPayment-networksResponse
*
* @public
*/
interface Get2FdxAccountsAccountidPayment_networksResponse {
data?: Array<PlaidAccountPaymentNetwork>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2FdxAccountsAccountidResponse
*
* @public
*/
interface Get2FdxAccountsAccountidResponse {
data?: PlaidAccount; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2FdxAccountsAccountidTransactionsResponse
*
* @public
*/
interface Get2FdxAccountsAccountidTransactionsResponse {
data?: Array<PlaidAccountTransaction>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2FdxCustomersCurrentResponse
*
* @public
*/
interface Get2FdxCustomersCurrentResponse {
data?: PlaidCustomer; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2Insights28hrResponse
*
* @public
*/
interface Get2Insights28hrResponse {
data?: Array<Engagement>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2InsightsHistoricalResponse
*
* @public
*/
interface Get2InsightsHistoricalResponse {
data?: Array<Engagement>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2LikesFirehoseStreamResponse
*
* @public
*/
interface Get2LikesFirehoseStreamResponse {
data?: LikeWithTweetAuthor; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2LikesSample10StreamResponse
*
* @public
*/
interface Get2LikesSample10StreamResponse {
data?: LikeWithTweetAuthor; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2ListsIdFollowersResponse
*
* @public
*/
interface Get2ListsIdFollowersResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2ListsIdMembersResponse
*
* @public
*/
interface Get2ListsIdMembersResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2ListsIdResponse
*
* @public
*/
interface Get2ListsIdResponse {
data?: List; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2ListsIdTweetsResponse
*
* @public
*/
interface Get2ListsIdTweetsResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2MediaAnalyticsResponse
*
* @public
*/
interface Get2MediaAnalyticsResponse {
data?: MediaAnalytics; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2MediaMediaKeyResponse
*
* @public
*/
interface Get2MediaMediaKeyResponse {
data?: Media; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2MediaResponse
*
* @public
*/
interface Get2MediaResponse {
data?: Array<Media>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2NewsIdResponse
*
* @public
*/
interface Get2NewsIdResponse {
data?: News; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2NewsSearchResponse
*
* @public
*/
interface Get2NewsSearchResponse {
data?: Array<News>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2NotesSearchNotesWrittenResponse
*
* @public
*/
interface Get2NotesSearchNotesWrittenResponse {
data?: Array<Note>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2NotesSearchPostsEligibleForNotesResponse
*
* @public
*/
interface Get2NotesSearchPostsEligibleForNotesResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2SpacesByCreatorIdsResponse
*
* @public
*/
interface Get2SpacesByCreatorIdsResponse {
data?: Array<Space>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2SpacesIdBuyersResponse
*
* @public
*/
interface Get2SpacesIdBuyersResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2SpacesIdResponse
*
* @public
*/
interface Get2SpacesIdResponse {
data?: Space; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2SpacesIdTweetsResponse
*
* @public
*/
interface Get2SpacesIdTweetsResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2SpacesResponse
*
* @public
*/
interface Get2SpacesResponse {
data?: Array<Space>; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2SpacesSearchResponse
*
* @public
*/
interface Get2SpacesSearchResponse {
data?: Array<Space>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TrendsByWoeidWoeidResponse
*
* @public
*/
interface Get2TrendsByWoeidWoeidResponse {
data?: Array<Trend>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2TweetsAnalyticsResponse
*
* @public
*/
interface Get2TweetsAnalyticsResponse {
data?: Analytics; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2TweetsCountsAllResponse
*
* @public
*/
interface Get2TweetsCountsAllResponse {
data?: Array<SearchCount>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TweetsCountsRecentResponse
*
* @public
*/
interface Get2TweetsCountsRecentResponse {
data?: Array<SearchCount>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TweetsFirehoseStreamLangEnResponse
*
* @public
*/
interface Get2TweetsFirehoseStreamLangEnResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsFirehoseStreamLangJaResponse
*
* @public
*/
interface Get2TweetsFirehoseStreamLangJaResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsFirehoseStreamLangKoResponse
*
* @public
*/
interface Get2TweetsFirehoseStreamLangKoResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsFirehoseStreamLangPtResponse
*
* @public
*/
interface Get2TweetsFirehoseStreamLangPtResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsFirehoseStreamResponse
*
* @public
*/
interface Get2TweetsFirehoseStreamResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsIdLikingUsersResponse
*
* @public
*/
interface Get2TweetsIdLikingUsersResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TweetsIdQuoteTweetsResponse
*
* @public
*/
interface Get2TweetsIdQuoteTweetsResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TweetsIdResponse
*
* @public
*/
interface Get2TweetsIdResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsIdRetweetedByResponse
*
* @public
*/
interface Get2TweetsIdRetweetedByResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TweetsIdRetweetsResponse
*
* @public
*/
interface Get2TweetsIdRetweetsResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TweetsResponse
*
* @public
*/
interface Get2TweetsResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsSample10StreamResponse
*
* @public
*/
interface Get2TweetsSample10StreamResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsSampleStreamResponse
*
* @public
*/
interface Get2TweetsSampleStreamResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsSearchAllResponse
*
* @public
*/
interface Get2TweetsSearchAllResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TweetsSearchRecentResponse
*
* @public
*/
interface Get2TweetsSearchRecentResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2TweetsSearchStreamResponse
*
* @public
*/
interface Get2TweetsSearchStreamResponse {
data?: Tweet; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2TweetsSearchStreamRulesCountsResponse
*
* @public
*/
interface Get2TweetsSearchStreamRulesCountsResponse {
data?: RulesCount; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2UsageTweetsResponse
*
* @public
*/
interface Get2UsageTweetsResponse {
data?: Usage; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2UsersByResponse
*
* @public
*/
interface Get2UsersByResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2UsersByUsernameUsernameResponse
*
* @public
*/
interface Get2UsersByUsernameUsernameResponse {
data?: User; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2UsersIdBlockingResponse
*
* @public
*/
interface Get2UsersIdBlockingResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdBookmarksResponse
*
* @public
*/
interface Get2UsersIdBookmarksResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdFollowedListsResponse
*
* @public
*/
interface Get2UsersIdFollowedListsResponse {
data?: Array<List>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdFollowersResponse
*
* @public
*/
interface Get2UsersIdFollowersResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdFollowingResponse
*
* @public
*/
interface Get2UsersIdFollowingResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdLikedTweetsResponse
*
* @public
*/
interface Get2UsersIdLikedTweetsResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdListMembershipsResponse
*
* @public
*/
interface Get2UsersIdListMembershipsResponse {
data?: Array<List>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdMentionsResponse
*
* @public
*/
interface Get2UsersIdMentionsResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdMutingResponse
*
* @public
*/
interface Get2UsersIdMutingResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdOwnedListsResponse
*
* @public
*/
interface Get2UsersIdOwnedListsResponse {
data?: Array<List>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdPinnedListsResponse
*
* @public
*/
interface Get2UsersIdPinnedListsResponse {
data?: Array<List>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdResponse
*
* @public
*/
interface Get2UsersIdResponse {
data?: User; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2UsersIdTimelinesReverseChronologicalResponse
*
* @public
*/
interface Get2UsersIdTimelinesReverseChronologicalResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersIdTweetsResponse
*
* @public
*/
interface Get2UsersIdTweetsResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersMeResponse
*
* @public
*/
interface Get2UsersMeResponse {
data?: User; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2UsersPersonalizedTrendsResponse
*
* @public
*/
interface Get2UsersPersonalizedTrendsResponse {
data?: Array<PersonalizedTrend>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Get2UsersRepostsOfMeResponse
*
* @public
*/
interface Get2UsersRepostsOfMeResponse {
data?: Array<Tweet>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2UsersResponse
*
* @public
*/
interface Get2UsersResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions;
} /**
Schema type for Get2UsersSearchResponse
*
* @public
*/
interface Get2UsersSearchResponse {
data?: Array<User>; /** none */
errors?: Array<Problem>;
includes?: Expansions; /** none */
meta?: Record<string, any>;
} /**
Schema type for Get2WebhooksResponse
*
* @public
*/
interface Get2WebhooksResponse {
data?: Array<WebhookConfig>; /** none */
errors?: Array<Problem>; /** none */
meta?: Record<string, any>;
}
/**
Schema type for HashtagEntity
*
* @public
*/
type HashtagEntity = any; /**
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
*
* @public
*/
interface HashtagFields {
tag: string;
} /**
HTTP Status Code.
*
* @public
*/
type HttpStatusCode = number;
/**
A problem that indicates this request is invalid.
*
* @public
*/
type InvalidRequestProblem = any;
/**
The rule you have submitted is invalid.
*
* @public
*/
type InvalidRuleProblem = any; /**
Compliance Job ID.
*
* @public
*/
type JobId = string; /**
A keyword to filter on.
*
* @public
*/
type Keyword = string; /**
Schema type for KillAllConnectionsResponse
*
* @public
*/
interface KillAllConnectionsResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for LikeComplianceSchema
*
* @public
*/
interface LikeComplianceSchema {
delete: UnlikeComplianceSchema;
} /**
The unique identifier of this Like.
*
* @public
*/
type LikeId = string;
/**
Likes compliance stream events.
*
* @public
*/
type LikesComplianceStreamResponse = any; /**
A Like event, with the tweet author user and the tweet being liked
*
* @public
*/
interface LikeWithTweetAuthor {
createdAt?: string;
id?: LikeId;
likedTweetId?: TweetId; /** Timestamp in milliseconds of creation. */
timestampMs?: number;
tweetAuthorId?: UserId;
} /**
A X List is a curated group of accounts.
*
* @public
*/
interface List {
createdAt?: string; /** none */
description?: string; /** none */
followerCount?: number;
id: ListId; /** none */
memberCount?: number; /** The name of this List. */
name: string;
ownerId?: UserId; /** none */
private?: boolean;
} /**
Schema type for ListAddUserRequest
*
* @public
*/
interface ListAddUserRequest {
userId: UserId;
} /**
Schema type for ListCreateRequest
*
* @public
*/
interface ListCreateRequest {
description?: string; /** none */
name: string; /** none */
private?: boolean;
} /**
Schema type for ListCreateResponse
*
* @public
*/
interface ListCreateResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for ListDeleteResponse
*
* @public
*/
interface ListDeleteResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for ListFollowedRequest
*
* @public
*/
interface ListFollowedRequest {
listId: ListId;
} /**
Schema type for ListFollowedResponse
*
* @public
*/
interface ListFollowedResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
The unique identifier of this List.
*
* @public
*/
type ListId = string; /**
Schema type for ListMutateResponse
*
* @public
*/
interface ListMutateResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for ListPinnedRequest
*
* @public
*/
interface ListPinnedRequest {
listId: ListId;
} /**
Schema type for ListPinnedResponse
*
* @public
*/
interface ListPinnedResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for ListUnpinResponse
*
* @public
*/
interface ListUnpinResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for ListUpdateRequest
*
* @public
*/
interface ListUpdateRequest {
description?: string; /** none */
name?: string; /** none */
private?: boolean;
} /**
Schema type for ListUpdateResponse
*
* @public
*/
interface ListUpdateResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for ManagementInfo
*
* @public
*/
interface ManagementInfo {
managed: boolean;
} /**
Schema type for Media
*
* @public
*/
interface Media {
height?: MediaHeight;
mediaKey?: MediaKey; /** none */
type: string;
width?: MediaWidth;
} /**
Schema type for MediaAnalytics
*
* @public
*/
interface MediaAnalytics {
data?: Array<Record<string, any>>; /** none */
errors?: Array<Problem>;
} /**
A string enum value which identifies a media use-case. This identifier is used to enforce use-case specific constraints (e.g. file size, video duration) and enable advanced features.
*
* @public
*/
type MediaCategory = "amplify_video" | "tweet_gif" | "tweet_image" | "tweet_video" | "dm_gif" | "dm_image" | "dm_video" | "subtitles"; /**
A string enum value which identifies a media use-case. This identifier is used to enforce use-case specific constraints (e.g. file size) and enable advanced features.
*
* @public
*/
type MediaCategoryOneShot = "tweet_image" | "dm_image" | "subtitles"; /**
The media category of uploaded media to which subtitles should be added/deleted
*
* @public
*/
type MediaCategorySubtitles = "AmplifyVideo" | "TweetVideo"; /**
The height of the media in pixels.
*
* @public
*/
type MediaHeight = number; /**
The unique identifier of this Media.
*
* @public
*/
type MediaId = string; /**
The Media Key identifier for this attachment.
*
* @public
*/
type MediaKey = string; /**
Schema type for MediaMetrics
*
* @public
*/
interface MediaMetrics {
ctaUrlClicks?: number; /** Tracks the number of clicks to watch a video or media content */
ctaWatchClicks?: number; /** Tracks the number of times a video or media is played from a user tap */
playFromTap?: number; /** Tracks the number of times a video reaches 25% of its duration */
playback25?: number; /** Tracks the number of times a video reaches 50% of its duration */
playback50?: number; /** Tracks the number of times a video reaches 75% of its duration */
playback75?: number; /** Tracks the number of times a video is played to completion */
playbackComplete?: number; /** Tracks the number of times a video playback is initiated */
playbackStart?: number; /** Tracks the number of times a video is viewed */
videoViews?: number; /** Tracks the total time spent watching a video, measured in milliseconds */
watchTimeMs?: number;
} /**
The file to upload.
*
* @public
*/
type MediaPayloadBinary = string; /**
The file to upload.
*
* @public
*/
type MediaPayloadByte = string;
/**
Schema type for MediaSegments
*
* @public
*/
type MediaSegments = any; /**
Schema type for MediaTimestampedMetrics
*
* @public
*/
interface MediaTimestampedMetrics {
metrics?: MediaMetrics; /** ISO8601 Time */
timestamp?: string;
}
/**
Schema type for MediaUploadAppendRequest
*
* @public
*/
type MediaUploadAppendRequest = any; /**
A response from getting a media upload request status.
*
* @public
*/
interface MediaUploadAppendResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for MediaUploadConfigRequest
*
* @public
*/
interface MediaUploadConfigRequest {
additionalOwners?: Array<UserId>;
mediaCategory?: MediaCategory; /** The type of media. */
mediaType?: "video/mp4" | "video/webm" | "video/mp2t" | "video/quicktime" | "text/srt" | "text/vtt" | "image/jpeg" | "image/gif" | "image/bmp" | "image/png" | "image/webp" | "image/pjpeg" | "image/tiff" | "model/gltf-binary" | "model/vnd.usdz+zip"; /** Whether this media is shared or not. */
shared?: boolean; /** The total size of the media upload in bytes. */
totalBytes?: number;
} /**
Schema type for MediaUploadRequestOneShot
*
* @public
*/
interface MediaUploadRequestOneShot {
additionalOwners?: Array<UserId>; /** none */
media: any;
mediaCategory: MediaCategoryOneShot; /** The type of image or subtitle. */
mediaType?: "text/srt" | "text/vtt" | "image/jpeg" | "image/bmp" | "image/png" | "image/webp" | "image/pjpeg" | "image/tiff"; /** Whether this media is shared or not. */
shared?: boolean;
} /**
A response from getting a media upload request status.
*
* @public
*/
interface MediaUploadResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
The width of the media in pixels.
*
* @public
*/
type MediaWidth = number;
/**
Schema type for MentionEntity
*
* @public
*/
type MentionEntity = any; /**
Represent the portion of text recognized as a User mention, and its start and end position within the text.
*
* @public
*/
interface MentionFields {
id?: UserId;
username: UserName;
} /**
Schema type for MetadataCreateRequest
*
* @public
*/
interface MetadataCreateRequest {
id: MediaId; /** none */
metadata?: Record<string, any>;
} /**
Schema type for MetadataCreateResponse
*
* @public
*/
interface MetadataCreateResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for Metrics
*
* @public
*/
interface Metrics {
appInstallAttempts?: number; /** Tracks number of App opens */
appOpens?: number; /** Tracks number of Detail expands */
detailExpands?: number; /** Tracks number of Email Tweet actions */
emailTweet?: number; /** Tracks total Engagements */
engagements?: number; /** Tracks number of Follows */
follows?: number; /** Tracks number of Hashtag clicks */
hashtagClicks?: number; /** Tracks number of Impressions */
impressions?: number; /** Tracks number of Likes */
likes?: number; /** Tracks number of Link clicks */
linkClicks?: number; /** Tracks number of Media engagements */
mediaEngagements?: number; /** Tracks number of Media views */
mediaViews?: number; /** Tracks number of Permalink clicks */
permalinkClicks?: number; /** Tracks number of Profile visits */
profileVisits?: number; /** Tracks number of Quote Tweets */
quoteTweets?: number; /** Tracks number of Replies */
replies?: number; /** Tracks number of Retweets */
retweets?: number; /** Tracks number of URL clicks */
urlClicks?: number; /** Tracks number of User Profile clicks */
userProfileClicks?: number;
} /**
Community Note misleading tags type.
*
* @public
*/
type MisleadingTags = "disputed_claim_as_fact" | "factual_error" | "manipulated_media" | "misinterpreted_satire" | "missing_important_context" | "other" | "outdated_information"; /**
Schema type for MuteUserMutationResponse
*
* @public
*/
interface MuteUserMutationResponse {
data?: Record<string, any>; /** none */
errors?: Array<Problem>;
} /**
Schema type for MuteUserRequest
*
* @public
*/
interface MuteUserRequest {
targetUserId: UserId;
} /**
The newest id in this response.
*
* @public
*/
type NewestId = string; /**
An AI generated news story.
*
* @public
*/
interface News {
category?: string; /** none */
clusterPostsResults?: Array<Record<string, any>>; /** none */
contexts?: Record<string, any>; /** none */
disclaimer?: string; /** The news hook. */
hook?: string; /** none */
keywords?: Array<string>; /** none */
lastUpdatedAtMs?: string; /** The headline. */
name?: string;
restId: NewsId; /** The news summary. */
summary?: string;
} /**
Unique identifier of news story.
*
* @public
*/
type NewsId = string; /**
The next token.
*
* @public
*/
type NextToken = string;
/**
A problem that indicates the user's rule set is not compliant.
*
* @public
*/
type NonCompliantRulesProblem = any; /**
A X Community Note is a note on a Post.
*
* @public
*/
interface Note {
id: NoteId;
info?: NoteInfo;
postId: TweetId;
status?: NoteRatingStatus;
testResult?: NoteTestResult;
} /**
Community Note classification type.
*
* @public
*/
type NoteClassification = "misinformed_or_potentially_misleading" | "not_misleading"; /**
The unique identifier of this Community Note.
*
* @public
*/
type NoteId = string; /**
A X Community Note is a note on a Post.
*
* @public
*/
interface NoteInfo {
classification: NoteClassification; /** none */
misleadingTags: Array<MisleadingTags>; /** The text summary in the Community Note. */
text: string; /** Whether the note provided trustworthy links. */
trustworthySources: boolean;
} /**
Community Note rating status
*
* @public
*/
type NoteRatingStatus = "currently_rated_helpful" | "currently_rated_not_helpful" | "firm_reject" | "insufficient_consensus" | "minimum_ratings_not_met" | "needs_more_ratings" | "needs_your_help"; /**
The evaluation result of a community note.
*
* @public
*/
interface NoteTestResult {
evaluatorScoreBucket?: string; /** The type of the evaluator. */
evaluatorType?: string;
} /**
The note content of the Tweet.
*
* @public
*/
type NoteTweetText = string;
/**
A problem that indicates your client application does not have the required OAuth1 permissions for the requested endpoint.
*
* @public
*/
type Oauth1PermissionsProblem = any; /**
The oldest id in this response.
*
* @public
*/
type OldestId = string;
/**
You have been disconnected for operational reasons.
*
* @public
*/
type OperationalDisconnectProblem = any; /**
A base32 pagination token.
*
* @public
*/
type PaginationToken32 = string; /**
A base36 pagination token.
*
* @public
*/
type PaginationToken36 = string; /**
A 'long' pagination token.
*
* @public
*/
type PaginationTokenLong = string; /**
A trend.
*
* @public
*/
interface PersonalizedTrend {
category?: string; /** Number of posts pertaining to this trend. */
postCount?: number; /** Name of the trend. */
trendName?: string; /** Time since this is trending. */
trendingSince?: string;
}
/**
Schema type for Photo
*
* @public
*/
type Photo = any; /**
Schema type for Place
*
* @public
*/
interface Place {
containedWithin?: Array<PlaceId>; /** The full name of the county in which this place exists. */
country?: string;
countryCode?: CountryCode; /** The full name of this place. */
fullName: string;
geo?: Geo;
id: PlaceId; /** The human readable name of this place. */
name?: string;
placeType?: PlaceType;
} /**
The identifier for this place.
*
* @public
*/
type PlaceId = string; /**
Schema type for PlaceType
*
* @public
*/
type PlaceType = "poi" | "neighborhood" | "city" | "admin" | "country" | "unknown"; /**
Descriptor for a Plaid account.
*
* @public
*/
interface PlaidAccount {
accountCategory: string; /** The Plaid account ID. */
accountId: string; /** The last 2-4 digits of the account number. */
accountNumberDisplay: string; /** The type of the account (e.g., checking, savings). */
accountType: string; /** The available balance of the account. */
availableBalance?: number;
currency: PlaidCurrency; /** The current balance of the account. */
currentBalance?: number; /** The nickname of the account. */
nickname?: string; /** The name of the product associated with the account. */
productName: string; /** The status of the account. */
status: string;
} /**
Contact information associated with a Plaid account.
*
* @public
*/
interface PlaidAccountContact {
addresses: Array<PlaidAddress>; /** List of email addresses associated with the account holder. */
emails: Array<string>;
name: PlaidName; /** Relationship of the contact to the account. */
relationship?: string; /** List of telephone numbers associated with the account holder. */
telephones: Array<PlaidTelephone>;
}