npm - @digisglobal/omnivox-sdk - Versions diffs - 0.6.1 → 0.7.0 - Mend

@digisglobal/omnivox-sdk 0.6.1 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/index.d.cts CHANGED Viewed

@@ -580,49 +580,95 @@ interface ContactsModuleOptions extends TokenProvider {
     /** Base URL of the Omnivox API (e.g. "https://api.omnivox.io"). */
     baseUrl: string;
 }
-/** Identity shape for creating a contact. */
+/** Channel discriminator for a contact identity (wire enum). */
+type ContactChannel = 'WHATSAPP' | 'EMAIL';
+/**
+ * Identity shape for creating / adding a contact identity (request body).
+ * Matches the API Zod contract: `{ channelType, rawIdentifier }`.
+ */
 interface ContactIdentityInput {
-    channel: string;
+    channelType: ContactChannel;
+    rawIdentifier: string;
+}
+/** Custom-field value on a create/patch request — referenced by field NAME. */
+interface ContactFieldValueInput {
+    fieldName: string;
     value: string;
-    [key: string]: unknown;
 }
 /** Input for creating a contact. */
 interface CreateContactInput {
     displayName: string;
-    identities: ContactIdentityInput[];
-    [key: string]: unknown;
+    /** Single identity (the API accepts `identity` or `identities[]`). */
+    identity?: ContactIdentityInput;
+    identities?: ContactIdentityInput[];
+    /** Tag NAMES from the catalog (unknown names → 422). Full set on create. */
+    tags?: string[];
+    /** Field values by NAME (unknown names → 422). */
+    fieldValues?: ContactFieldValueInput[];
 }
-/** Input for patching a contact. */
+/**
+ * Input for patching a contact. The PATCH endpoint is strict — only these
+ * keys are accepted. `tags`/`fieldValues`, when present, are full-replacement.
+ */
 interface PatchContactInput {
     displayName?: string;
     isActive?: boolean;
-    [key: string]: unknown;
+    tags?: string[];
+    fieldValues?: ContactFieldValueInput[];
 }
 /** Input for adding an identity to a contact. */
-interface AddIdentityInput {
-    channel: string;
-    value: string;
-    [key: string]: unknown;
-}
-/** Contact identity resource shape. */
+type AddIdentityInput = ContactIdentityInput;
+/** Contact identity resource shape (response). */
 interface ContactIdentity {
     id: string;
-    channel: string;
+    channelType: ContactChannel;
+    rawIdentifier: string;
+    normalizedIdentifier?: string;
+}
+/** A tag reference from the tenant catalog (response). */
+interface ContactTag {
+    id: string;
+    name: string;
+}
+/** A custom-field definition from the catalog (response). */
+interface ContactFieldDefinition {
+    id: string;
+    name: string;
+    type: string;
+}
+/**
+ * A custom-field value on contact detail (response). `fieldName` is a future
+ * enrichment (DEP-13) — until it lands, join `fieldId` against `metadata().fields`.
+ */
+interface ContactFieldValue {
+    fieldId: string;
     value: string;
-    [key: string]: unknown;
+    fieldName?: string;
 }
