@zavudev/sdk 0.17.0 → 0.18.0

package/src/client.ts

@@ -18,6 +18,16 @@ import { AbstractPage, type CursorParams, CursorResponse } from './core/paginati
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
+import {
+  Address,
+  AddressCreateParams,
+  AddressCreateResponse,
+  AddressListParams,
+  AddressRetrieveResponse,
+  AddressStatus,
+  Addresses,
+  AddressesCursor,
+} from './resources/addresses';
 import {
   Contact,
   ContactListParams,
@@ -54,6 +64,8 @@ import {
   PhoneNumberPricing,
   PhoneNumberPurchaseParams,
   PhoneNumberPurchaseResponse,
+  PhoneNumberRequirementsParams,
+  PhoneNumberRequirementsResponse,
   PhoneNumberRetrieveResponse,
   PhoneNumberSearchAvailableParams,
   PhoneNumberSearchAvailableResponse,
@@ -62,25 +74,21 @@ import {
   PhoneNumberUpdateParams,
   PhoneNumberUpdateResponse,
   PhoneNumbers,
+  Requirement,
+  RequirementAcceptanceCriteria,
+  RequirementFieldType,
+  RequirementType,
 } from './resources/phone-numbers';
 import {
-  Sender,
-  SenderCreateParams,
-  SenderListParams,
-  SenderUpdateParams,
-  SenderUpdateProfileParams,
-  SenderUpdateProfileResponse,
-  SenderUploadProfilePictureParams,
-  SenderUploadProfilePictureResponse,
-  SenderWebhook,
-  Senders,
-  SendersCursor,
-  WebhookEvent,
-  WebhookSecretResponse,
-  WhatsappBusinessProfile,
-  WhatsappBusinessProfileResponse,
-  WhatsappBusinessProfileVertical,
-} from './resources/senders';
+  RegulatoryDocument,
+  RegulatoryDocumentCreateParams,
+  RegulatoryDocumentCreateResponse,
+  RegulatoryDocumentListParams,
+  RegulatoryDocumentRetrieveResponse,
+  RegulatoryDocumentUploadURLResponse,
+  RegulatoryDocuments,
+  RegulatoryDocumentsCursor,
+} from './resources/regulatory-documents';
 import {
   Template,
   TemplateCreateParams,
@@ -102,6 +110,8 @@ import {
   BroadcastListParams,
   BroadcastMessageType,
   BroadcastProgress,
+  BroadcastRescheduleParams,
+  BroadcastRescheduleResponse,
   BroadcastRetrieveResponse,
   BroadcastSendParams,
   BroadcastSendResponse,
@@ -111,6 +121,24 @@ import {
   Broadcasts,
   BroadcastsCursor,
 } from './resources/broadcasts/broadcasts';
+import {
+  Sender,
+  SenderCreateParams,
+  SenderListParams,
+  SenderUpdateParams,
+  SenderUpdateProfileParams,
+  SenderUpdateProfileResponse,
+  SenderUploadProfilePictureParams,
+  SenderUploadProfilePictureResponse,
+  SenderWebhook,
+  Senders,
+  SendersCursor,
+  WebhookEvent,
+  WebhookSecretResponse,
+  WhatsappBusinessProfile,
+  WhatsappBusinessProfileResponse,
+  WhatsappBusinessProfileVertical,
+} from './resources/senders/senders';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -834,6 +862,8 @@ export class Zavudev {
   broadcasts: API.Broadcasts = new API.Broadcasts(this);
   introspect: API.Introspect = new API.Introspect(this);
   phoneNumbers: API.PhoneNumbers = new API.PhoneNumbers(this);
+  addresses: API.Addresses = new API.Addresses(this);
+  regulatoryDocuments: API.RegulatoryDocuments = new API.RegulatoryDocuments(this);
 }
 
 Zavudev.Messages = Messages;
@@ -843,6 +873,8 @@ Zavudev.Contacts = Contacts;
 Zavudev.Broadcasts = Broadcasts;
 Zavudev.Introspect = Introspect;
 Zavudev.PhoneNumbers = PhoneNumbers;
+Zavudev.Addresses = Addresses;
+Zavudev.RegulatoryDocuments = RegulatoryDocuments;
 
 export declare namespace Zavudev {
   export type RequestOptions = Opts.RequestOptions;
@@ -915,11 +947,13 @@ export declare namespace Zavudev {
     type BroadcastRetrieveResponse as BroadcastRetrieveResponse,
     type BroadcastUpdateResponse as BroadcastUpdateResponse,
     type BroadcastCancelResponse as BroadcastCancelResponse,
+    type BroadcastRescheduleResponse as BroadcastRescheduleResponse,
     type BroadcastSendResponse as BroadcastSendResponse,
     type BroadcastsCursor as BroadcastsCursor,
     type BroadcastCreateParams as BroadcastCreateParams,
     type BroadcastUpdateParams as BroadcastUpdateParams,
     type BroadcastListParams as BroadcastListParams,
+    type BroadcastRescheduleParams as BroadcastRescheduleParams,
     type BroadcastSendParams as BroadcastSendParams,
   };
 
@@ -939,14 +973,42 @@ export declare namespace Zavudev {
     type PhoneNumberPricing as PhoneNumberPricing,
     type PhoneNumberStatus as PhoneNumberStatus,
     type PhoneNumberType as PhoneNumberType,
+    type Requirement as Requirement,
+    type RequirementAcceptanceCriteria as RequirementAcceptanceCriteria,
+    type RequirementFieldType as RequirementFieldType,
+    type RequirementType as RequirementType,
     type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse,
     type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse,
     type PhoneNumberPurchaseResponse as PhoneNumberPurchaseResponse,
+    type PhoneNumberRequirementsResponse as PhoneNumberRequirementsResponse,
     type PhoneNumberSearchAvailableResponse as PhoneNumberSearchAvailableResponse,
     type OwnedPhoneNumbersCursor as OwnedPhoneNumbersCursor,
     type PhoneNumberUpdateParams as PhoneNumberUpdateParams,
     type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams,
+    type PhoneNumberRequirementsParams as PhoneNumberRequirementsParams,
     type PhoneNumberSearchAvailableParams as PhoneNumberSearchAvailableParams,
   };
+
+  export {
+    Addresses as Addresses,
+    type Address as Address,
+    type AddressStatus as AddressStatus,
+    type AddressCreateResponse as AddressCreateResponse,
+    type AddressRetrieveResponse as AddressRetrieveResponse,
+    type AddressesCursor as AddressesCursor,
+    type AddressCreateParams as AddressCreateParams,
+    type AddressListParams as AddressListParams,
+  };
+
+  export {
+    RegulatoryDocuments as RegulatoryDocuments,
+    type RegulatoryDocument as RegulatoryDocument,
+    type RegulatoryDocumentCreateResponse as RegulatoryDocumentCreateResponse,
+    type RegulatoryDocumentRetrieveResponse as RegulatoryDocumentRetrieveResponse,
+    type RegulatoryDocumentUploadURLResponse as RegulatoryDocumentUploadURLResponse,
+    type RegulatoryDocumentsCursor as RegulatoryDocumentsCursor,
+    type RegulatoryDocumentCreateParams as RegulatoryDocumentCreateParams,
+    type RegulatoryDocumentListParams as RegulatoryDocumentListParams,
+  };
 }

package/src/resources/addresses.ts

@@ -0,0 +1,160 @@
+// 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 { Cursor, type CursorParams, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Addresses extends APIResource {
+  /**
+   * Create a regulatory address for phone number purchases. Some countries require a
+   * verified address before phone numbers can be activated.
+   *
+   * @example
+   * ```ts
+   * const address = await client.addresses.create({
+   *   countryCode: 'DE',
+   *   locality: 'Berlin',
+   *   postalCode: '10115',
+   *   streetAddress: '123 Main St',
+   *   firstName: 'John',
+   *   lastName: 'Doe',
+   * });
+   * ```
+   */
+  create(body: AddressCreateParams, options?: RequestOptions): APIPromise<AddressCreateResponse> {
+    return this._client.post('/v1/addresses', { body, ...options });
+  }
+
+  /**
+   * Get a specific regulatory address.
+   *
+   * @example
+   * ```ts
+   * const address = await client.addresses.retrieve(
+   *   'addressId',
+   * );
+   * ```
+   */
+  retrieve(addressID: string, options?: RequestOptions): APIPromise<AddressRetrieveResponse> {
+    return this._client.get(path`/v1/addresses/${addressID}`, options);
+  }
+
+  /**
+   * List regulatory addresses for this project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const address of client.addresses.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: AddressListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AddressesCursor, Address> {
+    return this._client.getAPIList('/v1/addresses', Cursor<Address>, { query, ...options });
+  }
+
+  /**
+   * Delete a regulatory address. Cannot delete addresses that are in use.
+   *
+   * @example
+   * ```ts
+   * await client.addresses.delete('addressId');
+   * ```
+   */
+  delete(addressID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/addresses/${addressID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type AddressesCursor = Cursor<Address>;
+
+/**
+ * A regulatory address for phone number requirements.
+ */
+export interface Address {
+  id: string;
+
+  countryCode: string;
+
+  createdAt: string;
+
+  locality: string;
+
+  postalCode: string;
+
+  status: AddressStatus;
+
+  streetAddress: string;
+
+  administrativeArea?: string | null;
+
+  businessName?: string | null;
+
+  extendedAddress?: string | null;
+
+  firstName?: string | null;
+
+  lastName?: string | null;
+
+  updatedAt?: string;
+}
+
+export type AddressStatus = 'pending' | 'verified' | 'rejected';
+
+export interface AddressCreateResponse {
+  /**
+   * A regulatory address for phone number requirements.
+   */
+  address: Address;
+}
+
+export interface AddressRetrieveResponse {
+  /**
+   * A regulatory address for phone number requirements.
+   */
+  address: Address;
+}
+
+export interface AddressCreateParams {
+  countryCode: string;
+
+  locality: string;
+
+  postalCode: string;
+
+  streetAddress: string;
+
+  administrativeArea?: string;
+
+  businessName?: string;
+
+  extendedAddress?: string;
+
+  firstName?: string;
+
+  lastName?: string;
+}
+
+export interface AddressListParams extends CursorParams {}
+
+export declare namespace Addresses {
+  export {
+    type Address as Address,
+    type AddressStatus as AddressStatus,
+    type AddressCreateResponse as AddressCreateResponse,
+    type AddressRetrieveResponse as AddressRetrieveResponse,
+    type AddressesCursor as AddressesCursor,
+    type AddressCreateParams as AddressCreateParams,
+    type AddressListParams as AddressListParams,
+  };
+}

package/src/resources/broadcasts/broadcasts.ts

@@ -129,6 +129,26 @@ export class Broadcasts extends APIResource {
     return this._client.get(path`/v1/broadcasts/${broadcastID}/progress`, options);
   }
 
+  /**
+   * Update the scheduled time for a broadcast. The broadcast must be in scheduled
+   * status.
+   *
+   * @example
+   * ```ts
+   * const response = await client.broadcasts.reschedule(
+   *   'broadcastId',
+   *   { scheduledAt: '2024-01-15T14:00:00Z' },
+   * );
+   * ```
+   */
+  reschedule(
+    broadcastID: string,
+    body: BroadcastRescheduleParams,
+    options?: RequestOptions,
+  ): APIPromise<BroadcastRescheduleResponse> {
+    return this._client.patch(path`/v1/broadcasts/${broadcastID}/schedule`, { body, ...options });
+  }
+
   /**
    * Start sending the broadcast immediately or schedule for later. Reserves the
    * estimated cost from your balance.
@@ -396,6 +416,10 @@ export interface BroadcastCancelResponse {
   broadcast: Broadcast;
 }
 
+export interface BroadcastRescheduleResponse {
+  broadcast: Broadcast;
+}
+
 export interface BroadcastSendResponse {
   broadcast: Broadcast;
 }
@@ -478,6 +502,13 @@ export interface BroadcastListParams extends CursorParams {
   status?: BroadcastStatus;
 }
 
+export interface BroadcastRescheduleParams {
+  /**
+   * New scheduled time for the broadcast.
+   */
+  scheduledAt: string;
+}
+
 export interface BroadcastSendParams {
   /**
    * Schedule for future delivery. Omit to send immediately.
@@ -501,11 +532,13 @@ export declare namespace Broadcasts {
     type BroadcastRetrieveResponse as BroadcastRetrieveResponse,
     type BroadcastUpdateResponse as BroadcastUpdateResponse,
     type BroadcastCancelResponse as BroadcastCancelResponse,
+    type BroadcastRescheduleResponse as BroadcastRescheduleResponse,
     type BroadcastSendResponse as BroadcastSendResponse,
     type BroadcastsCursor as BroadcastsCursor,
     type BroadcastCreateParams as BroadcastCreateParams,
     type BroadcastUpdateParams as BroadcastUpdateParams,
     type BroadcastListParams as BroadcastListParams,
+    type BroadcastRescheduleParams as BroadcastRescheduleParams,
     type BroadcastSendParams as BroadcastSendParams,
   };
 

package/src/resources/broadcasts/index.ts

@@ -14,10 +14,12 @@ export {
   type BroadcastRetrieveResponse,
   type BroadcastUpdateResponse,
   type BroadcastCancelResponse,
+  type BroadcastRescheduleResponse,
   type BroadcastSendResponse,
   type BroadcastCreateParams,
   type BroadcastUpdateParams,
   type BroadcastListParams,
+  type BroadcastRescheduleParams,
   type BroadcastSendParams,
   type BroadcastContactsCursor,
   type BroadcastsCursor,

package/src/resources/index.ts

@@ -1,5 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Addresses,
+  type Address,
+  type AddressStatus,
+  type AddressCreateResponse,
+  type AddressRetrieveResponse,
+  type AddressCreateParams,
+  type AddressListParams,
+  type AddressesCursor,
+} from './addresses';
 export {
   Broadcasts,
   type Broadcast,
@@ -14,10 +24,12 @@ export {
   type BroadcastRetrieveResponse,
   type BroadcastUpdateResponse,
   type BroadcastCancelResponse,
+  type BroadcastRescheduleResponse,
   type BroadcastSendResponse,
   type BroadcastCreateParams,
   type BroadcastUpdateParams,
   type BroadcastListParams,
+  type BroadcastRescheduleParams,
   type BroadcastSendParams,
   type BroadcastContactsCursor,
   type BroadcastsCursor,
@@ -57,16 +69,32 @@ export {
   type PhoneNumberPricing,
   type PhoneNumberStatus,
   type PhoneNumberType,
+  type Requirement,
+  type RequirementAcceptanceCriteria,
+  type RequirementFieldType,
+  type RequirementType,
   type PhoneNumberRetrieveResponse,
   type PhoneNumberUpdateResponse,
   type PhoneNumberPurchaseResponse,
+  type PhoneNumberRequirementsResponse,
   type PhoneNumberSearchAvailableResponse,
   type PhoneNumberUpdateParams,
   type PhoneNumberListParams,
   type PhoneNumberPurchaseParams,
+  type PhoneNumberRequirementsParams,
   type PhoneNumberSearchAvailableParams,
   type OwnedPhoneNumbersCursor,
 } from './phone-numbers';
+export {
+  RegulatoryDocuments,
+  type RegulatoryDocument,
+  type RegulatoryDocumentCreateResponse,
+  type RegulatoryDocumentRetrieveResponse,
+  type RegulatoryDocumentUploadURLResponse,
+  type RegulatoryDocumentCreateParams,
+  type RegulatoryDocumentListParams,
+  type RegulatoryDocumentsCursor,
+} from './regulatory-documents';
 export {
   Senders,
   type Sender,
@@ -84,7 +112,7 @@ export {
   type SenderUpdateProfileParams,
   type SenderUploadProfilePictureParams,
   type SendersCursor,
-} from './senders';
+} from './senders/senders';
 export {
   Templates,
   type Template,

package/src/resources/phone-numbers.ts

@@ -93,6 +93,25 @@ export class PhoneNumbers extends APIResource {
     });
   }
 
+  /**
+   * Get regulatory requirements for purchasing phone numbers in a specific country.
+   * Some countries require additional documentation (addresses, identity documents)
+   * before phone numbers can be activated.
+   *
+   * @example
+   * ```ts
+   * const response = await client.phoneNumbers.requirements({
+   *   countryCode: 'xx',
+   * });
+   * ```
+   */
+  requirements(
+    query: PhoneNumberRequirementsParams,
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberRequirementsResponse> {
+    return this._client.get('/v1/phone-numbers/requirements', { query, ...options });
+  }
+
   /**
    * Search for available phone numbers to purchase by country and type.
    *
@@ -206,6 +225,62 @@ export type PhoneNumberStatus = 'active' | 'suspended' | 'pending';
 
 export type PhoneNumberType = 'local' | 'mobile' | 'tollFree';
 
+/**
+ * A group of requirements for a specific country/phone type combination.
+ */
+export interface Requirement {
+  id: string;
+
+  action: string;
+
+  countryCode: string;
+
+  phoneNumberType: string;
+
+  requirementTypes: Array<RequirementType>;
+}
+
+/**
+ * Acceptance criteria for a requirement.
+ */
+export interface RequirementAcceptanceCriteria {
+  allowedValues?: Array<string> | null;
+
+  maxLength?: number | null;
+
+  minLength?: number | null;
+
+  regexPattern?: string | null;
+}
+
+/**
+ * Type of requirement field.
+ */
+export type RequirementFieldType = 'textual' | 'address' | 'document' | 'action';
+
+/**
+ * A specific requirement type within a requirement group.
+ */
+export interface RequirementType {
+  id: string;
+
+  description: string;
+
+  name: string;
+
+  /**
+   * Type of requirement field.
+   */
+  type: RequirementFieldType;
+
+  /**
+   * Acceptance criteria for a requirement.
+   */
+  acceptanceCriteria?: RequirementAcceptanceCriteria;
+
+  example?: string | null;
+}
+
 export interface PhoneNumberRetrieveResponse {
   phoneNumber: OwnedPhoneNumber;
 }
@@ -218,6 +293,10 @@ export interface PhoneNumberPurchaseResponse {
   phoneNumber: OwnedPhoneNumber;
 }
 
+export interface PhoneNumberRequirementsResponse {
+  items: Array<Requirement>;
+}
+
 export interface PhoneNumberSearchAvailableResponse {
   items: Array<AvailablePhoneNumber>;
 }
@@ -253,6 +332,18 @@ export interface PhoneNumberPurchaseParams {
   name?: string;
 }
 
+export interface PhoneNumberRequirementsParams {
+  /**
+   * Two-letter ISO country code.
+   */
+  countryCode: string;
+
+  /**
+   * Type of phone number (local, mobile, tollFree).
+   */
+  type?: PhoneNumberType;
+}
+
 export interface PhoneNumberSearchAvailableParams {
   /**
    * Two-letter ISO country code.
@@ -284,14 +375,20 @@ export declare namespace PhoneNumbers {
     type PhoneNumberPricing as PhoneNumberPricing,
     type PhoneNumberStatus as PhoneNumberStatus,
     type PhoneNumberType as PhoneNumberType,
+    type Requirement as Requirement,
+    type RequirementAcceptanceCriteria as RequirementAcceptanceCriteria,
+    type RequirementFieldType as RequirementFieldType,
+    type RequirementType as RequirementType,
     type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse,
     type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse,
     type PhoneNumberPurchaseResponse as PhoneNumberPurchaseResponse,
+    type PhoneNumberRequirementsResponse as PhoneNumberRequirementsResponse,
     type PhoneNumberSearchAvailableResponse as PhoneNumberSearchAvailableResponse,
     type OwnedPhoneNumbersCursor as OwnedPhoneNumbersCursor,
     type PhoneNumberUpdateParams as PhoneNumberUpdateParams,
     type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams,
+    type PhoneNumberRequirementsParams as PhoneNumberRequirementsParams,
     type PhoneNumberSearchAvailableParams as PhoneNumberSearchAvailableParams,
   };
 }