@talqing/sdk 0.13.2 → 0.14.0

package/src/gen/types.gen.ts

@@ -1913,6 +1913,10 @@ export type CatalogResponse = {
      * Turn Detector Languages
      */
     turn_detector_languages: Array<LanguageOption>;
+    /**
+     * Whatsapp Template Languages
+     */
+    whatsapp_template_languages: Array<string>;
 };
 
 /**
@@ -3731,6 +3735,64 @@ export type CreateWhatsAppBatchRequest = {
     window?: TimeWindow | null;
 };
 
+/**
+ * CreateWhatsAppTemplateRequest
+ */
+export type CreateWhatsAppTemplateRequest = {
+    /**
+     * Body
+     *
+     * Variables are named: `{{first_name}}`.
+     */
+    body: string;
+    /**
+     * Buttons
+     */
+    buttons?: Array<WhatsAppTemplateQuickReplyButtonInput | WhatsAppTemplateUrlButtonInput | WhatsAppTemplatePhoneButtonInput | WhatsAppTemplateVoiceCallButtonInput | WhatsAppTemplateCopyCodeButtonInput>;
+    /**
+     * Category
+     */
+    category: 'marketing' | 'utility';
+    /**
+     * Examples
+     *
+     * A realistic sample for every variable; WhatsApp reviews them.
+     */
+    examples?: {
+        [key: string]: string;
+    };
+    /**
+     * Footer
+     */
+    footer?: string | null;
+    /**
+     * Header
+     */
+    header?: ({
+        type: 'text';
+    } & WhatsAppTemplateTextHeaderInput) | ({
+        type: 'document' | 'image' | 'video';
+    } & WhatsAppTemplateMediaHeaderInput) | null;
+    /**
+     * Integration Id
+     *
+     * A Twilio WhatsApp sender; the template is account-wide.
+     */
+    integration_id: string;
+    /**
+     * Language
+     *
+     * One of the catalog's `whatsapp_template_languages`.
+     */
+    language: string;
+    /**
+     * Name
+     *
+     * Lowercase letters, digits and `_`.
+     */
+    name: string;
+};
+
 /**
  * CreditBalanceResponse
  *
@@ -13653,7 +13715,7 @@ export type WhatsAppBatchResponse = {
      * Status
      */
     status: 'draft' | 'scheduled' | 'sending' | 'paused' | 'completed' | 'canceled' | 'failed';
-    template: WhatsAppTemplate;
+    template: WhatsAppTemplateSnapshot;
     /**
      * Timezone
      */
