x-twitter-scraper 0.4.1 → 0.5.0

package/src/resources/support/tickets.ts

@@ -2,7 +2,9 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
+import { maybeMultipartFormRequestOptions } from '../../internal/uploads';
 import { path } from '../../internal/utils/path';
 
 /**
@@ -20,8 +22,22 @@ export class Tickets extends APIResource {
    * });
    * ```
    */
-  create(body: TicketCreateParams, options?: RequestOptions): APIPromise<TicketCreateResponse> {
-    return this._client.post('/support/tickets', { body, ...options });
+  create(params: TicketCreateParams, options?: RequestOptions): APIPromise<TicketCreateResponse> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post(
+      '/support/tickets',
+      maybeMultipartFormRequestOptions(
+        {
+          body,
+          ...options,
+          headers: buildHeaders([
+            { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+            options?.headers,
+          ]),
+        },
+        this._client,
+      ),
+    );
   }
 
   /**
@@ -76,13 +92,40 @@ export class Tickets extends APIResource {
    * );
    * ```
    */
-  reply(id: string, body: TicketReplyParams, options?: RequestOptions): APIPromise<TicketReplyResponse> {
-    return this._client.post(path`/support/tickets/${id}/messages`, { body, ...options });
+  reply(id: string, params: TicketReplyParams, options?: RequestOptions): APIPromise<TicketReplyResponse> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post(
+      path`/support/tickets/${id}/messages`,
+      maybeMultipartFormRequestOptions(
+        {
+          body,
+          ...options,
+          headers: buildHeaders([
+            { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+            options?.headers,
+          ]),
+        },
+        this._client,
+      ),
+    );
   }
 }
 
 export interface TicketCreateResponse {
-  publicId?: string;
+  attachments: Array<TicketCreateResponse.Attachment>;
+
+  publicId: string;
+}
+
+export namespace TicketCreateResponse {
+  /**
+   * Attachment identifier and initial processing state.
+   */
+  export interface Attachment {
+    publicId: string;
+
+    status: 'pending' | 'ready' | 'failed';
+  }
 }
 
 export interface TicketRetrieveResponse {
@@ -101,12 +144,51 @@ export interface TicketRetrieveResponse {
 
 export namespace TicketRetrieveResponse {
   export interface Message {
+    attachments?: Array<Message.Attachment>;
+
     body?: string;
 
     createdAt?: string;
 
     sender?: string;
   }
+
+  export namespace Message {
+    /**
+     * Downloadable image or video attached to a support message.
+     */
+    export interface Attachment {
+      /**
+       * Validated media type.
+       */
+      contentType:
+        | 'image/jpeg'
+        | 'image/png'
+        | 'image/gif'
+        | 'image/webp'
+        | 'video/mp4'
+        | 'video/quicktime'
+        | 'video/webm';
+
+      filename: string;
+
+      /**
+       * Attachment media class.
+       */
+      kind: 'image' | 'video';
+
+      publicId: string;
+
+      sizeBytes: number;
+
+      /**
+       * Storage processing state.
+       */
+      status: 'pending' | 'ready' | 'failed';
+
+      url: string;
+    }
+  }
 }
 
 export interface TicketUpdateResponse {
@@ -136,13 +218,38 @@ export namespace TicketListResponse {
 }
 
 export interface TicketReplyResponse {
-  publicId?: string;
+  attachments: Array<TicketReplyResponse.Attachment>;
+
+  publicId: string;
+}
+
+export namespace TicketReplyResponse {
+  /**
+   * Attachment identifier and initial processing state.
+   */
+  export interface Attachment {
+    publicId: string;
+
+    status: 'pending' | 'ready' | 'failed';
+  }
 }
 
 export interface TicketCreateParams {
+  /**
+   * Body param
+   */
   body: string;
 
+  /**
+   * Body param
+   */
   subject: string;
+
+  /**
+   * Header param: Generate one random value per ticket or reply. Reuse it only when
+   * retrying identical text and attachments. Never log this value.
+   */
+  'Idempotency-Key'?: string;
 }
 
 export interface TicketUpdateParams {
@@ -150,7 +257,16 @@ export interface TicketUpdateParams {
 }
 
 export interface TicketReplyParams {
+  /**
+   * Body param
+   */
   body: string;
+
+  /**
+   * Header param: Generate one random value per ticket or reply. Reuse it only when
+   * retrying identical text and attachments. Never log this value.
+   */
+  'Idempotency-Key'?: string;
 }
 
 export declare namespace Tickets {

package/src/resources/x/account-connection-challenges.ts

@@ -16,7 +16,7 @@ export class AccountConnectionChallenges extends APIResource {
    * ```ts
    * const response =
    *   await client.x.accountConnectionChallenges.submit('id', {
-   *     email_code: '123456',
+   *     email_code: '<EMAIL_VERIFICATION_CODE>',
    *   });
    * ```
    */

package/src/resources/x/accounts.ts

@@ -15,9 +15,10 @@ export class Accounts extends APIResource {
    * @example
    * ```ts
    * const account = await client.x.accounts.create({
-   *   email: 'user@example.com',
+   *   email: 'account@example.invalid',
    *   password: '<ACCOUNT_PASSWORD>',
-   *   username: 'elonmusk',
+   *   username: 'your_x_username',
+   *   totp_secret: '<TOTP_SECRET>',
    * });
    * ```
    */
@@ -83,6 +84,7 @@ export class Accounts extends APIResource {
    * ```ts
    * const response = await client.x.accounts.reauth('id', {
    *   password: '<ACCOUNT_PASSWORD>',
+   *   email: 'account@example.invalid',
    *   totp_secret: '<TOTP_SECRET>',
    * });
    * ```
@@ -101,10 +103,11 @@ export interface XAccount {
   createdAt: string;
 
   /**
-   * Derived connection health. `healthy` = ready. `needsReauth` = reconnect the
-   * account. `locked` = unlock the account on x.com first. `suspended` = X
-   * suspended the account. `recovering` = retry is available after cooldown.
-   * `temporaryIssue` = retry shortly.
+   * Derived connection health. `healthy` = session active. `needsReauth` = user must
+   * submit fresh credentials. `locked` = X locked the account; unlock on x.com
+   * first. `suspended` = X banned the account. `recovering` = past cooldown, will
+   * auto-retry on next use. `temporaryIssue` = temporary connection problem; retry
+   * shortly.
    */
   health: 'healthy' | 'locked' | 'needsReauth' | 'recovering' | 'suspended' | 'temporaryIssue';