@whooshbang/sdk 6.0.0 → 7.1.0

package/dist/client.js

@@ -1,6 +1,6 @@
 import { validateWhoAmI, validateOperatorCollection, validateOperatorResolution, validateCreateOperatorMessageRequest, validateOperatorMessageResult, validateOperatorBroadcast, validateOperatorPreferences, validateOperatorConnectRequest, } from "@whooshbang/contracts";
 import { validateAssertEmailConsentRequest, validateBindingSummary, } from "@whooshbang/contracts";
-import { contractValidationErrors, validateOrganizationCredential, validateOrganizationCredentialCollection, validateOrganizationCredentialRotation, validateOrganizationCredentialSecretReveal, validateBillingProjectSlots, validateBillingPromotions, validateBillingPromotion, validateRedeemBillingPromotionRequest, validateAssignBillingProjectSlotsRequest, validateSubscriptionChange, validateConfirmSubscriptionChangeRequest, validateBillingEntitlements, validateSubscriptionSelection, validateProjectAttribution, validateUpdateProjectAttributionRequest, validateAutoTopUpSettings, validateUpdateAutoTopUpSettingsRequest, validateBillingAccount, validateCardSetup, validateCreateCreditPurchaseRequest, validateCreditPurchase, validateBillingInvoiceCollection, validateUpdateBillingReceiptEmailRequest, validateOrganizationProjection, validateApiCredential, validateApiCredentialCollection, validateApiCredentialRotation, validateApiCredentialSecretReveal, validateAttachNotifierConnectionRequest, validateChannelConnection, validateChannelConnectionCollection, validateConnectionProviderCollection, validateUsageReport, validateMessageListPage, validateMessageDeliveryHistory, validateMessageNotificationImage, validateInteractionTimeline, validateUpdateEmailSenderRequest, validateCustomerEventDeliveryHistory, validateCustomerEventDeliveryAttempt, validateDeliveryHolds, validateMachineClientOperationsList, validateRecipientCopyCatalogue, validateNotifierConnectionCollection, validateProjectRecipientExperience, validateRecipientBrandLogoUpload, validateNotificationImageAsset, validateUpdateProjectRecipientExperienceRequest, validateEnvironmentRecipientExperience, validateUpdateEnvironmentRecipientExperienceRequest, validateSubscriberChannelSettings, validateAcknowledgeEmailRemediationRequest, validateCreateRecipientSessionRequest, validateCreateRecipientSessionResponse, validateRecipientSession, validateCreateProviderHandoffRequest, validateProviderHandoff, validateSetPreferredBindingRequest, validatePreferredBinding, validateCreateSubscriberRequest, validateSubscriber, validateSubscriberDataExport, validateUpdateSubscriberRequest, validateSubscriberCollection, validateCloseOrganizationRequest, validateInviteTeammateRequest, validateTeammate, validateTeammateAccessRequest, validateTeammateCollection, validateOrganizationClosureResult, validateCreateSubscriberGroupRequest, validateUpdateSubscriberGroupRequest, validateSubscriberGroup, validateSubscriberGroupCollection, validateSubscriberGroupMembership, validateSubscriberGroupMembershipCollection, validateCreateGroupBroadcastRequest, validateGroupBroadcast, validateCreateOrganizationCredentialRequest, validateCreateApiCredentialRequest, validateCreateChannelConnectionRequest, validateCreateCustomerEndpointRequest, validateCreateMachineClientRequest, validateCreateMessageRequest, validateCancelEscalationByKeyRequest, validateEscalationPathPreview, validateEscalationOrder, validateEscalationOrderCollection, validateSaveEscalationOrderRequest, validateQuietHours, validateSaveQuietHoursRequest, validateEscalationPolicy, validateEscalationPolicyCollection, validateEscalationLimits, validateUpdateEscalationLimitsRequest, validateEscalationPagingLimitReport, validateUpdateEscalationPolicyRequest, validateCancelEscalationRequest, validateEscalation, validateMessageCategory, validateMessageCategoryCollection, validateCreateMessageCategoryRequest, validateUpdateMessageCategoryRequest, validateSubscriberCategoryPreference, validateSubscriberCategoryPreferenceCollection, validateSetSubscriberCategoryPreferenceRequest, validateCreateProjectRequest, validateUpdateProjectRequest, validateCreateSubscriptionLinkRequest, validateCustomerEndpoint, validateCustomerEndpointAttemptCollection, validateCustomerEndpointCollection, validateCustomerEndpointMutationResult, validateInteractionSummary, validateMachineClient, validateMachineCredential, validateMachineEventAckRequest, validateMachineEventAckResponse, validateMachineEventPollResponse, validateMessage, validateProblem, validateProject, validateProjectCollection, validateRecipientCopyOverride, validateRecipientCopyOverrideCollection, validateProviderCapabilitiesCollection, validateProviderInstallationCollection, validateEmailDomainCollection, validateCreateEmailDomainRequest, validateRegisterMachineCredentialRequest, validateRotateOrganizationCredentialRequest, validateRotateApiCredentialRequest, validateConnectionTest, validateConnectionTestCollection, validateCreateConnectionTestRequest, validateCustomerApplicationManifest, validateRotateChannelConnectionCredentialRequest, validateRotateCustomerEndpointRequest, validateSubscriptionLink, validateUpdateChannelConnectionRequest, validateUpdateRecipientCopyOverrideRequest, } from "@whooshbang/contracts";
+import { contractValidationErrors, validateOrganizationCredential, validateOrganizationCredentialCollection, validateOrganizationCredentialRotation, validateOrganizationCredentialSecretReveal, validateBillingProjectSlots, validateBillingPromotions, validateBillingPromotion, validateRedeemBillingPromotionRequest, validateAssignBillingProjectSlotsRequest, validateSubscriptionChange, validateConfirmSubscriptionChangeRequest, validateBillingEntitlements, validateSubscriptionSelection, validateProjectAttribution, validateUpdateProjectAttributionRequest, validateAutoTopUpSettings, validateUpdateAutoTopUpSettingsRequest, validateBillingAccount, validateCardSetup, validateCreateCreditPurchaseRequest, validateCreditPurchase, validateBillingInvoiceCollection, validateUpdateBillingReceiptEmailRequest, validateOrganizationProjection, validateApiCredential, validateApiCredentialCollection, validateApiCredentialRotation, validateApiCredentialSecretReveal, validateAttachNotifierConnectionRequest, validateChannelConnection, validateChannelConnectionCollection, validateConnectionProviderCollection, validateUsageReport, validateMessageListPage, validateMessageDeliveryHistory, validateMessageNotificationImage, validateInteractionTimeline, validateUpdateEmailSenderRequest, validateCustomerEventDeliveryHistory, validateCustomerEventDeliveryAttempt, validateDeliveryHolds, validateMachineClientOperationsList, validateRecipientCopyCatalogue, validateNotifierConnectionCollection, validateProjectRecipientExperience, validateRecipientBrandLogoUpload, validateNotificationImageAsset, validateUpdateProjectRecipientExperienceRequest, validateEnvironmentRecipientExperience, validateUpdateEnvironmentRecipientExperienceRequest, validateSubscriberChannelSettings, validateAcknowledgeEmailRemediationRequest, validateCreateRecipientSessionRequest, validateCreateRecipientSessionResponse, validateRecipientSession, validateCreateProviderHandoffRequest, validateProviderHandoff, validateSetPreferredBindingRequest, validatePreferredBinding, validateCreateSubscriberRequest, validateSubscriber, validateSubscriberDataExport, validateUpdateSubscriberRequest, validateSubscriberCollection, validateCloseOrganizationRequest, validateInviteTeammateRequest, validateTeammate, validateTeammateAccessRequest, validateTeammateCollection, validateOrganizationClosureResult, validateCreateSubscriberGroupRequest, validateUpdateSubscriberGroupRequest, validateSubscriberGroup, validateSubscriberGroupCollection, validateSubscriberGroupMembership, validateSubscriberGroupMembershipCollection, validateCreateGroupBroadcastRequest, validateGroupBroadcast, validateCreateOrganizationCredentialRequest, validateCreateApiCredentialRequest, validateCreateChannelConnectionRequest, validateCreateCustomerEndpointRequest, validateCreateMachineClientRequest, validateCreateMessageRequest, validateCancelEscalationByKeyRequest, validateEscalationPathPreview, validateEscalationOrder, validateEscalationOrderCollection, validateSaveEscalationOrderRequest, validateQuietHours, validateSaveQuietHoursRequest, validateSetDigestPreferenceRequest, validateSetSubscriberDigestSettingRequest, validateSubscriberDigestSettings, validateEscalationPolicy, validateEscalationPolicyCollection, validateEscalationLimits, validateUpdateEscalationLimitsRequest, validateEscalationPagingLimitReport, validateUpdateEscalationPolicyRequest, validateCancelEscalationRequest, validateEscalation, validateMessageCategory, validateMessageCategoryCollection, validateCreateMessageCategoryRequest, validateUpdateMessageCategoryRequest, validateSubscriberCategoryPreference, validateSubscriberCategoryPreferenceCollection, validateSetSubscriberCategoryPreferenceRequest, validateCreateProjectRequest, validateUpdateProjectRequest, validateCreateSubscriptionLinkRequest, validateCustomerEndpoint, validateCustomerEndpointAttemptCollection, validateCustomerEndpointCollection, validateCustomerEndpointMutationResult, validateInteractionSummary, validateMachineClient, validateMachineCredential, validateMachineEventAckRequest, validateMachineEventAckResponse, validateMachineEventPollResponse, validateMessage, validateProblem, validateProject, validateProjectCollection, validateRecipientCopyOverride, validateRecipientCopyOverrideCollection, validateProviderCapabilitiesCollection, validateProviderInstallationCollection, validateEmailDomainCollection, validateCreateEmailDomainRequest, validateRegisterMachineCredentialRequest, validateRotateOrganizationCredentialRequest, validateRotateApiCredentialRequest, validateConnectionTest, validateConnectionTestCollection, validateCreateConnectionTestRequest, validateCustomerApplicationManifest, validateRotateChannelConnectionCredentialRequest, validateRotateCustomerEndpointRequest, validateSubscriptionLink, validateUpdateChannelConnectionRequest, validateUpdateRecipientCopyOverrideRequest, } from "@whooshbang/contracts";
 import { validateAdditiveCompatible } from "./additive-compatibility.js";
 import { WhooshBangContractError, WhooshBangOutcomeUnknownError, WhooshBangProblemError, WhooshBangProtocolError, WhooshBangTransportError, WhooshBangValidationError, validationError, } from "./errors.js";
 import { interactionAnswer } from "./interactions.js";
