samva 0.11.0 → 0.13.0

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

@@ -94,6 +94,36 @@ export type ExtensionVersionRef = {
 };
 export type ExtensionVersionId = string;
 export type ExtensionId = string;
+export type UpgradeExtensionResponse = {
+    installation: ExtensionInstallation;
+    fromVersion: ExtensionVersionRef;
+    toVersion: ExtensionVersionRef;
+    permissionDiff: ExtensionPermissionDiff;
+    dryRun: boolean;
+    versionChange: ExtensionVersionChange | null;
+};
+export type ExtensionVersionChange = {
+    id: string;
+    organizationId: OrganizationId;
+    installationId: ExtensionInstallationId;
+    extensionId: ExtensionId;
+    fromVersion: ExtensionVersionRef;
+    toVersion: ExtensionVersionRef;
+    permissionDiff: ExtensionPermissionDiff;
+    changedBy: UserId;
+    changedAt: string;
+};
+export type UserId = string;
+export type ExtensionPermissionDiff = {
+    added: Array<"permission:read" | "permission:update" | "permission:send" | "permission:quarantine.read" | "event:mailbox.message.received" | "event:mailbox.message.sent" | "event:mailbox.action.pending_approval" | "event:mailbox.message.quarantined" | "event:mailbox.message.released" | "event:mailbox.message.discarded">;
+    removed: Array<"permission:read" | "permission:update" | "permission:send" | "permission:quarantine.read" | "event:mailbox.message.received" | "event:mailbox.message.sent" | "event:mailbox.action.pending_approval" | "event:mailbox.message.quarantined" | "event:mailbox.message.released" | "event:mailbox.message.discarded">;
+};
+export type OrganizationId = string;
+export type UpgradeExtensionPayload = {
+    version?: string | ExtensionVersionId | null | undefined;
+    acceptPermissions?: Array<"permission:read" | "permission:update" | "permission:send" | "permission:quarantine.read" | "event:mailbox.message.received" | "event:mailbox.message.sent" | "event:mailbox.action.pending_approval" | "event:mailbox.message.quarantined" | "event:mailbox.message.released" | "event:mailbox.message.discarded"> | null | undefined;
+    dryRun?: boolean | null | undefined;
+};
 export type SuccessResponse = {
     success: boolean;
 };
@@ -274,6 +304,17 @@ export type BillingProviderError = {
     _tag: "BillingProviderError";
     message: string;
 };
