x-twitter-scraper 0.1.0

package/src/resources/account.ts

@@ -0,0 +1,88 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Account info & settings
+ */
+export class Account extends APIResource {
+  /**
+   * Get account info
+   */
+  retrieve(options?: RequestOptions): APIPromise<AccountRetrieveResponse> {
+    return this._client.get('/account', { ...options, __security: { apiKeyAuth: true } });
+  }
+
+  /**
+   * Set linked X username
+   */
+  setXUsername(
+    body: AccountSetXUsernameParams,
+    options?: RequestOptions,
+  ): APIPromise<AccountSetXUsernameResponse> {
+    return this._client.put('/account/x-identity', { body, ...options });
+  }
+
+  /**
+   * Update account locale
+   */
+  updateLocale(
+    body: AccountUpdateLocaleParams,
+    options?: RequestOptions,
+  ): APIPromise<AccountUpdateLocaleResponse> {
+    return this._client.patch('/account', { body, ...options, __security: {} });
+  }
+}
+
+export interface AccountRetrieveResponse {
+  monitorsAllowed: number;
+
+  monitorsUsed: number;
+
+  plan: 'active' | 'inactive';
+
+  currentPeriod?: AccountRetrieveResponse.CurrentPeriod;
+}
+
+export namespace AccountRetrieveResponse {
+  export interface CurrentPeriod {
+    end: string;
+
+    start: string;
+
+    usagePercent: number;
+  }
+}
+
+export interface AccountSetXUsernameResponse {
+  success: true;
+
+  xUsername: string;
+}
+
+export interface AccountUpdateLocaleResponse {
+  success: true;
+}
+
+export interface AccountSetXUsernameParams {
+  /**
+   * X username without @
+   */
+  username: string;
+}
+
+export interface AccountUpdateLocaleParams {
+  locale: 'en' | 'tr' | 'es';
+}
+
+export declare namespace Account {
+  export {
+    type AccountRetrieveResponse as AccountRetrieveResponse,
+    type AccountSetXUsernameResponse as AccountSetXUsernameResponse,
+    type AccountUpdateLocaleResponse as AccountUpdateLocaleResponse,
+    type AccountSetXUsernameParams as AccountSetXUsernameParams,
+    type AccountUpdateLocaleParams as AccountUpdateLocaleParams,
+  };
+}

package/src/resources/api-keys.ts

@@ -0,0 +1,80 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * API key management (session auth only)
+ */
+export class APIKeys extends APIResource {
+  /**
+   * Create API key
+   */
+  create(body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKeyCreateResponse> {
+    return this._client.post('/api-keys', { body, ...options, __security: {} });
+  }
+
+  /**
+   * List API keys
+   */
+  list(options?: RequestOptions): APIPromise<APIKeyListResponse> {
+    return this._client.get('/api-keys', { ...options, __security: {} });
+  }
+
+  /**
+   * Revoke API key
+   */
+  revoke(id: string, options?: RequestOptions): APIPromise<APIKeyRevokeResponse> {
+    return this._client.delete(path`/api-keys/${id}`, { ...options, __security: {} });
+  }
+}
+
+export interface APIKey {
+  id: string;
+
+  createdAt: string;
+
+  isActive: boolean;
+
+  name: string;
+
+  prefix: string;
+
+  lastUsedAt?: string;
+}
+
+export interface APIKeyCreateResponse {
+  id: string;
+
+  createdAt: string;
+
+  fullKey: string;
+
+  name: string;
+
+  prefix: string;
+}
+
+export interface APIKeyListResponse {
+  keys: Array<APIKey>;
+}
+
+export interface APIKeyRevokeResponse {
+  success: true;
+}
+
+export interface APIKeyCreateParams {
+  name?: string;
+}
+
+export declare namespace APIKeys {
+  export {
+    type APIKey as APIKey,
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyListResponse as APIKeyListResponse,
+    type APIKeyRevokeResponse as APIKeyRevokeResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+  };
+}

package/src/resources/bot/bot.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as PlatformLinksAPI from './platform-links';
+import { PlatformLinks } from './platform-links';
+
+export class Bot extends APIResource {
+  platformLinks: PlatformLinksAPI.PlatformLinks = new PlatformLinksAPI.PlatformLinks(this._client);
+}
+
+Bot.PlatformLinks = PlatformLinks;
+
+export declare namespace Bot {
+  export { PlatformLinks as PlatformLinks };
+}

package/src/resources/bot/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Bot } from './bot';
+export { PlatformLinks } from './platform-links';