-/** Contact resource shape returned by the API. */
+/** A conversation summary embedded on contact detail (response). */
+interface ContactConversationSummary {
+    id: string;
+    contactIdentityId: string;
+    status: string;
+    lastInboundAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Contact resource shape returned by the API (list + detail). */
 interface ContactItem {
     id: string;
     displayName: string;
+    isActive?: boolean;
+    createdAt?: string;
     identities?: ContactIdentity[];
-    [key: string]: unknown;
+    tags?: ContactTag[];
+    fieldValues?: ContactFieldValue[];
+    conversations?: ContactConversationSummary[];
 }
 /** Contacts metadata (tag catalog and custom-field definitions). */
 interface ContactsMetadata {
-    tags: unknown[];
-    customFields: unknown[];
-    [key: string]: unknown;
+    tags: ContactTag[];
+    fields: ContactFieldDefinition[];
 }
 /** Paginated list response. */
 interface PagedList$2<T> {
@@ -1588,4 +1634,4 @@ declare function createWhatsAppBusinessAccountsModule(options: WhatsAppBusinessA
 /** Return type of createWhatsAppBusinessAccountsModule. */
 type WhatsAppBusinessAccountsModule = ReturnType<typeof createWhatsAppBusinessAccountsModule>;
-export { type AddIdentityInput, type AgentItem, type AgentsModule, type AgentsModuleOptions, type ApiKeyItem, type AssignInput, type AttachmentUploadResult, type AttachmentUrlResult, type AttachmentsModule, type AttachmentsModuleOptions, type AuthMeAgent, type AuthMeModule, type AuthMeModuleOptions, type AuthMeResponse, type AuthMeTenant, type AuthorDraftInput, type BasicEmailChannelConfig, type BasicEmailChannelSecret, type CannedResponseItem, type CannedResponseListOpts, type CannedResponseSearchOpts, type CannedResponsesModule, type CannedResponsesModuleOptions, type Channel, type ChannelListItem, type ChannelStatus, type ChannelType, type ChannelsModule, type ChannelsModuleOptions, type ContactIdentity, type ContactIdentityInput, type ContactItem, type ContactSearchOpts, type ContactsMetadata, type ContactsModule, type ContactsModuleOptions, type ConversationItem, type ConversationListOpts, type ConversationsModule, type ConversationsModuleOptions, type CreateAgentInput, type CreateApiKeyInput, type CreateApiKeyResponse, type CreateCannedResponseInput, type CreateChannelBody, type CreateContactInput, type CreateEmailChannelBody, type CreateEmailTemplateInput, type CreateWhatsAppChannelBody, type CredentialsMode, type EmailChannelConfig, type EmailChannelSecret, type EmailImapConfig, type EmailSmtpConfig, type EmailTemplateItem, type EmailTemplateListOpts, type ImportApprovedResult, type LobbyEntry, type LobbyListOpts, type MessageItem, type MessageListOpts, type MessageReadUpdatePayload, type MessageStatusPayload, type MessagesModule, type MessagesModuleOptions, type OAuth2CertificateEmailChannelSecret, type OAuth2ClientSecretEmailChannelSecret, type OAuth2EmailChannelConfig, type OAuth2EmailChannelSecret, type OmnivoxClient, type OmnivoxClientOptions, OmnivoxRequestError, type PageOpts, type PageParams, type PagedResponse, type ParticipantPayload, type PatchContactInput, type PatchEmailTemplateInput, type PickupInput, type ReopenOrCreateInput, type RevokeApiKeyResponse, type SendMessageInput, type SendTemplateInput, type SubmitResult, type TemplatesModule, type TemplatesModuleOptions, type TenantsModule, type TenantsModuleOptions, type TokenProvider, type TypingIndicatorPayload, type UpdateCannedResponseInput, type UpdateChannelBody, type UpdateStatusInput, type UpdateWhatsAppTemplateInput, type WhatsAppBusinessAccountItem, type WhatsAppBusinessAccountsModule, type WhatsAppBusinessAccountsModuleOptions, type WhatsAppChannelConfig, type WhatsAppRecoveryOption, type WhatsAppTemplateHistoryEvent, type WhatsAppTemplateItem, type WsAuth, type WsClient, type WsClientInstance, type WsClientOptions, type WsConnectionState, type WsEventPayloads, buildPageParams, createAgentsModule, createApiKeyTokenProvider, createAttachmentsModule, createAuthMeModule, createCannedResponsesModule, createChannelsModule, createContactsModule, createConversationsModule, createMessagesModule, createOmnivoxClient, createSessionTokenProvider, createTemplatesModule, createTenantsModule, createWhatsAppBusinessAccountsModule, createWsClient, iteratePages };
+export { type AddIdentityInput, type AgentItem, type AgentsModule, type AgentsModuleOptions, type ApiKeyItem, type AssignInput, type AttachmentUploadResult, type AttachmentUrlResult, type AttachmentsModule, type AttachmentsModuleOptions, type AuthMeAgent, type AuthMeModule, type AuthMeModuleOptions, type AuthMeResponse, type AuthMeTenant, type AuthorDraftInput, type BasicEmailChannelConfig, type BasicEmailChannelSecret, type CannedResponseItem, type CannedResponseListOpts, type CannedResponseSearchOpts, type CannedResponsesModule, type CannedResponsesModuleOptions, type Channel, type ChannelListItem, type ChannelStatus, type ChannelType, type ChannelsModule, type ChannelsModuleOptions, type ContactChannel, type ContactConversationSummary, type ContactFieldDefinition, type ContactFieldValue, type ContactFieldValueInput, type ContactIdentity, type ContactIdentityInput, type ContactItem, type ContactSearchOpts, type ContactTag, type ContactsMetadata, type ContactsModule, type ContactsModuleOptions, type ConversationItem, type ConversationListOpts, type ConversationsModule, type ConversationsModuleOptions, type CreateAgentInput, type CreateApiKeyInput, type CreateApiKeyResponse, type CreateCannedResponseInput, type CreateChannelBody, type CreateContactInput, type CreateEmailChannelBody, type CreateEmailTemplateInput, type CreateWhatsAppChannelBody, type CredentialsMode, type EmailChannelConfig, type EmailChannelSecret, type EmailImapConfig, type EmailSmtpConfig, type EmailTemplateItem, type EmailTemplateListOpts, type ImportApprovedResult, type LobbyEntry, type LobbyListOpts, type MessageItem, type MessageListOpts, type MessageReadUpdatePayload, type MessageStatusPayload, type MessagesModule, type MessagesModuleOptions, type OAuth2CertificateEmailChannelSecret, type OAuth2ClientSecretEmailChannelSecret, type OAuth2EmailChannelConfig, type OAuth2EmailChannelSecret, type OmnivoxClient, type OmnivoxClientOptions, OmnivoxRequestError, type PageOpts, type PageParams, type PagedResponse, type ParticipantPayload, type PatchContactInput, type PatchEmailTemplateInput, type PickupInput, type ReopenOrCreateInput, type RevokeApiKeyResponse, type SendMessageInput, type SendTemplateInput, type SubmitResult, type TemplatesModule, type TemplatesModuleOptions, type TenantsModule, type TenantsModuleOptions, type TokenProvider, type TypingIndicatorPayload, type UpdateCannedResponseInput, type UpdateChannelBody, type UpdateStatusInput, type UpdateWhatsAppTemplateInput, type WhatsAppBusinessAccountItem, type WhatsAppBusinessAccountsModule, type WhatsAppBusinessAccountsModuleOptions, type WhatsAppChannelConfig, type WhatsAppRecoveryOption, type WhatsAppTemplateHistoryEvent, type WhatsAppTemplateItem, type WsAuth, type WsClient, type WsClientInstance, type WsClientOptions, type WsConnectionState, type WsEventPayloads, buildPageParams, createAgentsModule, createApiKeyTokenProvider, createAttachmentsModule, createAuthMeModule, createCannedResponsesModule, createChannelsModule, createContactsModule, createConversationsModule, createMessagesModule, createOmnivoxClient, createSessionTokenProvider, createTemplatesModule, createTenantsModule, createWhatsAppBusinessAccountsModule, createWsClient, iteratePages };

package/dist/index.d.ts CHANGED Viewed

@@ -580,49 +580,95 @@ interface ContactsModuleOptions extends TokenProvider {
     /** Base URL of the Omnivox API (e.g. "https://api.omnivox.io"). */
     baseUrl: string;
 }
-/** Identity shape for creating a contact. */
+/** Channel discriminator for a contact identity (wire enum). */
+type ContactChannel = 'WHATSAPP' | 'EMAIL';
+/**
+ * Identity shape for creating / adding a contact identity (request body).
+ * Matches the API Zod contract: `{ channelType, rawIdentifier }`.
+ */
 interface ContactIdentityInput {
-    channel: string;
+    channelType: ContactChannel;
+    rawIdentifier: string;
+}
+/** Custom-field value on a create/patch request — referenced by field NAME. */
+interface ContactFieldValueInput {
+    fieldName: string;
     value: string;
-    [key: string]: unknown;
 }
 /** Input for creating a contact. */
 interface CreateContactInput {
     displayName: string;
-    identities: ContactIdentityInput[];
-    [key: string]: unknown;
+    /** Single identity (the API accepts `identity` or `identities[]`). */
+    identity?: ContactIdentityInput;
+    identities?: ContactIdentityInput[];
+    /** Tag NAMES from the catalog (unknown names → 422). Full set on create. */
+    tags?: string[];
+    /** Field values by NAME (unknown names → 422). */
+    fieldValues?: ContactFieldValueInput[];
 }
-/** Input for patching a contact. */
+/**
+ * Input for patching a contact. The PATCH endpoint is strict — only these
+ * keys are accepted. `tags`/`fieldValues`, when present, are full-replacement.
+ */
 interface PatchContactInput {
     displayName?: string;
     isActive?: boolean;
-    [key: string]: unknown;
+    tags?: string[];
+    fieldValues?: ContactFieldValueInput[];
 }
 /** Input for adding an identity to a contact. */
-interface AddIdentityInput {
-    channel: string;
-    value: string;
-    [key: string]: unknown;
-}
-/** Contact identity resource shape. */
+type AddIdentityInput = ContactIdentityInput;
+/** Contact identity resource shape (response). */
 interface ContactIdentity {
     id: string;
-    channel: string;
+    channelType: ContactChannel;
+    rawIdentifier: string;
+    normalizedIdentifier?: string;
+}
+/** A tag reference from the tenant catalog (response). */
+interface ContactTag {
+    id: string;
+    name: string;
+}
+/** A custom-field definition from the catalog (response). */
+interface ContactFieldDefinition {
+    id: string;
+    name: string;
+    type: string;
+}
+/**
+ * A custom-field value on contact detail (response). `fieldName` is a future
+ * enrichment (DEP-13) — until it lands, join `fieldId` against `metadata().fields`.
+ */
+interface ContactFieldValue {
+    fieldId: string;
     value: string;
-    [key: string]: unknown;
+    fieldName?: string;
 }
-/** Contact resource shape returned by the API. */
+/** A conversation summary embedded on contact detail (response). */
+interface ContactConversationSummary {
+    id: string;
+    contactIdentityId: string;
+    status: string;
+    lastInboundAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Contact resource shape returned by the API (list + detail). */
 interface ContactItem {
     id: string;
     displayName: string;
+    isActive?: boolean;
+    createdAt?: string;
     identities?: ContactIdentity[];
-    [key: string]: unknown;
+    tags?: ContactTag[];
+    fieldValues?: ContactFieldValue[];
+    conversations?: ContactConversationSummary[];
 }
 /** Contacts metadata (tag catalog and custom-field definitions). */
 interface ContactsMetadata {
-    tags: unknown[];
-    customFields: unknown[];
-    [key: string]: unknown;
+    tags: ContactTag[];
+    fields: ContactFieldDefinition[];
 }
 /** Paginated list response. */
 interface PagedList$2<T> {
@@ -1588,4 +1634,4 @@ declare function createWhatsAppBusinessAccountsModule(options: WhatsAppBusinessA
 /** Return type of createWhatsAppBusinessAccountsModule. */
 type WhatsAppBusinessAccountsModule = ReturnType<typeof createWhatsAppBusinessAccountsModule>;
-export { type AddIdentityInput, type AgentItem, type AgentsModule, type AgentsModuleOptions, type ApiKeyItem, type AssignInput, type AttachmentUploadResult, type AttachmentUrlResult, type AttachmentsModule, type AttachmentsModuleOptions, type AuthMeAgent, type AuthMeModule, type AuthMeModuleOptions, type AuthMeResponse, type AuthMeTenant, type AuthorDraftInput, type BasicEmailChannelConfig, type BasicEmailChannelSecret, type CannedResponseItem, type CannedResponseListOpts, type CannedResponseSearchOpts, type CannedResponsesModule, type CannedResponsesModuleOptions, type Channel, type ChannelListItem, type ChannelStatus, type ChannelType, type ChannelsModule, type ChannelsModuleOptions, type ContactIdentity, type ContactIdentityInput, type ContactItem, type ContactSearchOpts, type ContactsMetadata, type ContactsModule, type ContactsModuleOptions, type ConversationItem, type ConversationListOpts, type ConversationsModule, type ConversationsModuleOptions, type CreateAgentInput, type CreateApiKeyInput, type CreateApiKeyResponse, type CreateCannedResponseInput, type CreateChannelBody, type CreateContactInput, type CreateEmailChannelBody, type CreateEmailTemplateInput, type CreateWhatsAppChannelBody, type CredentialsMode, type EmailChannelConfig, type EmailChannelSecret, type EmailImapConfig, type EmailSmtpConfig, type EmailTemplateItem, type EmailTemplateListOpts, type ImportApprovedResult, type LobbyEntry, type LobbyListOpts, type MessageItem, type MessageListOpts, type MessageReadUpdatePayload, type MessageStatusPayload, type MessagesModule, type MessagesModuleOptions, type OAuth2CertificateEmailChannelSecret, type OAuth2ClientSecretEmailChannelSecret, type OAuth2EmailChannelConfig, type OAuth2EmailChannelSecret, type OmnivoxClient, type OmnivoxClientOptions, OmnivoxRequestError, type PageOpts, type PageParams, type PagedResponse, type ParticipantPayload, type PatchContactInput, type PatchEmailTemplateInput, type PickupInput, type ReopenOrCreateInput, type RevokeApiKeyResponse, type SendMessageInput, type SendTemplateInput, type SubmitResult, type TemplatesModule, type TemplatesModuleOptions, type TenantsModule, type TenantsModuleOptions, type TokenProvider, type TypingIndicatorPayload, type UpdateCannedResponseInput, type UpdateChannelBody, type UpdateStatusInput, type UpdateWhatsAppTemplateInput, type WhatsAppBusinessAccountItem, type WhatsAppBusinessAccountsModule, type WhatsAppBusinessAccountsModuleOptions, type WhatsAppChannelConfig, type WhatsAppRecoveryOption, type WhatsAppTemplateHistoryEvent, type WhatsAppTemplateItem, type WsAuth, type WsClient, type WsClientInstance, type WsClientOptions, type WsConnectionState, type WsEventPayloads, buildPageParams, createAgentsModule, createApiKeyTokenProvider, createAttachmentsModule, createAuthMeModule, createCannedResponsesModule, createChannelsModule, createContactsModule, createConversationsModule, createMessagesModule, createOmnivoxClient, createSessionTokenProvider, createTemplatesModule, createTenantsModule, createWhatsAppBusinessAccountsModule, createWsClient, iteratePages };
+export { type AddIdentityInput, type AgentItem, type AgentsModule, type AgentsModuleOptions, type ApiKeyItem, type AssignInput, type AttachmentUploadResult, type AttachmentUrlResult, type AttachmentsModule, type AttachmentsModuleOptions, type AuthMeAgent, type AuthMeModule, type AuthMeModuleOptions, type AuthMeResponse, type AuthMeTenant, type AuthorDraftInput, type BasicEmailChannelConfig, type BasicEmailChannelSecret, type CannedResponseItem, type CannedResponseListOpts, type CannedResponseSearchOpts, type CannedResponsesModule, type CannedResponsesModuleOptions, type Channel, type ChannelListItem, type ChannelStatus, type ChannelType, type ChannelsModule, type ChannelsModuleOptions, type ContactChannel, type ContactConversationSummary, type ContactFieldDefinition, type ContactFieldValue, type ContactFieldValueInput, type ContactIdentity, type ContactIdentityInput, type ContactItem, type ContactSearchOpts, type ContactTag, type ContactsMetadata, type ContactsModule, type ContactsModuleOptions, type ConversationItem, type ConversationListOpts, type ConversationsModule, type ConversationsModuleOptions, type CreateAgentInput, type CreateApiKeyInput, type CreateApiKeyResponse, type CreateCannedResponseInput, type CreateChannelBody, type CreateContactInput, type CreateEmailChannelBody, type CreateEmailTemplateInput, type CreateWhatsAppChannelBody, type CredentialsMode, type EmailChannelConfig, type EmailChannelSecret, type EmailImapConfig, type EmailSmtpConfig, type EmailTemplateItem, type EmailTemplateListOpts, type ImportApprovedResult, type LobbyEntry, type LobbyListOpts, type MessageItem, type MessageListOpts, type MessageReadUpdatePayload, type MessageStatusPayload, type MessagesModule, type MessagesModuleOptions, type OAuth2CertificateEmailChannelSecret, type OAuth2ClientSecretEmailChannelSecret, type OAuth2EmailChannelConfig, type OAuth2EmailChannelSecret, type OmnivoxClient, type OmnivoxClientOptions, OmnivoxRequestError, type PageOpts, type PageParams, type PagedResponse, type ParticipantPayload, type PatchContactInput, type PatchEmailTemplateInput, type PickupInput, type ReopenOrCreateInput, type RevokeApiKeyResponse, type SendMessageInput, type SendTemplateInput, type SubmitResult, type TemplatesModule, type TemplatesModuleOptions, type TenantsModule, type TenantsModuleOptions, type TokenProvider, type TypingIndicatorPayload, type UpdateCannedResponseInput, type UpdateChannelBody, type UpdateStatusInput, type UpdateWhatsAppTemplateInput, type WhatsAppBusinessAccountItem, type WhatsAppBusinessAccountsModule, type WhatsAppBusinessAccountsModuleOptions, type WhatsAppChannelConfig, type WhatsAppRecoveryOption, type WhatsAppTemplateHistoryEvent, type WhatsAppTemplateItem, type WsAuth, type WsClient, type WsClientInstance, type WsClientOptions, type WsConnectionState, type WsEventPayloads, buildPageParams, createAgentsModule, createApiKeyTokenProvider, createAttachmentsModule, createAuthMeModule, createCannedResponsesModule, createChannelsModule, createContactsModule, createConversationsModule, createMessagesModule, createOmnivoxClient, createSessionTokenProvider, createTemplatesModule, createTenantsModule, createWhatsAppBusinessAccountsModule, createWsClient, iteratePages };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@digisglobal/omnivox-sdk",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "exports": {