telnyx 7.25.0 → 7.27.0

package/src/resources/whatsapp/hosted-signups.ts

@@ -0,0 +1,221 @@
+// 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 { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class HostedSignups extends APIResource {
+  /**
+   * List hosted signups created by the account, newest first. Expired hosted signups
+   * are included.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const hostedSignupListResponse of client.whatsapp.hostedSignups.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: HostedSignupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<HostedSignupListResponsesDefaultFlatPagination, HostedSignupListResponse> {
+    return this._client.getAPIList(
+      '/whatsapp/hosted_signups',
+      DefaultFlatPagination<HostedSignupListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Create a time-limited onboarding URL on the Telnyx-hosted Embedded Signup page
+   * for a Tech Provider's end customer. Set `signup_type` to `coexistence` to launch
+   * Meta's WhatsApp Business app coexistence flow instead of standard Cloud API
+   * onboarding.
+   *
+   * @example
+   * ```ts
+   * const hostedSignup =
+   *   await client.whatsapp.hostedSignups.create({
+   *     app_id: '123456789012345',
+   *     signup_type: 'coexistence',
+   *   });
+   * ```
+   */
+  create(body: HostedSignupCreateParams, options?: RequestOptions): APIPromise<HostedSignupCreateResponse> {
+    return this._client.post('/whatsapp/hosted_signups', { body, ...options });
+  }
+
+  /**
+   * Retrieve a hosted signup and its onboarding URL.
+   *
+   * @example
+   * ```ts
+   * const hostedSignup =
+   *   await client.whatsapp.hostedSignups.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<HostedSignupRetrieveResponse> {
+    return this._client.get(path`/whatsapp/hosted_signups/${id}`, options);
+  }
+}
+
+export type HostedSignupListResponsesDefaultFlatPagination = DefaultFlatPagination<HostedSignupListResponse>;
+
+export interface HostedSignupCreateResponse {
+  data?: HostedSignupCreateResponse.Data;
+}
+
+export namespace HostedSignupCreateResponse {
+  export interface Data {
+    /**
+     * Hosted signup ID
+     */
+    id?: string;
+
+    /**
+     * Meta App ID the hosted signup onboards customers into
+     */
+    app_id?: string;
+
+    created_at?: string;
+
+    /**
+     * When the onboarding URL stops working
+     */
+    expires_at?: string;
+
+    /**
+     * Signed token embedded in `url`
+     */
+    jwt?: string;
+
+    record_type?: 'whatsapp_jwt';
+
+    /**
+     * Meta Partner Solution ID linked to the app. Returned only when creating a hosted
+     * signup.
+     */
+    solution_id?: string;
+
+    /**
+     * Hosted onboarding URL to share with the end customer
+     */
+    url?: string;
+  }
+}
+
+export interface HostedSignupRetrieveResponse {
+  data?: HostedSignupRetrieveResponse.Data;
+}
+
+export namespace HostedSignupRetrieveResponse {
+  export interface Data {
+    /**
+     * Hosted signup ID
+     */
+    id?: string;
+
+    /**
+     * Meta App ID the hosted signup onboards customers into
+     */
+    app_id?: string;
+
+    created_at?: string;
+
+    /**
+     * When the onboarding URL stops working
+     */
+    expires_at?: string;
+
+    /**
+     * Signed token embedded in `url`
+     */
+    jwt?: string;
+
+    record_type?: 'whatsapp_jwt';
+
+    /**
+     * Meta Partner Solution ID linked to the app. Returned only when creating a hosted
+     * signup.
+     */
+    solution_id?: string;
+
+    /**
+     * Hosted onboarding URL to share with the end customer
+     */
+    url?: string;
+  }
+}
+
+export interface HostedSignupListResponse {
+  /**
+   * Hosted signup ID
+   */
+  id?: string;
+
+  /**
+   * Meta App ID the hosted signup onboards customers into
+   */
+  app_id?: string;
+
+  created_at?: string;
+
+  /**
+   * When the onboarding URL stops working
+   */
+  expires_at?: string;
+
+  /**
+   * Signed token embedded in `url`
+   */
+  jwt?: string;
+
+  record_type?: 'whatsapp_jwt';
+
+  /**
+   * Meta Partner Solution ID linked to the app. Returned only when creating a hosted
+   * signup.
+   */
+  solution_id?: string;
+
+  /**
+   * Hosted onboarding URL to share with the end customer
+   */
+  url?: string;
+}
+
+export interface HostedSignupListParams extends DefaultFlatPaginationParams {}
+
+export interface HostedSignupCreateParams {
+  /**
+   * Meta App ID linked to the Telnyx account. The app must be enabled.
+   */
+  app_id: string;
+
+  /**
+   * When the onboarding URL expires, in RFC 3339 format. Must be in the future and
+   * at most 3 days ahead. Defaults to 24 hours after creation.
+   */
+  expires_at?: string;
+
+  /**
+   * Onboarding flow the hosted page launches. Use `coexistence` for a number that
+   * remains active in the WhatsApp Business app.
+   */
+  signup_type?: 'standard' | 'coexistence';
+}
+
+export declare namespace HostedSignups {
+  export {
+    type HostedSignupCreateResponse as HostedSignupCreateResponse,
+    type HostedSignupRetrieveResponse as HostedSignupRetrieveResponse,
+    type HostedSignupListResponse as HostedSignupListResponse,
+    type HostedSignupListResponsesDefaultFlatPagination as HostedSignupListResponsesDefaultFlatPagination,
+    type HostedSignupListParams as HostedSignupListParams,
+    type HostedSignupCreateParams as HostedSignupCreateParams,
+  };
+}