package/src/resources/bot/platform-links.ts

@@ -0,0 +1,5 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+
+export class PlatformLinks extends APIResource {}

package/src/resources/bot.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './bot/index';

package/src/resources/compose.ts

@@ -0,0 +1,83 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Tweet composition, drafts, writing styles & radar
+ */
+export class Compose extends APIResource {
+  /**
+   * Compose, refine, or score a tweet
+   */
+  create(body: ComposeCreateParams, options?: RequestOptions): APIPromise<ComposeCreateResponse> {
+    return this._client.post('/compose', { body, ...options });
+  }
+}
+
+export type ComposeCreateResponse = { [key: string]: unknown };
+
+export interface ComposeCreateParams {
+  /**
+   * Workflow step
+   */
+  step: 'compose' | 'refine' | 'score';
+
+  /**
+   * Extra context or URLs (refine)
+   */
+  additionalContext?: string;
+
+  /**
+   * Desired call to action (refine)
+   */
+  callToAction?: string;
+
+  /**
+   * Tweet draft text to evaluate (score)
+   */
+  draft?: string;
+
+  /**
+   * Optimization goal
+   */
+  goal?: 'engagement' | 'followers' | 'authority' | 'conversation';
+
+  /**
+   * Whether a link is attached (score)
+   */
+  hasLink?: boolean;
+
+  /**
+   * Whether media is attached (score)
+   */
+  hasMedia?: boolean;
+
+  /**
+   * Media type (refine)
+   */
+  mediaType?: 'photo' | 'video' | 'none';
+
+  /**
+   * Cached style username for voice matching (compose)
+   */
+  styleUsername?: string;
+
+  /**
+   * Desired tone (refine)
+   */
+  tone?: string;
+
+  /**
+   * Tweet topic (compose, refine)
+   */
+  topic?: string;
+}
+
+export declare namespace Compose {
+  export {
+    type ComposeCreateResponse as ComposeCreateResponse,
+    type ComposeCreateParams as ComposeCreateParams,
+  };
+}

package/src/resources/credits.ts

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Subscription & billing
+ */
+export class Credits extends APIResource {
+  /**
+   * Get credits balance
+   */
+  retrieveBalance(options?: RequestOptions): APIPromise<CreditRetrieveBalanceResponse> {
+    return this._client.get('/credits', options);
+  }
+
+  /**
+   * Top up credits balance
+   */
+  topupBalance(
+    body: CreditTopupBalanceParams,
+    options?: RequestOptions,
+  ): APIPromise<CreditTopupBalanceResponse> {
+    return this._client.post('/credits/topup', { body, ...options });
+  }
+}
+
+export interface CreditRetrieveBalanceResponse {
+  auto_topup_enabled: boolean;
+
+  balance: number;
+
+  lifetime_purchased: number;
+
+  lifetime_used: number;
+}
+
+export interface CreditTopupBalanceResponse {
+  success: true;
+}
+
+export interface CreditTopupBalanceParams {
+  /**
+   * Amount to top up in credits
+   */
+  amount: number;
+}
+
+export declare namespace Credits {
+  export {
+    type CreditRetrieveBalanceResponse as CreditRetrieveBalanceResponse,
+    type CreditTopupBalanceResponse as CreditTopupBalanceResponse,
+    type CreditTopupBalanceParams as CreditTopupBalanceParams,
+  };
+}

