@zavudev/sdk 0.56.0 → 0.58.0

package/src/resources/number-10dlc/campaigns/campaigns.ts

@@ -1,51 +1,32 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 import { APIResource } from '../../../core/resource';
-import * as PhoneNumbersAPI from './phone-numbers';
-import {
-  PhoneNumberAssignParams,
-  PhoneNumberAssignResponse,
-  PhoneNumberListResponse,
-  PhoneNumberUnassignParams,
-  PhoneNumbers,
-  TenDlcPhoneNumberAssignment,
-} from './phone-numbers';
 import { APIPromise } from '../../../core/api-promise';
-import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
+import { Cursor, PagePromise } from '../../../core/pagination';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
+import type * as T from '../../../types';
+import * as PhoneNumbersAPI from './phone-numbers';
+import {
+  PhoneNumbers,
+  type TenDlcPhoneNumberAssignment,
+  type PhoneNumberListResponse,
+  type PhoneNumberAssignResponse,
+  type PhoneNumberAssignParams,
+  type PhoneNumberUnassignParams,
+} from './phone-numbers';
 
 export class Campaigns extends APIResource {
   phoneNumbers: PhoneNumbersAPI.PhoneNumbers = new PhoneNumbersAPI.PhoneNumbers(this._client);
 
   /**
+   * Create 10DLC campaign
+   *
    * Create a 10DLC campaign under an existing brand. The campaign starts in draft
    * status. Submit it for carrier review using the submit endpoint.
    *
-   * @example
-   * ```ts
-   * const campaign = await client.number10dlc.campaigns.create({
-   *   affiliateMarketing: false,
-   *   ageGated: false,
-   *   brandId: 'brand_abc123',
-   *   description:
-   *     'Send order status updates and shipping notifications to customers who opted in.',
-   *   directLending: false,
-   *   embeddedLink: true,
-   *   embeddedPhone: false,
-   *   name: 'Order Notifications',
-   *   numberPooling: false,
-   *   sampleMessages: [
-   *     'Hi {{name}}, your order #{{order_id}} has shipped! Track it at {{url}}',
-   *     'Your order #{{order_id}} has been delivered. Thank you for your purchase!',
-   *   ],
-   *   subscriberHelp: true,
-   *   subscriberOptIn: true,
-   *   subscriberOptOut: true,
-   *   useCase: 'ACCOUNT_NOTIFICATION',
-   * });
-   * ```
+   * `POST /v1/10dlc/campaigns`
    */
   create(body: CampaignCreateParams, options?: RequestOptions): APIPromise<CampaignCreateResponse> {
     return this._client.post('/v1/10dlc/campaigns', { body, ...options });
@@ -54,25 +35,18 @@ export class Campaigns extends APIResource {
   /**
    * Get 10DLC campaign
    *
-   * @example
-   * ```ts
-   * const campaign =
-   *   await client.number10dlc.campaigns.retrieve('campaignId');
-   * ```
+   * `GET /v1/10dlc/campaigns/{campaignId}`
    */
   retrieve(campaignID: string, options?: RequestOptions): APIPromise<CampaignRetrieveResponse> {
     return this._client.get(path`/v1/10dlc/campaigns/${campaignID}`, options);
   }
 
   /**
+   * Update 10DLC campaign
+   *
    * Update a 10DLC campaign in draft status. Cannot update after submission.
    *
-   * @example
-   * ```ts
-   * const campaign = await client.number10dlc.campaigns.update(
-   *   'campaignId',
-   * );
-   * ```
+   * `PATCH /v1/10dlc/campaigns/{campaignId}`
    */
   update(
     campaignID: string,
@@ -83,15 +57,11 @@ export class Campaigns extends APIResource {
   }
 
   /**
+   * List 10DLC campaigns
+   *
    * List 10DLC campaign registrations for this project.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const tenDlcCampaign of client.number10dlc.campaigns.list()) {
-   *   // ...
-   * }
-   * ```
+   * `GET /v1/10dlc/campaigns`
    */
   list(
     query: CampaignListParams | null | undefined = {},
@@ -103,10 +73,7 @@ export class Campaigns extends APIResource {
   /**
    * Delete 10DLC campaign
    *
-   * @example
-   * ```ts
-   * await client.number10dlc.campaigns.delete('campaignId');
-   * ```
+   * `DELETE /v1/10dlc/campaigns/{campaignId}`
    */
   delete(campaignID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/v1/10dlc/campaigns/${campaignID}`, {
@@ -116,218 +83,55 @@ export class Campaigns extends APIResource {
   }
 
   /**
-   * Submit a draft campaign for carrier review. The campaign must be in draft status
-   * and its brand must be verified. TCR's one-time registration fee is charged from
-   * your balance at submission ($15 for standard use cases, $2 for LOW_VOLUME),
-   * passed through at cost and refunded if the carrier rejects it. Once approved,
-   * the campaign's monthly TCR fee ($10 standard, $2 LOW_VOLUME) is charged from
-   * your balance while the campaign is active — see registrationCostCents and
-   * monthlyFeeCents on the campaign object.
+   * Submit 10DLC campaign for review
+   *
+   * The team must have an approved Business Verification (KYB): submitting without
+   * one returns `403` with code `kyb_required`. Submit a draft campaign for carrier
+   * review. The campaign must be in draft status and its brand must be verified.
+   * TCR's one-time registration fee is charged from your balance at submission ($15
+   * for standard use cases, $2 for LOW_VOLUME), passed through at cost and refunded
+   * if the carrier rejects it. Once approved, the campaign's monthly TCR fee ($10
+   * standard, $2 LOW_VOLUME) is charged from your balance while the campaign is
+   * active — see registrationCostCents and monthlyFeeCents on the campaign object.
    *
-   * @example
-   * ```ts
-   * const response = await client.number10dlc.campaigns.submit(
-   *   'campaignId',
-   * );
-   * ```
+   * `POST /v1/10dlc/campaigns/{campaignId}/submit`
    */
   submit(campaignID: string, options?: RequestOptions): APIPromise<CampaignSubmitResponse> {
     return this._client.post(path`/v1/10dlc/campaigns/${campaignID}/submit`, options);
   }
 
   /**
+   * Sync 10DLC campaign status
+   *
    * Sync the campaign status with the registration provider. Use this to check for
    * approval updates after submission.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.number10dlc.campaigns.syncStatus(
-   *     'campaignId',
-   *   );
-   * ```
+   * `POST /v1/10dlc/campaigns/{campaignId}/sync`
    */
   syncStatus(campaignID: string, options?: RequestOptions): APIPromise<CampaignSyncStatusResponse> {
     return this._client.post(path`/v1/10dlc/campaigns/${campaignID}/sync`, options);
   }
 }
 
-export type TenDlcCampaignsCursor = Cursor<TenDlcCampaign>;
-
-export interface TenDlcCampaign {
-  id: string;
-
-  affiliateMarketing: boolean;
-
-  ageGated: boolean;
-
-  /**
-   * ID of the brand this campaign belongs to.
-   */
-  brandId: string;
-
-  createdAt: string;
-
-  /**
-   * Description of the messaging campaign.
-   */
-  description: string;
-
-  directLending: boolean;
-
-  embeddedLink: boolean;
-
-  embeddedPhone: boolean;
-
-  name: string;
-
-  numberPooling: boolean;
-
-  /**
-   * Sample messages representative of campaign content.
-   */
-  sampleMessages: Array<string>;
-
-  /**
-   * Status of a 10DLC campaign registration.
-   */
-  status: 'draft' | 'pending' | 'approved' | 'rejected';
-
-  subscriberHelp: boolean;
-
-  subscriberOptIn: boolean;
-
-  subscriberOptOut: boolean;
-
-  updatedAt: string;
-
-  /**
-   * Campaign use case type.
-   */
-  useCase: string;
-
-  approvedAt?: string | null;
-
-  /**
-   * Daily message limit based on brand trust score.
-   */
-  dailyLimit?: number | null;
-
-  failureReason?: string | null;
-
-  helpMessage?: string | null;
-
-  messageFlow?: string | null;
-
-  /**
-   * Recurring monthly fee in cents.
-   */
-  monthlyFeeCents?: number | null;
-
-  optInKeywords?: Array<string> | null;
-
-  optOutKeywords?: Array<string> | null;
-
-  /**
-   * One-time registration cost in cents.
-   */
-  registrationCostCents?: number | null;
-
-  submittedAt?: string | null;
-
-  subUseCases?: Array<string> | null;
-}
-
-export interface CampaignCreateResponse {
-  campaign: TenDlcCampaign;
-}
-
-export interface CampaignRetrieveResponse {
-  campaign: TenDlcCampaign;
-}
-
-export interface CampaignUpdateResponse {
-  campaign: TenDlcCampaign;
-}
-
-export interface CampaignSubmitResponse {
-  campaign: TenDlcCampaign;
-}
-
-export interface CampaignSyncStatusResponse {
-  campaign: TenDlcCampaign;
-}
-
-export interface CampaignCreateParams {
-  affiliateMarketing: boolean;
-
-  ageGated: boolean;
-
-  /**
-   * ID of the brand to create this campaign under.
-   */
-  brandId: string;
-
-  description: string;
+export type TenDlcCampaignsCursor = Cursor<T.TenDlcCampaign>;
 
-  directLending: boolean;
+export type TenDlcCampaign = T.TenDlcCampaign;
 
-  embeddedLink: boolean;
+export type CampaignCreateResponse = T.TenDlcCampaignResponse;
 
-  embeddedPhone: boolean;
+export type CampaignRetrieveResponse = T.TenDlcCampaignResponse;
 
-  name: string;
+export type CampaignUpdateResponse = T.TenDlcCampaignResponse;
 
-  numberPooling: boolean;
+export type CampaignSubmitResponse = T.TenDlcCampaignResponse;
 
-  sampleMessages: Array<string>;
+export type CampaignSyncStatusResponse = T.TenDlcCampaignResponse;
 
-  subscriberHelp: boolean;
+export type CampaignCreateParams = T.Number10dlcCampaignsCreateParams;
 
-  subscriberOptIn: boolean;
+export type CampaignUpdateParams = T.Number10dlcCampaignsUpdateParams;
 
-  subscriberOptOut: boolean;
-
-  /**
-   * Campaign use case (e.g., ACCOUNT_NOTIFICATION, MARKETING, 2FA).
-   */
-  useCase: string;
-
-  helpMessage?: string;
-
-  messageFlow?: string;
-
-  optInKeywords?: Array<string>;
-
-  optOutKeywords?: Array<string>;
-
-  subUseCases?: Array<string>;
-}
-
-export interface CampaignUpdateParams {
-  description?: string;
-
-  helpMessage?: string;
-
-  messageFlow?: string;
-
-  name?: string;
-
-  optInKeywords?: Array<string>;
-
-  optOutKeywords?: Array<string>;
-
-  sampleMessages?: Array<string>;
-}
-
-export interface CampaignListParams extends CursorParams {
-  /**
-   * Filter campaigns by brand ID.
-   */
-  brandId?: string;
-}
-
-Campaigns.PhoneNumbers = PhoneNumbers;
+export type CampaignListParams = T.Number10dlcCampaignsListParams;
 
 export declare namespace Campaigns {
   export {
@@ -341,9 +145,6 @@ export declare namespace Campaigns {
     type CampaignCreateParams as CampaignCreateParams,
     type CampaignUpdateParams as CampaignUpdateParams,
     type CampaignListParams as CampaignListParams,
-  };
-
-  export {
     PhoneNumbers as PhoneNumbers,
     type TenDlcPhoneNumberAssignment as TenDlcPhoneNumberAssignment,
     type PhoneNumberListResponse as PhoneNumberListResponse,

package/src/resources/number-10dlc/campaigns/index.ts

@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 export {
   Campaigns,

package/src/resources/number-10dlc/campaigns/phone-numbers.ts

@@ -1,39 +1,41 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
+import { Cursor, PagePromise } from '../../../core/pagination';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
+import type * as T from '../../../types';
 
 export class PhoneNumbers extends APIResource {
   /**
-   * List phone numbers assigned to a 10DLC campaign.
+   * List campaign phone number assignments
    *
-   * @example
-   * ```ts
-   * const phoneNumbers =
-   *   await client.number10dlc.campaigns.phoneNumbers.list(
-   *     'campaignId',
-   *   );
-   * ```
+   * List phone numbers assigned to a 10DLC campaign. A number that was unassigned is
+   * no longer listed.
+   *
+   * `GET /v1/10dlc/campaigns/{campaignId}/phone-numbers`
    */
-  list(campaignID: string, options?: RequestOptions): APIPromise<PhoneNumberListResponse> {
-    return this._client.get(path`/v1/10dlc/campaigns/${campaignID}/phone-numbers`, options);
+  list(
+    campaignID: string,
+    query: PhoneNumberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TenDlcPhoneNumberAssignmentsCursor, TenDlcPhoneNumberAssignment> {
+    return this._client.getAPIList(
+      path`/v1/10dlc/campaigns/${campaignID}/phone-numbers`,
+      Cursor<TenDlcPhoneNumberAssignment>,
+      { query, ...options },
+    );
   }
 
   /**
+   * Assign phone number to campaign
+   *
    * Assign a US phone number to an approved 10DLC campaign. The campaign must be in
    * approved status.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.number10dlc.campaigns.phoneNumbers.assign(
-   *     'campaignId',
-   *     { phoneNumberId: 'pn_abc123' },
-   *   );
-   * ```
+   * `POST /v1/10dlc/campaigns/{campaignId}/phone-numbers`
    */
   assign(
     campaignID: string,
@@ -44,15 +46,11 @@ export class PhoneNumbers extends APIResource {
   }
 
   /**
+   * Unassign phone number from campaign
+   *
    * Remove a phone number assignment from a 10DLC campaign.
    *
-   * @example
-   * ```ts
-   * await client.number10dlc.campaigns.phoneNumbers.unassign(
-   *   'assignmentId',
-   *   { campaignId: 'campaignId' },
-   * );
-   * ```
+   * `DELETE /v1/10dlc/campaigns/{campaignId}/phone-numbers/{assignmentId}`
    */
   unassign(
     assignmentID: string,
@@ -67,50 +65,19 @@ export class PhoneNumbers extends APIResource {
   }
 }
 
-export interface TenDlcPhoneNumberAssignment {
-  id: string;
-
-  campaignId: string;
-
-  createdAt: string;
-
-  phoneNumberId: string;
-
-  /**
-   * Assignment status.
-   */
-  status: 'pending' | 'active' | 'failed';
-
-  updatedAt: string;
+export type TenDlcPhoneNumberAssignment = T.TenDlcPhoneNumberAssignment;
 
-  assignedAt?: string | null;
+export type PhoneNumberListResponse = T.ListTenDlcCampaignPhoneNumbersResponse;
 
-  failureReason?: string | null;
-}
+export type PhoneNumberAssignResponse = T.TenDlcAssignmentResponse;
 
-export interface PhoneNumberListResponse {
-  items: Array<TenDlcPhoneNumberAssignment>;
+export type PhoneNumberAssignParams = T.Number10dlcCampaignsPhoneNumbersAssignParams;
 
-  nextCursor?: string | null;
-}
+export type PhoneNumberUnassignParams = T.Number10dlcCampaignsPhoneNumbersUnassignParams;
 
-export interface PhoneNumberAssignResponse {
-  assignment: TenDlcPhoneNumberAssignment;
-}
+export type PhoneNumberListParams = T.Number10dlcCampaignsPhoneNumbersListParams;
 
-export interface PhoneNumberAssignParams {
-  /**
-   * ID of the phone number to assign.
-   */
-  phoneNumberId: string;
-}
-
-export interface PhoneNumberUnassignParams {
-  /**
-   * 10DLC campaign ID.
-   */
-  campaignId: string;
-}
+export type TenDlcPhoneNumberAssignmentsCursor = Cursor<T.TenDlcPhoneNumberAssignment>;
 
 export declare namespace PhoneNumbers {
   export {

package/src/resources/number-10dlc/campaigns.ts

@@ -1,3 +1,3 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 export * from './campaigns/index';

package/src/resources/number-10dlc/index.ts

@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 export {
   Brands,

package/src/resources/number-10dlc/number-10dlc.ts

@@ -1,34 +1,34 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 import { APIResource } from '../../core/resource';
 import * as BrandsAPI from './brands';
+import * as CampaignsAPI from './campaigns/campaigns';
 import {
-  BrandCreateParams,
-  BrandCreateResponse,
-  BrandListParams,
-  BrandListUseCasesResponse,
-  BrandRetrieveResponse,
-  BrandSubmitResponse,
-  BrandSyncStatusResponse,
-  BrandUpdateParams,
-  BrandUpdateResponse,
   Brands,
-  TenDlcBrand,
-  TenDlcBrandsCursor,
+  type TenDlcBrand,
+  type BrandCreateResponse,
+  type BrandRetrieveResponse,
+  type BrandUpdateResponse,
+  type BrandListUseCasesResponse,
+  type BrandSubmitResponse,
+  type BrandSyncStatusResponse,
+  type TenDlcBrandsCursor,
+  type BrandCreateParams,
+  type BrandUpdateParams,
+  type BrandListParams,
 } from './brands';
-import * as CampaignsAPI from './campaigns/campaigns';
 import {
-  CampaignCreateParams,
-  CampaignCreateResponse,
-  CampaignListParams,
-  CampaignRetrieveResponse,
-  CampaignSubmitResponse,
-  CampaignSyncStatusResponse,
-  CampaignUpdateParams,
-  CampaignUpdateResponse,
   Campaigns,
-  TenDlcCampaign,
-  TenDlcCampaignsCursor,
+  type TenDlcCampaign,
+  type CampaignCreateResponse,
+  type CampaignRetrieveResponse,
+  type CampaignUpdateResponse,
+  type CampaignSubmitResponse,
+  type CampaignSyncStatusResponse,
+  type TenDlcCampaignsCursor,
+  type CampaignCreateParams,
+  type CampaignUpdateParams,
+  type CampaignListParams,
 } from './campaigns/campaigns';
 
 export class Number10dlc extends APIResource {
@@ -36,9 +36,6 @@ export class Number10dlc extends APIResource {
   campaigns: CampaignsAPI.Campaigns = new CampaignsAPI.Campaigns(this._client);
 }
 
-Number10dlc.Brands = Brands;
-Number10dlc.Campaigns = Campaigns;
-
 export declare namespace Number10dlc {
   export {
     Brands as Brands,
@@ -53,9 +50,6 @@ export declare namespace Number10dlc {
     type BrandCreateParams as BrandCreateParams,
     type BrandUpdateParams as BrandUpdateParams,
     type BrandListParams as BrandListParams,
-  };
-
-  export {
     Campaigns as Campaigns,
     type TenDlcCampaign as TenDlcCampaign,
     type CampaignCreateResponse as CampaignCreateResponse,

package/src/resources/number-10dlc.ts

@@ -1,3 +1,3 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 export * from './number-10dlc/index';