package/src/resources/whatsapp/index.ts

@@ -7,6 +7,15 @@ export {
   type BusinessAccountListParams,
   type BusinessAccountListResponsesDefaultFlatPagination,
 } from './business-accounts/index';
+export {
+  HostedSignups,
+  type HostedSignupCreateResponse,
+  type HostedSignupRetrieveResponse,
+  type HostedSignupListResponse,
+  type HostedSignupListParams,
+  type HostedSignupCreateParams,
+  type HostedSignupListResponsesDefaultFlatPagination,
+} from './hosted-signups';
 export {
   PhoneNumbers,
   type PhoneNumberListResponse,
@@ -20,6 +29,13 @@ export {
   type PhoneNumberGetParams,
   type PhoneNumberListResponsesDefaultFlatPagination,
 } from './phone-numbers/index';
+export {
+  Signup,
+  type SignupListResponse,
+  type SignupRetrieveStatusResponse,
+  type SignupListParams,
+  type SignupListResponsesDefaultFlatPagination,
+} from './signup';
 export {
   Templates,
   type WhatsappTemplateBodyComponent,

package/src/resources/whatsapp/phone-numbers/calling-routing.ts

@@ -10,9 +10,9 @@ import { path } from '../../../internal/utils/path';
  */
 export class CallingRouting extends APIResource {
   /**
-   * Retrieve the routing connection currently stored for a BYON (Bring Your Own
-   * Number) phone number: the connection that inbound WhatsApp calls to the number
-   * are delivered to.
+   * Retrieve the connection ID currently stored for a WhatsApp Calling BYON (Bring
+   * Your Own Number) phone number: the connection that inbound WhatsApp calls to the
+   * number are delivered to.
    *
    * Use it to check the result of
    * `PATCH /whatsapp/phone_numbers/{id}/calling_routing`. A read made immediately
@@ -33,8 +33,9 @@ export class CallingRouting extends APIResource {
   }
 
   /**
-   * Set or clear the connection that inbound WhatsApp calls to a BYON (Bring Your
-   * Own Number) phone number are delivered to.
+   * Set or clear the connection ID for a WhatsApp Calling BYON (Bring Your Own
+   * Number) phone number: the connection that inbound WhatsApp calls to the number
+   * are delivered to.
    *
    * The update is processed asynchronously. A `202` response means the request was
    * accepted, not that the routing changed. Check the result with

package/src/resources/whatsapp/signup.ts

@@ -0,0 +1,188 @@
+// 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 { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Signup extends APIResource {
+  /**
+   * List finished WhatsApp Embedded Signup sessions, with status `SUCCESS` or
+   * `FAILURE`, newest first. Use the `errors` of a failed session to see why
+   * provisioning stopped.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const signupListResponse of client.whatsapp.signup.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: SignupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SignupListResponsesDefaultFlatPagination, SignupListResponse> {
+    return this._client.getAPIList('/whatsapp/signup', DefaultFlatPagination<SignupListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve the current state and status of a WhatsApp Embedded Signup session.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.whatsapp.signup.retrieveStatus('id');
+   * ```
+   */
+  retrieveStatus(id: string, options?: RequestOptions): APIPromise<SignupRetrieveStatusResponse> {
+    return this._client.get(path`/whatsapp/signup/${id}/status`, options);
+  }
+}
+
+export type SignupListResponsesDefaultFlatPagination = DefaultFlatPagination<SignupListResponse>;
+
+export interface SignupListResponse {
+  created_at?: string;
+
+  /**
+   * Tech provider customer reference submitted with the signup
+   */
+  customer_id?: string;
+
+  /**
+   * Errors recorded during provisioning
+   */
+  errors?: Array<string>;
+
+  record_type?: 'whatsapp_session_id';
+
+  /**
+   * Signup session ID
+   */
+  session_id?: string;
+
+  /**
+   * Current provisioning step, or the step that failed. `REGISTER_PHONE_NUMBER` is
+   * skipped for coexistence signups.
+   */
+  state?:
+    | 'SUBSCRIBE_WEBHOOKS'
+    | 'ASSIGNED_USERS'
+    | 'SHARE_CREDIT_LINE'
+    | 'REGISTER_PHONE_NUMBER'
+    | 'ADD_WABA_TO_DB'
+    | 'ADD_PHONE_NUMBERS_TO_DB'
+    | 'COMPLETE';
+
+  /**
+   * `INCOMPLETE` waits for the Meta signup code, `PENDING` is in progress, `SUCCESS`
+   * finished provisioning, and `FAILURE` stopped at `state`.
+   */
+  status?: 'INCOMPLETE' | 'PENDING' | 'SUCCESS' | 'FAILURE';
+
+  updated_at?: string;
+
+  /**
+   * Telnyx user ID that owns the signup session
+   */
+  user_id?: string;
+
+  /**
+   * Meta WhatsApp Business Account ID
+   */
+  waba_id?: string;
+}
+
+export interface SignupRetrieveStatusResponse {
+  data?: SignupRetrieveStatusResponse.Data;
+}
+
+export namespace SignupRetrieveStatusResponse {
+  export interface Data {
+    created_at?: string;
+
+    /**
+     * Tech provider customer reference submitted with the signup
+     */
+    customer_id?: string;
+
+    /**
+     * Errors recorded during provisioning
+     */
+    errors?: Array<string>;
+
+    record_type?: 'whatsapp_session_id';
+
+    /**
+     * Signup session ID
+     */
+    session_id?: string;
+
+    /**
+     * Current provisioning step, or the step that failed. `REGISTER_PHONE_NUMBER` is
+     * skipped for coexistence signups.
+     */
+    state?:
+      | 'SUBSCRIBE_WEBHOOKS'
+      | 'ASSIGNED_USERS'
+      | 'SHARE_CREDIT_LINE'
+      | 'REGISTER_PHONE_NUMBER'
+      | 'ADD_WABA_TO_DB'
+      | 'ADD_PHONE_NUMBERS_TO_DB'
+      | 'COMPLETE';
+
+    /**
+     * `INCOMPLETE` waits for the Meta signup code, `PENDING` is in progress, `SUCCESS`
+     * finished provisioning, and `FAILURE` stopped at `state`.
+     */
+    status?: 'INCOMPLETE' | 'PENDING' | 'SUCCESS' | 'FAILURE';
+
+    updated_at?: string;
+
+    /**
+     * Telnyx user ID that owns the signup session
+     */
+    user_id?: string;
+
+    /**
+     * Meta WhatsApp Business Account ID
+     */
+    waba_id?: string;
+  }
+}
+
+export interface SignupListParams extends DefaultFlatPaginationParams {
+  /**
+   * Return sessions created at or after this time (RFC 3339)
+   */
+  'filter[created_at][gte]'?: string;
+
+  /**
+   * Return sessions created at or before this time (RFC 3339)
+   */
+  'filter[created_at][lte]'?: string;
+
+  /**
+   * Filter by the tech provider customer reference
+   */
+  'filter[customer_id]'?: string;
+
+  /**
+   * Filter by Meta WABA ID
+   */
+  'filter[waba_id]'?: string;
+}
+
+export declare namespace Signup {
+  export {
+    type SignupListResponse as SignupListResponse,
+    type SignupRetrieveStatusResponse as SignupRetrieveStatusResponse,
+    type SignupListResponsesDefaultFlatPagination as SignupListResponsesDefaultFlatPagination,
+    type SignupListParams as SignupListParams,
+  };
+}

package/src/resources/whatsapp/whatsapp.ts

@@ -1,6 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as HostedSignupsAPI from './hosted-signups';
+import {
+  HostedSignupCreateParams,
+  HostedSignupCreateResponse,
+  HostedSignupListParams,
+  HostedSignupListResponse,
+  HostedSignupListResponsesDefaultFlatPagination,
+  HostedSignupRetrieveResponse,
+  HostedSignups,
+} from './hosted-signups';
+import * as SignupAPI from './signup';
+import {
+  Signup,
+  SignupListParams,
+  SignupListResponse,
+  SignupListResponsesDefaultFlatPagination,
+  SignupRetrieveStatusResponse,
+} from './signup';
 import * as TemplatesAPI from './templates';
 import {
   TemplateCreateParams,
@@ -51,12 +69,16 @@ export class Whatsapp extends APIResource {
   templates: TemplatesAPI.Templates = new TemplatesAPI.Templates(this._client);
   phoneNumbers: PhoneNumbersAPI.PhoneNumbers = new PhoneNumbersAPI.PhoneNumbers(this._client);
   userData: UserDataAPI.UserData = new UserDataAPI.UserData(this._client);
+  signup: SignupAPI.Signup = new SignupAPI.Signup(this._client);
+  hostedSignups: HostedSignupsAPI.HostedSignups = new HostedSignupsAPI.HostedSignups(this._client);
 }
 
 Whatsapp.BusinessAccounts = BusinessAccounts;
 Whatsapp.Templates = Templates;
 Whatsapp.PhoneNumbers = PhoneNumbers;
 Whatsapp.UserData = UserData;
+Whatsapp.Signup = Signup;
+Whatsapp.HostedSignups = HostedSignups;
 
 export declare namespace Whatsapp {
   export {
@@ -100,4 +122,22 @@ export declare namespace Whatsapp {
     type UserDataUpdateResponse as UserDataUpdateResponse,
     type UserDataUpdateParams as UserDataUpdateParams,
   };
+
+  export {
+    Signup as Signup,
+    type SignupListResponse as SignupListResponse,
+    type SignupRetrieveStatusResponse as SignupRetrieveStatusResponse,
+    type SignupListResponsesDefaultFlatPagination as SignupListResponsesDefaultFlatPagination,
+    type SignupListParams as SignupListParams,
+  };
+
+  export {
+    HostedSignups as HostedSignups,
+    type HostedSignupCreateResponse as HostedSignupCreateResponse,
+    type HostedSignupRetrieveResponse as HostedSignupRetrieveResponse,
+    type HostedSignupListResponse as HostedSignupListResponse,
+    type HostedSignupListResponsesDefaultFlatPagination as HostedSignupListResponsesDefaultFlatPagination,
+    type HostedSignupListParams as HostedSignupListParams,
+    type HostedSignupCreateParams as HostedSignupCreateParams,
+  };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '7.25.0'; // x-release-please-version
+export const VERSION = '7.27.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.25.0";
+export declare const VERSION = "7.27.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "7.25.0";
+export declare const VERSION = "7.27.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '7.25.0'; // x-release-please-version
+exports.VERSION = '7.27.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '7.25.0'; // x-release-please-version
+export const VERSION = '7.27.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map