@zavudev/sdk 0.31.0 → 0.43.0

package/src/resources/sub-accounts/sub-accounts.ts

@@ -0,0 +1,252 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as APIKeysAPI from './api-keys';
+import {
+  APIKeyCreateParams,
+  APIKeyCreateResponse,
+  APIKeyListResponse,
+  APIKeyRevokeParams,
+  APIKeys,
+} from './api-keys';
+import { APIPromise } from '../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class SubAccounts extends APIResource {
+  apiKeys: APIKeysAPI.APIKeys = new APIKeysAPI.APIKeys(this._client);
+
+  /**
+   * Create a new sub-account (project) with its own API key. All charges are billed
+   * to the parent team's balance. Use creditLimit to set a spending cap. The
+   * sub-account's API key is returned only in the creation response. Requires a
+   * parent project API key; sub-account API keys receive HTTP 403.
+   *
+   * @example
+   * ```ts
+   * const subAccount = await client.subAccounts.create({
+   *   name: 'Client ABC',
+   * });
+   * ```
+   */
+  create(body: SubAccountCreateParams, options?: RequestOptions): APIPromise<SubAccountCreateResponse> {
+    return this._client.post('/v1/sub-accounts', { body, ...options });
+  }
+
+  /**
+   * Get sub-account. Requires a parent project API key; sub-account API keys receive
+   * HTTP 403.
+   *
+   * @example
+   * ```ts
+   * const subAccount = await client.subAccounts.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SubAccountRetrieveResponse> {
+    return this._client.get(path`/v1/sub-accounts/${id}`, options);
+  }
+
+  /**
+   * Update sub-account. Requires a parent project API key; sub-account API keys
+   * receive HTTP 403.
+   *
+   * @example
+   * ```ts
+   * const subAccount = await client.subAccounts.update('id');
+   * ```
+   */
+  update(
+    id: string,
+    body: SubAccountUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<SubAccountUpdateResponse> {
+    return this._client.patch(path`/v1/sub-accounts/${id}`, { body, ...options });
+  }
+
+  /**
+   * List sub-accounts for this team. Requires a parent project API key; sub-account
+   * API keys receive HTTP 403.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const subAccount of client.subAccounts.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: SubAccountListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SubAccountsCursor, SubAccount> {
+    return this._client.getAPIList('/v1/sub-accounts', Cursor<SubAccount>, { query, ...options });
+  }
+
+  /**
+   * Deactivate a sub-account. Remaining balance is returned to the parent team and
+   * all API keys are revoked. Requires a parent project API key; sub-account API
+   * keys receive HTTP 403.
+   *
+   * @example
+   * ```ts
+   * const response = await client.subAccounts.deactivate('id');
+   * ```
+   */
+  deactivate(id: string, options?: RequestOptions): APIPromise<SubAccountDeactivateResponse> {
+    return this._client.delete(path`/v1/sub-accounts/${id}`, options);
+  }
+
+  /**
+   * Get spending information for a sub-account. Returns the parent team's balance,
+   * the sub-account's total spending, and its credit limit (spending cap). Requires
+   * a parent project API key; sub-account API keys receive HTTP 403.
+   *
+   * @example
+   * ```ts
+   * const response = await client.subAccounts.getBalance('id');
+   * ```
+   */
+  getBalance(id: string, options?: RequestOptions): APIPromise<SubAccountGetBalanceResponse> {
+    return this._client.get(path`/v1/sub-accounts/${id}/balance`, options);
+  }
+}
+
+export type SubAccountsCursor = Cursor<SubAccount>;
+
+export interface SubAccount {
+  id: string;
+
+  createdAt: string;
+
+  name: string;
+
+  status: 'active' | 'inactive';
+
+  /**
+   * Total amount spent by this sub-account in cents.
+   */
+  totalSpent: number;
+
+  /**
+   * API key for the sub-account. Only returned on creation.
+   */
+  apiKey?: string;
+
+  /**
+   * Spending cap in cents. When reached, messages from this sub-account will be
+   * blocked.
+   */
+  creditLimit?: number | null;
+
+  /**
+   * External reference ID set by the parent account.
+   */
+  externalId?: string | null;
+
+  metadata?: { [key: string]: unknown } | null;
+}
+
+export interface SubAccountCreateResponse {
+  subAccount: SubAccount;
+}
+
+export interface SubAccountRetrieveResponse {
+  subAccount: SubAccount;
+}
+
+export interface SubAccountUpdateResponse {
+  subAccount: SubAccount;
+}
+
+export interface SubAccountDeactivateResponse {
+  /**
+   * Number of API keys revoked.
+   */
+  keysRevoked: number;
+
+  message: string;
+}
+
+export interface SubAccountGetBalanceResponse {
+  /**
+   * Team balance in cents. All charges are billed to the parent team.
+   */
+  balance: number;
+
+  currency: string;
+
+  /**
+   * Spending cap in cents (only for sub-accounts).
+   */
+  creditLimit?: number | null;
+
+  /**
+   * Whether this API key belongs to a sub-account.
+   */
+  isSubAccount?: boolean;
+
+  /**
+   * Total amount spent by this sub-account in cents (only for sub-accounts).
+   */
+  totalSpent?: number | null;
+}
+
+export interface SubAccountCreateParams {
+  /**
+   * Name of the sub-account.
+   */
+  name: string;
+
+  /**
+   * Spending cap in cents. When reached, messages from this sub-account will be
+   * blocked. Omit or set to 0 for no limit.
+   */
+  creditLimit?: number;
+
+  /**
+   * External reference ID for your own tracking.
+   */
+  externalId?: string;
+
+  metadata?: { [key: string]: unknown };
+}
+
+export interface SubAccountUpdateParams {
+  creditLimit?: number | null;
+
+  externalId?: string;
+
+  metadata?: { [key: string]: unknown };
+
+  name?: string;
+
+  status?: 'active' | 'inactive';
+}
+
+export interface SubAccountListParams extends CursorParams {}
+
+SubAccounts.APIKeys = APIKeys;
+
+export declare namespace SubAccounts {
+  export {
+    type SubAccount as SubAccount,
+    type SubAccountCreateResponse as SubAccountCreateResponse,
+    type SubAccountRetrieveResponse as SubAccountRetrieveResponse,
+    type SubAccountUpdateResponse as SubAccountUpdateResponse,
+    type SubAccountDeactivateResponse as SubAccountDeactivateResponse,
+    type SubAccountGetBalanceResponse as SubAccountGetBalanceResponse,
+    type SubAccountsCursor as SubAccountsCursor,
+    type SubAccountCreateParams as SubAccountCreateParams,
+    type SubAccountUpdateParams as SubAccountUpdateParams,
+    type SubAccountListParams as SubAccountListParams,
+  };
+
+  export {
+    APIKeys as APIKeys,
+    type APIKeyCreateResponse as APIKeyCreateResponse,
+    type APIKeyListResponse as APIKeyListResponse,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyRevokeParams as APIKeyRevokeParams,
+  };
+}

