sequenzy 2.1.2 → 2.1.6

package/dist/esm/api/resources/inApp/client/Client.js

@@ -248,6 +248,66 @@ export class InAppClient {
         }
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/in-app/messages");
     }
+    /**
+     * Built-in starting points for in_app sequence steps. Each config is a complete step without a label; link buttons have no url until you add one. Requires the sequences:read scope.
+     *
+     * @param {InAppClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Sequenzy.UnauthorizedError}
+     * @throws {@link Sequenzy.ForbiddenError}
+     * @throws {@link errors.SequenzyError}
+     * @throws {@link errors.SequenzyTimeoutError}
+     *
+     * @example
+     *     await client.inApp.listInAppTemplates()
+     */
+    listInAppTemplates(requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listInAppTemplates(requestOptions));
+    }
+    async __listInAppTemplates(requestOptions) {
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.SequenzyEnvironment.Default, "in-app/templates"),
+            method: "GET",
+            headers: _headers,
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return {
+                data: serializers.ListInAppTemplatesResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                }),
+                rawResponse: _response.rawResponse,
+            };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.SequenzyError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/in-app/templates");
+    }
     /**
      * Records that the app displayed, clicked, dismissed or read an item. The first report of each type sets its timestamp; repeats change nothing except clickCount, and recorded is false. Clicks, dismissals and reads also mark the item displayed. Messages leave the open feed once displayed, clicked or dismissed; cards once dismissed. Requires the subscribers:write scope.
      *
@@ -328,4 +388,82 @@ export class InAppClient {
         }
         return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/in-app/messages/{messageId}/events");
     }
+    /**
+     * Writes an in-app message's eyebrow, title, message and button labels with AI from a brief. Nothing is saved. Requires the sequences:write scope; limited to 20 requests a minute per workspace.
+     *
+     * @param {Sequenzy.WriteInAppCopyRequest} request
+     * @param {InAppClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Sequenzy.UnauthorizedError}
+     * @throws {@link Sequenzy.ForbiddenError}
+     * @throws {@link Sequenzy.UnprocessableEntityError}
+     * @throws {@link Sequenzy.TooManyRequestsError}
+     * @throws {@link Sequenzy.InternalServerError}
+     * @throws {@link errors.SequenzyError}
+     * @throws {@link errors.SequenzyTimeoutError}
+     *
+     * @example
+     *     await client.inApp.writeInAppCopy({
+     *         brief: "brief"
+     *     })
+     */
+    writeInAppCopy(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__writeInAppCopy(request, requestOptions));
+    }
+    async __writeInAppCopy(request, requestOptions) {
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.SequenzyEnvironment.Default, "in-app/copy"),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
+            requestType: "json",
+            body: mergeAdditionalBodyParameters(serializers.WriteInAppCopyRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "strip",
+                omitUndefined: true,
+            }), requestOptions?.additionalBodyParameters),
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return {
+                data: serializers.WriteInAppCopyResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                }),
+                rawResponse: _response.rawResponse,
+            };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 422:
+                    throw new Sequenzy.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new Sequenzy.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new Sequenzy.InternalServerError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.SequenzyError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/in-app/copy");
+    }
 }

package/dist/esm/api/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts

@@ -0,0 +1,13 @@
+import type * as Sequenzy from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         brief: "brief"
+ *     }
+ */
+export interface WriteInAppCopyRequest {
+    brief: string;
+    format?: Sequenzy.WriteInAppCopyRequestFormat;
+    hasImage?: boolean;
+    kind?: Sequenzy.WriteInAppCopyRequestKind;
+}

package/dist/esm/api/resources/inApp/client/requests/WriteInAppCopyRequest.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/inApp/client/requests/index.d.ts

@@ -2,3 +2,4 @@ export type { DeleteInAppMessageRequest } from "./DeleteInAppMessageRequest.js";
 export type { GetInAppStepStatsRequest } from "./GetInAppStepStatsRequest.js";
 export type { ListInAppMessagesRequest } from "./ListInAppMessagesRequest.js";
 export type { RecordInAppEventRequest } from "./RecordInAppEventRequest.js";
+export type { WriteInAppCopyRequest } from "./WriteInAppCopyRequest.js";

package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponse.d.ts

@@ -0,0 +1,5 @@
+import type * as Sequenzy from "../../../index.js";
+export interface ListInAppTemplatesResponse {
+    success?: boolean;
+    templates?: Sequenzy.ListInAppTemplatesResponseTemplatesItem[];
+}

