@zavudev/sdk 0.58.1 → 0.59.1

package/src/v2/resources/contacts.ts

@@ -0,0 +1,112 @@
+// Generated by zavu-codegen from apps/docs/api-reference/v2/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';
+
+/** Contacts and the identifiers they are reached at. */
+export class Contacts extends APIResource {
+  /**
+   * List contacts
+   *
+   * List contacts with their channels. A repeated `tag` means all of them.
+   *
+   * `GET /v2/contacts`
+   */
+  list(
+    query: ContactListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ContactsCursor, Contact> {
+    return this._client.getAPIList('/v2/contacts', Cursor<Contact>, { query, ...options });
+  }
+
+  /**
+   * Create a contact
+   *
+   * Create a contact with one or more channels. An identifier another contact
+   * already holds on the same channel is refused (`400 duplicate_identifier`, with
+   * `details.conflicts[{channel, identifier, contactId}]`); update the existing
+   * contact with `PATCH /v2/contacts/{contactId}` instead.
+   *
+   * `POST /v2/contacts`
+   */
+  create(body: ContactCreateParams, options?: RequestOptions): APIPromise<ContactCreateResponse> {
+    return this._client.post('/v2/contacts', { body, ...options });
+  }
+
+  /**
+   * Get a contact
+   *
+   * `GET /v2/contacts/{contactId}`
+   */
+  retrieve(contactID: string, options?: RequestOptions): APIPromise<ContactRetrieveResponse> {
+    return this._client.get(path`/v2/contacts/${contactID}`, options);
+  }
+
+  /**
+   * Update a contact
+   *
+   * `PATCH /v2/contacts/{contactId}`
+   */
+  update(
+    contactID: string,
+    body: ContactUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ContactUpdateResponse> {
+    return this._client.patch(path`/v2/contacts/${contactID}`, { body, ...options });
+  }
+
+  /**
+   * Delete a contact
+   *
+   * Permanently delete a contact and its channels (right to erasure). Conversations,
+   * message history and campaign delivery logs are kept and no longer reference it.
+   *
+   * `DELETE /v2/contacts/{contactId}`
+   */
+  delete(contactID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/contacts/${contactID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type ContactListParams = T.ContactsListParams;
+
+export type Contact = T.Contact;
+
+export type ContactsCursor = Cursor<T.Contact>;
+
+export type ContactChannel = T.ContactChannel;
+
+export type ContactCreateParams = T.ContactsCreateParams;
+
+export type ContactCreateResponse = T.Contact;
+
+export type ContactChannelInput = T.ContactChannelInput;
+
+export type ContactRetrieveResponse = T.Contact;
+
+export type ContactUpdateParams = T.ContactsUpdateParams;
+
+export type ContactUpdateResponse = T.Contact;
+
+export declare namespace Contacts {
+  export {
+    type Contact as Contact,
+    type ContactChannel as ContactChannel,
+    type ContactChannelInput as ContactChannelInput,
+    type ContactCreateParams as ContactCreateParams,
+    type ContactCreateResponse as ContactCreateResponse,
+    type ContactListParams as ContactListParams,
+    type ContactRetrieveResponse as ContactRetrieveResponse,
+    type ContactUpdateParams as ContactUpdateParams,
+    type ContactUpdateResponse as ContactUpdateResponse,
+    type ContactsCursor as ContactsCursor,
+  };
+}

package/src/v2/resources/conversations.ts

@@ -0,0 +1,89 @@
+// Generated by zavu-codegen from apps/docs/api-reference/v2/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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import type * as T from '../types';
+import { type Message, type MessagesCursor } from './messages';
+
+/** Inbox threads, one per contact across channels. */
+export class Conversations extends APIResource {
+  /**
+   * List conversations
+   *
+   * List inbox threads, most recently active first. Filter by `from` (one of your
+   * addresses) and `channel`. Each conversation carries `from`, the address it was
+   * last handled from.
+   *
+   * `GET /v2/conversations`
+   */
+  list(
+    query: ConversationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ConversationsCursor, Conversation> {
+    return this._client.getAPIList('/v2/conversations', Cursor<Conversation>, { query, ...options });
+  }
+
+  /**
+   * Get a conversation
+   *
+   * `GET /v2/conversations/{conversationId}`
+   */
+  retrieve(conversationID: string, options?: RequestOptions): APIPromise<ConversationRetrieveResponse> {
+    return this._client.get(path`/v2/conversations/${conversationID}`, options);
+  }
+
+  /**
+   * List a conversation's messages
+   *
+   * Reply with `POST /v2/messages` and this `conversationId`.
+   *
+   * `GET /v2/conversations/{conversationId}/messages`
+   */
+  listMessages(
+    conversationID: string,
+    query: ConversationListMessagesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MessagesCursor, Message> {
+    return this._client.getAPIList(path`/v2/conversations/${conversationID}/messages`, Cursor<Message>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Mark a conversation read
+   *
+   * Resets `unreadCount` in your inbox. Sends no read receipt to the contact.
+   *
+   * `POST /v2/conversations/{conversationId}/read`
+   */
+  markAsRead(conversationID: string, options?: RequestOptions): APIPromise<ConversationMarkAsReadResponse> {
+    return this._client.post(path`/v2/conversations/${conversationID}/read`, options);
+  }
+}
+
+export type ConversationListParams = T.ConversationsListParams;
+
+export type Conversation = T.Conversation;
+
+export type ConversationsCursor = Cursor<T.Conversation>;
+
+export type ConversationRetrieveResponse = T.GetConversationV2Response;
+
+export type ConversationListMessagesParams = T.ConversationsListMessagesParams;
+
+export type ConversationMarkAsReadResponse = T.MarkConversationReadV2Response;
+
+export declare namespace Conversations {
+  export {
+    type Conversation as Conversation,
+    type ConversationListMessagesParams as ConversationListMessagesParams,
+    type ConversationListParams as ConversationListParams,
+    type ConversationMarkAsReadResponse as ConversationMarkAsReadResponse,
+    type ConversationRetrieveResponse as ConversationRetrieveResponse,
+    type ConversationsCursor as ConversationsCursor,
+  };
+}

package/src/v2/resources/email-domains.ts

@@ -0,0 +1,107 @@
+// Generated by zavu-codegen from apps/docs/api-reference/v2/openapi.json. Do not edit: run `bun run codegen`.
+
+import { APIResource } from '../../core/resource';
+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';
+
+/** Domains to send email from. */
+export class EmailDomains extends APIResource {
+  /**
+   * List email domains
+   *
+   * Email domains of this project.
+   *
+   * `GET /v2/email-domains`
+   */
+  list(options?: RequestOptions): APIPromise<EmailDomainListResponse> {
+    return this._client.get('/v2/email-domains', options);
+  }
+
+  /**
+   * Add an email domain
+   *
+   * Add a domain to send email from. `domain` is validated first: a bare domain (a
+   * leading `https://` and a trailing path are dropped); anything else, spaces
+   * included, is `400` with `details.errors[0].path` `["domain"]`. Adding a domain
+   * the project already has returns it with `200` (nothing created), like `POST
+   * /v2/channels`.
+   *
+   * Returns the DNS records to publish; the DKIM CNAMEs are required. If they could
+   * not be generated, the domain is still created (`201`) but comes back
+   * `verifiable: false` with `setupError`: remove it and add it again, or contact
+   * support. Verify cannot fix it.
+   *
+   * Publish the records exactly as returned, verify, then connect an address with
+   * `POST /v2/channels {"type":"email"}`.
+   *
+   * `POST /v2/email-domains`
+   */
+  create(body: EmailDomainCreateParams, options?: RequestOptions): APIPromise<EmailDomainCreateResponse> {
+    return this._client.post('/v2/email-domains', { body, ...options });
+  }
+
+  /**
+   * Get an email domain
+   *
+   * The domain with its DNS records and status.
+   *
+   * `GET /v2/email-domains/{emailDomainId}`
+   */
+  retrieve(emailDomainID: string, options?: RequestOptions): APIPromise<EmailDomainRetrieveResponse> {
+    return this._client.get(path`/v2/email-domains/${emailDomainID}`, options);
+  }
+
+  /**
+   * Remove an email domain
+   *
+   * `DELETE /v2/email-domains/{emailDomainId}`
+   */
+  delete(emailDomainID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/email-domains/${emailDomainID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Verify an email domain
+   *
+   * Re-check the domain's DNS records and refresh its status. `404` only for a
+   * domain that is not this project's; `503 verification_unavailable` when the check
+   * could not run (nothing changed, retry). A domain with no DKIM records
+   * (`verifiable: false`) cannot verify whatever DNS says: verify runs the check (it
+   * may recover the records), and when the domain still has none it answers `409
+   * domain_setup_failed` with the same `setupError` the domain carries.
+   *
+   * `POST /v2/email-domains/{emailDomainId}/verify`
+   */
+  verify(emailDomainID: string, options?: RequestOptions): APIPromise<EmailDomainVerifyResponse> {
+    return this._client.post(path`/v2/email-domains/${emailDomainID}/verify`, options);
+  }
+}
+
+export type EmailDomainListResponse = T.ListEmailDomainsV2Response;
+
+export type EmailDomain = T.EmailDomain;
+
+export type EmailDomainCreateParams = T.EmailDomainsCreateParams;
+
+export type EmailDomainCreateResponse = T.AddEmailDomainV2Response;
+
+export type EmailDomainRetrieveResponse = T.GetEmailDomainV2Response;
+
+export type EmailDomainVerifyResponse = T.VerifyEmailDomainV2Response;
+
+export declare namespace EmailDomains {
+  export {
+    type EmailDomain as EmailDomain,
+    type EmailDomainCreateParams as EmailDomainCreateParams,
+    type EmailDomainCreateResponse as EmailDomainCreateResponse,
+    type EmailDomainListResponse as EmailDomainListResponse,
+    type EmailDomainRetrieveResponse as EmailDomainRetrieveResponse,
+    type EmailDomainVerifyResponse as EmailDomainVerifyResponse,
+  };
+}

package/src/v2/resources/functions.ts

@@ -0,0 +1,73 @@
+// Generated by zavu-codegen from apps/docs/api-reference/v2/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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import type * as T from '../types';
+
+/** Configure Zavu Functions. */
+export class Functions extends APIResource {
+  /**
+   * List functions
+   *
+   * The project's functions, newest first.
+   *
+   * `GET /v2/functions`
+   */
+  list(
+    query: FunctionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ZavuFunctionsCursor, ZavuFunction> {
+    return this._client.getAPIList('/v2/functions', Cursor<ZavuFunction>, { query, ...options });
+  }
+
+  /**
+   * Get a function
+   *
+   * `GET /v2/functions/{functionId}`
+   */
+  retrieve(functionID: string, options?: RequestOptions): APIPromise<FunctionRetrieveResponse> {
+    return this._client.get(path`/v2/functions/${functionID}`, options);
+  }
+
+  /**
+   * Configure a function
+   *
+   * Name, description, timeout, memory, architecture, pause and the HTTP endpoint,
+   * with the same rules as the dashboard's Settings tab.
+   *
+   * `PATCH /v2/functions/{functionId}`
+   */
+  update(
+    functionID: string,
+    body: FunctionUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FunctionUpdateResponse> {
+    return this._client.patch(path`/v2/functions/${functionID}`, { body, ...options });
+  }
+}
+
+export type FunctionListParams = T.FunctionsListParams;
+
+export type ZavuFunction = T.ZavuFunction;
+
+export type ZavuFunctionsCursor = Cursor<T.ZavuFunction>;
+
+export type FunctionRetrieveResponse = T.GetFunctionV2Response;
+
+export type FunctionUpdateParams = T.FunctionsUpdateParams;
+
+export type FunctionUpdateResponse = T.UpdateFunctionV2Response;
+
+export declare namespace Functions {
+  export {
+    type FunctionListParams as FunctionListParams,
+    type FunctionRetrieveResponse as FunctionRetrieveResponse,
+    type FunctionUpdateParams as FunctionUpdateParams,
+    type FunctionUpdateResponse as FunctionUpdateResponse,
+    type ZavuFunction as ZavuFunction,
+    type ZavuFunctionsCursor as ZavuFunctionsCursor,
+  };
+}

package/src/v2/resources/index.ts

@@ -0,0 +1,138 @@
+// Generated by zavu-codegen from apps/docs/api-reference/v2/openapi.json. Do not edit: run `bun run codegen`.
+
+export {
+  Messages,
+  type MessageSendParams,
+  type MessageSendResponse,
+  type ChannelTypeRequest,
+  type EmailAttachmentInput,
+  type Message,
+  type MessageContent,
+  type MessageType,
+  type Routing,
+  type SendMessageResponse,
+  type MessageListParams,
+  type MessagesCursor,
+  type ChannelType,
+  type MessageStatus,
+  type MessageRetrieveResponse,
+} from './messages';
+export {
+  Conversations,
+  type ConversationListParams,
+  type Conversation,
+  type ConversationsCursor,
+  type ConversationRetrieveResponse,
+  type ConversationListMessagesParams,
+  type ConversationMarkAsReadResponse,
+} from './conversations';
+export {
+  Contacts,
+  type ContactListParams,
+  type Contact,
+  type ContactsCursor,
+  type ContactChannel,
+  type ContactCreateParams,
+  type ContactCreateResponse,
+  type ContactChannelInput,
+  type ContactRetrieveResponse,
+  type ContactUpdateParams,
+  type ContactUpdateResponse,
+} from './contacts';
+export {
+  Channels,
+  type ChannelListParams,
+  type ChannelEntry,
+  type ChannelEntriesCursor,
+  type ChannelConnectParams,
+  type ChannelConnectResponse,
+  type ChannelRetrieveResponse,
+  type ActivatableChannel,
+  type ChannelActivateResponse,
+  type ChannelDeactivateResponse,
+} from './channels';
+export {
+  Templates,
+  type TemplateListParams,
+  type Template,
+  type TemplatesCursor,
+  type WhatsAppCategory,
+  type TemplateCreateParams,
+  type TemplateCreateResponse,
+  type TemplateRetrieveResponse,
+  type TemplateSubmitParams,
+  type TemplateSubmitResponse,
+} from './templates';
+export {
+  Campaigns,
+  type CampaignListParams,
+  type Broadcast,
+  type BroadcastsCursor,
+  type BroadcastChannel,
+  type BroadcastContent,
+  type BroadcastMessageType,
+  type BroadcastStatus,
+  type CampaignCreateParams,
+  type CampaignCreateResponse,
+  type CampaignRetrieveResponse,
+  type CampaignSendParams,
+  type CampaignSendResponse,
+  type CampaignProgressResponse,
+  type BroadcastProgress,
+  type CampaignCancelResponse,
+} from './campaigns/campaigns';
+export {
+  Webhook,
+  type WebhookRetrieveResponse,
+  type ProjectWebhookV2,
+  type SenderWebhookV1,
+  type WebhookSetParams,
+  type WebhookSetResponse,
+  type WebhookEvent,
+  type WebhookSignatureVersion,
+  type WebhookRotateSecretResponse,
+} from './webhook';
+export {
+  Agents,
+  type AgentListParams,
+  type Agent,
+  type AgentsCursor,
+  type AgentProvider,
+  type AgentVoiceConfig,
+  type AgentCreateParams,
+  type AgentCreateResponse,
+  type AgentRetrieveResponse,
+  type AgentUpdateParams,
+  type AgentUpdateResponse,
+  type AgentTestParams,
+  type AgentTestResponse,
+} from './agents/agents';
+export {
+  Numbers,
+  type NumberSearchAvailableParams,
+  type NumberSearchAvailableResponse,
+  type AvailablePhoneNumber,
+  type PhoneNumberType,
+  type NumberPurchaseParams,
+  type NumberPurchaseResponse,
+  type ErrorBody,
+  type OwnedPhoneNumber,
+} from './numbers';
+export {
+  EmailDomains,
+  type EmailDomainListResponse,
+  type EmailDomain,
+  type EmailDomainCreateParams,
+  type EmailDomainCreateResponse,
+  type EmailDomainRetrieveResponse,
+  type EmailDomainVerifyResponse,
+} from './email-domains';
+export {
+  Functions,
+  type FunctionListParams,
+  type ZavuFunction,
+  type ZavuFunctionsCursor,
+  type FunctionRetrieveResponse,
+  type FunctionUpdateParams,
+  type FunctionUpdateResponse,
+} from './functions';

package/src/v2/resources/messages.ts

@@ -0,0 +1,129 @@
+// Generated by zavu-codegen from apps/docs/api-reference/v2/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 { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import type * as T from '../types';
+
+/** Send, list and read messages. */
+export class Messages extends APIResource {
+  /**
+   * Send a message
+   *
+   * Send one message. The body is the /v1 message body plus `from` and
+   * `conversationId`. There is no `Zavu-Sender` header.
+   *
+   * **Where it leaves from:** `conversationId` if given, else `from` (an address),
+   * else the project default. See `from` for ambiguous addresses.
+   *
+   * **Which transport:** decided by the first branch that applies, and reported in
+   * `routing.reason`: a test-mode key uses the WhatsApp sandbox; an email-address
+   * `to` uses email; a WhatsApp-only `messageType` uses WhatsApp; an explicit
+   * `channel` is used as given; otherwise the fixed order over the sender's ACTIVE
+   * transports (for a phone number: WhatsApp, then SMS, then one-way SMS). The order
+   * ignores price and the 24-hour window. A `channel` that contradicts the recipient
+   * (an email `to` on anything but `email`, or `channel: "email"` with a phone
+   * number or chat id) or a WhatsApp-only `messageType` is refused with `400`; /v1
+   * overrides the first and last silently.
+   *
+   * **When nothing can send** the answer is always `409 no_channel`, whatever the
+   * reason: no channel at all, an explicit `channel` that is not connected, an email
+   * `to` without an email channel, a WhatsApp-only `messageType` without WhatsApp.
+   * `details.connect` lists what this project can connect to reach `to`, with the
+   * exact call for each (`POST /v2/channels`, `POST /v2/numbers`), and the message
+   * never names an address that carries nothing.
+   *
+   * **Fallback** from WhatsApp to SMS, when enabled, happens after this call
+   * returned, once the WhatsApp send fails. It is not visible in `routing`; read
+   * `attemptedChannels` on the message or wait for the webhooks. Before falling back
+   * to SMS, a message sent through /v2 is checked for an approved 10DLC campaign (+1
+   * numbers) and an active connection; when either is missing it stays `failed` with
+   * `errorCode` `TEN_DLC_REQUIRED` or `CHANNEL_INACTIVE`.
+   *
+   * Limits, risk review, pricing and verification are exactly /v1's: see `POST
+   * /v1/messages`.
+   *
+   * `POST /v2/messages`
+   */
+  send(
+    body: MessageSendParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MessageSendResponse> {
+    return this._client.post('/v2/messages', { body, ...options });
+  }
+
+  /**
+   * List messages
+   *
+   * List messages of this project, newest first.
+   *
+   * `GET /v2/messages`
+   */
+  list(
+    query: MessageListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MessagesCursor, Message> {
+    return this._client.getAPIList('/v2/messages', Cursor<Message>, { query, ...options });
+  }
+
+  /**
+   * Get a message
+   *
+   * A message, with `from` and `to` naming addresses, plus `attemptedChannels` and
+   * `riskHold`.
+   *
+   * `GET /v2/messages/{messageId}`
+   */
+  retrieve(messageID: string, options?: RequestOptions): APIPromise<MessageRetrieveResponse> {
+    return this._client.get(path`/v2/messages/${messageID}`, options);
+  }
+}
+
+export type MessageSendParams = T.MessagesSendParams;
+
+export type MessageSendResponse = T.SendMessageResponse;
+
+export type ChannelTypeRequest = T.ChannelTypeRequest;
+
+export type EmailAttachmentInput = T.EmailAttachmentInput;
+
+export type Message = T.Message;
+
+export type MessageContent = T.MessageContent;
+
+export type MessageType = T.MessageType;
+
+export type Routing = T.Routing;
+
+export type SendMessageResponse = T.SendMessageResponse;
+
+export type MessageListParams = T.MessagesListParams;
+
+export type MessagesCursor = Cursor<T.Message>;
+
+export type ChannelType = T.ChannelType;
+
+export type MessageStatus = T.MessageStatus;
+
+export type MessageRetrieveResponse = T.GetMessageV2Response;
+
+export declare namespace Messages {
+  export {
+    type ChannelType as ChannelType,
+    type ChannelTypeRequest as ChannelTypeRequest,
+    type EmailAttachmentInput as EmailAttachmentInput,
+    type Message as Message,
+    type MessageContent as MessageContent,
+    type MessageListParams as MessageListParams,
+    type MessageRetrieveResponse as MessageRetrieveResponse,
+    type MessageSendParams as MessageSendParams,
+    type MessageSendResponse as MessageSendResponse,
+    type MessageStatus as MessageStatus,
+    type MessageType as MessageType,
+    type MessagesCursor as MessagesCursor,
+    type Routing as Routing,
+    type SendMessageResponse as SendMessageResponse,
+  };
+}