@zavudev/sdk 0.17.0 → 0.19.0

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,
   };
 }

package/src/resources/regulatory-documents.ts

@@ -0,0 +1,184 @@
+// 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 RegulatoryDocuments extends APIResource {
+  /**
+   * Create a regulatory document record after uploading the file. Use the upload-url
+   * endpoint first to get an upload URL.
+   *
+   * @example
+   * ```ts
+   * const regulatoryDocument =
+   *   await client.regulatoryDocuments.create({
+   *     documentType: 'passport',
+   *     fileSize: 102400,
+   *     mimeType: 'image/jpeg',
+   *     name: 'Passport Scan',
+   *     storageId: 'kg2abc123...',
+   *   });
+   * ```
+   */
+  create(
+    body: RegulatoryDocumentCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<RegulatoryDocumentCreateResponse> {
+    return this._client.post('/v1/documents', { body, ...options });
+  }
+
+  /**
+   * Get a specific regulatory document.
+   *
+   * @example
+   * ```ts
+   * const regulatoryDocument =
+   *   await client.regulatoryDocuments.retrieve('documentId');
+   * ```
+   */
+  retrieve(documentID: string, options?: RequestOptions): APIPromise<RegulatoryDocumentRetrieveResponse> {
+    return this._client.get(path`/v1/documents/${documentID}`, options);
+  }
+
+  /**
+   * List regulatory documents for this project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const regulatoryDocument of client.regulatoryDocuments.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: RegulatoryDocumentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RegulatoryDocumentsCursor, RegulatoryDocument> {
+    return this._client.getAPIList('/v1/documents', Cursor<RegulatoryDocument>, { query, ...options });
+  }
+
+  /**
+   * Delete a regulatory document. Cannot delete verified documents.
+   *
+   * @example
+   * ```ts
+   * await client.regulatoryDocuments.delete('documentId');
+   * ```
+   */
+  delete(documentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/documents/${documentID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get a presigned URL to upload a document file. After uploading, use the
+   * storageId to create the document record.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.regulatoryDocuments.uploadURL();
+   * ```
+   */
+  uploadURL(options?: RequestOptions): APIPromise<RegulatoryDocumentUploadURLResponse> {
+    return this._client.post('/v1/documents/upload-url', options);
+  }
+}
+
+export type RegulatoryDocumentsCursor = Cursor<RegulatoryDocument>;
+
+/**
+ * A regulatory document for phone number requirements.
+ */
+export interface RegulatoryDocument {
+  id: string;
+
+  createdAt: string;
+
+  documentType:
+    | 'passport'
+    | 'national_id'
+    | 'drivers_license'
+    | 'utility_bill'
+    | 'tax_id'
+    | 'business_registration'
+    | 'proof_of_address'
+    | 'other';
+
+  name: string;
+
+  status: 'pending' | 'uploaded' | 'verified' | 'rejected';
+
+  fileSize?: number;
+
+  mimeType?: string;
+
+  rejectionReason?: string | null;
+
+  updatedAt?: string;
+}
+
+export interface RegulatoryDocumentCreateResponse {
+  /**
+   * A regulatory document for phone number requirements.
+   */
+  document: RegulatoryDocument;
+}
+
+export interface RegulatoryDocumentRetrieveResponse {
+  /**
+   * A regulatory document for phone number requirements.
+   */
+  document: RegulatoryDocument;
+}
+
+export interface RegulatoryDocumentUploadURLResponse {
+  /**
+   * Pre-signed URL for uploading the file.
+   */
+  uploadUrl: string;
+}
+
+export interface RegulatoryDocumentCreateParams {
+  documentType:
+    | 'passport'
+    | 'national_id'
+    | 'drivers_license'
+    | 'utility_bill'
+    | 'tax_id'
+    | 'business_registration'
+    | 'proof_of_address'
+    | 'other';
+
+  fileSize: number;
+
+  mimeType: string;
+
+  name: string;
+
+  /**
+   * Storage ID from the upload-url endpoint.
+   */
+  storageId: string;
+}
+
+export interface RegulatoryDocumentListParams extends CursorParams {}
+
+export declare namespace RegulatoryDocuments {
+  export {
+    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,
+  };
+}