@@ -80,6 +80,45 @@ function usageQuery(operation, options) {
     return search.size === 0 ? "" : `?${search.toString()}`;
 }
 const templateRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+function validateAuthoredTemplate(value) {
+    return (validateTemplateCatalogEntry(value) &&
+        Number.isSafeInteger(value.draftVersion));
+}
+function validatePublishedRevision(value) {
+    return (templateRecord(value) &&
+        Number.isSafeInteger(value.revision) &&
+        templateRecord(value.definition) &&
+        typeof value.publishedAt === "string");
+}
+function validateRevisionCollection(value) {
+    return (templateRecord(value) &&
+        Array.isArray(value.items) &&
+        value.items.every((item) => validatePublishedRevision(item)));
+}
+function validateTemplatePreview(value) {
+    return (templateRecord(value) &&
+        typeof value.channel === "string" &&
+        templateRecord(value.normalizedInput) &&
+        typeof value.templateLocale === "string");
+}
+function validateEmailLayout(value) {
+    return (templateRecord(value) &&
+        typeof value.id === "string" &&
+        typeof value.name === "string" &&
+        typeof value.isDefault === "boolean" &&
+        typeof value.disabled === "boolean" &&
+        templateRecord(value.draft) &&
+        Number.isSafeInteger(value.draftVersion) &&
+        Number.isSafeInteger(value.latestPublishedRevision));
+}
+function validateEmailLayoutCollection(value) {
+    return (templateRecord(value) &&
+        Array.isArray(value.items) &&
+        value.items.every((item) => validateEmailLayout(item)));
+}
+function validateDefaultLayout(value) {
+    return templateRecord(value) && typeof value.default_layout_id === "string";
+}
 function validateTemplateCatalog(value) {
     return (templateRecord(value) &&
         Array.isArray(value.items) &&
@@ -1477,6 +1516,202 @@ export class WhooshBangClient {
             strictResponse: true,
         });
     }