package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts

@@ -0,0 +1,9 @@
+import type * as Sequenzy from "../../../index.js";
+export interface ListInAppTemplatesResponseTemplatesItem {
+    category?: Sequenzy.ListInAppTemplatesResponseTemplatesItemCategory;
+    /** An in_app step config without a label. */
+    config?: Record<string, unknown>;
+    description?: string;
+    id?: string;
+    name?: string;
+}

package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts

@@ -0,0 +1,7 @@
+export declare const ListInAppTemplatesResponseTemplatesItemCategory: {
+    readonly Conversion: "Conversion";
+    readonly Onboarding: "Onboarding";
+    readonly Announcement: "Announcement";
+    readonly Engagement: "Engagement";
+};
+export type ListInAppTemplatesResponseTemplatesItemCategory = (typeof ListInAppTemplatesResponseTemplatesItemCategory)[keyof typeof ListInAppTemplatesResponseTemplatesItemCategory];

package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+export const ListInAppTemplatesResponseTemplatesItemCategory = {
+    Conversion: "Conversion",
+    Onboarding: "Onboarding",
+    Announcement: "Announcement",
+    Engagement: "Engagement",
+};

package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts

@@ -0,0 +1,6 @@
+export declare const WriteInAppCopyRequestFormat: {
+    readonly Modal: "modal";
+    readonly Banner: "banner";
+    readonly Fullscreen: "fullscreen";
+};
+export type WriteInAppCopyRequestFormat = (typeof WriteInAppCopyRequestFormat)[keyof typeof WriteInAppCopyRequestFormat];

package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestFormat.js

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+export const WriteInAppCopyRequestFormat = {
+    Modal: "modal",
+    Banner: "banner",
+    Fullscreen: "fullscreen",
+};

package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestKind.d.ts

@@ -0,0 +1,5 @@
+export declare const WriteInAppCopyRequestKind: {
+    readonly Message: "message";
+    readonly Card: "card";
+};
+export type WriteInAppCopyRequestKind = (typeof WriteInAppCopyRequestKind)[keyof typeof WriteInAppCopyRequestKind];

package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestKind.js

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const WriteInAppCopyRequestKind = {
+    Message: "message",
+    Card: "card",
+};

package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponse.d.ts

@@ -0,0 +1,5 @@
+import type * as Sequenzy from "../../../index.js";
+export interface WriteInAppCopyResponse {
+    copy?: Sequenzy.WriteInAppCopyResponseCopy;
+    success?: boolean;
+}

package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponse.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts

@@ -0,0 +1,7 @@
+import type * as Sequenzy from "../../../index.js";
+export interface WriteInAppCopyResponseCopy {
+    body?: string;
+    buttons?: Sequenzy.WriteInAppCopyResponseCopyButtonsItem[];
+    eyebrow?: string;
+    title?: string;
+}

package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopy.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts

@@ -0,0 +1,5 @@
+import type * as Sequenzy from "../../../index.js";
+export interface WriteInAppCopyResponseCopyButtonsItem {
+    action?: Sequenzy.WriteInAppCopyResponseCopyButtonsItemAction;
+    label?: string;
+}

package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts

@@ -0,0 +1,5 @@
+export declare const WriteInAppCopyResponseCopyButtonsItemAction: {
+    readonly OpenUrl: "open_url";
+    readonly Dismiss: "dismiss";
+};
+export type WriteInAppCopyResponseCopyButtonsItemAction = (typeof WriteInAppCopyResponseCopyButtonsItemAction)[keyof typeof WriteInAppCopyResponseCopyButtonsItemAction];

package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js

@@ -0,0 +1,5 @@
+// This file was auto-generated by Fern from our API Definition.
+export const WriteInAppCopyResponseCopyButtonsItemAction = {
+    OpenUrl: "open_url",
+    Dismiss: "dismiss",
+};

package/dist/esm/api/resources/inApp/types/index.d.ts

@@ -5,5 +5,14 @@ export * from "./ListInAppMessagesRequestKind.js";
 export * from "./ListInAppMessagesRequestStatus.js";
 export * from "./ListInAppMessagesResponse.js";
 export * from "./ListInAppMessagesResponseStatus.js";
