samva 0.23.0 → 0.23.1

package/dist/client/types.gen.d.ts

@@ -252,6 +252,12 @@ export type Namespace = {
 export type NamespaceMetadata = {
     [key: string]: string;
 };
+/**
+ * Your own labels for the namespace, such as the id of your customer it serves. Samva stores them and never reads them.
+ */
+export type NamespaceMetadataWritable = {
+    [key: string]: string | undefined;
+};
 export type UpdateNamespacePayload = {
     name?: string | null | undefined;
     metadata?: {
@@ -461,6 +467,9 @@ export type ConversationId = string;
 export type JsonObject = {
     [key: string]: JsonValue;
 };
+export type JsonObjectWritable = {
+    [key: string]: JsonValueWritable | undefined;
+};
 export type TemplateId = string;
 export type MailboxEndpointId = string;
 export type EmailAttachment = {
@@ -969,6 +978,9 @@ export type MailboxEndpoint = {
 export type MailboxMetadata = {
     [key: string]: string;
 };
+export type MailboxMetadataWritable = {
+    [key: string]: string | undefined;
+};
 export type MailboxStatus = "active" | "paused";
 export type UpdateMailboxEndpointPayload = {
     displayName?: string | null | null | undefined;
@@ -984,7 +996,7 @@ export type UpdateMailboxPayload = {
     metadata?: MailboxMetadataPatch | null | undefined;
 };
 export type MailboxMetadataPatch = {
-    [key: string]: string | null;
+    [key: string]: string | null | undefined;
 };
 export type CreateMailboxPayload = {
     namespaceId?: NamespaceId | null | undefined;
@@ -1882,12 +1894,22 @@ export type JourneyDefinition = {
     goal?: JourneyGoal | undefined;
     reentry?: boolean | undefined;
 };
+export type JourneyDefinitionWritable = {
+    trigger: JourneyTrigger;
+    rootNodeId: JourneyNodeId;
+    nodes: {
+        [key: string]: JourneyNodeWritable | undefined;
+    };
+    goal?: JourneyGoal | undefined;
+    reentry?: boolean | undefined;
+};
 export type JourneyGoal = {
     eventName: JourneyEventName;
 };
 export type JourneyEventName = JourneyCustomEventName | "contact.created" | "contact.tag_added" | "contact.joined_group";
 export type JourneyCustomEventName = string;
 export type JourneyNode = JourneySendEmailNode | JourneyWaitNode | JourneyWaitForEventNode | JourneyBranchNode | JourneyUpdateTagsNode | JourneyWebhookNode | JourneyExitNode;
+export type JourneyNodeWritable = JourneySendEmailNodeWritable | JourneyWaitNode | JourneyWaitForEventNode | JourneyBranchNode | JourneyUpdateTagsNode | JourneyWebhookNodeWritable | JourneyExitNode;
 export type JourneyExitNode = {
     type: "exit";
     config: JourneyEmptyConfig;
@@ -1901,12 +1923,20 @@ export type JourneyWebhookNode = {
     config: JourneyWebhookConfig;
     next: [JourneyNextEdge];
 };
+export type JourneyWebhookNodeWritable = {
+    type: "webhook";
+    config: JourneyWebhookConfigWritable;
+    next: [JourneyNextEdge];
+};
 export type JourneyNextEdge = {
     nodeId: JourneyNodeId;
 };
 export type JourneyWebhookConfig = {
     data?: JsonObject | undefined;
 };
+export type JourneyWebhookConfigWritable = {
+    data?: JsonObjectWritable | undefined;
+};
 export type JourneyUpdateTagsNode = {
     type: "update_tags";
     config: JourneyUpdateTagsConfig;
@@ -1993,11 +2023,21 @@ export type JourneySendEmailNode = {
     config: JourneySendEmailConfig;
     next: [JourneyNextEdge];
 };
+export type JourneySendEmailNodeWritable = {
+    type: "send_email";
+    config: JourneySendEmailConfigWritable;
+    next: [JourneyNextEdge];
+};
 export type JourneySendEmailConfig = {
     template: TemplateId | string;
     senderId?: EmailSenderId | undefined;
     templateData?: JsonObject | undefined;
 };
+export type JourneySendEmailConfigWritable = {
+    template: TemplateId | string;
+    senderId?: EmailSenderId | undefined;
+    templateData?: JsonObjectWritable | undefined;
+};
 export type EmailSenderId = string;
 export type JourneyTrigger = JourneyCustomEventTrigger | JourneyContactCreatedTrigger | JourneyTagAddedTrigger | JourneyGroupJoinedTrigger;
 export type JourneyGroupJoinedTrigger = {
@@ -2089,7 +2129,7 @@ export type BatchEventsPayload = {
 export type CreateEventPayload = {
     contact: ContactEventReference;
     name: string;
-    properties?: JsonObject | null | undefined;
+    properties?: JsonObjectWritable | null | undefined;
     occurredAt?: string | null | undefined;
     idempotencyKey?: string | null | undefined;
 };
@@ -2155,9 +2195,21 @@ export type ContactProfile = {
     customFields?: ContactCustomFields | null | undefined;
     source?: "api" | "import" | "manual" | "form" | null | undefined;
 };
+export type ContactProfileWritable = {
+    firstName?: string | null | undefined;
+    lastName?: string | null | undefined;
+    company?: string | null | undefined;
+    jobTitle?: string | null | undefined;
+    location?: ContactLocation | null | undefined;
+    customFields?: ContactCustomFieldsWritable | null | undefined;
+    source?: "api" | "import" | "manual" | "form" | null | undefined;
+};
 export type ContactCustomFields = {
     [key: string]: string | number | boolean | null;
 };
+export type ContactCustomFieldsWritable = {
+    [key: string]: string | number | boolean | null | undefined;
+};
 export type ContactLocation = {
     country: string;
     state: string;
@@ -2204,7 +2256,7 @@ export type ContactProfileUpdate = {
     company?: string | null | null | undefined;
     jobTitle?: string | null | null | undefined;
     location?: ContactLocation | null | null | undefined;
-    customFields?: ContactCustomFields | null | undefined;
+    customFields?: ContactCustomFieldsWritable | null | undefined;
 };
 export type ContactLookup = {
     type: "email";
@@ -2292,9 +2344,23 @@ export type ConversationContext = {
         workflowData?: UnknownRecord | null | undefined;
     } | null | undefined;
 };
+export type ConversationContextWritable = {
+    customerData?: UnknownRecordWritable | null | undefined;
+    previousConversations?: Array<string> | null | undefined;
+    sessionVariables?: UnknownRecordWritable | null | undefined;
+    workflowState?: {
+        currentStep?: string | null | undefined;
+        completedSteps?: Array<string> | null | undefined;
+        pendingSteps?: Array<string> | null | undefined;
+        workflowData?: UnknownRecordWritable | null | undefined;
+    } | null | undefined;
+};
 export type UnknownRecord = {
     [key: string]: JsonValue;
 };
+export type UnknownRecordWritable = {
+    [key: string]: JsonValueWritable | undefined;
+};
 export type ConversationContacts = {
     contactIds: [ContactId, ...Array<ContactId>];
 };
@@ -3006,6 +3072,9 @@ export type CampaignContent = {
 export type CampaignContentMetadata = {
     [key: string]: JsonValue;
 } | null;
+export type CampaignContentMetadataWritable = {
+    [key: string]: JsonValueWritable | undefined;
+} | null;
 export type CampaignConversationRef = ConversationId | null | null;
 export type EmailContent = {
     subject?: string | null | undefined;
@@ -3028,6 +3097,27 @@ export type EmailContent = {
     tracking?: EmailTrackingOverrideV1 | undefined;
     footer?: EmailFooterOverride | undefined;
 };
+export type EmailContentWritable = {
+    subject?: string | null | undefined;
+    html?: string | null | undefined;
+    text?: string | null | undefined;
+    attachments?: EmailAttachments | undefined;
+    publicationId?: TemplatePublicationId | undefined;
+    inputContractId?: TemplateInputContractId | undefined;
+    templateId?: TemplateId | null | undefined;
+    templateSlug?: string | null | undefined;
+    templateData?: TemplateDataWritable | undefined;
+    locale?: RenderLocale | undefined;
+    timeZone?: RenderTimeZone | undefined;
+    inReplyToMessageId?: MessageId | null | undefined;
+    replyTo?: ReplyToAddresses | undefined;
+    /**
+     * The unsubscribe group for this send. Omit to inherit the template group; null disables group inheritance for a direct send. Campaigns require a group.
+     */
+    unsubscribeGroupId?: UnsubscribeId | null | null | undefined;
+    tracking?: EmailTrackingOverrideV1 | undefined;
+    footer?: EmailFooterOverride | undefined;
+};
 export type EmailFooterOverride = {
     enabled?: boolean | null | undefined;
 };
@@ -3046,6 +3136,7 @@ export type EmailTrackingOverrideV1 = {
 };
 export type ReplyToAddresses = Array<string> | null | null;
 export type TemplateData = JsonObject | null;
+export type TemplateDataWritable = JsonObjectWritable | null;
 export type EmailAttachments = Array<EmailAttachment> | null;
 export type CampaignRunPage = {
     items: Array<CampaignRun>;
@@ -3086,7 +3177,7 @@ export type CampaignContentInput = {
     channel: "email";
     email: EmailDispatchContent;
     conversationId?: CampaignConversationRef | undefined;
-    metadata?: CampaignContentMetadata | undefined;
+    metadata?: CampaignContentMetadataWritable | undefined;
 };
 export type EmailDispatchContent = {
     subject?: string | null | undefined;
@@ -3097,7 +3188,7 @@ export type EmailDispatchContent = {
     inputContractId?: TemplateInputContractId | undefined;
     templateId?: TemplateId | null | undefined;
     templateSlug?: string | null | undefined;
-    templateData?: TemplateData | undefined;
+    templateData?: TemplateDataWritable | undefined;
     locale?: RenderLocale | undefined;
     timeZone?: RenderTimeZone | undefined;
     inReplyToMessageId?: MessageId | null | undefined;
@@ -3159,6 +3250,9 @@ export type SendMessagePayload = {
 export type MessageMetadata = {
     [key: string]: JsonValue;
 } | null;
+export type MessageMetadataWritable = {
+    [key: string]: JsonValueWritable | undefined;
+} | null;
 export type EmailSendMessagePayload = {
     conversationId?: ConversationId | null | null | undefined;
     metadata?: MessageMetadata | undefined;
@@ -3190,7 +3284,7 @@ export type ScheduledMessagePage = {
 };
 export type DispatchSendMessagePayload = {
     conversationId?: ConversationId | null | null | undefined;
-    metadata?: MessageMetadata | undefined;
+    metadata?: MessageMetadataWritable | undefined;
     channel: "email";
     to: EmailRecipients;
     cc?: EmailCcRecipients | undefined;
@@ -3364,6 +3458,9 @@ export type MessageSender = {
 export type JsonValue = string | number | boolean | null | Array<JsonValue> | {
     [key: string]: JsonValue;
 };
+export type JsonValueWritable = string | number | boolean | null | Array<JsonValueWritable> | {
+    [key: string]: JsonValueWritable | undefined;
+};
 export type MessagesListData = {
     body?: never;
     path?: never;
@@ -3418,13 +3515,13 @@ export type MessagesListResponse = MessagesListResponses[keyof MessagesListRespo
 export type MessagesSendData = {
     body: {
         conversationId?: ConversationId | null | null | undefined;
-        metadata?: MessageMetadata | undefined;
+        metadata?: MessageMetadataWritable | undefined;
         channel: "email";
         to: EmailRecipients;
         cc?: EmailCcRecipients | undefined;
         bcc?: EmailBccRecipients | undefined;
         from?: EmailSender | undefined;
-        email: EmailContent;
+        email: EmailContentWritable;
     };
     headers?: {
         "idempotency-key"?: string | null | undefined;
@@ -3795,13 +3892,13 @@ export type MessagesGetEmailResponse = MessagesGetEmailResponses[keyof MessagesG
 export type MessagesValidateEmailData = {
     body: {
         conversationId?: ConversationId | null | null | undefined;
-        metadata?: MessageMetadata | undefined;
+        metadata?: MessageMetadataWritable | undefined;
         channel: "email";
         to: EmailRecipients;
         cc?: EmailCcRecipients | undefined;
         bcc?: EmailBccRecipients | undefined;
         from?: EmailSender | undefined;
-        email: EmailContent;
+        email: EmailContentWritable;
     };
     path?: never;
     query?: never;
@@ -7272,7 +7369,7 @@ export type EmailCreateForwardingRuleData = {
         priority?: number | null | undefined;
         isActive?: boolean | null | undefined;
         metadata?: {
-            [key: string]: JsonValue;
+            [key: string]: JsonValueWritable | undefined;
         } | null | null | undefined;
     };
     path?: never;
@@ -7379,7 +7476,7 @@ export type EmailUpdateForwardingRuleData = {
         priority?: number | null | undefined;
         isActive?: boolean | null | undefined;
         metadata?: {
-            [key: string]: JsonValue;
+            [key: string]: JsonValueWritable | undefined;
         } | null | null | undefined;
     };
     path: {
@@ -8270,8 +8367,8 @@ export type ConversationsCreateData = {
         priority?: number | null | undefined;
         urgency?: "low" | "medium" | "high" | "critical" | null | undefined;
         complexity?: "simple" | "moderate" | "complex" | null | undefined;
-        metadata?: JsonObject | null | undefined;
-        context?: ConversationContext | null | null | undefined;
+        metadata?: JsonObjectWritable | null | undefined;
+        context?: ConversationContextWritable | null | null | undefined;
         tags?: Array<string> | null | undefined;
         categories?: Array<string> | null | undefined;
         isTest?: boolean | null | undefined;
@@ -8366,8 +8463,8 @@ export type ConversationsUpdateData = {
         priority?: number | null | undefined;
         urgency?: "low" | "medium" | "high" | "critical" | null | undefined;
         complexity?: "simple" | "moderate" | "complex" | null | undefined;
-        context?: ConversationContext | null | null | undefined;
-        metadata?: JsonObject | null | undefined;
+        context?: ConversationContextWritable | null | null | undefined;
+        metadata?: JsonObjectWritable | null | undefined;
         isTest?: boolean | null | undefined;
         isInternal?: boolean | null | undefined;
         isPrivate?: boolean | null | undefined;
@@ -8865,13 +8962,13 @@ export type ContactsCreateData = {
         displayName?: string | null | null | undefined;
         avatar?: string | null | null | undefined;
         identities?: Array<ContactIdentityInput> | null | undefined;
-        profile?: ContactProfile | null | null | undefined;
+        profile?: ContactProfileWritable | null | null | undefined;
         preferences?: ContactPreferences | null | null | undefined;
         tags?: Array<string> | null | undefined;
         status?: "active" | "paused" | "blocked" | "archived" | null | undefined;
         statusReason?: string | null | null | undefined;
         externalId?: string | null | null | undefined;
-        metadata?: JsonObject | null | null | undefined;
+        metadata?: JsonObjectWritable | null | null | undefined;
     };
     path?: never;
     query?: never;
@@ -8981,7 +9078,7 @@ export type ContactsFindOrCreateData = {
             displayName?: string | null | null | undefined;
             avatar?: string | null | null | undefined;
             identities?: Array<ContactIdentityInput> | null | undefined;
-            profile?: ContactProfile | null | null | undefined;
+            profile?: ContactProfileWritable | null | null | undefined;
             externalId?: string | null | null | undefined;
         } | null | undefined;
     };
@@ -9138,7 +9235,7 @@ export type ContactsUpdateData = {
         status?: "active" | "paused" | "blocked" | "archived" | null | undefined;
         statusReason?: string | null | null | undefined;
         externalId?: string | null | null | undefined;
-        metadata?: JsonObject | null | undefined;
+        metadata?: JsonObjectWritable | null | undefined;
     };
     path: {
         id: ContactId;
@@ -9289,7 +9386,7 @@ export type ContactsSetConsentData = {
          */
         source: string;
         capturedAt: string;
-        proof?: JsonObject | null | undefined;
+        proof?: JsonObjectWritable | null | undefined;
     };
     path: {
         id: ContactId;
@@ -9480,13 +9577,13 @@ export type ContactsBulkImportData = {
             displayName?: string | null | null | undefined;
             avatar?: string | null | null | undefined;
             identities?: Array<ContactIdentityInput> | null | undefined;
-            profile?: ContactProfile | null | null | undefined;
+            profile?: ContactProfileWritable | null | null | undefined;
             preferences?: ContactPreferences | null | null | undefined;
             tags?: Array<string> | null | undefined;
             status?: "active" | "paused" | "blocked" | "archived" | null | undefined;
             statusReason?: string | null | null | undefined;
             externalId?: string | null | null | undefined;
-            metadata?: JsonObject | null | null | undefined;
+            metadata?: JsonObjectWritable | null | null | undefined;
         }>;
         onConflict?: "skip" | "update" | null | undefined;
     };
@@ -9823,7 +9920,7 @@ export type EventsCreateData = {
     body: {
         contact: ContactEventReference;
         name: string;
-        properties?: JsonObject | null | undefined;
+        properties?: JsonObjectWritable | null | undefined;
         occurredAt?: string | null | undefined;
         idempotencyKey?: string | null | undefined;
     };
@@ -10007,7 +10104,7 @@ export type JourneysListResponse = JourneysListResponses[keyof JourneysListRespo
 export type JourneysCreateData = {
     body: {
         name: JourneyName;
-        definition: JourneyDefinition;
+        definition: JourneyDefinitionWritable;
     };
     path?: never;
     query?: never;
@@ -10194,7 +10291,7 @@ export type JourneysUpdateResponse = JourneysUpdateResponses[keyof JourneysUpdat
 export type JourneysReplaceDraftData = {
     body: {
         revision: string;
-        definition: JourneyDefinition;
+        definition: JourneyDefinitionWritable;
     };
     path: {
         id: JourneyId;
@@ -10754,7 +10851,7 @@ export type ContactGroupsCreateData = {
         description?: string | null | null | undefined;
         type?: "static" | "dynamic" | "smart" | null | undefined;
         criteria?: {
-            [key: string]: JsonValue;
+            [key: string]: JsonValueWritable | undefined;
         } | null | null | undefined;
         color?: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null | null | undefined;
         icon?: string | null | null | undefined;
@@ -10927,7 +11024,7 @@ export type ContactGroupsUpdateData = {
         description?: string | null | null | undefined;
         type?: "static" | "dynamic" | "smart" | null | undefined;
         criteria?: {
-            [key: string]: JsonValue;
+            [key: string]: JsonValueWritable | undefined;
         } | null | null | undefined;
         color?: "clay" | "sand" | "moss" | "sky" | "plum" | "rose" | null | null | undefined;
         icon?: string | null | null | undefined;
@@ -11188,7 +11285,7 @@ export type ContactGroupsPreviewData = {
             conditions?: Array<{
                 field: string;
                 operator: string;
-                value: JsonValue;
+                value: JsonValueWritable;
             }> | null | undefined;
         };
     };
@@ -14343,7 +14440,7 @@ export type TemplatesRenderPublicationData = {
          * The input to render with, validated against the publication's input schema.
          */
         data: {
-            [key: string]: JsonValue;
+            [key: string]: JsonValueWritable | undefined;
         };
         locale?: RenderLocale | undefined;
         timeZone?: RenderTimeZone | undefined;
@@ -15166,7 +15263,7 @@ export type WebhooksCreateData = {
         mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | undefined;
         namespaceId?: NamespaceId | null | undefined;
         headers?: {
-            [key: string]: string;
+            [key: string]: string | undefined;
         } | null | undefined;
         status?: "active" | "disabled" | null | undefined;
     };
@@ -15320,7 +15417,7 @@ export type WebhooksUpdateData = {
         mailboxIds?: [MailboxId, ...Array<MailboxId>] | null | null | undefined;
         namespaceId?: NamespaceId | null | null | undefined;
         headers?: {
-            [key: string]: string;
+            [key: string]: string | undefined;
         } | null | undefined;
         status?: "active" | "disabled" | null | undefined;
     };
@@ -15371,7 +15468,7 @@ export type WebhooksUpdateResponse = WebhooksUpdateResponses[keyof WebhooksUpdat
 export type WebhooksTestData = {
     body: {
         data?: {
-            [key: string]: JsonValue;
+            [key: string]: JsonValueWritable | undefined;
         } | null | undefined;
     };
     path: {
@@ -15741,7 +15838,7 @@ export type OrganizationsUpdateData = {
         timezone?: IanaTimezone | null | undefined;
         isActive?: boolean | null | undefined;
         metadata?: {
-            [key: string]: JsonValue;
+            [key: string]: JsonValueWritable | undefined;
         } | null | undefined;
         replyToDefault?: Array<string> | null | null | undefined;
         emailFooterEnabledDefault?: boolean | null | null | undefined;
@@ -16562,7 +16659,7 @@ export type MailboxesCreateData = {
         endpoint: CreateMailboxEndpointPayload;
         name: string;
         slug?: string | null | undefined;
-        metadata?: MailboxMetadata | null | undefined;
+        metadata?: MailboxMetadataWritable | null | undefined;
     };
     path?: never;
     query?: never;
@@ -19547,7 +19644,7 @@ export type NamespacesListResponse = NamespacesListResponses[keyof NamespacesLis
 export type NamespacesCreateData = {
     body: {
         name: string;
-        metadata?: NamespaceMetadata | null | undefined;
+        metadata?: NamespaceMetadataWritable | null | undefined;
     };
     path?: never;
     query?: never;
@@ -19679,7 +19776,7 @@ export type NamespacesUpdateData = {
     body: {
         name?: string | null | undefined;
         metadata?: {
-            [key: string]: string | null;
+            [key: string]: string | null | undefined;
         } | null | undefined;
     };
     path: {

package/dist/package.js

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "0.23.0";
+var version = "0.23.1";
 //#endregion
 export { version };