@wix/auto_sdk_automations_activation-log 1.0.5 → 1.0.6

package/build/meta.d.mts

@@ -0,0 +1,405 @@
+import { aj as GetActivationLogRequest$1, ak as GetActivationLogResponse$1, al as ListActivationLogsRequest$1, a as ListActivationLogsResponse$1, as as SearchActivationLogsByPayloadPiiValueRequest$1, b as SearchActivationLogsByPayloadPiiValueResponse$1 } from './automations-activation-logs-v1-activation-log-activation-log.universal-CgZ_qxWG.mjs';
+
+interface ActivationLog {
+    /**
+     * Activation ID
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * The activated automation ID
+     * @format GUID
+     */
+    automationId?: string;
+    /** The activated automation revision */
+    automationRevision?: string;
+    /** Automation activation status */
+    status?: StatusWithLiterals;
+    /** Scheduled status additional info */
+    initiatedInfo?: InitiatedStatusInfo;
+    /** Scheduled status additional info */
+    scheduledInfo?: ScheduledStatusInfo;
+    /** Started status additional info */
+    startedInfo?: StartedStatusInfo;
+    /** Ended status additional info */
+    endedInfo?: EndedStatusInfo;
+    /** Cancelled status additional info */
+    cancelledInfo?: CancelledStatusInfo;
+    /** Failed status additional info */
+    failedInfo?: FailedStatusInfo;
+    /** Skipped status additional info */
+    skippedInfo?: SkippedStatusInfo;
+    /**
+     * Warnings information
+     * @maxSize 15
+     */
+    warnings?: Warning[];
+    /** Created date */
+    createdDate?: Date | null;
+}
+declare enum Target {
+    UNKNOWN_TARGET = "UNKNOWN_TARGET",
+    SCHEDULE = "SCHEDULE",
+    IMMEDIATE = "IMMEDIATE"
+}
+/** @enumType */
+type TargetWithLiterals = Target | 'UNKNOWN_TARGET' | 'SCHEDULE' | 'IMMEDIATE';
+declare enum CancellationReason {
+    UNKNOWN_CANCELLATION_REASON = "UNKNOWN_CANCELLATION_REASON",
+    /** Indicating that the activation was cancelled directly */
+    EVENT_CANCELLED = "EVENT_CANCELLED",
+    /** Indicating that the activation is cancelled because the automation was deactivated */
+    AUTOMATION_DEACTIVATED = "AUTOMATION_DEACTIVATED",
+    /** Indicating that the activation is cancelled because the automation was deleted */
+    AUTOMATION_DELETED = "AUTOMATION_DELETED",
+    /** Indicating that the activation is cancelled after the automation schedule time was reached */
+    CANCELLED_BY_REFRESH_PAYLOAD = "CANCELLED_BY_REFRESH_PAYLOAD",
+    /** Indicates that the activation was cancelled due to a UoU GDPR "Right to be Forgotten" request. */
+    CANCELLED_BY_GDPR_REQUEST = "CANCELLED_BY_GDPR_REQUEST"
+}
+/** @enumType */
+type CancellationReasonWithLiterals = CancellationReason | 'UNKNOWN_CANCELLATION_REASON' | 'EVENT_CANCELLED' | 'AUTOMATION_DEACTIVATED' | 'AUTOMATION_DELETED' | 'CANCELLED_BY_REFRESH_PAYLOAD' | 'CANCELLED_BY_GDPR_REQUEST';
+interface Identity {
+    /**
+     * User ID
+     * @format GUID
+     */
+    userId?: string | null;
+    /**
+     * App ID
+     * @format GUID
+     */
+    appId?: string | null;
+}
+declare enum ErrorReason {
+    /** Unexpected error reason */
+    UNEXPECTED_ERROR_REASON = "UNEXPECTED_ERROR_REASON",
+    /** Failed to evaluate the schedule date expression */
+    SCHEDULE_DATE_EVALUATION_FAILED = "SCHEDULE_DATE_EVALUATION_FAILED"
+}
+/** @enumType */
+type ErrorReasonWithLiterals = ErrorReason | 'UNEXPECTED_ERROR_REASON' | 'SCHEDULE_DATE_EVALUATION_FAILED';
+declare enum SkipReason {
+    UNKNOWN_SKIP_REASON = "UNKNOWN_SKIP_REASON",
+    /** Activation was skipped because the scheduled execution time had already passed at the time of execution */
+    SCHEDULE_DATE_EXPIRED = "SCHEDULE_DATE_EXPIRED",
+    /** Activation was skipped because the trigger filters defined in the automation did not match the payload. */
+    TRIGGER_FILTERS_NOT_PASSED = "TRIGGER_FILTERS_NOT_PASSED",
+    /** Activation was skipped because it exceeded the configured rate limit (maximum number of executions allowed in a time period). */
+    RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED",
+    /** Activation was skipped because an event with the same idempotency key was already processed. */
+    EVENT_ALREADY_PROCESSED = "EVENT_ALREADY_PROCESSED"
+}
+/** @enumType */
+type SkipReasonWithLiterals = SkipReason | 'UNKNOWN_SKIP_REASON' | 'SCHEDULE_DATE_EXPIRED' | 'TRIGGER_FILTERS_NOT_PASSED' | 'RATE_LIMIT_EXCEEDED' | 'EVENT_ALREADY_PROCESSED';
+declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** This indicates activation is not started yet (no action has run yet) */
+    INITIATED = "INITIATED",
+    /** The activation is in scheduled status when the automation has future date or debounce defined and we're in the waiting stage (no action has run yet) */
+    SCHEDULED = "SCHEDULED",
+    /** This indicates the automation activation has started and currently in progress */
+    STARTED = "STARTED",
+    /** This indicates all the automation actions were handled either by invoking them, skipping them etc. */
+    ENDED = "ENDED",
+    /** This indicates the activation was cancelled */
+    CANCELLED = "CANCELLED",
+    /**
+     * This indicates the activation failed to start
+     * Note that failure in the activation of a single action will not result a failure in activation of the entire automation
+     */
+    FAILED = "FAILED",
+    /**
+     * Indicates that the automation activation was skipped without executing any actions.
+     * Note that an activation will either be skipped immediately or move to INITIATED state.
+     */
+    SKIPPED = "SKIPPED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'INITIATED' | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELLED' | 'FAILED' | 'SKIPPED';
+interface InitiatedStatusInfo {
+    /** Created date */
+    statusChangedDate?: Date | null;
+    /** Target */
+    target?: TargetWithLiterals;
+    /** The reported trigger payload */
+    payload?: Record<string, any> | null;
+    /**
+     * External entity ID
+     * @maxLength 40
+     */
+    externalEntityId?: string | null;
+    /**
+     * Unique identifier for the request that initiated the automation
+     * @maxLength 100
+     */
+    requestId?: string | null;
+}
+interface ScheduledStatusInfo {
+    /** Created date */
+    statusChangedDate?: Date | null;
+    /**
+     * Schedule identifier
+     * @format GUID
+     */
+    scheduleId?: string;
+    /** Indicating when the activation should start */
+    date?: Date | null;
+}
+interface StartedStatusInfo {
+    /** Created date */
+    statusChangedDate?: Date | null;
+    /** Enriched and refreshed payload */
+    payload?: Record<string, any> | null;
+}
+interface EndedStatusInfo {
+    /** Created date */
+    statusChangedDate?: Date | null;
+    /** Indicates if the activation failed with errors in one or more actions. Actions that failed but eventually ended are not included */
+    withFailedActions?: boolean | null;
+}
+interface CancelledStatusInfo {
+    /** Created date */
+    statusChangedDate?: Date | null;
+    /** Cancellation reason */
+    reason?: CancellationReasonWithLiterals;
+    /** The identity (such as user, app etc.) that caused the cancellation */
+    initiator?: Identity;
+}
+interface FailedStatusInfo {
+    /** Created date */
+    statusChangedDate?: Date | null;
+    /**
+     * Error description
+     * @maxLength 1000
+     * @readonly
+     */
+    errorDescription?: string;
+    /**
+     * Error code
+     * @maxLength 20
+     */
+    errorCode?: string | null;
+    /** Error reason */
+    errorReason?: ErrorReasonWithLiterals;
+    /** Event payload */
+    payload?: Record<string, any> | null;
+    /**
+     * External entity ID
+     * @maxLength 40
+     */
+    externalEntityId?: string | null;
+    /**
+     * Unique identifier for the request that initiated the automation
+     * @maxLength 100
+     */
+    requestId?: string | null;
+}
+interface SkippedStatusInfo {
+    /** Created date */
+    statusChangedDate?: Date | null;
+    /** The reason why the automation activation was skipped */
+    reason?: SkipReasonWithLiterals;
+    /** The reported trigger payload */
+    payload?: Record<string, any> | null;
+    /**
+     * External entity ID
+     * @maxLength 40
+     */
+    externalEntityId?: string | null;
+    /**
+     * Unique identifier for the request that initiated the automation
+     * @maxLength 100
+     */
+    requestId?: string | null;
+}
+interface Warning {
+    /** Event date */
+    warningDate?: Date | null;
+    /**
+     * Detailed description of what caused the warning
+     * @maxLength 1000
+     * @readonly
+     */
+    errorDescription?: string;
+    /**
+     * Error code of what caused the warning
+     * @maxLength 20
+     * @readonly
+     */
+    errorCode?: string | null;
+    /** The reason for the warning */
+    reason?: WarningReasonWithLiterals;
+}
+declare enum WarningReason {
+    UNKNOWN_WARNING_REASON = "UNKNOWN_WARNING_REASON",
+    /** Failed to enrich payload with studio site enrichment */
+    STUDIO_SITE_ENRICHMENT_FAILED = "STUDIO_SITE_ENRICHMENT_FAILED",
+    /** Failed to refresh payload data */
+    REFRESH_PAYLOAD_FAILED = "REFRESH_PAYLOAD_FAILED",
+    /** Failed to retrieve contact information */
+    GET_CONTACT_ENRICHMENT_FAILED = "GET_CONTACT_ENRICHMENT_FAILED",
+    /** Failed to retrieve member information */
+    GET_MEMBER_ENRICHMENT_FAILED = "GET_MEMBER_ENRICHMENT_FAILED"
+}
+/** @enumType */
+type WarningReasonWithLiterals = WarningReason | 'UNKNOWN_WARNING_REASON' | 'STUDIO_SITE_ENRICHMENT_FAILED' | 'REFRESH_PAYLOAD_FAILED' | 'GET_CONTACT_ENRICHMENT_FAILED' | 'GET_MEMBER_ENRICHMENT_FAILED';
+interface GetActivationLogRequest {
+    /**
+     * Activation log ID
+     * @format GUID
+     */
+    activationId: string;
+}
+interface GetActivationLogResponse {
+    /** Activation log */
+    activationLog?: ActivationLog;
+}
+interface ListActivationLogsRequest extends ListActivationLogsRequestIdentifierOneOf {
+    /** Look up activations by automation id */
+    automationIdInfo?: AutomationIdInfo;
+    /** Look up activations by preinstalled identifier */
+    preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
+    /** From created date, If not specified, defaults to 30 days before the current time. */
+    fromCreatedDate?: Date | null;
+    /** To created date, If not specified, defaults to current time. */
+    toCreatedDate?: Date | null;
+    /** Paging */
+    cursorPaging?: CursorPaging;
+    /** Should return payload in the response */
+    includePayload?: boolean | null;
+    /** identifier type for the activations to list */
+    identifierType: IdentifierTypeWithLiterals;
+}
+/** @oneof */
+interface ListActivationLogsRequestIdentifierOneOf {
+    /** Look up activations by automation id */
+    automationIdInfo?: AutomationIdInfo;
+    /** Look up activations by preinstalled identifier */
+    preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 500
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+/** Type of identifier used to look up activation logs */
+declare enum IdentifierType {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE"
+}
+/** @enumType */
+type IdentifierTypeWithLiterals = IdentifierType | 'UNKNOWN_TYPE';
+interface AutomationIdInfo {
+    /**
+     * Automation ID
+     * @format GUID
+     */
+    automationId?: string;
+}
+interface PreinstalledIdentifierInfo {
+    /**
+     * ID of the app that defines the preinstalled automation.
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Application component ID.
+     * @format GUID
+     */
+    componentId?: string;
+}
+interface ListActivationLogsResponse {
+    /** List of activation logs */
+    activationLogs?: ActivationLog[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor string that point to the next page */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+}
+interface SearchActivationLogsByPayloadPiiValueRequest extends SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf {
+    /** Filter activations by value and automation id */
+    automationIdInfo?: AutomationIdInfo;
+    /** Filter activations by value and preinstalled */
+    preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
+    /**
+     * Value to search in the payload
+     * @minLength 1
+     * @maxLength 50
+     */
+    value: string;
+    /** Paging */
+    cursorPaging?: CursorPaging;
+    /** Should return payload in the response */
+    includePayload?: boolean | null;
+    /** Filter by */
+    filterBy?: FilterByWithLiterals;
+    /** From created date */
+    fromCreatedDate?: Date | null;
+    /** To created date */
+    toCreatedDate?: Date | null;
+}
+/** @oneof */
+interface SearchActivationLogsByPayloadPiiValueRequestFilterOptionOneOf {
+    /** Filter activations by value and automation id */
+    automationIdInfo?: AutomationIdInfo;
+    /** Filter activations by value and preinstalled */
+    preinstalledIdentifierInfo?: PreinstalledIdentifierInfo;
+}
+/** FilterBy */
+declare enum FilterBy {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE"
+}
+/** @enumType */
+type FilterByWithLiterals = FilterBy | 'UNKNOWN_TYPE';
+interface SearchActivationLogsByPayloadPiiValueResponse {
+    /** List of activation logs */
+    activationLogs?: ActivationLog[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getActivationLog(): __PublicMethodMetaInfo<'GET', {
+    activationId: string;
+}, GetActivationLogRequest$1, GetActivationLogRequest, GetActivationLogResponse$1, GetActivationLogResponse>;
+declare function listActivationLogs(): __PublicMethodMetaInfo<'GET', {}, ListActivationLogsRequest$1, ListActivationLogsRequest, ListActivationLogsResponse$1, ListActivationLogsResponse>;
+declare function searchActivationLogsByPayloadPiiValue(): __PublicMethodMetaInfo<'POST', {}, SearchActivationLogsByPayloadPiiValueRequest$1, SearchActivationLogsByPayloadPiiValueRequest, SearchActivationLogsByPayloadPiiValueResponse$1, SearchActivationLogsByPayloadPiiValueResponse>;
+
+export { type __PublicMethodMetaInfo, getActivationLog, listActivationLogs, searchActivationLogsByPayloadPiiValue };