+export * from "./ListInAppTemplatesResponse.js";
+export * from "./ListInAppTemplatesResponseTemplatesItem.js";
+export * from "./ListInAppTemplatesResponseTemplatesItemCategory.js";
 export * from "./RecordInAppEventRequestType.js";
 export * from "./RecordInAppEventResponse.js";
+export * from "./WriteInAppCopyRequestFormat.js";
+export * from "./WriteInAppCopyRequestKind.js";
+export * from "./WriteInAppCopyResponse.js";
+export * from "./WriteInAppCopyResponseCopy.js";
+export * from "./WriteInAppCopyResponseCopyButtonsItem.js";
+export * from "./WriteInAppCopyResponseCopyButtonsItemAction.js";

package/dist/esm/api/resources/inApp/types/index.js

@@ -5,5 +5,14 @@ export * from "./ListInAppMessagesRequestKind.js";
 export * from "./ListInAppMessagesRequestStatus.js";
 export * from "./ListInAppMessagesResponse.js";
 export * from "./ListInAppMessagesResponseStatus.js";
+export * from "./ListInAppTemplatesResponse.js";
+export * from "./ListInAppTemplatesResponseTemplatesItem.js";
+export * from "./ListInAppTemplatesResponseTemplatesItemCategory.js";
 export * from "./RecordInAppEventRequestType.js";
 export * from "./RecordInAppEventResponse.js";
+export * from "./WriteInAppCopyRequestFormat.js";
+export * from "./WriteInAppCopyRequestKind.js";
+export * from "./WriteInAppCopyResponse.js";
+export * from "./WriteInAppCopyResponseCopy.js";
+export * from "./WriteInAppCopyResponseCopyButtonsItem.js";
+export * from "./WriteInAppCopyResponseCopyButtonsItemAction.js";

package/dist/esm/api/resources/push/client/Client.d.ts