+    /** The template as its author sees it, including the editable draft. */
+    async getMessageTemplateForAuthoring(projectId, reference, options = {}) {
+        const operation = "getMessageTemplate";
+        return this.#request({
+            method: "GET",
+            operation,
+            options,
+            sideEffect: false,
+            path: `${templateRoot(operation, projectId)}/${pathSegment(operation, reference, "reference")}`,
+            validator: validateAuthoredTemplate,
+        });
+    }
+    /** Every template, drafts and disabled ones included, for authoring. */
+    async listMessageTemplatesForAuthoring(projectId, query = {}, options = {}) {
+        const operation = "listMessageTemplates";
+        const params = new URLSearchParams();
+        if (query.search !== undefined)
+            params.set("search", query.search);
+        if (query.category !== undefined)
+            params.set("category", query.category);
+        if (query.after !== undefined)
+            params.set("after", query.after);
+        if (query.limit !== undefined)
+            params.set("limit", String(query.limit));
+        if (query.page !== undefined)
+            params.set("page", String(query.page));
+        const suffix = params.size === 0 ? "" : `?${params}`;
+        return this.#request({
+            method: "GET",
+            operation,
+            options,
+            sideEffect: false,
+            path: `${templateRoot(operation, projectId)}${suffix}`,
+            validator: (value) => validateTemplateCatalog(value) &&
+                value.items.every((item) => validateAuthoredTemplate(item)),
+        });
+    }
+    async createMessageTemplate(projectId, request, options = {}) {
+        const operation = "createMessageTemplate";
+        return this.#request({
+            body: request,
+            method: "POST",
+            operation,
+            options,
+            sideEffect: true,
+            path: templateRoot(operation, projectId),
+            validator: validateAuthoredTemplate,
+        });
+    }
+    /** Renames, recategorises, disables or re-enables a template. */
+    async updateMessageTemplate(projectId, templateId, request, options = {}) {
+        const operation = "updateMessageTemplateMetadata";
+        return this.#request({
+            body: request,
+            method: "PATCH",
+            operation,
+            options,
+            sideEffect: true,
+            path: `${templateRoot(operation, projectId)}/${pathSegment(operation, templateId, "templateId")}`,
+            validator: validateAuthoredTemplate,
+        });
+    }
+    /** Replaces the draft. `draftVersion` is the version last read; a newer save refuses this one. */
+    async saveMessageTemplateDraft(projectId, templateId, draftVersion, definition, options = {}) {
+        const operation = "saveMessageTemplateDraft";
+        return this.#request({
+            body: { draft_version: draftVersion, definition },
+            method: "PUT",
+            operation,
+            options,
+            sideEffect: true,
+            path: `${templateRoot(operation, projectId)}/${pathSegment(operation, templateId, "templateId")}/draft`,
+            validator: validateAuthoredTemplate,
+        });
+    }
+    /** Validates the draft completely and publishes it as the next revision. */
+    async publishMessageTemplate(projectId, templateId, draftVersion, options = {}) {
+        const operation = "publishMessageTemplate";
+        return this.#request({
+            body: { draft_version: draftVersion },
+            method: "POST",
+            operation,
+            options,
+            sideEffect: true,
+            path: `${templateRoot(operation, projectId)}/${pathSegment(operation, templateId, "templateId")}/publish`,
+            validator: validatePublishedRevision,
+        });
+    }
+    async listMessageTemplateRevisions(projectId, templateId, options = {}) {
+        const operation = "listMessageTemplateRevisions";
+        return this.#request({
+            method: "GET",
+            operation,
+            options,
+            sideEffect: false,
+            path: `${templateRoot(operation, projectId)}/${pathSegment(operation, templateId, "templateId")}/revisions`,
+            validator: validateRevisionCollection,
+        });
+    }
+    /** Renders the draft, a revision or an unsaved definition. Nothing is sent. */
+    async previewMessageTemplate(projectId, templateId, request, options = {}) {
+        const operation = "previewMessageTemplate";
+        return this.#request({
+            body: request,
+            method: "POST",
+            operation,
+            options,
+            sideEffect: false,
+            path: `${templateRoot(operation, projectId)}/${pathSegment(operation, templateId, "templateId")}/preview`,
+            validator: validateTemplatePreview,
+        });
+    }
+    /** Sends the exact draft to one subscriber as a test. It never publishes. */
+    async testSendMessageTemplateDraft(projectId, environmentId, templateId, request, options = {}) {
+        const operation = "testSendMessageTemplateDraft";
+        return this.#request({
+            body: request,
+            method: "POST",
+            operation,
+            options,
+            idempotencyKey: options.idempotencyKey,
+            sideEffect: true,
+            path: `${environmentRoot(operation, projectId, environmentId)}/message-templates/${pathSegment(operation, templateId, "templateId")}/test-send`,
+            validator: validateTemplateMessageSendResult,
+        });
+    }
+    async listEmailLayouts(projectId, options = {}) {
+        const operation = "listEmailLayouts";
+        return this.#request({
+            method: "GET",
+            operation,
+            options,
+            sideEffect: false,
+            path: layoutRoot(operation, projectId),
+            validator: validateEmailLayoutCollection,
+        });
+    }
+    async getEmailLayout(projectId, layoutId, options = {}) {
+        const operation = "getEmailLayout";
+        return this.#request({
+            method: "GET",
+            operation,
+            options,
+            sideEffect: false,
+            path: `${layoutRoot(operation, projectId)}/${pathSegment(operation, layoutId, "layoutId")}`,
+            validator: validateEmailLayout,
+        });
+    }
+    async createEmailLayout(projectId, request, options = {}) {
+        const operation = "createEmailLayout";
+        return this.#request({
+            body: request,
+            method: "POST",
+            operation,
+            options,
+            sideEffect: true,
+            path: layoutRoot(operation, projectId),
+            validator: validateEmailLayout,
+        });
+    }
+    async saveEmailLayoutDraft(projectId, layoutId, draftVersion, definition, options = {}) {
+        const operation = "saveEmailLayoutDraft";
+        return this.#request({
+            body: { draft_version: draftVersion, definition },
+            method: "PUT",
+            operation,
+            options,
+            sideEffect: true,
+            path: `${layoutRoot(operation, projectId)}/${pathSegment(operation, layoutId, "layoutId")}/draft`,
+            validator: validateEmailLayout,
+        });
+    }
+    async publishEmailLayout(projectId, layoutId, draftVersion, options = {}) {
+        const operation = "publishEmailLayout";
+        return this.#request({
+            body: { draft_version: draftVersion },
+            method: "POST",
+            operation,
+            options,
+            sideEffect: true,
+            path: `${layoutRoot(operation, projectId)}/${pathSegment(operation, layoutId, "layoutId")}/publish`,
+            validator: validatePublishedRevision,
+        });
+    }
+    /** Makes a published layout the project's default for email templates. */
+    async setDefaultEmailLayout(projectId, layoutId, options = {}) {
+        const operation = "setDefaultEmailLayout";
+        return this.#request({
+            method: "POST",
+            operation,
+            options,
+            sideEffect: true,
+            path: `${layoutRoot(operation, projectId)}/${pathSegment(operation, layoutId, "layoutId")}/default`,
+            validator: validateDefaultLayout,
+        });
+    }
     async createMessageCategory(projectId, request, options = {}) {
         const operation = "createMessageCategory";
         assertInput(operation, request, validateCreateMessageCategoryRequest);
@@ -1688,6 +1923,40 @@ export class WhooshBangClient {
             validator: validateQuietHours,
         });
     }
