@zavudev/sdk 0.56.0 → 0.58.0

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

@@ -1,35 +1,21 @@
-// 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, 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';
 
 export class Brands extends APIResource {
   /**
+   * Create 10DLC brand
+   *
    * Create a 10DLC brand registration. The brand starts in draft status. Submit it
    * for review using the submit endpoint.
    *
-   * @example
-   * ```ts
-   * const brand = await client.number10dlc.brands.create({
-   *   city: 'San Francisco',
-   *   country: 'US',
-   *   displayName: 'Acme Corp',
-   *   email: 'compliance@acme.com',
-   *   entityType: 'PRIVATE_PROFIT',
-   *   phone: '+14155551234',
-   *   postalCode: '94102',
-   *   state: 'CA',
-   *   street: '123 Main St',
-   *   vertical: 'Technology',
-   *   companyName: 'Acme Corporation',
-   *   ein: '12-3456789',
-   *   website: 'https://acme.com',
-   * });
-   * ```
+   * `POST /v1/10dlc/brands`
    */
   create(body: BrandCreateParams, options?: RequestOptions): APIPromise<BrandCreateResponse> {
     return this._client.post('/v1/10dlc/brands', { body, ...options });
@@ -38,26 +24,18 @@ export class Brands extends APIResource {
   /**
    * Get 10DLC brand
    *
-   * @example
-   * ```ts
-   * const brand = await client.number10dlc.brands.retrieve(
-   *   'brandId',
-   * );
-   * ```
+   * `GET /v1/10dlc/brands/{brandId}`
    */
   retrieve(brandID: string, options?: RequestOptions): APIPromise<BrandRetrieveResponse> {
     return this._client.get(path`/v1/10dlc/brands/${brandID}`, options);
   }
 
   /**
+   * Update 10DLC brand
+   *
    * Update a 10DLC brand in draft status. Cannot update after submission.
    *
-   * @example
-   * ```ts
-   * const brand = await client.number10dlc.brands.update(
-   *   'brandId',
-   * );
-   * ```
+   * `PATCH /v1/10dlc/brands/{brandId}`
    */
   update(
     brandID: string,
@@ -68,15 +46,11 @@ export class Brands extends APIResource {
   }
 
   /**
+   * List 10DLC brands
+   *
    * List 10DLC brand registrations for this project.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const tenDlcBrand of client.number10dlc.brands.list()) {
-   *   // ...
-   * }
-   * ```
+   * `GET /v1/10dlc/brands`
    */
   list(
     query: BrandListParams | null | undefined = {},
@@ -88,10 +62,7 @@ export class Brands extends APIResource {
   /**
    * Delete 10DLC brand
    *
-   * @example
-   * ```ts
-   * await client.number10dlc.brands.delete('brandId');
-   * ```
+   * `DELETE /v1/10dlc/brands/{brandId}`
    */
   delete(brandID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/v1/10dlc/brands/${brandID}`, {
@@ -101,268 +72,74 @@ export class Brands extends APIResource {
   }
 
   /**
+   * List 10DLC use cases
+   *
    * List available use cases for 10DLC campaign registration.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.number10dlc.brands.listUseCases();
-   * ```
+   * `GET /v1/10dlc/brands/use-cases`
    */
   listUseCases(options?: RequestOptions): APIPromise<BrandListUseCasesResponse> {
     return this._client.get('/v1/10dlc/brands/use-cases', options);
   }
 
   /**
+   * Submit 10DLC brand for review
+   *
    * Submit a draft brand to The Campaign Registry (TCR) for vetting. The brand must
-   * be in draft status. TCR's one-time $4 brand registration fee is charged from
-   * your balance at submission (passed through at cost) and refunded if the carrier
-   * rejects the registration. A team that already paid this fee through the
-   * compliance flow is not charged again. Campaign registration is billed separately
-   * when a campaign is submitted.
+   * be in draft status, and the team must have an approved Business Verification
+   * (KYB) — carriers register a brand against a vetted legal entity, so submitting
+   * without one returns `403` with code `kyb_required`.
+   *
+   * TCR's one-time $4 brand registration fee is charged from your balance at
+   * submission (passed through at cost) and refunded if the carrier rejects the
+   * registration. The fee is per BRAND: a team registering a second legal entity
+   * pays it again. A brand already paid for through the compliance flow is not
+   * charged twice. Campaign registration is billed separately when a campaign is
+   * submitted.
    *
-   * @example
-   * ```ts
-   * const response = await client.number10dlc.brands.submit(
-   *   'brandId',
-   * );
-   * ```
+   * `POST /v1/10dlc/brands/{brandId}/submit`
    */
   submit(brandID: string, options?: RequestOptions): APIPromise<BrandSubmitResponse> {
     return this._client.post(path`/v1/10dlc/brands/${brandID}/submit`, options);
   }
 
   /**
+   * Sync 10DLC brand status
+   *
    * Sync the brand status with the registration provider. Use this to check for
    * approval updates after submission.
    *
-   * @example
-   * ```ts
-   * const response = await client.number10dlc.brands.syncStatus(
-   *   'brandId',
-   * );
-   * ```
+   * `POST /v1/10dlc/brands/{brandId}/sync`
    */
   syncStatus(brandID: string, options?: RequestOptions): APIPromise<BrandSyncStatusResponse> {
     return this._client.post(path`/v1/10dlc/brands/${brandID}/sync`, options);
   }
 }
 
-export type TenDlcBrandsCursor = Cursor<TenDlcBrand>;
-
-export interface TenDlcBrand {
-  id: string;
-
-  city: string;
-
-  /**
-   * Two-letter ISO country code.
-   */
-  country: string;
-
-  createdAt: string;
-
-  /**
-   * Display name of the brand.
-   */
-  displayName: string;
-
-  email: string;
-
-  /**
-   * Business entity type for 10DLC brand registration.
-   */
-  entityType: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR';
-
-  /**
-   * Contact phone number in E.164 format.
-   */
-  phone: string;
-
-  postalCode: string;
-
-  state: string;
-
-  /**
-   * Status of a 10DLC brand registration.
-   */
-  status: 'draft' | 'pending' | 'verified' | 'rejected';
-
-  street: string;
-
-  updatedAt: string;
-
-  /**
-   * Industry vertical.
-   */
-  vertical: string;
-
-  brandRelationship?: string | null;
-
-  /**
-   * Trust score assigned by TCR after vetting.
-   */
-  brandScore?: number | null;
-
-  /**
-   * Legal company name.
-   */
-  companyName?: string | null;
-
-  /**
-   * Employer Identification Number (EIN).
-   */
-  ein?: string | null;
-
-  /**
-   * Reason for rejection, if applicable.
-   */
-  failureReason?: string | null;
-
-  firstName?: string | null;
-
-  lastName?: string | null;
-
-  stockExchange?: string | null;
+export type TenDlcBrandsCursor = Cursor<T.TenDlcBrand>;
 
-  stockSymbol?: string | null;
+export type TenDlcBrand = T.TenDlcBrand;
 
-  submittedAt?: string | null;
-
-  verifiedAt?: string | null;
-
-  website?: string | null;
-}
-
-export interface BrandCreateResponse {
-  brand: TenDlcBrand;
-}
-
-export interface BrandRetrieveResponse {
-  brand: TenDlcBrand;
-}
+export type BrandCreateResponse = T.TenDlcBrandResponse;
 
-export interface BrandUpdateResponse {
-  brand: TenDlcBrand;
-}
+export type BrandRetrieveResponse = T.TenDlcBrandResponse;
 
-export interface BrandListUseCasesResponse {
-  useCases: Array<BrandListUseCasesResponse.UseCase>;
-}
+export type BrandUpdateResponse = T.TenDlcBrandResponse;
 
+export type BrandListUseCasesResponse = T.ListTenDlcUseCasesResponse;
 export namespace BrandListUseCasesResponse {
-  export interface UseCase {
-    description?: string;
-
-    name?: string;
-  }
-}
-
-export interface BrandSubmitResponse {
-  brand: TenDlcBrand;
-}
-
-export interface BrandSyncStatusResponse {
-  brand: TenDlcBrand;
-}
-
-export interface BrandCreateParams {
-  city: string;
-
-  /**
-   * Two-letter ISO country code.
-   */
-  country: string;
-
-  /**
-   * Display name of the brand.
-   */
-  displayName: string;
-
-  email: string;
-
-  /**
-   * Business entity type for 10DLC brand registration.
-   */
-  entityType: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR';
-
-  /**
-   * Contact phone in E.164 format.
-   */
-  phone: string;
-
-  postalCode: string;
-
-  state: string;
-
-  street: string;
-
-  /**
-   * Industry vertical.
-   */
-  vertical: string;
-
-  /**
-   * Legal company name.
-   */
-  companyName?: string;
-
-  /**
-   * Employer Identification Number (format: XX-XXXXXXX).
-   */
-  ein?: string;
-
-  firstName?: string;
-
-  lastName?: string;
-
-  stockExchange?: string;
-
-  stockSymbol?: string;
-
-  website?: string;
+  export type UseCase = T.ListTenDlcUseCasesResponseUseCasesItem;
 }
 
-export interface BrandUpdateParams {
-  city?: string;
-
-  companyName?: string;
-
-  country?: string;
+export type BrandSubmitResponse = T.TenDlcBrandResponse;
 
-  displayName?: string;
+export type BrandSyncStatusResponse = T.TenDlcBrandResponse;
 
-  ein?: string;
+export type BrandCreateParams = T.Number10dlcBrandsCreateParams;
 
-  email?: string;
-
-  /**
-   * Business entity type for 10DLC brand registration.
-   */
-  entityType?: 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR';
-
-  firstName?: string;
-
-  lastName?: string;
-
-  phone?: string;
-
-  postalCode?: string;
-
-  state?: string;
-
-  stockExchange?: string;
-
-  stockSymbol?: string;
-
-  street?: string;
-
-  vertical?: string;
-
-  website?: string;
-}
+export type BrandUpdateParams = T.Number10dlcBrandsUpdateParams;
 
-export interface BrandListParams extends CursorParams {}
+export type BrandListParams = T.Number10dlcBrandsListParams;
 
 export declare namespace Brands {
   export {