@zavudev/sdk 0.56.0 → 0.58.0

package/src/resources/contacts/channels.ts

@@ -1,23 +1,19 @@
-// 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 ContactsAPI from './contacts';
 import { APIPromise } from '../../core/api-promise';
 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 Channels extends APIResource {
   /**
+   * Update channel
+   *
    * Update a contact's channel properties.
    *
-   * @example
-   * ```ts
-   * const channel = await client.contacts.channels.update(
-   *   'channelId',
-   *   { contactId: 'contactId' },
-   * );
-   * ```
+   * `PATCH /v1/contacts/{contactId}/channels/{channelId}`
    */
   update(
     channelID: string,
@@ -29,33 +25,22 @@ export class Channels extends APIResource {
   }
 
   /**
+   * Add channel to contact
+   *
    * Add a new communication channel to an existing contact.
    *
-   * @example
-   * ```ts
-   * const response = await client.contacts.channels.add(
-   *   'contactId',
-   *   {
-   *     channel: 'email',
-   *     identifier: 'john.work@company.com',
-   *     label: 'work',
-   *   },
-   * );
-   * ```
+   * `POST /v1/contacts/{contactId}/channels`
    */
   add(contactID: string, body: ChannelAddParams, options?: RequestOptions): APIPromise<ChannelAddResponse> {
     return this._client.post(path`/v1/contacts/${contactID}/channels`, { body, ...options });
   }
 
   /**
+   * Remove channel from contact
+   *
    * Remove a communication channel from a contact. Cannot remove the last channel.
    *
-   * @example
-   * ```ts
-   * await client.contacts.channels.remove('channelId', {
-   *   contactId: 'contactId',
-   * });
-   * ```
+   * `DELETE /v1/contacts/{contactId}/channels/{channelId}`
    */
   remove(channelID: string, params: ChannelRemoveParams, options?: RequestOptions): APIPromise<void> {
     const { contactId } = params;
@@ -66,15 +51,11 @@ export class Channels extends APIResource {
   }
 
   /**
+   * Set channel as primary
+   *
    * Set a channel as the primary channel for its type.
    *
-   * @example
-   * ```ts
-   * const response = await client.contacts.channels.setPrimary(
-   *   'channelId',
-   *   { contactId: 'contactId' },
-   * );
-   * ```
+   * `POST /v1/contacts/{contactId}/channels/{channelId}/primary`
    */
   setPrimary(
     channelID: string,
@@ -86,83 +67,19 @@ export class Channels extends APIResource {
   }
 }
 
-export interface ChannelUpdateResponse {
-  /**
-   * A communication channel for a contact.
-   */
-  channel: ContactsAPI.ContactChannel;
-}
-
-export interface ChannelAddResponse {
-  /**
-   * A communication channel for a contact.
-   */
-  channel: ContactsAPI.ContactChannel;
-}
-
-export interface ChannelSetPrimaryResponse {
-  /**
-   * A communication channel for a contact.
-   */
-  channel: ContactsAPI.ContactChannel;
-}
-
-export interface ChannelUpdateParams {
-  /**
-   * Path param
-   */
-  contactId: string;
-
-  /**
-   * Body param: Optional label for the channel. Set to null to clear.
-   */
-  label?: string | null;
-
-  /**
-   * Body param
-   */
-  metadata?: { [key: string]: string };
-
-  /**
-   * Body param: Whether the channel is verified.
-   */
-  verified?: boolean;
-}
-
-export interface ChannelAddParams {
-  /**
-   * Channel type.
-   */
-  channel: 'sms' | 'whatsapp' | 'email' | 'telegram' | 'instagram' | 'messenger' | 'voice';
+export type ChannelUpdateResponse = T.ContactChannelResponse;
 
-  /**
-   * Channel identifier (phone number in E.164 format or email address).
-   */
-  identifier: string;
+export type ChannelAddResponse = T.ContactChannelResponse;
 
-  /**
-   * ISO country code for phone numbers.
-   */
-  countryCode?: string;
+export type ChannelSetPrimaryResponse = T.ContactChannelResponse;
 
-  /**
-   * Whether this should be the primary channel for its type.
-   */
-  isPrimary?: boolean;
+export type ChannelUpdateParams = T.ContactsChannelsUpdateParams;
 
-  /**
-   * Optional label for the channel.
-   */
-  label?: string;
-}
+export type ChannelAddParams = T.ContactsChannelsAddParams;
 
-export interface ChannelRemoveParams {
-  contactId: string;
-}
+export type ChannelRemoveParams = T.ContactsChannelsRemoveParams;
 
-export interface ChannelSetPrimaryParams {
-  contactId: string;
-}
+export type ChannelSetPrimaryParams = T.ContactsChannelsSetPrimaryParams;
 
 export declare namespace Channels {
   export {

package/src/resources/contacts/contacts.ts

@@ -1,42 +1,33 @@
-// 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 ChannelsAPI from './channels';
-import {
-  ChannelAddParams,
-  ChannelAddResponse,
-  ChannelRemoveParams,
-  ChannelSetPrimaryParams,
-  ChannelSetPrimaryResponse,
-  ChannelUpdateParams,
-  ChannelUpdateResponse,
-  Channels,
-} from './channels';
 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 ChannelsAPI from './channels';
+import {
+  Channels,
+  type ChannelUpdateResponse,
+  type ChannelAddResponse,
+  type ChannelSetPrimaryResponse,
+  type ChannelUpdateParams,
+  type ChannelAddParams,
+  type ChannelRemoveParams,
+  type ChannelSetPrimaryParams,
+} from './channels';
 
 export class Contacts extends APIResource {
   channels: ChannelsAPI.Channels = new ChannelsAPI.Channels(this._client);
 
   /**
+   * Create contact
+   *
    * Create a new contact with one or more communication channels.
    *
-   * @example
-   * ```ts
-   * const contact = await client.contacts.create({
-   *   channels: [
-   *     {
-   *       channel: 'sms',
-   *       identifier: '+14155551234',
-   *       isPrimary: true,
-   *     },
-   *   ],
-   *   displayName: 'John Doe',
-   * });
-   * ```
+   * `POST /v1/contacts`
    */
   create(body: ContactCreateParams, options?: RequestOptions): APIPromise<Contact> {
     return this._client.post('/v1/contacts', { body, ...options });
@@ -45,10 +36,7 @@ export class Contacts extends APIResource {
   /**
    * Get contact
    *
-   * @example
-   * ```ts
-   * const contact = await client.contacts.retrieve('contactId');
-   * ```
+   * `GET /v1/contacts/{contactId}`
    */
   retrieve(contactID: string, options?: RequestOptions): APIPromise<Contact> {
     return this._client.get(path`/v1/contacts/${contactID}`, options);
@@ -57,25 +45,18 @@ export class Contacts extends APIResource {
   /**
    * Update contact
    *
-   * @example
-   * ```ts
-   * const contact = await client.contacts.update('contactId');
-   * ```
+   * `PATCH /v1/contacts/{contactId}`
    */
   update(contactID: string, body: ContactUpdateParams, options?: RequestOptions): APIPromise<Contact> {
     return this._client.patch(path`/v1/contacts/${contactID}`, { body, ...options });
   }
 
   /**
+   * List contacts
+   *
    * List contacts with their communication channels.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const contact of client.contacts.list()) {
-   *   // ...
-   * }
-   * ```
+   * `GET /v1/contacts`
    */
   list(
     query: ContactListParams | null | undefined = {},
@@ -85,17 +66,16 @@ export class Contacts extends APIResource {
   }
 
   /**
+   * Delete contact
+   *
    * Permanently delete a contact and its communication channels. Implements
    * right-to-erasure obligations under GDPR Art. 17, Ley 19.628 (Chile) Art. 12,
-   * CCPA § 1798.105, and LGPD Art. 18.VI. The contact, its channels, and any
-   * associated agent flow sessions and conversation threads are removed. Past
-   * message records and broadcast delivery logs are retained for billing/audit but
-   * no longer reference the deleted contact.
+   * CCPA § 1798.105, and LGPD Art. 18.VI. The contact, its channels and any
+   * associated agent flow sessions are removed. Conversation threads, message
+   * history and broadcast delivery logs are kept and no longer reference the deleted
+   * contact.
    *
-   * @example
-   * ```ts
-   * await client.contacts.delete('contactId');
-   * ```
+   * `DELETE /v1/contacts/{contactId}`
    */
   delete(contactID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/v1/contacts/${contactID}`, {
@@ -105,31 +85,13 @@ export class Contacts extends APIResource {
   }
 
   /**
-   * Dismiss the merge suggestion for a contact.
+   * Merge contacts
    *
-   * @example
-   * ```ts
-   * await client.contacts.dismissMergeSuggestion('contactId');
-   * ```
-   */
-  dismissMergeSuggestion(contactID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/v1/contacts/${contactID}/merge-suggestion`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
-  /**
    * Merge a source contact into this contact. All channels from the source contact
    * will be moved to the target contact, and the source contact will be marked as
    * merged.
    *
-   * @example
-   * ```ts
-   * const contact = await client.contacts.merge('contactId', {
-   *   sourceContactId: 'jx7xyz789',
-   * });
-   * ```
+   * `POST /v1/contacts/{contactId}/merge`
    */
   merge(contactID: string, body: ContactMergeParams, options?: RequestOptions): APIPromise<Contact> {
     return this._client.post(path`/v1/contacts/${contactID}/merge`, { body, ...options });
@@ -138,223 +100,32 @@ export class Contacts extends APIResource {
   /**
    * Get contact by phone number
    *
-   * @example
-   * ```ts
-   * const contact = await client.contacts.retrieveByPhone(
-   *   'phoneNumber',
-   * );
-   * ```
+   * `GET /v1/contacts/phone/{phoneNumber}`
    */
   retrieveByPhone(phoneNumber: string, options?: RequestOptions): APIPromise<Contact> {
     return this._client.get(path`/v1/contacts/phone/${phoneNumber}`, options);
   }
 }
 
-export type ContactsCursor = Cursor<Contact>;
-
-export interface Contact {
-  id: string;
-
-  /**
-   * List of available messaging channels for this contact.
-   */
-  availableChannels: Array<string>;
-
-  createdAt: string;
-
-  metadata: { [key: string]: string };
-
-  /**
-   * Whether this contact has been verified.
-   */
-  verified: boolean;
-
-  /**
-   * All communication channels for this contact.
-   */
-  channels?: Array<ContactChannel>;
-
-  countryCode?: string;
-
-  /**
-   * Preferred channel for this contact.
-   */
-  defaultChannel?: 'sms' | 'whatsapp' | 'telegram' | 'email' | 'instagram' | 'messenger' | 'voice';
-
-  /**
-   * Display name for the contact.
-   */
-  displayName?: string;
-
-  /**
-   * DEPRECATED: Use primaryPhone instead. Primary phone number in E.164 format.
-   */
-  phoneNumber?: string;
-
-  /**
-   * Primary email address.
-   */
-  primaryEmail?: string;
-
-  /**
-   * Primary phone number in E.164 format.
-   */
-  primaryPhone?: string;
-
-  /**
-   * Contact's WhatsApp profile name. Only available for WhatsApp contacts.
-   */
-  profileName?: string | null;
-
-  /**
-   * ID of a contact suggested for merging.
-   */
-  suggestedMergeWith?: string;
-
-  updatedAt?: string;
-}
-
-/**
- * A communication channel for a contact.
- */
-export interface ContactChannel {
-  id: string;
-
-  /**
-   * Channel type.
-   */
-  channel: 'sms' | 'whatsapp' | 'email' | 'telegram' | 'instagram' | 'messenger' | 'voice';
-
-  createdAt: string;
+export type ContactsCursor = Cursor<T.Contact>;
 
-  /**
-   * Channel identifier (phone number or email address).
-   */
-  identifier: string;
-
-  /**
-   * Whether this is the primary channel for its type.
-   */
-  isPrimary: boolean;
-
-  /**
-   * Whether this channel has been verified.
-   */
-  verified: boolean;
-
-  /**
-   * ISO country code for phone numbers.
-   */
-  countryCode?: string;
-
-  /**
-   * Optional label for the channel.
-   */
-  label?: string;
-
-  /**
-   * Last time a message was received on this channel.
-   */
-  lastInboundAt?: string;
-
-  metadata?: { [key: string]: string };
-
-  /**
-   * Delivery metrics for this channel.
-   */
-  metrics?: ContactChannel.Metrics;
-
-  updatedAt?: string;
-}
+export type Contact = T.Contact;
 
+export type ContactChannel = T.ContactChannel;
 export namespace ContactChannel {
-  /**
-   * Delivery metrics for this channel.
-   */
-  export interface Metrics {
-    avgDeliveryTimeMs?: number;
-
-    failureCount?: number;
-
-    lastSuccessAt?: string;
-
-    successCount?: number;
-
-    totalAttempts?: number;
-  }
-}
-
-export interface ContactCreateParams {
-  /**
-   * Communication channels for the contact.
-   */
-  channels: Array<ContactCreateParams.Channel>;
-
-  /**
-   * Display name for the contact.
-   */
-  displayName?: string;
-
-  /**
-   * Arbitrary metadata to associate with the contact.
-   */
-  metadata?: { [key: string]: string };
+  export type Metrics = T.ContactChannelMetrics;
 }
 
+export type ContactCreateParams = T.ContactsCreateParams;
 export namespace ContactCreateParams {
-  /**
-   * Input for creating a contact channel.
-   */
-  export interface Channel {
-    /**
-     * Channel type.
-     */
-    channel: 'sms' | 'whatsapp' | 'email' | 'telegram' | 'instagram' | 'messenger' | 'voice';
-
-    /**
-     * Channel identifier (phone number in E.164 format or email address).
-     */
-    identifier: string;
-
-    /**
-     * ISO country code for phone numbers.
-     */
-    countryCode?: string;
-
-    /**
-     * Whether this should be the primary channel for its type.
-     */
-    isPrimary?: boolean;
-
-    /**
-     * Optional label for the channel.
-     */
-    label?: string;
-  }
-}
-
-export interface ContactUpdateParams {
-  /**
-   * Preferred channel for this contact. Set to null to clear.
-   */
-  defaultChannel?: 'sms' | 'whatsapp' | 'telegram' | 'email' | 'instagram' | 'messenger' | 'voice' | null;
-
-  metadata?: { [key: string]: string };
+  export type Channel = T.ContactChannelInput;
 }
 
-export interface ContactListParams extends CursorParams {
-  phoneNumber?: string;
-}
+export type ContactUpdateParams = T.ContactsUpdateParams;
 
-export interface ContactMergeParams {
-  /**
-   * ID of the contact to merge into the target contact. The source contact will be
-   * marked as merged.
-   */
-  sourceContactId: string;
-}
+export type ContactListParams = T.ContactsListParams;
 
-Contacts.Channels = Channels;
+export type ContactMergeParams = T.ContactsMergeParams;
 
 export declare namespace Contacts {
   export {
@@ -365,9 +136,6 @@ export declare namespace Contacts {
     type ContactUpdateParams as ContactUpdateParams,
     type ContactListParams as ContactListParams,
     type ContactMergeParams as ContactMergeParams,
-  };
-
-  export {
     Channels as Channels,
     type ChannelUpdateResponse as ChannelUpdateResponse,
     type ChannelAddResponse as ChannelAddResponse,

package/src/resources/contacts/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 {
   Channels,

package/src/resources/contacts.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 './contacts/index';