+    /**
+     * One subscriber's digest settings: for each category, the policy in
+     * effect, where each setting comes from, what the subscriber may change,
+     * their saved choices and your setting for them (FXO-3729).
+     */
+    async getSubscriberDigestSettings(projectId, environmentId, subscriberId, options = {}) {
+        const operation = "getSubscriberDigestSettings";
+        return this.#request({
+            method: "GET",
+            operation,
+            options,
+            sideEffect: false,
+            path: `${environmentRoot(operation, projectId, environmentId)}/subscribers/${pathSegment(operation, subscriberId, "subscriberId")}/digest-settings`,
+            validator: validateSubscriberDigestSettings,
+        });
+    }
+    /**
+     * Your digest setting for one subscriber and category, and which settings
+     * they can't change; `{ setting: null }` removes it. Their own choice is
+     * kept and returns when you unlock.
+     */
+    async setSubscriberDigestSetting(projectId, environmentId, subscriberId, categoryKey, request, options = {}) {
+        const operation = "setSubscriberDigestSetting";
+        assertInput(operation, request, validateSetSubscriberDigestSettingRequest);
+        return this.#request({
+            body: request,
+            method: "PUT",
+            operation,
+            options,
+            sideEffect: true,
+            path: `${environmentRoot(operation, projectId, environmentId)}/subscribers/${pathSegment(operation, subscriberId, "subscriberId")}/digest-settings/categories/${pathSegment(operation, categoryKey, "categoryKey")}`,
+            validator: validateSubscriberDigestSettings,
+        });
+    }
     async transitionSubscriberBinding(projectId, environmentId, subscriberId, bindingId, action, options = {}) {
         const operation = "transitionSubscriberBinding";
         if (!["pause", "resume", "unsubscribe"].includes(action)) {
@@ -4069,6 +4338,58 @@ export class WhooshBangRecipientSessionClient {
             validator: validateQuietHours,
         });
     }