package/src/resources/sub-accounts.ts

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

package/src/resources/templates.ts

@@ -98,7 +98,8 @@ export interface Template {
   id: string;
 
   /**
-   * Template body with variables: {{1}}, {{2}}, etc.
+   * Default template body with variables: {{1}}, {{2}}, or named variables like
+   * {{contact.first_name}}. Used when no channel-specific body is set.
    */
   body: string;
 
@@ -113,7 +114,7 @@ export interface Template {
   language: string;
 
   /**
-   * Template name (must match WhatsApp template name).
+   * Template name. For WhatsApp, must match the approved template name in Meta.
    */
   name: string;
 
@@ -149,8 +150,23 @@ export interface Template {
    */
   headerType?: string;
 
+  /**
+   * Channel-specific body for Instagram messages. Falls back to `body` if not set.
+   */
+  instagramBody?: string;
+
+  /**
+   * Channel-specific body for SMS messages. Falls back to `body` if not set.
+   */
+  smsBody?: string;
+
   status?: 'draft' | 'pending' | 'approved' | 'rejected';
 
+  /**
+   * Channel-specific body for Telegram messages. Falls back to `body` if not set.
+   */
+  telegramBody?: string;
+
   updatedAt?: string;
 
   /**
@@ -166,6 +182,12 @@ export interface Template {
 
 export namespace Template {
   export interface Button {
+    /**
+     * Sample value used to substitute `{{1}}` in the URL when submitting the template
+     * to Meta for review. Only present for dynamic URL buttons.
+     */
+    example?: string;
+
     /**
      * OTP button type. Required when type is 'otp'.
      */
@@ -217,6 +239,9 @@ export namespace Template {
 export type WhatsappCategory = 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
 
 export interface TemplateCreateParams {
+  /**
+   * Default template body. Used when no channel-specific body is set.
+   */
   body: string;
 
   language: string;
@@ -238,6 +263,36 @@ export interface TemplateCreateParams {
    */
   codeExpirationMinutes?: number;
 
+  /**
+   * Footer text for the template.
+   */
+  footer?: string;
+
+  /**
+   * Header content (text string or media URL).
+   */
+  headerContent?: string;
+
+  /**
+   * Type of header for the template.
+   */
+  headerType?: 'text' | 'image' | 'video' | 'document';
+
+  /**
+   * Channel-specific body for Instagram. Falls back to `body` if not set.
+   */
+  instagramBody?: string;
+
+  /**
+   * Channel-specific body for SMS. Falls back to `body` if not set.
+   */
+  smsBody?: string;
+
+  /**
+   * Channel-specific body for Telegram. Falls back to `body` if not set.
+   */
+  telegramBody?: string;
+
   variables?: Array<string>;
 
   /**
@@ -252,6 +307,13 @@ export namespace TemplateCreateParams {
 
     type: 'quick_reply' | 'url' | 'phone' | 'otp';
 
+    /**
+     * Sample value Meta uses to review templates with a dynamic URL button.
+     * Substituted into `{{1}}` of the URL when the template is submitted to Meta. Only
+     * meaningful when `url` contains `{{1}}`; ignored for static URLs.
+     */
+    example?: string;
+
     /**
      * Required when type is 'otp'. COPY_CODE shows copy button, ONE_TAP enables
      * Android autofill.
@@ -270,6 +332,11 @@ export namespace TemplateCreateParams {
      */
     signatureHash?: string;
 
+    /**
+     * Button destination. Use `{{1}}` exactly once for a dynamic URL (e.g.
+     * `https://example.com/orders/{{1}}`); WhatsApp only accepts the strict `{{1}}`
+     * form. Static URLs must not contain any `{{...}}` placeholder.
+     */
     url?: string;
   }
 }

package/src/resources/urls.ts

@@ -0,0 +1,125 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class URLs extends APIResource {
+  /**
+   * List URLs that have been verified for this project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const verifiedURL of client.urls.listVerified()) {
+   *   // ...
+   * }
+   * ```
+   */
+  listVerified(
+    query: URLListVerifiedParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<VerifiedURLsCursor, VerifiedURL> {
+    return this._client.getAPIList('/v1/urls', Cursor<VerifiedURL>, { query, ...options });
+  }
+
+  /**
+   * Get details of a specific verified URL.
+   *
+   * @example
+   * ```ts
+   * const response = await client.urls.retrieveDetails('urlId');
+   * ```
+   */
+  retrieveDetails(urlID: string, options?: RequestOptions): APIPromise<URLRetrieveDetailsResponse> {
+    return this._client.get(path`/v1/urls/${urlID}`, options);
+  }
+
+  /**
+   * Submit a URL for verification. URLs are automatically checked against Google Web
+   * Risk API. Safe URLs are auto-approved, malicious URLs are blocked. URL
+   * shorteners (bit.ly, t.co, etc.) are always blocked.
+   *
+   * **Important:** All SMS and Email messages containing URLs require those URLs to
+   * be verified before the message can be sent. This endpoint allows
+   * pre-verification of URLs.
+   *
+   * @example
+   * ```ts
+   * const response = await client.urls.submitForVerification({
+   *   url: 'https://example.com/page',
+   * });
+   * ```
+   */
+  submitForVerification(
+    body: URLSubmitForVerificationParams,
+    options?: RequestOptions,
+  ): APIPromise<URLSubmitForVerificationResponse> {
+    return this._client.post('/v1/urls', { body, ...options });
+  }
+}
+
+export type VerifiedURLsCursor = Cursor<VerifiedURL>;
+
+export interface VerifiedURL {
+  id: string;
+
+  createdAt: string;
+
+  /**
+   * Domain extracted from the URL.
+   */
+  domain: string;
+
+  /**
+   * Status of a verified URL.
+   */
+  status: 'pending' | 'approved' | 'rejected' | 'malicious';
+
+  /**
+   * The verified URL.
+   */
+  url: string;
+
+  /**
+   * How the URL was approved or rejected.
+   */
+  approvalType?: 'manual' | 'auto_web_risk';
+
+  updatedAt?: string;
+}
+
+export interface URLRetrieveDetailsResponse {
+  url: VerifiedURL;
+}
+
+export interface URLSubmitForVerificationResponse {
+  url: VerifiedURL;
+}
+
+export interface URLListVerifiedParams extends CursorParams {
+  /**
+   * Filter by verification status.
+   */
+  status?: 'pending' | 'approved' | 'rejected' | 'malicious';
+}
+
+export interface URLSubmitForVerificationParams {
+  /**
+   * The URL to submit for verification.
+   */
+  url: string;
+}
+
+export declare namespace URLs {
+  export {
+    type VerifiedURL as VerifiedURL,
+    type URLRetrieveDetailsResponse as URLRetrieveDetailsResponse,
+    type URLSubmitForVerificationResponse as URLSubmitForVerificationResponse,
+    type VerifiedURLsCursor as VerifiedURLsCursor,
+    type URLListVerifiedParams as URLListVerifiedParams,
+    type URLSubmitForVerificationParams as URLSubmitForVerificationParams,
+  };
+}

package/src/resources/usage.ts

@@ -0,0 +1,48 @@
+// 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 { RequestOptions } from '../internal/request-options';
+
+export class Usage extends APIResource {
+  /**
+   * Get the current month's usage counters for A2P messages and emails, along with
+   * the tier limits.
+   */
+  retrieve(options?: RequestOptions): APIPromise<UsageRetrieveResponse> {
+    return this._client.get('/v1/usage', options);
+  }
+}
+
+export interface UsageRetrieveResponse {
+  /**
+   * Emails sent this month.
+   */
+  emailsSent: number;
+
+  limits: UsageRetrieveResponse.Limits;
+
+  /**
+   * A2P messages sent this month (WhatsApp replies + Telegram).
+   */
+  messagesA2P: number;
+
+  /**
+   * Current month in YYYY-MM format.
+   */
+  monthKey: string;
+
+  tier: 'free' | 'pro' | 'scale' | 'enterprise';
+}
+
+export namespace UsageRetrieveResponse {
+  export interface Limits {
+    emails?: number;
+
+    messagesA2P?: number;
+  }
+}
+
+export declare namespace Usage {
+  export { type UsageRetrieveResponse as UsageRetrieveResponse };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.31.0'; // x-release-please-version
+export const VERSION = '0.43.0'; // x-release-please-version

package/uploads.d.mts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/uploads.d.ts

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.js";
 //# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,kCAA+B"}

package/uploads.mjs

@@ -1,2 +1,3 @@
+/** @deprecated Import from ./core/uploads instead */
 export * from "./core/uploads.mjs";
 //# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,mCAA+B"}

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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