@@ -126,6 +126,31 @@ export declare class PushClient {
      */
     duplicatePushCampaign(request: Sequenzy.DuplicatePushCampaignRequest, requestOptions?: PushClient.RequestOptions): core.HttpResponsePromise<Sequenzy.DuplicatePushCampaignResponse>;
     private __duplicatePushCampaign;
+    /**
+     * Ends the contact's activity on every device running it. Tokens are marked ended as APNs accepts the push, so an end that failed can be sent again. Without dismissalDate iOS keeps an ended activity on the Lock Screen for up to four hours. Requires the transactional:send scope.
+     *
+     * @param {Sequenzy.EndLiveActivityRequest} request
+     * @param {PushClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Sequenzy.BadRequestError}
+     * @throws {@link Sequenzy.UnauthorizedError}
+     * @throws {@link Sequenzy.ForbiddenError}
+     * @throws {@link Sequenzy.NotFoundError}
+     * @throws {@link Sequenzy.UnprocessableEntityError}
+     * @throws {@link Sequenzy.InternalServerError}
+     * @throws {@link errors.SequenzyError}
+     * @throws {@link errors.SequenzyTimeoutError}
+     *
+     * @example
+     *     await client.push.endLiveActivity({
+     *         activityId: "order-1234",
+     *         contentState: {
+     *             "key": "value"
+     *         }
+     *     })
+     */
+    endLiveActivity(request: Sequenzy.EndLiveActivityRequest, requestOptions?: PushClient.RequestOptions): core.HttpResponsePromise<Sequenzy.LiveActivityDispatch>;
+    private __endLiveActivity;
     /**
      * Counts the contacts in an audience (audienceCount) and those with an active device on the selected platforms (eligibleCount). Email status does not affect push eligibility. Requires the campaigns:read scope.
      *
@@ -206,6 +231,24 @@ export declare class PushClient {
      */
     getPushSettings(requestOptions?: PushClient.RequestOptions): core.HttpResponsePromise<Sequenzy.GetPushSettingsResponse>;
     private __getPushSettings;
+    /**
+     * Lists ActivityKit tokens the Sequenzy iOS SDK reported, with a summary per activity type (for the contact when email or subscriberId is given). push_to_start tokens can start an activity of their type; update tokens address one running activity. Tokens are masked. Requires the subscribers:read scope.
+     *
+     * @param {Sequenzy.ListLiveActivitiesRequest} request
+     * @param {PushClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Sequenzy.UnauthorizedError}
+     * @throws {@link Sequenzy.ForbiddenError}
+     * @throws {@link Sequenzy.NotFoundError}
+     * @throws {@link Sequenzy.InternalServerError}
+     * @throws {@link errors.SequenzyError}
+     * @throws {@link errors.SequenzyTimeoutError}
+     *
+     * @example
+     *     await client.push.listLiveActivities()
+     */
+    listLiveActivities(request?: Sequenzy.ListLiveActivitiesRequest, requestOptions?: PushClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListLiveActivitiesResponse>;
+    private __listLiveActivities;
     /**
      * Lists push campaigns, newest first. Push campaigns also appear in GET /campaigns with type push. Requires the campaigns:read scope.
      *
@@ -350,6 +393,34 @@ export declare class PushClient {
      */
     setFcmCredentials(request: Sequenzy.SetFcmCredentialsRequest, requestOptions?: PushClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SetFcmCredentialsResponse>;
     private __setFcmCredentials;
+    /**
+     * Starts an iOS Live Activity remotely (push-to-start, iOS 17.2+) on every device of one contact that reported a push-to-start token for activityType. Sequenzy adds sequenzy.activityId to the attributes so the SDK can report the new activity's update token under your id. Returns 202 with tokenCount 0, sending nothing, when no device can start it. Calling it again starts another copy. Requires the transactional:send scope.
+     *
+     * @param {Sequenzy.StartLiveActivityRequest} request
+     * @param {PushClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Sequenzy.BadRequestError}
+     * @throws {@link Sequenzy.UnauthorizedError}
+     * @throws {@link Sequenzy.ForbiddenError}
+     * @throws {@link Sequenzy.NotFoundError}
+     * @throws {@link Sequenzy.UnprocessableEntityError}
+     * @throws {@link Sequenzy.InternalServerError}
+     * @throws {@link errors.SequenzyError}
+     * @throws {@link errors.SequenzyTimeoutError}
+     *
+     * @example
+     *     await client.push.startLiveActivity({
+     *         activityId: "order-1234",
+     *         activityType: "DeliveryAttributes",
+     *         alert: {},
+     *         contentState: {
+     *             "minutesAway": 8,
+     *             "status": "out_for_delivery"
+     *         }
+     *     })
+     */
+    startLiveActivity(request: Sequenzy.StartLiveActivityRequest, requestOptions?: PushClient.RequestOptions): core.HttpResponsePromise<Sequenzy.LiveActivityDispatch>;
+    private __startLiveActivity;
     /**
      * Moves a scheduled push campaign back to draft. The queued send is discarded. Requires the campaigns:send scope.
      *
@@ -372,6 +443,32 @@ export declare class PushClient {
      */
     unschedulePushCampaign(request: Sequenzy.UnschedulePushCampaignRequest, requestOptions?: PushClient.RequestOptions): core.HttpResponsePromise<Sequenzy.UnschedulePushCampaignResponse>;
     private __unschedulePushCampaign;
+    /**
+     * Sends new content state to every running copy of the contact's activity (one per device that reported an update token). Each request carries a fixed timestamp, so a retried or late delivery never replaces newer content. Returns tokenCount 0 when no running copy has reported a token. Requires the transactional:send scope.
+     *
+     * @param {Sequenzy.UpdateLiveActivityRequest} request
+     * @param {PushClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Sequenzy.BadRequestError}
+     * @throws {@link Sequenzy.UnauthorizedError}
+     * @throws {@link Sequenzy.ForbiddenError}
+     * @throws {@link Sequenzy.NotFoundError}
+     * @throws {@link Sequenzy.UnprocessableEntityError}
+     * @throws {@link Sequenzy.InternalServerError}
+     * @throws {@link errors.SequenzyError}
+     * @throws {@link errors.SequenzyTimeoutError}
+     *
+     * @example
+     *     await client.push.updateLiveActivity({
+     *         activityId: "order-1234",
+     *         contentState: {
+     *             "minutesAway": 8,
+     *             "status": "out_for_delivery"
+     *         }
+     *     })
+     */
+    updateLiveActivity(request: Sequenzy.UpdateLiveActivityRequest, requestOptions?: PushClient.RequestOptions): core.HttpResponsePromise<Sequenzy.LiveActivityDispatch>;
+    private __updateLiveActivity;
     /**
      * Updates a draft or scheduled push campaign. Only the fields you pass change; content fields merge over the stored content. A scheduled campaign keeps its schedule and cannot be cleared to empty content. Requires the campaigns:write scope.
      *