+export type SenderNotReadyError = {
+    _tag: "SenderNotReadyError";
+    message: string;
+    sender: string;
+    retryAfterSeconds?: number | null | undefined;
+};
+export type RateLimitedError = {
+    _tag: "RateLimitedError";
+    message: string;
+    retryAfterSeconds: number;
+};
 export type PaymentRequiredError = {
     _tag: "PaymentRequiredError";
     message: string;
@@ -281,6 +322,15 @@ export type PaymentRequiredError = {
     currentUsage: number;
     limit: number;
 };
+export type OnboardingReviewRequiredError = {
+    _tag: "OnboardingReviewRequiredError";
+    message: string;
+    code: "review_required" | "review_in_progress" | "information_required" | "review_rejected" | "identity_review_required" | "identity_review_rejected" | "identity_changed";
+    decision: "undecided" | "approved" | "rejected";
+    stage: "collecting" | "automated_review" | "manual_review" | "information_requested" | "complete";
+    nextAction: "wait_for_review" | "provide_information" | "verify_sending_identity" | "reapply" | "contact_support";
+    identityId?: string | null | undefined;
+};
 export type MailboxActionPage = {
     items: Array<MailboxAction>;
     nextCursor: string | null;
@@ -668,7 +718,6 @@ export type CreateMailboxGrantPayload = {
     role: MailboxGrantRole;
     sendMode?: MailboxSendMode | null | undefined;
 };
-export type UserId = string;
 export type MailboxGrantPage = {
     items: Array<MailboxGrant>;
     nextCursor: string | null;
@@ -871,11 +920,6 @@ export type ApiKeyPage = {
     items: Array<ApiKey>;
     nextCursor: string | null;
 };
-export type RateLimitedError = {
-    _tag: "RateLimitedError";
-    message: string;
-    retryAfterSeconds: number;
-};
 export type OperationAccepted = {
     operation: Operation;
     links: {
@@ -1124,7 +1168,6 @@ export type CreateBrand = {
 export type BrandList = {
     items: Array<Brand>;
 };
-export type OrganizationId = string;
 export type TemplateProjectId = string;
 export type TemplateId = string;
 export type TemplateInputContractId = string;
@@ -1407,25 +1450,6 @@ export type BulkUpdateResult = {
     updated: number;
     failed: number;
 };
-export type UnknownRecord = {
-    [key: string]: JsonValue;
-};
-export type Contact = {
-    id: ContactId;
-    name: string;
-    displayName: string | null;
-    avatar: string | null;
-    status: "active" | "paused" | "blocked" | "archived";
-    statusReason: string | null;
-    externalId: string | null;
-    identities: Array<ContactIdentity>;
-    profile: ContactProfile | null;
-    preferences: ContactPreferences | null;
-    tags: Array<string>;
-    metadata: JsonObject | null;
-    createdAt: string;
-    updatedAt: string;
-};
 export type JsonObject = {
     [key: string]: JsonValue;
 };
@@ -1459,14 +1483,30 @@ export type ContactLocation = {
     city: string;
     timezone: string;
 };
-export type ContactTags = {
-    tags: [string, ...Array<string>];
-};
 export type ContactIdentityInput = {
     channel: "email";
     identifier: string;
     verified?: boolean | null | undefined;
 };
+export type Contact = {
+    id: ContactId;
+    name: string;
+    displayName: string | null;
+    avatar: string | null;
+    status: "active" | "paused" | "blocked" | "archived";
+    statusReason: string | null;
+    externalId: string | null;
+    identities: Array<ContactIdentity>;
+    profile: ContactProfile | null;
+    preferences: ContactPreferences | null;
+    tags: Array<string>;
+    metadata: JsonObject | null;
+    createdAt: string;
+    updatedAt: string;
+};
+export type ContactTags = {
+    tags: [string, ...Array<string>];
+};
 export type ContactProfileUpdate = {
     firstName?: string | null | null | undefined;
     lastName?: string | null | null | undefined;
@@ -1549,6 +1589,9 @@ export type ConversationContext = {
         workflowData?: UnknownRecord | null | undefined;
     } | null | undefined;
 };
+export type UnknownRecord = {
+    [key: string]: JsonValue;
+};
 export type ConversationContacts = {
     contactIds: [ContactId, ...Array<ContactId>];
 };
@@ -1775,6 +1818,7 @@ export type ForwardingRuleList = {
         id: EmailForwardingRuleId;
         name: string;
         description: string | null;
+        domainId: EmailDomainId | null;
         sourcePattern: string | null;
         forwardTo: Array<string>;
         preserveHeaders: boolean;
@@ -1918,6 +1962,7 @@ export type CustomTrackingStatus = {
         hostname: string;
         region: string;
         sslStatus: string | null;
+        certificate: CustomTrackingCertificate | null;
         dnsRecords: {
             tracking: CustomTrackingDnsRecord | null;
             dcvDelegation: CustomTrackingDnsRecord | null;
@@ -1932,6 +1977,45 @@ export type CustomTrackingDnsRecord = {
     type: string;
     value: string;
 };
+export type CustomTrackingCertificate = {
+    reason: {
+        code: "initializing" | "awaiting-hostname" | "awaiting-dcv" | "issuing" | "caa-blocked" | "validation-error" | "timed-out" | "verifying-route" | "ready" | "provider-unreachable";
+        message: string;
+    };
+    lastCheckedAt: string | null;
+    nextCheckAt: string | null;
+};
+export type ReceivingStatus = {
+    domain: string;
+    receivingHost: string;
+    sending: {
+        satisfied: boolean;
+        phase: "dns-setup" | "provisioning" | "verifying" | "ready" | "degraded" | "failed";
+    };
+    destination: {
+        satisfied: boolean;
+        endpointId: WebhookEndpointId | null;
+        forwardingRules: number;
+        mailboxes: number;
+    };
+    receiving: {
+        satisfied: boolean;
+        catchAll: boolean;
+    };
+    mx: {
+        satisfied: boolean;
+        state: "pointing-here" | "elsewhere" | "missing" | "unknown";
+        expected: {
+            exchange: string;
+            priority: number;
+        };
+        current: Array<{
+            exchange: string;
+            priority: number;
+        }>;
+    };
+    ready: boolean;
+};
 export type DomainConnectCompleteResult = {
     status: "applied" | "cancelled" | "failed" | "invalid";
 };
@@ -2438,15 +2522,6 @@ export type DeliveryUnavailableError = {
     message: string;
     retryAfterSeconds: number;
 };
-export type OnboardingReviewRequiredError = {
-    _tag: "OnboardingReviewRequiredError";
-    message: string;
-    code: "review_required" | "review_in_progress" | "information_required" | "review_rejected" | "identity_review_required" | "identity_review_rejected" | "identity_changed";
-    decision: "undecided" | "approved" | "rejected";
-    stage: "collecting" | "automated_review" | "manual_review" | "information_requested" | "complete";
-    nextAction: "wait_for_review" | "provide_information" | "verify_sending_identity" | "reapply" | "contact_support";
-    identityId?: string | null | undefined;
-};
 export type MessageReceipt = {
     id: MessageId;
     status: "pending" | "scheduled" | "queued" | "processing" | "sent" | "delivered" | "read" | "failed" | "bounced" | "complained";
@@ -2667,9 +2742,9 @@ export type MessagesSendErrors = {
      */
     502: BillingProviderError | ExternalServiceError;
     /**
-     * DeliveryUnavailableError
+     * SenderNotReadyError | DeliveryUnavailableError
      */
-    503: DeliveryUnavailableError;
+    503: SenderNotReadyError | DeliveryUnavailableError;
     /**
      * GatewayTimeoutError
      */
@@ -3021,6 +3096,10 @@ export type MessagesValidateEmailErrors = {
      * InternalError
      */
     500: InternalError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -3477,6 +3556,10 @@ export type ScheduledMessagesResumeErrors = {
      * ExternalServiceError
      */
     502: ExternalServiceError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -3797,6 +3880,10 @@ export type CampaignsScheduleRunErrors = {
      * ExternalServiceError
      */
     502: ExternalServiceError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -4907,6 +4994,48 @@ export type EmailEnableReceivingResponses = {
     };
 };
 export type EmailEnableReceivingResponse = EmailEnableReceivingResponses[keyof EmailEnableReceivingResponses];
+export type EmailGetReceivingStatusData = {
+    body?: never;
+    path: {
+        id: EmailDomainId;
+    };
+    query?: never;
+    url: "/v1/email/domains/{id}/receiving-status";
+};
+export type EmailGetReceivingStatusErrors = {
+    /**
+     * UnauthorizedError
+     */
+    401: UnauthorizedError;
+    /**
+     * ForbiddenError
+     */
+    403: ForbiddenError;
+    /**
+     * ResourceNotFoundError
+     */
+    404: ResourceNotFoundError;
+    /**
+     * ValidationError
+     */
+    422: ValidationError;
+    /**
+     * InternalError
+     */
+    500: InternalError;
+    /**
+     * GatewayTimeoutError
+     */
+    504: GatewayTimeoutError;
+};
+export type EmailGetReceivingStatusError = EmailGetReceivingStatusErrors[keyof EmailGetReceivingStatusErrors];
+export type EmailGetReceivingStatusResponses = {
+    /**
+     * ReceivingStatus
+     */
+    200: ReceivingStatus;
+};
+export type EmailGetReceivingStatusResponse = EmailGetReceivingStatusResponses[keyof EmailGetReceivingStatusResponses];
 export type EmailSetDefaultDomainData = {
     body?: never;
     path: {
@@ -5224,6 +5353,56 @@ export type EmailEnableCustomTrackingResponses = {
     200: CustomTrackingStatus;
 };
 export type EmailEnableCustomTrackingResponse = EmailEnableCustomTrackingResponses[keyof EmailEnableCustomTrackingResponses];
+export type EmailRecheckCustomTrackingData = {
+    body?: never;
+    path: {
+        id: EmailDomainId;
+    };
+    query?: never;
+    url: "/v1/email/domains/{id}/custom-tracking/recheck";
+};
+export type EmailRecheckCustomTrackingErrors = {
+    /**
+     * UnauthorizedError
+     */
+    401: UnauthorizedError;
+    /**
+     * ForbiddenError
+     */
+    403: ForbiddenError;
+    /**
+     * ResourceNotFoundError
+     */
+    404: ResourceNotFoundError;
+    /**
+     * ConflictError
+     */
+    409: ConflictError;
+    /**
+     * ValidationError
+     */
+    422: ValidationError;
+    /**
+     * InternalError
+     */
+    500: InternalError;
+    /**
+     * EmailChannelError
+     */
+    502: EmailChannelError;
+    /**
+     * GatewayTimeoutError
+     */
+    504: GatewayTimeoutError;
+};
+export type EmailRecheckCustomTrackingError = EmailRecheckCustomTrackingErrors[keyof EmailRecheckCustomTrackingErrors];
+export type EmailRecheckCustomTrackingResponses = {
+    /**
+     * CustomTrackingStatus
+     */
+    200: CustomTrackingStatus;
+};
+export type EmailRecheckCustomTrackingResponse = EmailRecheckCustomTrackingResponses[keyof EmailRecheckCustomTrackingResponses];
 export type EmailGetCustomTrackingDomainConnectData = {
     body?: never;
     path: {
@@ -5703,7 +5882,7 @@ export type EmailGetStatsResponses = {
 export type EmailGetStatsResponse = EmailGetStatsResponses[keyof EmailGetStatsResponses];
 export type EmailEnableCatchAllData = {
     body: {
-        endpointId: WebhookEndpointId;
+        endpointId?: WebhookEndpointId | null | undefined;
     };
     path: {
         id: EmailDomainId;
@@ -8529,16 +8708,18 @@ export type ContactsBulkImportData = {
     body: {
         contacts: Array<{
             name: string;
-            email?: string | null | undefined;
-            phone?: string | null | undefined;
+            displayName?: string | null | null | undefined;
+            avatar?: string | null | null | undefined;
+            identities?: Array<ContactIdentityInput> | null | undefined;
+            profile?: ContactProfile | null | null | undefined;
+            preferences?: ContactPreferences | null | null | undefined;
             tags?: Array<string> | null | undefined;
-            firstName?: string | null | undefined;
-            lastName?: string | null | undefined;
-            company?: string | null | undefined;
-            jobTitle?: string | null | undefined;
-            customFields?: UnknownRecord | null | undefined;
+            status?: "active" | "paused" | "blocked" | "archived" | null | undefined;
+            statusReason?: string | null | null | undefined;
+            externalId?: string | null | null | undefined;
+            metadata?: JsonObject | null | null | undefined;
         }>;
-        upsertByEmail?: boolean | null | undefined;
+        onConflict?: "skip" | "update" | null | undefined;
     };
     path?: never;
     query?: never;
@@ -9340,8 +9521,6 @@ export type ContactGroupsEvaluateDynamicResponse = ContactGroupsEvaluateDynamicR
 export type ContactGroupsPreviewData = {
     body: {
         criteria: {
-            contactTypes?: Array<string> | null | undefined;
-            capabilities?: Array<string> | null | undefined;
             tags?: Array<string> | null | undefined;
             channels?: Array<string> | null | undefined;
             match?: "all" | "any" | null | undefined;
@@ -9388,7 +9567,6 @@ export type ContactGroupsPreviewResponses = {
         sample: Array<{
             id: ContactId;
             name: string;
-            type: string;
             status: string;
         }>;
     };
@@ -15873,9 +16051,9 @@ export type MailboxesSendMessageErrors = {
      */
     402: PaymentRequiredError;
     /**
-     * ForbiddenError
+     * ForbiddenError | OnboardingReviewRequiredError
      */
-    403: ForbiddenError;
+    403: ForbiddenError | OnboardingReviewRequiredError;
     /**
      * ResourceNotFoundError
      */
@@ -15888,6 +16066,10 @@ export type MailboxesSendMessageErrors = {
      * ValidationError
      */
     422: ValidationError;
+    /**
+     * RateLimitedError
+     */
+    429: RateLimitedError;
     /**
      * InternalError
      */
@@ -15896,6 +16078,10 @@ export type MailboxesSendMessageErrors = {
      * BillingProviderError
      */
     502: BillingProviderError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -16067,9 +16253,9 @@ export type MailboxesReplyErrors = {
      */
     402: PaymentRequiredError;
     /**
-     * ForbiddenError
+     * ForbiddenError | OnboardingReviewRequiredError
      */
-    403: ForbiddenError;
+    403: ForbiddenError | OnboardingReviewRequiredError;
     /**
      * ResourceNotFoundError
      */
@@ -16082,6 +16268,10 @@ export type MailboxesReplyErrors = {
      * ValidationError
      */
     422: ValidationError;
+    /**
+     * RateLimitedError
+     */
+    429: RateLimitedError;
     /**
      * InternalError
      */
@@ -16090,6 +16280,10 @@ export type MailboxesReplyErrors = {
      * BillingProviderError
      */
     502: BillingProviderError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -16131,9 +16325,9 @@ export type MailboxesReplyAllErrors = {
      */
     402: PaymentRequiredError;
     /**
-     * ForbiddenError
+     * ForbiddenError | OnboardingReviewRequiredError
      */
-    403: ForbiddenError;
+    403: ForbiddenError | OnboardingReviewRequiredError;
     /**
      * ResourceNotFoundError
      */
@@ -16146,6 +16340,10 @@ export type MailboxesReplyAllErrors = {
      * ValidationError
      */
     422: ValidationError;
+    /**
+     * RateLimitedError
+     */
+    429: RateLimitedError;
     /**
      * InternalError
      */
@@ -16154,6 +16352,10 @@ export type MailboxesReplyAllErrors = {
      * BillingProviderError
      */
     502: BillingProviderError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -16196,9 +16398,9 @@ export type MailboxesForwardErrors = {
      */
     402: PaymentRequiredError;
     /**
-     * ForbiddenError
+     * ForbiddenError | OnboardingReviewRequiredError
      */
-    403: ForbiddenError;
+    403: ForbiddenError | OnboardingReviewRequiredError;
     /**
      * ResourceNotFoundError
      */
@@ -16211,6 +16413,10 @@ export type MailboxesForwardErrors = {
      * ValidationError
      */
     422: ValidationError;
+    /**
+     * RateLimitedError
+     */
+    429: RateLimitedError;
     /**
      * InternalError
      */
@@ -16219,6 +16425,10 @@ export type MailboxesForwardErrors = {
      * BillingProviderError
      */
     502: BillingProviderError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -16639,9 +16849,9 @@ export type MailboxesSendDraftErrors = {
      */
     402: PaymentRequiredError;
     /**
-     * ForbiddenError
+     * ForbiddenError | OnboardingReviewRequiredError
      */
-    403: ForbiddenError;
+    403: ForbiddenError | OnboardingReviewRequiredError;
     /**
      * ResourceNotFoundError
      */
@@ -16654,6 +16864,10 @@ export type MailboxesSendDraftErrors = {
      * ValidationError
      */
     422: ValidationError;
+    /**
+     * RateLimitedError
+     */
+    429: RateLimitedError;
     /**
      * InternalError
      */
@@ -16662,6 +16876,10 @@ export type MailboxesSendDraftErrors = {
      * BillingProviderError
      */
     502: BillingProviderError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -16742,9 +16960,9 @@ export type MailboxesApproveActionErrors = {
      */
     402: PaymentRequiredError;
     /**
-     * ForbiddenError
+     * ForbiddenError | OnboardingReviewRequiredError
      */
-    403: ForbiddenError;
+    403: ForbiddenError | OnboardingReviewRequiredError;
     /**
      * ResourceNotFoundError
      */
@@ -16757,6 +16975,10 @@ export type MailboxesApproveActionErrors = {
      * ValidationError
      */
     422: ValidationError;
+    /**
+     * RateLimitedError
+     */
+    429: RateLimitedError;
     /**
      * InternalError
      */
@@ -16765,6 +16987,10 @@ export type MailboxesApproveActionErrors = {
      * BillingProviderError
      */
     502: BillingProviderError;
+    /**
+     * SenderNotReadyError
+     */
+    503: SenderNotReadyError;
     /**
      * GatewayTimeoutError
      */
@@ -17524,6 +17750,56 @@ export type ExtensionInstallationsGetResponses = {
     200: ExtensionInstallation;
 };
 export type ExtensionInstallationsGetResponse = ExtensionInstallationsGetResponses[keyof ExtensionInstallationsGetResponses];
+export type ExtensionInstallationsUpgradeData = {
+    body: {
+        version?: string | ExtensionVersionId | null | undefined;
+        acceptPermissions?: Array<"permission:read" | "permission:update" | "permission:send" | "permission:quarantine.read" | "event:mailbox.message.received" | "event:mailbox.message.sent" | "event:mailbox.action.pending_approval" | "event:mailbox.message.quarantined" | "event:mailbox.message.released" | "event:mailbox.message.discarded"> | null | undefined;
+        dryRun?: boolean | null | undefined;
+    };
+    path: {
+        id: ExtensionInstallationId;
+    };
+    query?: never;
+    url: "/v1/extension-installations/{id}/upgrade";
+};
+export type ExtensionInstallationsUpgradeErrors = {
+    /**
+     * UnauthorizedError
+     */
+    401: UnauthorizedError;
+    /**
+     * ForbiddenError
+     */
+    403: ForbiddenError;
+    /**
+     * ResourceNotFoundError
+     */
+    404: ResourceNotFoundError;
+    /**
+     * ConflictError
+     */
+    409: ConflictError;
+    /**
+     * ValidationError
+     */
+    422: ValidationError;
+    /**
+     * InternalError
+     */
+    500: InternalError;
+    /**
+     * GatewayTimeoutError
+     */
+    504: GatewayTimeoutError;
+};
+export type ExtensionInstallationsUpgradeError = ExtensionInstallationsUpgradeErrors[keyof ExtensionInstallationsUpgradeErrors];
+export type ExtensionInstallationsUpgradeResponses = {
+    /**
+     * UpgradeExtensionResponse
+     */
+    200: UpgradeExtensionResponse;
+};
+export type ExtensionInstallationsUpgradeResponse = ExtensionInstallationsUpgradeResponses[keyof ExtensionInstallationsUpgradeResponses];
 export type ExtensionInstallationsDisableData = {
     body?: never;
     path: {