package/src/resources/drafts.ts

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Tweet composition, drafts, writing styles & radar
+ */
+export class Drafts extends APIResource {
+  /**
+   * Save a tweet draft
+   */
+  create(body: DraftCreateParams, options?: RequestOptions): APIPromise<DraftDetail> {
+    return this._client.post('/drafts', { body, ...options });
+  }
+
+  /**
+   * Get draft by ID
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DraftDetail> {
+    return this._client.get(path`/drafts/${id}`, options);
+  }
+
+  /**
+   * List saved drafts
+   */
+  list(
+    query: DraftListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DraftListResponse> {
+    return this._client.get('/drafts', { query, ...options });
+  }
+
+  /**
+   * Delete a draft
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/drafts/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface Draft {
+  id: string;
+
+  createdAt: string;
+
+  text: string;
+
+  goal?: string;
+
+  topic?: string;
+}
+
+export interface DraftDetail {
+  id: string;
+
+  createdAt: string;
+
+  text: string;
+
+  updatedAt: string;
+
+  goal?: string;
+
+  topic?: string;
+}
+
+export interface DraftListResponse {
+  drafts: Array<Draft>;
+
+  hasMore: boolean;
+
+  nextCursor?: string;
+}
+
+export interface DraftCreateParams {
+  text: string;
+
+  goal?: 'engagement' | 'followers' | 'authority' | 'conversation';
+
+  topic?: string;
+}
+
+export interface DraftListParams {
+  /**
+   * Cursor for pagination
+   */
+  afterCursor?: string;
+
+  limit?: number;
+}
+
+export declare namespace Drafts {
+  export {
+    type Draft as Draft,
+    type DraftDetail as DraftDetail,
+    type DraftListResponse as DraftListResponse,
+    type DraftCreateParams as DraftCreateParams,
+    type DraftListParams as DraftListParams,
+  };
+}

package/src/resources/draws.ts

@@ -0,0 +1,192 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Giveaway draws from tweet replies
+ */
+export class Draws extends APIResource {
+  /**
+   * Get draw details
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DrawRetrieveResponse> {
+    return this._client.get(path`/draws/${id}`, options);
+  }
+
+  /**
+   * List draws
+   */
+  list(
+    query: DrawListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DrawListResponse> {
+    return this._client.get('/draws', { query, ...options });
+  }
+
+  /**
+   * Export draw data
+   */
+  export(
+    id: string,
+    query: DrawExportParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Response> {
+    return this._client.get(path`/draws/${id}/export`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+
+  /**
+   * Run giveaway draw
+   */
+  run(body: DrawRunParams, options?: RequestOptions): APIPromise<DrawRunResponse> {
+    return this._client.post('/draws', { body, ...options });
+  }
+}
+
+export interface DrawDetail {
+  id: string;
+
+  createdAt: string;
+
+  status: string;
+
+  totalEntries: number;
+
+  tweetAuthorUsername: string;
+
+  tweetId: string;
+
+  tweetLikeCount: number;
+
+  tweetQuoteCount: number;
+
+  tweetReplyCount: number;
+
+  tweetRetweetCount: number;
+
+  tweetText: string;
+
+  tweetUrl: string;
+
+  validEntries: number;
+
+  drawnAt?: string;
+}
+
+export interface DrawListItem {
+  id: string;
+
+  createdAt: string;
+
+  status: string;
+
+  totalEntries: number;
+
+  tweetUrl: string;
+
+  validEntries: number;
+
+  drawnAt?: string;
+}
+
+export interface Winner {
+  authorUsername: string;
+
+  isBackup: boolean;
+
+  position: number;
+
+  tweetId: string;
+}
+
+export interface DrawRetrieveResponse {
+  draw: DrawDetail;
+
+  winners: Array<Winner>;
+}
+
+export interface DrawListResponse {
+  draws: Array<DrawListItem>;
+
+  hasMore: boolean;
+
+  nextCursor?: string;
+}
+
+export interface DrawRunResponse {
+  id: string;
+
+  totalEntries: number;
+
+  tweetId: string;
+
+  validEntries: number;
+
+  winners: Array<Winner>;
+}
+
+export interface DrawListParams {
+  /**
+   * Cursor for pagination
+   */
+  after?: string;
+
+  limit?: number;
+}
+
+export interface DrawExportParams {
+  format?: 'csv' | 'json' | 'md' | 'md-document' | 'pdf' | 'txt' | 'xlsx';
+
+  /**
+   * Export winners or all entries
+   */
+  type?: 'winners' | 'entries';
+}
+
+export interface DrawRunParams {
+  tweetUrl: string;
+
+  backupCount?: number;
+
+  filterAccountAgeDays?: number;
+
+  filterLanguage?: string;
+
+  filterMinFollowers?: number;
+
+  mustFollowUsername?: string;
+
+  mustRetweet?: boolean;
+
+  requiredHashtags?: Array<string>;
+
+  requiredKeywords?: Array<string>;
+
+  requiredMentions?: Array<string>;
+
+  uniqueAuthorsOnly?: boolean;
+
+  winnerCount?: number;
+}
+
+export declare namespace Draws {
+  export {
+    type DrawDetail as DrawDetail,
+    type DrawListItem as DrawListItem,
+    type Winner as Winner,
+    type DrawRetrieveResponse as DrawRetrieveResponse,
+    type DrawListResponse as DrawListResponse,
+    type DrawRunResponse as DrawRunResponse,
+    type DrawListParams as DrawListParams,
+    type DrawExportParams as DrawExportParams,
+    type DrawRunParams as DrawRunParams,
+  };
+}