@@ -13774,7 +13836,7 @@ export type WhatsAppRecipientResponse = {
 /**
  * WhatsAppTemplate
  *
- * The whole message: header, body, footer and buttons.
+ * A template and where WhatsApp's review of it stands. Only `approved` can be sent.
  */
 export type WhatsAppTemplate = {
     /**
@@ -13788,7 +13850,17 @@ export type WhatsAppTemplate = {
     /**
      * Category
      */
-    category: string;
+    category: 'marketing' | 'utility' | 'authentication';
+    /**
+     * Created At
+     */
+    created_at: string;
+    /**
+     * Examples
+     */
+    examples: {
+        [key: string]: string;
+    };
     /**
      * Footer
      */
@@ -13806,6 +13878,14 @@ export type WhatsAppTemplate = {
      * Name
      */
     name: string;
+    /**
+     * Rejection Reason
+     */
+    rejection_reason: string | null;
+    /**
+     * Status
+     */
+    status: 'pending' | 'approved' | 'rejected' | 'paused' | 'disabled';
     /**
      * Unsupported Reason
      */
@@ -13832,6 +13912,10 @@ export type WhatsAppTemplateButton = {
      * Text
      */
     text: string;
+    /**
+     * Ttl Minutes
+     */
+    ttl_minutes: number | null;
     /**
      * Type
      */
@@ -13842,6 +13926,22 @@ export type WhatsAppTemplateButton = {
     url: string | null;
 };
 
+/**
+ * WhatsAppTemplateCopyCodeButtonInput
+ *
+ * WhatsApp labels it "Copy Code".
+ */
+export type WhatsAppTemplateCopyCodeButtonInput = {
+    /**
+     * Code
+     */
+    code: string;
+    /**
+     * Type
+     */
+    type: 'copy_code';
+};
+
 /**
  * WhatsAppTemplateHeader
  */
@@ -13860,6 +13960,151 @@ export type WhatsAppTemplateHeader = {
     url: string | null;
 };
 
+/**
+ * WhatsAppTemplateMediaHeaderInput
+ */
+export type WhatsAppTemplateMediaHeaderInput = {
+    /**
+     * Type
+     */
+    type: 'image' | 'video' | 'document';
+    /**
+     * Url
+     *
+     * A public https file; WhatsApp downloads it.
+     */
+    url: string;
+};
+
+/**
+ * WhatsAppTemplatePhoneButtonInput
+ */
+export type WhatsAppTemplatePhoneButtonInput = {
+    /**
+     * Phone Number
+     */
+    phone_number: string;
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Type
+     */
+    type: 'phone_number';
+};
+
+/**
+ * WhatsAppTemplateQuickReplyButtonInput
+ */
+export type WhatsAppTemplateQuickReplyButtonInput = {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Type
+     */
+    type: 'quick_reply';
+};
+
+/**
+ * WhatsAppTemplateSnapshot
+ *
+ * The whole message as a batch sends it: header, body, footer and buttons.
+ */
+export type WhatsAppTemplateSnapshot = {
+    /**
+     * Body
+     */
+    body: string;
+    /**
+     * Buttons
+     */
+    buttons: Array<WhatsAppTemplateButton>;
+    /**
+     * Category
+     */
+    category: 'marketing' | 'utility' | 'authentication';
+    /**
+     * Footer
+     */
+    footer: string | null;
+    header: WhatsAppTemplateHeader | null;
+    /**
+     * Id
+     */
+    id: string;
+    /**
+     * Language
+     */
+    language: string;
+    /**
+     * Name
+     */
+    name: string;
+    /**
+     * Variables
+     */
+    variables: Array<string>;
+};
+
+/**
+ * WhatsAppTemplateTextHeaderInput
+ */
+export type WhatsAppTemplateTextHeaderInput = {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Type
+     */
+    type: 'text';
+};
+
+/**
+ * WhatsAppTemplateUrlButtonInput
+ */
+export type WhatsAppTemplateUrlButtonInput = {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Type
+     */
+    type: 'url';
+    /**
+     * Url
+     *
+     * May end in one variable, after a `/`.
+     */
+    url: string;
+};
+
+/**
+ * WhatsAppTemplateVoiceCallButtonInput
+ *
+ * Starts a WhatsApp call to the sending number.
+ */
+export type WhatsAppTemplateVoiceCallButtonInput = {
+    /**
+     * Text
+     */
+    text: string;
+    /**
+     * Ttl Minutes
+     *
+     * How long the button works after sending. Default 7 days.
+     */
+    ttl_minutes?: number | null;
+    /**
+     * Type
+     */
+    type: 'voice_call';
+};
+
 /**
  * WhatsAppTemplatesResponse
  */
@@ -23568,6 +23813,10 @@ export type WhatsappTemplatesListData = {
          * A connected WhatsApp sender.
          */
         integration_id: string;
+        /**
+         * Status
+         */
+        status?: Array<'pending' | 'approved' | 'rejected' | 'paused' | 'disabled'> | null;
     };
     url: '/v1/whatsapp/templates';
 };
@@ -23598,6 +23847,112 @@ export type WhatsappTemplatesListResults = {
 
 export type WhatsappTemplatesListResult = WhatsappTemplatesListResults[keyof WhatsappTemplatesListResults];
 
+export type WhatsappTemplatesCreateData = {
+    body: CreateWhatsAppTemplateRequest;
+    path?: never;
+    query?: never;
+    url: '/v1/whatsapp/templates';
+};
+
+export type WhatsappTemplatesCreateErrors = {
+    /**
+     * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
+     */
+    400: ErrorResponse;
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * Authenticated, but this organization role may not perform the operation.
+     */
+    403: ErrorResponse;
+    /**
+     * The resource's current state forbids this — a name already taken, a job already running.
+     */
+    409: ErrorResponse;
+    /**
+     * The request did not match this operation's schema; `detail.errors` lists each field.
+     */
+    422: ErrorResponse;
+    /**
+     * Unexpected error. Every error this API returns carries this body.
+     */
+    default: ErrorResponse;
+};
+
+export type WhatsappTemplatesCreateError = WhatsappTemplatesCreateErrors[keyof WhatsappTemplatesCreateErrors];
+
+export type WhatsappTemplatesCreateResults = {
+    /**
+     * Successful Response
+     */
+    201: WhatsAppTemplate;
+};
+
+export type WhatsappTemplatesCreateResult = WhatsappTemplatesCreateResults[keyof WhatsappTemplatesCreateResults];
+
+export type WhatsappTemplatesDeleteData = {
+    body?: never;
+    path: {
+        /**
+         * Template Id
+         */
+        template_id: string;
+    };
+    query: {
+        /**
+         * Integration Id
+         *
+         * A WhatsApp sender on the template's account.
+         */
+        integration_id: string;
+    };
+    url: '/v1/whatsapp/templates/{template_id}';
+};
+
+export type WhatsappTemplatesDeleteErrors = {
+    /**
+     * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
+     */
+    400: ErrorResponse;
+    /**
+     * Missing credential, or one that is revoked or no longer a member of this organization.
+     */
+    401: ErrorResponse;
+    /**
+     * Authenticated, but this organization role may not perform the operation.
+     */
+    403: ErrorResponse;
+    /**
+     * No such resource in this organization.
+     */
+    404: ErrorResponse;
+    /**
+     * The resource's current state forbids this — a name already taken, a job already running.
+     */
+    409: ErrorResponse;
+    /**
+     * The request did not match this operation's schema; `detail.errors` lists each field.
+     */
+    422: ErrorResponse;
+    /**
+     * Unexpected error. Every error this API returns carries this body.
+     */
+    default: ErrorResponse;
+};
+
+export type WhatsappTemplatesDeleteError = WhatsappTemplatesDeleteErrors[keyof WhatsappTemplatesDeleteErrors];
+
+export type WhatsappTemplatesDeleteResults = {
+    /**
+     * Successful Response
+     */
+    200: OkResponse;
+};
+
+export type WhatsappTemplatesDeleteResult = WhatsappTemplatesDeleteResults[keyof WhatsappTemplatesDeleteResults];
+
 export type WhatsappTwilioSendersListData = {
     body: TwilioSendersRequest;
     path?: never;