@zavudev/sdk 0.57.0 → 0.58.0

package/src/resources/templates.ts

@@ -1,27 +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 Templates extends APIResource {
   /**
+   * Create template
+   *
    * Create a WhatsApp message template. Note: Templates must be approved by Meta
    * before use.
    *
-   * @example
-   * ```ts
-   * const template = await client.templates.create({
-   *   body: 'Hi {{1}}, your order {{2}} has been confirmed and will ship within 24 hours.',
-   *   language: 'en',
-   *   name: 'order_confirmation',
-   *   variables: ['customer_name', 'order_id'],
-   *   whatsappCategory: 'UTILITY',
-   * });
-   * ```
+   * `POST /v1/templates`
    */
   create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<Template> {
     return this._client.post('/v1/templates', { body, ...options });
@@ -30,27 +24,18 @@ export class Templates extends APIResource {
   /**
    * Get template
    *
-   * @example
-   * ```ts
-   * const template = await client.templates.retrieve(
-   *   'templateId',
-   * );
-   * ```
+   * `GET /v1/templates/{templateId}`
    */
   retrieve(templateID: string, options?: RequestOptions): APIPromise<Template> {
     return this._client.get(path`/v1/templates/${templateID}`, options);
   }
 
   /**
+   * List templates
+   *
    * List WhatsApp message templates for this project.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const template of client.templates.list()) {
-   *   // ...
-   * }
-   * ```
+   * `GET /v1/templates`
    */
   list(
     query: TemplateListParams | null | undefined = {},
@@ -62,10 +47,7 @@ export class Templates extends APIResource {
   /**
    * Delete template
    *
-   * @example
-   * ```ts
-   * await client.templates.delete('templateId');
-   * ```
+   * `DELETE /v1/templates/{templateId}`
    */
   delete(templateID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/v1/templates/${templateID}`, {
@@ -75,34 +57,39 @@ export class Templates extends APIResource {
   }
 
   /**
+   * Submit template for approval
+   *
    * Submit a WhatsApp template to Meta for approval. The template must be in draft
    * status and associated with a sender that has a WhatsApp Business Account
    * configured.
    *
-   * @example
-   * ```ts
-   * const template = await client.templates.submit(
-   *   'templateId',
-   *   { senderId: 'sender_abc123', category: 'UTILITY' },
-   * );
-   * ```
+   * `POST /v1/templates/{templateId}/submit`
    */
   submit(templateID: string, body: TemplateSubmitParams, options?: RequestOptions): APIPromise<Template> {
     return this._client.post(path`/v1/templates/${templateID}/submit`, { body, ...options });
   }
 
   /**
-   * Reconcile this project's templates against WhatsApp. Two things happen per
+   * Sync templates from WhatsApp
+   *
+   * Reconcile this project's templates against WhatsApp. Three things happen per
    * connected WhatsApp Business Account: templates that exist on Meta but not in
-   * Zavu are imported (or linked to an existing template with the same name), and
-   * the approval status of the templates Zavu already knows about is refreshed from
-   * Meta.
+   * Zavu are imported (or linked to an existing template with the same name), the
+   * approval status of the templates Zavu already knows about is refreshed from
+   * Meta, and their **category** is refreshed from Meta.
+   *
+   * The category matters because it is what each message is billed under, and Meta
+   * reassigns it on its own — commonly `UTILITY` to `MARKETING`, on a template
+   * that is already approved and whose status therefore never moves. A template
+   * whose category changed but whose status did not is still counted in `updated`.
+   * This is the way to repair templates whose category drifted before you started
+   * listening for `template.status_changed`.
    *
-   * This is what to call when a template was created outside Zavu — in Meta Business
-   * Manager, or by another tool — or when a `template.status_changed` webhook was
-   * missed and a template is stuck in `pending`. Status changes normally arrive by
-   * webhook; this endpoint is the recovery path and the only path for a template
-   * Zavu never created.
+   * This is what to call when a template was created outside Zavu — in Meta
+   * Business Manager, or by another tool — or when a `template.status_changed`
+   * webhook was missed and a template is stuck in `pending`. Status changes normally
+   * arrive by webhook; this endpoint is the recovery path and the only path for a
+   * template Zavu never created.
    *
    * Templates that Meta reports as rejected or disabled are not imported; they are
    * counted in `skipped`. Existing local templates are matched first by Meta
@@ -110,14 +97,11 @@ export class Templates extends APIResource {
    *
    * By default every sender in the project with a WhatsApp Business Account is
    * synced. Pass `senderId` to sync only that sender's account. The call is
-   * synchronous — it waits for Meta and returns what changed — so it can take a few
-   * seconds per account. A failure on one account does not fail the request: it is
-   * reported in `errors` and the remaining accounts are still synced.
+   * synchronous — it waits for Meta and returns what changed — so it can take a
+   * few seconds per account. A failure on one account does not fail the request: it
+   * is reported in `errors` and the remaining accounts are still synced.
    *
-   * @example
-   * ```ts
-   * const response = await client.templates.sync();
-   * ```
+   * `POST /v1/templates/sync`
    */
   sync(
     body: TemplateSyncParams | null | undefined = {},
@@ -127,323 +111,28 @@ export class Templates extends APIResource {
   }
 }
 
-export type TemplatesCursor = Cursor<Template>;
-
-export interface Template {
-  id: string;
-
-  /**
-   * Default template body with variables: positional ({{1}}, {{2}}) or named
-   * ({{customer_name}}, {{contact.first_name}}). Templates created in Zavu are
-   * submitted to Meta as positional; templates imported from a WhatsApp Business
-   * Account keep their original format (named or positional). Used when no
-   * channel-specific body is set.
-   */
-  body: string;
-
-  /**
-   * WhatsApp template category.
-   */
-  category: WhatsappCategory;
-
-  /**
-   * Language code.
-   */
-  language: string;
-
-  /**
-   * Template name. For WhatsApp, must match the approved template name in Meta.
-   */
-  name: string;
-
-  /**
-   * Add 'Do not share this code' disclaimer. Only for AUTHENTICATION templates.
-   */
-  addSecurityRecommendation?: boolean;
-
-  /**
-   * Template buttons.
-   */
-  buttons?: Array<Template.Button>;
-
-  /**
-   * Code expiration time in minutes. Only for AUTHENTICATION templates.
-   */
-  codeExpirationMinutes?: number;
-
-  createdAt?: string;
-
-  /**
-   * Footer text for the template.
-   */
-  footer?: string;
-
-  /**
-   * Header content (text or media URL).
-   */
-  headerContent?: string;
-
-  /**
-   * Type of header (text, image, video, document).
-   */
-  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;
-
-  /**
-   * List of variable names for documentation.
-   */
-  variables?: Array<string>;
-
-  /**
-   * WhatsApp-specific template information.
-   */
-  whatsapp?: Template.Whatsapp;
-}
+export type TemplatesCursor = Cursor<T.Template>;
 
+export type Template = T.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'.
-     */
-    otpType?: 'COPY_CODE' | 'ONE_TAP';
-
-    /**
-     * Android package name. Required for ONE_TAP buttons.
-     */
-    packageName?: string;
-
-    phoneNumber?: string;
-
-    /**
-     * Android app signature hash. Required for ONE_TAP buttons.
-     */
-    signatureHash?: string;
-
-    text?: string;
-
-    type?: 'quick_reply' | 'url' | 'phone' | 'otp' | 'request_contact_info';
-
-    url?: string;
-  }
-
-  /**
-   * WhatsApp-specific template information.
-   */
-  export interface Whatsapp {
-    /**
-     * WhatsApp Business Account namespace.
-     */
-    namespace?: string;
-
-    /**
-     * WhatsApp approval status.
-     */
-    status?: string;
-
-    /**
-     * WhatsApp template name.
-     */
-    templateName?: string;
-  }
+  export type Button = T.TemplateButtonsItem;
+  export type Whatsapp = T.TemplateWhatsapp;
 }
 
-/**
- * WhatsApp template category.
- */
-export type WhatsappCategory = 'UTILITY' | 'MARKETING' | 'AUTHENTICATION';
+export type WhatsappCategory = T.WhatsAppCategory;
 
-export interface TemplateSyncResponse {
-  /**
-   * WhatsApp Business Accounts reconciled in this call.
-   */
-  accountsSynced: number;
-
-  /**
-   * Problems hit while syncing. Non-empty with a 200 means part of the sync did not
-   * complete — the rest still did.
-   */
-  errors: Array<string>;
-
-  /**
-   * Templates that existed on Meta and were created in Zavu by this call.
-   */
-  imported: number;
-
-  /**
-   * Existing Zavu templates that were matched to a Meta template by name and bound
-   * to its Meta ID.
-   */
-  linked: number;
-
-  /**
-   * Meta templates left alone: already linked to a Zavu template, or
-   * rejected/disabled on Meta.
-   */
-  skipped: number;
-
-  /**
-   * Templates whose approval status changed to match Meta.
-   */
-  updated: number;
-}
-
-export interface TemplateCreateParams {
-  /**
-   * Default template body. Used when no channel-specific body is set.
-   */
-  body: string;
-
-  language: string;
-
-  name: string;
-
-  /**
-   * Add 'Do not share this code' disclaimer. Only for AUTHENTICATION templates.
-   */
-  addSecurityRecommendation?: boolean;
-
-  /**
-   * Template buttons (max 3).
-   */
-  buttons?: Array<TemplateCreateParams.Button>;
-
-  /**
-   * Code expiration time in minutes. Only for AUTHENTICATION templates.
-   */
-  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>;
-
-  /**
-   * WhatsApp template category.
-   */
-  whatsappCategory?: WhatsappCategory;
-}
+export type TemplateSyncResponse = T.SyncTemplatesResponse;
 
+export type TemplateCreateParams = T.TemplatesCreateParams;
 export namespace TemplateCreateParams {
-  export interface Button {
-    /**
-     * `request_contact_info` renders a fixed **Share Contact Info** button that asks
-     * the recipient to share their phone number — useful when a contact adopted a
-     * WhatsApp username and you only know their BSUID. It takes no other fields.
-     */
-    type: 'quick_reply' | 'url' | 'phone' | 'otp' | 'request_contact_info';
-
-    /**
-     * 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.
-     */
-    otpType?: 'COPY_CODE' | 'ONE_TAP';
-
-    /**
-     * Android package name. Required for ONE_TAP buttons.
-     */
-    packageName?: string;
-
-    phoneNumber?: string;
-
-    /**
-     * Android app signature hash. Required for ONE_TAP buttons.
-     */
-    signatureHash?: string;
-
-    /**
-     * Button label. Required for every type except `request_contact_info`, whose label
-     * is fixed by WhatsApp.
-     */
-    text?: 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;
-  }
+  export type Button = T.TemplateCreateRequestButtonsItem;
 }
 
-export interface TemplateListParams extends CursorParams {}
+export type TemplateListParams = T.TemplatesListParams;
 
-export interface TemplateSubmitParams {
-  /**
-   * The sender ID with the WhatsApp Business Account to submit the template to.
-   */
-  senderId: string;
-
-  /**
-   * Template category. If not provided, uses the category set on the template.
-   */
-  category?: WhatsappCategory;
-}
+export type TemplateSubmitParams = T.TemplatesSubmitParams;
 
-export interface TemplateSyncParams {
-  /**
-   * Sync only the WhatsApp Business Account attached to this sender. If omitted,
-   * every WhatsApp sender in the project is synced.
-   */
-  senderId?: string;
-}
+export type TemplateSyncParams = T.TemplatesSyncParams;
 
 export declare namespace Templates {
   export {

package/src/resources/urls.ts

@@ -1,23 +1,20 @@
-// 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 { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
+import type * as T from '../types';
 
 export class URLs extends APIResource {
   /**
+   * Escalate a rejected URL
+   *
    * Request manual review of a rejected URL. Only URLs in 'rejected' status can be
    * escalated; the status then moves to 'escalated'.
    *
-   * @example
-   * ```ts
-   * const response = await client.urls.escalate('urlId', {
-   *   reason:
-   *     'This is our official landing page and was rejected in error.',
-   * });
-   * ```
+   * `POST /v1/urls/{urlId}/escalate`
    */
   escalate(
     urlID: string,
@@ -28,15 +25,11 @@ export class URLs extends APIResource {
   }
 
   /**
+   * List verified URLs
+   *
    * 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()) {
-   *   // ...
-   * }
-   * ```
+   * `GET /v1/urls`
    */
   listVerified(
     query: URLListVerifiedParams | null | undefined = {},
@@ -46,32 +39,30 @@ export class URLs extends APIResource {
   }
 
   /**
+   * Get URL details
+   *
    * Get details of a specific verified URL.
    *
-   * @example
-   * ```ts
-   * const response = await client.urls.retrieveDetails('urlId');
-   * ```
+   * `GET /v1/urls/{urlId}`
    */
   retrieveDetails(urlID: string, options?: RequestOptions): APIPromise<URLRetrieveDetailsResponse> {
     return this._client.get(path`/v1/urls/${urlID}`, options);
   }
 
   /**
+   * Submit URL for verification
+   *
    * 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.
+   * **Important:** SMS, one-way SMS and voice messages containing URLs require those
+   * URLs to be verified before the message can be sent; a URL that is not yet known
+   * is checked when the message is sent. Email, WhatsApp, Telegram, Instagram and
+   * Messenger messages are not checked. This endpoint allows pre-verification of
+   * URLs.
    *
-   * @example
-   * ```ts
-   * const response = await client.urls.submitForVerification({
-   *   url: 'https://example.com/page',
-   * });
-   * ```
+   * `POST /v1/urls`
    */
   submitForVerification(
     body: URLSubmitForVerificationParams,
@@ -81,70 +72,21 @@ export class URLs extends APIResource {
   }
 }
 
-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' | 'escalated' | 'malicious';
-
-  /**
-   * The verified URL.
-   */
-  url: string;
-
-  /**
-   * How the URL was approved or rejected.
-   */
-  approvalType?: 'manual' | 'auto_web_risk';
-
-  updatedAt?: string;
-}
+export type VerifiedURLsCursor = Cursor<T.VerifiedUrl>;
 
-export interface URLEscalateResponse {
-  message: string;
+export type VerifiedURL = T.VerifiedUrl;
 
-  url: VerifiedURL;
-}
+export type URLEscalateResponse = T.EscalateUrlResponse;
 
-export interface URLRetrieveDetailsResponse {
-  url: VerifiedURL;
-}
+export type URLRetrieveDetailsResponse = T.VerifiedUrlResponse;
 
-export interface URLSubmitForVerificationResponse {
-  url: VerifiedURL;
-}
+export type URLSubmitForVerificationResponse = T.VerifiedUrlResponse;
 
-export interface URLEscalateParams {
-  /**
-   * Why the URL should be reviewed manually.
-   */
-  reason: string;
-}
+export type URLEscalateParams = T.UrlsEscalateParams;
 
-export interface URLListVerifiedParams extends CursorParams {
-  /**
-   * Filter by verification status.
-   */
-  status?: 'pending' | 'approved' | 'rejected' | 'escalated' | 'malicious';
-}
+export type URLListVerifiedParams = T.UrlsListVerifiedParams;
 
-export interface URLSubmitForVerificationParams {
-  /**
-   * The URL to submit for verification.
-   */
-  url: string;
-}
+export type URLSubmitForVerificationParams = T.UrlsSubmitForVerificationParams;
 
 export declare namespace URLs {
   export {

package/src/resources.ts

@@ -1 +1,3 @@
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
+
 export * from './resources/index';