telnyx 6.7.0 → 6.8.0

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

@@ -0,0 +1,193 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as CallingSettingsAPI from './calling-settings';
+import {
+  CallingSettingRetrieveResponse,
+  CallingSettingUpdateParams,
+  CallingSettingUpdateResponse,
+  CallingSettings,
+  WhatsappCallingSettingsData,
+} from './calling-settings';
+import * as ProfileAPI from './profile/profile';
+import {
+  Profile,
+  ProfileRetrieveResponse,
+  ProfileUpdateParams,
+  ProfileUpdateResponse,
+  WhatsappProfileData,
+} from './profile/profile';
+import { APIPromise } from '../../../core/api-promise';
+import {
+  DefaultFlatPagination,
+  type DefaultFlatPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Manage Whatsapp phone numbers
+ */
+export class PhoneNumbers extends APIResource {
+  callingSettings: CallingSettingsAPI.CallingSettings = new CallingSettingsAPI.CallingSettings(this._client);
+  profile: ProfileAPI.Profile = new ProfileAPI.Profile(this._client);
+
+  /**
+   * List Whatsapp phone numbers
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const phoneNumberListResponse of client.whatsapp.phoneNumbers.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: PhoneNumberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PhoneNumberListResponsesDefaultFlatPagination, PhoneNumberListResponse> {
+    return this._client.getAPIList(
+      '/v2/whatsapp/phone_numbers',
+      DefaultFlatPagination<PhoneNumberListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a Whatsapp phone number
+   *
+   * @example
+   * ```ts
+   * await client.whatsapp.phoneNumbers.delete('phone_number');
+   * ```
+   */
+  delete(phoneNumber: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/whatsapp/phone_numbers/${phoneNumber}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Resend verification code
+   *
+   * @example
+   * ```ts
+   * await client.whatsapp.phoneNumbers.resendVerification(
+   *   'phone_number',
+   * );
+   * ```
+   */
+  resendVerification(
+    phoneNumber: string,
+    body: PhoneNumberResendVerificationParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.post(path`/v2/whatsapp/phone_numbers/${phoneNumber}/resend_verification`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Submit verification code for a phone number
+   *
+   * @example
+   * ```ts
+   * await client.whatsapp.phoneNumbers.verify('phone_number', {
+   *   code: 'code',
+   * });
+   * ```
+   */
+  verify(phoneNumber: string, body: PhoneNumberVerifyParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/v2/whatsapp/phone_numbers/${phoneNumber}/verify`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type PhoneNumberListResponsesDefaultFlatPagination = DefaultFlatPagination<PhoneNumberListResponse>;
+
+export interface PhoneNumberListResponse {
+  calling_enabled?: boolean;
+
+  created_at?: string;
+
+  display_name?: string;
+
+  enabled?: boolean;
+
+  /**
+   * Phone number in E164 format
+   */
+  phone_number?: string;
+
+  /**
+   * Whatsapp phone number ID
+   */
+  phone_number_id?: string;
+
+  /**
+   * Whatsapp quality rating
+   */
+  quality_rating?: string;
+
+  record_type?: string;
+
+  status?: string;
+
+  /**
+   * User ID
+   */
+  user_id?: string;
+
+  /**
+   * WABA ID of Whatsapp business account
+   */
+  waba_id?: string;
+}
+
+export interface PhoneNumberListParams extends DefaultFlatPaginationParams {}
+
+export interface PhoneNumberResendVerificationParams {
+  verification_method?: 'sms' | 'voice';
+}
+
+export interface PhoneNumberVerifyParams {
+  code: string;
+}
+
+PhoneNumbers.CallingSettings = CallingSettings;
+PhoneNumbers.Profile = Profile;
+
+export declare namespace PhoneNumbers {
+  export {
+    type PhoneNumberListResponse as PhoneNumberListResponse,
+    type PhoneNumberListResponsesDefaultFlatPagination as PhoneNumberListResponsesDefaultFlatPagination,
+    type PhoneNumberListParams as PhoneNumberListParams,
+    type PhoneNumberResendVerificationParams as PhoneNumberResendVerificationParams,
+    type PhoneNumberVerifyParams as PhoneNumberVerifyParams,
+  };
+
+  export {
+    CallingSettings as CallingSettings,
+    type WhatsappCallingSettingsData as WhatsappCallingSettingsData,
+    type CallingSettingRetrieveResponse as CallingSettingRetrieveResponse,
+    type CallingSettingUpdateResponse as CallingSettingUpdateResponse,
+    type CallingSettingUpdateParams as CallingSettingUpdateParams,
+  };
+
+  export {
+    Profile as Profile,
+    type WhatsappProfileData as WhatsappProfileData,
+    type ProfileRetrieveResponse as ProfileRetrieveResponse,
+    type ProfileUpdateResponse as ProfileUpdateResponse,
+    type ProfileUpdateParams as ProfileUpdateParams,
+  };
+}

package/src/resources/whatsapp/phone-numbers/profile/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Photo, type PhotoUploadResponse, type PhotoUploadParams } from './photo';
+export {
+  Profile,
+  type WhatsappProfileData,
+  type ProfileRetrieveResponse,
+  type ProfileUpdateResponse,
+  type ProfileUpdateParams,
+} from './profile';

package/src/resources/whatsapp/phone-numbers/profile/photo.ts

@@ -0,0 +1,70 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as ProfileAPI from './profile';
+import { APIPromise } from '../../../../core/api-promise';
+import { type Uploadable } from '../../../../core/uploads';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { multipartFormRequestOptions } from '../../../../internal/uploads';
+import { path } from '../../../../internal/utils/path';
+
+/**
+ * Manage Whatsapp phone numbers
+ */
+export class Photo extends APIResource {
+  /**
+   * Delete Whatsapp profile photo
+   *
+   * @example
+   * ```ts
+   * await client.whatsapp.phoneNumbers.profile.photo.delete(
+   *   'phone_number',
+   * );
+   * ```
+   */
+  delete(phoneNumber: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/whatsapp/phone_numbers/${phoneNumber}/profile/photo`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Upload Whatsapp profile photo
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.whatsapp.phoneNumbers.profile.photo.upload(
+   *     'phone_number',
+   *     { file: fs.createReadStream('path/to/file') },
+   *   );
+   * ```
+   */
+  upload(
+    phoneNumber: string,
+    body: PhotoUploadParams,
+    options?: RequestOptions,
+  ): APIPromise<PhotoUploadResponse> {
+    return this._client.post(
+      path`/v2/whatsapp/phone_numbers/${phoneNumber}/profile/photo`,
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+}
+
+export interface PhotoUploadResponse {
+  data?: ProfileAPI.WhatsappProfileData;
+}
+
+export interface PhotoUploadParams {
+  /**
+   * Image file (JPEG recommended, max 10 MB)
+   */
+  file: Uploadable;
+}
+
+export declare namespace Photo {
+  export { type PhotoUploadResponse as PhotoUploadResponse, type PhotoUploadParams as PhotoUploadParams };
+}

package/src/resources/whatsapp/phone-numbers/profile/profile.ts

@@ -0,0 +1,121 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as PhotoAPI from './photo';
+import { Photo, PhotoUploadParams, PhotoUploadResponse } from './photo';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+/**
+ * Manage Whatsapp phone numbers
+ */
+export class Profile extends APIResource {
+  photo: PhotoAPI.Photo = new PhotoAPI.Photo(this._client);
+
+  /**
+   * Get phone number business profile
+   *
+   * @example
+   * ```ts
+   * const profile =
+   *   await client.whatsapp.phoneNumbers.profile.retrieve(
+   *     'phone_number',
+   *   );
+   * ```
+   */
+  retrieve(phoneNumber: string, options?: RequestOptions): APIPromise<ProfileRetrieveResponse> {
+    return this._client.get(path`/v2/whatsapp/phone_numbers/${phoneNumber}/profile`, options);
+  }
+
+  /**
+   * Update phone number business profile
+   *
+   * @example
+   * ```ts
+   * const profile =
+   *   await client.whatsapp.phoneNumbers.profile.update(
+   *     'phone_number',
+   *   );
+   * ```
+   */
+  update(
+    phoneNumber: string,
+    body: ProfileUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProfileUpdateResponse> {
+    return this._client.patch(path`/v2/whatsapp/phone_numbers/${phoneNumber}/profile`, { body, ...options });
+  }
+}
+
+export interface WhatsappProfileData {
+  id?: string;
+
+  about?: string;
+
+  address?: string;
+
+  category?: string;
+
+  created_at?: string;
+
+  description?: string;
+
+  display_name?: string;
+
+  email?: string;
+
+  /**
+   * Whatsapp phone number ID
+   */
+  phone_number_id?: string;
+
+  profile_photo_url?: string;
+
+  record_type?: string;
+
+  updated_at?: string;
+
+  website?: string;
+}
+
+export interface ProfileRetrieveResponse {
+  data?: WhatsappProfileData;
+}
+
+export interface ProfileUpdateResponse {
+  data?: WhatsappProfileData;
+}
+
+export interface ProfileUpdateParams {
+  about?: string;
+
+  address?: string;
+
+  category?: string;
+
+  description?: string;
+
+  display_name?: string;
+
+  email?: string;
+
+  website?: string;
+}
+
+Profile.Photo = Photo;
+
+export declare namespace Profile {
+  export {
+    type WhatsappProfileData as WhatsappProfileData,
+    type ProfileRetrieveResponse as ProfileRetrieveResponse,
+    type ProfileUpdateResponse as ProfileUpdateResponse,
+    type ProfileUpdateParams as ProfileUpdateParams,
+  };
+
+  export {
+    Photo as Photo,
+    type PhotoUploadResponse as PhotoUploadResponse,
+    type PhotoUploadParams as PhotoUploadParams,
+  };
+}

package/src/resources/whatsapp/phone-numbers/profile.ts

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

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

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

package/src/resources/whatsapp/templates.ts

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { WhatsappTemplateDataDefaultFlatPagination } from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Manage Whatsapp message templates
+ */
+export class Templates extends APIResource {
+  /**
+   * Create a Whatsapp message template
+   *
+   * @example
+   * ```ts
+   * const template = await client.whatsapp.templates.create({
+   *   category: 'MARKETING',
+   *   components: [{ foo: 'bar' }],
+   *   language: 'language',
+   *   name: 'name',
+   *   waba_id: 'waba_id',
+   * });
+   * ```
+   */
+  create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<TemplateCreateResponse> {
+    return this._client.post('/v2/whatsapp/message_templates', { body, ...options });
+  }
+
+  /**
+   * List Whatsapp message templates
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const whatsappTemplateData of client.whatsapp.templates.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: TemplateListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<WhatsappTemplateDataDefaultFlatPagination, Shared.WhatsappTemplateData> {
+    return this._client.getAPIList(
+      '/v2/whatsapp/message_templates',
+      DefaultFlatPagination<Shared.WhatsappTemplateData>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface TemplateCreateResponse {
+  data?: Shared.WhatsappTemplateData;
+}
+
+export interface TemplateCreateParams {
+  category: 'MARKETING' | 'UTILITY' | 'AUTHENTICATION';
+
+  components: Array<{ [key: string]: unknown }>;
+
+  language: string;
+
+  name: string;
+
+  waba_id: string;
+}
+
+export interface TemplateListParams extends DefaultFlatPaginationParams {
+  /**
+   * Filter by category
+   */
+  'filter[category]'?: 'MARKETING' | 'UTILITY' | 'AUTHENTICATION';
+
+  /**
+   * Search templates by name
+   */
+  'filter[search]'?: string;
+
+  /**
+   * Filter by template status
+   */
+  'filter[status]'?: string;
+
+  /**
+   * Filter by WABA ID
+   */
+  'filter[waba_id]'?: string;
+}
+
+export declare namespace Templates {
+  export {
+    type TemplateCreateResponse as TemplateCreateResponse,
+    type TemplateCreateParams as TemplateCreateParams,
+    type TemplateListParams as TemplateListParams,
+  };
+}
+
+export { type WhatsappTemplateDataDefaultFlatPagination };

package/src/resources/whatsapp/whatsapp.ts

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as TemplatesAPI from './templates';
+import { TemplateCreateParams, TemplateCreateResponse, TemplateListParams, Templates } from './templates';
+import * as BusinessAccountsAPI from './business-accounts/business-accounts';
+import {
+  BusinessAccountListParams,
+  BusinessAccountListResponse,
+  BusinessAccountListResponsesDefaultFlatPagination,
+  BusinessAccountRetrieveResponse,
+  BusinessAccounts,
+} from './business-accounts/business-accounts';
+import * as PhoneNumbersAPI from './phone-numbers/phone-numbers';
+import {
+  PhoneNumberListParams,
+  PhoneNumberListResponse,
+  PhoneNumberListResponsesDefaultFlatPagination,
+  PhoneNumberResendVerificationParams,
+  PhoneNumberVerifyParams,
+  PhoneNumbers,
+} from './phone-numbers/phone-numbers';
+
+export class Whatsapp extends APIResource {
+  businessAccounts: BusinessAccountsAPI.BusinessAccounts = new BusinessAccountsAPI.BusinessAccounts(
+    this._client,
+  );
+  templates: TemplatesAPI.Templates = new TemplatesAPI.Templates(this._client);
+  phoneNumbers: PhoneNumbersAPI.PhoneNumbers = new PhoneNumbersAPI.PhoneNumbers(this._client);
+}
+
+Whatsapp.BusinessAccounts = BusinessAccounts;
+Whatsapp.Templates = Templates;
+Whatsapp.PhoneNumbers = PhoneNumbers;
+
+export declare namespace Whatsapp {
+  export {
+    BusinessAccounts as BusinessAccounts,
+    type BusinessAccountRetrieveResponse as BusinessAccountRetrieveResponse,
+    type BusinessAccountListResponse as BusinessAccountListResponse,
+    type BusinessAccountListResponsesDefaultFlatPagination as BusinessAccountListResponsesDefaultFlatPagination,
+    type BusinessAccountListParams as BusinessAccountListParams,
+  };
+
+  export {
+    Templates as Templates,
+    type TemplateCreateResponse as TemplateCreateResponse,
+    type TemplateCreateParams as TemplateCreateParams,
+    type TemplateListParams as TemplateListParams,
+  };
+
+  export {
+    PhoneNumbers as PhoneNumbers,
+    type PhoneNumberListResponse as PhoneNumberListResponse,
+    type PhoneNumberListResponsesDefaultFlatPagination as PhoneNumberListResponsesDefaultFlatPagination,
+    type PhoneNumberListParams as PhoneNumberListParams,
+    type PhoneNumberResendVerificationParams as PhoneNumberResendVerificationParams,
+    type PhoneNumberVerifyParams as PhoneNumberVerifyParams,
+  };
+}

package/src/resources/whatsapp-message-templates.ts

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Manage Whatsapp message templates
+ */
+export class WhatsappMessageTemplates extends APIResource {
+  /**
+   * Get a Whatsapp message template by ID
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<WhatsappMessageTemplateRetrieveResponse> {
+    return this._client.get(path`/v2/whatsapp_message_templates/${id}`, options);
+  }
+
+  /**
+   * Update a Whatsapp message template
+   */
+  update(
+    id: string,
+    body: WhatsappMessageTemplateUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<WhatsappMessageTemplateUpdateResponse> {
+    return this._client.patch(path`/v2/whatsapp_message_templates/${id}`, { body, ...options });
+  }
+
+  /**
+   * Delete a Whatsapp message template
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/whatsapp_message_templates/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface WhatsappMessageTemplateRetrieveResponse {
+  data?: Shared.WhatsappTemplateData;
+}
+
+export interface WhatsappMessageTemplateUpdateResponse {
+  data?: Shared.WhatsappTemplateData;
+}
+
+export interface WhatsappMessageTemplateUpdateParams {
+  category?: 'MARKETING' | 'UTILITY' | 'AUTHENTICATION';
+
+  components?: Array<{ [key: string]: unknown }>;
+}
+
+export declare namespace WhatsappMessageTemplates {
+  export {
+    type WhatsappMessageTemplateRetrieveResponse as WhatsappMessageTemplateRetrieveResponse,
+    type WhatsappMessageTemplateUpdateResponse as WhatsappMessageTemplateUpdateResponse,
+    type WhatsappMessageTemplateUpdateParams as WhatsappMessageTemplateUpdateParams,
+  };
+}

package/src/resources/whatsapp.ts

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

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.7.0'; // x-release-please-version
+export const VERSION = '6.8.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.7.0";
+export declare const VERSION = "6.8.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 = '6.7.0'; // x-release-please-version
+exports.VERSION = '6.8.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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