+    /**
+     * This subscriber's digest settings: only the categories whose owner lets
+     * them choose something, with what is in effect and what they can change,
+     * plus their Default (FXO-3729).
+     */
+    async getDigestSettings(options = {}) {
+        const operation = "getDigestSettings";
+        return this.#request({
+            method: "GET",
+            operation,
+            options,
+            path: "v1/recipient-session/digest-settings",
+            sideEffect: false,
+            validator: validateSubscriberDigestSettings,
+        });
+    }
+    /**
+     * Sets this subscriber's Default digest choice, or clears it with
+     * `{ preference: null }`. A setting the owner doesn't offer fails with
+     * `request_invalid` naming it, and the previous setting stays.
+     */
+    async setDefaultDigestPreference(request, options = {}) {
+        const operation = "setDefaultDigestPreference";
+        assertInput(operation, request, validateSetDigestPreferenceRequest);
+        return this.#request({
+            body: request,
+            method: "PUT",
+            operation,
+            options,
+            path: "v1/recipient-session/digest-settings/default",
+            sideEffect: true,
+            validator: validateSubscriberDigestSettings,
+        });
+    }
+    /**
+     * Sets this subscriber's digest choice for one category, or clears it so
+     * the category follows the Default again. Locked or unoffered settings
+     * fail with `request_invalid` and the previous setting stays.
+     */
+    async setCategoryDigestPreference(categoryKey, request, options = {}) {
+        const operation = "setCategoryDigestPreference";
+        assertInput(operation, request, validateSetDigestPreferenceRequest);
+        return this.#request({
+            body: request,
+            method: "PUT",
+            operation,
+            options,
+            path: `v1/recipient-session/digest-settings/categories/${pathSegment(operation, categoryKey, "categoryKey")}`,
+            sideEffect: true,
+            validator: validateSubscriberDigestSettings,
+        });
+    }
     /** Turns off this subscriber's quiet hours. */
     async resetQuietHours(options = {}) {
         const operation = "resetQuietHours";
@@ -4171,6 +4492,12 @@ function environmentRoot(operation, projectId, environmentId) {
     const environment = pathSegment(operation, environmentId, "environmentId");
     return `v1/projects/${project}/environments/${environment}`;
 }
+function templateRoot(operation, projectId) {
+    return `v1/projects/${pathSegment(operation, projectId, "projectId")}/message-templates`;
+}
+function layoutRoot(operation, projectId) {
+    return `v1/projects/${pathSegment(operation, projectId, "projectId")}/email-layouts`;
+}
 function subscriberGroupPath(operation, root, groupKey) {
     return `${root}/subscriber-groups/${pathSegment(operation, groupKey, "groupKey")}`;
 }