@wix/auto_sdk_benefit-programs_programs 1.0.24 → 1.0.26

package/build/cjs/meta.d.ts

@@ -134,6 +134,18 @@ interface CommonIdentificationDataIdOneOf {
      */
     wixUserId?: string;
 }
+declare enum IdentityType {
+    /** Unknown type. This value is not used. */
+    UNKNOWN = "UNKNOWN",
+    /** A site visitor who has not logged in. */
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    /** A logged-in site member. */
+    MEMBER = "MEMBER",
+    /** A Wix account holder, such as a site owner or contributor. */
+    WIX_USER = "WIX_USER"
+}
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
 interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -159,6 +171,26 @@ interface ProgramDefinitionInfo {
      */
     externalId?: string | null;
 }
+interface ProgramProvisioned {
+    /** Program which has been provisioned */
+    program?: Program;
+}
+interface ProgramRenewed {
+    /** Program which has been renewed */
+    program?: Program;
+}
+interface ProgramEnded {
+    /** Program which has been ended */
+    program?: Program;
+}
+interface ProgramPaused {
+    /** Program which has been paused */
+    program?: Program;
+}
+interface ProgramResumed {
+    /** Program which has been resumed */
+    program?: Program;
+}
 /** In case pool_definition_id is provided should test if it's part of a package. If it is, reject the request */
 interface ProvisionProgramRequest {
     /** The program definition or pool definition to use to provision the program. */
@@ -232,6 +264,18 @@ interface ProvisionProgramResponse {
     /** Provisioned program. */
     program?: Program;
 }
+interface ProgramAlreadyExists {
+    /**
+     * Key of a program that already exists
+     * @format GUID
+     */
+    externalProgramId?: string;
+    /**
+     * Key of a program that already exists
+     * @format GUID
+     */
+    namespace?: string;
+}
 /** Updates the pool credit amount according to the configuration. */
 interface RenewProgramRequest {
     /**
@@ -271,6 +315,12 @@ interface PauseProgramResponse {
      */
     jobId?: string;
 }
+interface ProgramStatusTransitionNotAllowed {
+    /** Current status of the program */
+    currentStatus?: ProgramStatusWithLiterals;
+    /** Status to which the program is being transitioned */
+    requestedStatus?: ProgramStatusWithLiterals;
+}
 interface ResumeProgramRequest {
     /**
      * ID of program to resume.
@@ -304,6 +354,59 @@ interface EndProgramResponse {
      */
     jobId?: string;
 }
+interface UpdateProgramStatusRequest {
+    /**
+     * Program to update
+     * @format GUID
+     */
+    programId?: string;
+    /** Program revision */
+    programRevision?: string;
+    /** Status to update */
+    status?: ProgramStatusWithLiterals;
+    /** Status to update */
+    targetStatus?: ProgramStatusWithLiterals;
+}
+interface UpdateProgramStatusResponse {
+    /** The updated Program */
+    program?: Program;
+}
+interface UpsertMigratedProgramRequest {
+    /**
+     * Order id
+     * @format GUID
+     */
+    orderId?: string;
+    /**
+     * Plan id
+     * @format GUID
+     */
+    planId?: string;
+    /**
+     * Order member id
+     * @format GUID
+     */
+    memberId?: string;
+    /** Order status */
+    status?: OrderStatusWithLiterals;
+    /**
+     * Plan name
+     * @maxLength 64
+     */
+    planName?: string;
+}
+declare enum OrderStatus {
+    UNKNOWN = "UNKNOWN",
+    ACTIVE = "ACTIVE",
+    PAUSED = "PAUSED",
+    ENDED = "ENDED"
+}
+/** @enumType */
+type OrderStatusWithLiterals = OrderStatus | 'UNKNOWN' | 'ACTIVE' | 'PAUSED' | 'ENDED';
+interface UpsertMigratedProgramResponse {
+    /** Inserted or updated program */
+    program?: Program;
+}
 interface UpdateProgramRequest {
     /** Program to update. */
     program: Program;
@@ -431,6 +534,186 @@ interface GetProgramByExternalIdAndNamespaceResponse {
     /** Retrieved program. */
     program?: Program;
 }
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** @docsIgnore */
+type ProvisionProgramApplicationErrors = {
+    code?: 'PROGRAM_ALREADY_EXISTS';
+    description?: string;
+    data?: ProgramAlreadyExists;
+} | {
+    code?: 'IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type PauseProgramApplicationErrors = {
+    code?: 'PROGRAM_STATUS_TRANSITION_NOT_ALLOWED';
+    description?: string;
+    data?: ProgramStatusTransitionNotAllowed;
+} | {
+    code?: 'ALREADY_EXECUTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type ResumeProgramApplicationErrors = {
+    code?: 'PROGRAM_STATUS_TRANSITION_NOT_ALLOWED';
+    description?: string;
+    data?: ProgramStatusTransitionNotAllowed;
+} | {
+    code?: 'ALREADY_EXECUTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type EndProgramApplicationErrors = {
+    code?: 'PROGRAM_STATUS_TRANSITION_NOT_ALLOWED';
+    description?: string;
+    data?: ProgramStatusTransitionNotAllowed;
+};
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -456,4 +739,4 @@ declare function getProgram(): __PublicMethodMetaInfo<'GET', {
 declare function queryPrograms(): __PublicMethodMetaInfo<'POST', {}, QueryProgramsRequest$1, QueryProgramsRequest, QueryProgramsResponse$1, QueryProgramsResponse>;
 declare function getProgramByExternalIdAndNamespace(): __PublicMethodMetaInfo<'GET', {}, GetProgramByExternalIdAndNamespaceRequest$1, GetProgramByExternalIdAndNamespaceRequest, GetProgramByExternalIdAndNamespaceResponse$1, GetProgramByExternalIdAndNamespaceResponse>;
 
-export { type __PublicMethodMetaInfo, endProgram, getProgram, getProgramByExternalIdAndNamespace, pauseProgram, provisionProgram, queryPrograms, renewProgram, resumeProgram, updateProgram };
+export { type ActionEvent as ActionEventOriginal, type CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOfOriginal, type CommonIdentificationData as CommonIdentificationDataOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EndProgramApplicationErrors as EndProgramApplicationErrorsOriginal, type EndProgramRequest as EndProgramRequestOriginal, type EndProgramResponse as EndProgramResponseOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetProgramByExternalIdAndNamespaceRequest as GetProgramByExternalIdAndNamespaceRequestOriginal, type GetProgramByExternalIdAndNamespaceResponse as GetProgramByExternalIdAndNamespaceResponseOriginal, type GetProgramRequest as GetProgramRequestOriginal, type GetProgramResponse as GetProgramResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, IdentityType as IdentityTypeOriginal, type IdentityTypeWithLiterals as IdentityTypeWithLiteralsOriginal, type MessageEnvelope as MessageEnvelopeOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type PauseProgramApplicationErrors as PauseProgramApplicationErrorsOriginal, type PauseProgramRequest as PauseProgramRequestOriginal, type PauseProgramResponse as PauseProgramResponseOriginal, type PoolDefinitionLookupIdIdOneOf as PoolDefinitionLookupIdIdOneOfOriginal, type PoolDefinitionLookupId as PoolDefinitionLookupIdOriginal, type ProgramAlreadyExists as ProgramAlreadyExistsOriginal, type ProgramDefinitionInfo as ProgramDefinitionInfoOriginal, type ProgramEnded as ProgramEndedOriginal, type Program as ProgramOriginal, type ProgramPaused as ProgramPausedOriginal, type ProgramProvisioned as ProgramProvisionedOriginal, type ProgramRenewed as ProgramRenewedOriginal, type ProgramResumed as ProgramResumedOriginal, ProgramStatus as ProgramStatusOriginal, type ProgramStatusTransitionNotAllowed as ProgramStatusTransitionNotAllowedOriginal, type ProgramStatusWithLiterals as ProgramStatusWithLiteralsOriginal, type ProvisionProgramApplicationErrors as ProvisionProgramApplicationErrorsOriginal, type ProvisionProgramRequest as ProvisionProgramRequestOriginal, ProvisionProgramRequestProgramStatus as ProvisionProgramRequestProgramStatusOriginal, type ProvisionProgramRequestProgramStatusWithLiterals as ProvisionProgramRequestProgramStatusWithLiteralsOriginal, type ProvisionProgramResponse as ProvisionProgramResponseOriginal, type QueryProgramsRequest as QueryProgramsRequestOriginal, type QueryProgramsResponse as QueryProgramsResponseOriginal, type RenewProgramRequest as RenewProgramRequestOriginal, type RenewProgramResponse as RenewProgramResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type ResumeProgramApplicationErrors as ResumeProgramApplicationErrorsOriginal, type ResumeProgramRequest as ResumeProgramRequestOriginal, type ResumeProgramResponse as ResumeProgramResponseOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type UpdateProgramRequest as UpdateProgramRequestOriginal, type UpdateProgramResponse as UpdateProgramResponseOriginal, type UpdateProgramStatusRequest as UpdateProgramStatusRequestOriginal, type UpdateProgramStatusResponse as UpdateProgramStatusResponseOriginal, type UpsertMigratedProgramRequest as UpsertMigratedProgramRequestOriginal, type UpsertMigratedProgramResponse as UpsertMigratedProgramResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, endProgram, getProgram, getProgramByExternalIdAndNamespace, pauseProgram, provisionProgram, queryPrograms, renewProgram, resumeProgram, updateProgram };

package/build/cjs/meta.js

@@ -20,6 +20,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // meta.ts
 var meta_exports = {};
 __export(meta_exports, {
+  IdentityTypeOriginal: () => IdentityType,
+  OrderStatusOriginal: () => OrderStatus,
+  ProgramStatusOriginal: () => ProgramStatus,
+  ProvisionProgramRequestProgramStatusOriginal: () => ProvisionProgramRequestProgramStatus,
+  SortOrderOriginal: () => SortOrder,
+  WebhookIdentityTypeOriginal: () => WebhookIdentityType,
   endProgram: () => endProgram2,
   getProgram: () => getProgram2,
   getProgramByExternalIdAndNamespace: () => getProgramByExternalIdAndNamespace2,
@@ -40,92 +46,7 @@ var import_field_mask = require("@wix/sdk-runtime/transformations/field-mask");
 var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
 var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
 function resolveWixBenefitProgramsV1ProgramProgramServiceUrl(opts) {
-  const domainToMappings = {
-    "api._api_base_domain_": [
-      {
-        srcPath: "/programs",
-        destPath: ""
-      }
-    ],
-    _: [
-      {
-        srcPath: "/_api/benefit-programs-programs",
-        destPath: ""
-      }
-    ],
-    "editor._base_domain_": [
-      {
-        srcPath: "/_api/benefit-programs-programs",
-        destPath: ""
-      },
-      {
-        srcPath: "/_api/benefit-programs/v1/programs",
-        destPath: "/v1/programs"
-      }
-    ],
-    "blocks._base_domain_": [
-      {
-        srcPath: "/_api/benefit-programs-programs",
-        destPath: ""
-      },
-      {
-        srcPath: "/_api/benefit-programs/v1/programs",
-        destPath: "/v1/programs"
-      }
-    ],
-    "create.editorx": [
-      {
-        srcPath: "/_api/benefit-programs-programs",
-        destPath: ""
-      },
-      {
-        srcPath: "/_api/benefit-programs/v1/programs",
-        destPath: "/v1/programs"
-      }
-    ],
-    "editor.wixapps.net": [
-      {
-        srcPath: "/_api/benefit-programs-programs",
-        destPath: ""
-      },
-      {
-        srcPath: "/_api/benefit-programs/v1/programs",
-        destPath: "/v1/programs"
-      }
-    ],
-    "manage._base_domain_": [
-      {
-        srcPath: "/_api/benefit-programs-programs",
-        destPath: ""
-      },
-      {
-        srcPath: "/_api/benefit-programs/v1/programs",
-        destPath: "/v1/programs"
-      }
-    ],
-    "www._base_domain_": [
-      {
-        srcPath: "/_api/benefit-programs-programs",
-        destPath: ""
-      },
-      {
-        srcPath: "/_api/benefit-programs/v1/programs",
-        destPath: "/v1/programs"
-      }
-    ],
-    "*.dev.wix-code.com": [
-      {
-        srcPath: "/_api/benefit-programs/v1/programs",
-        destPath: "/v1/programs"
-      }
-    ],
-    "www.wixapis.com": [
-      {
-        srcPath: "/benefit-programs/v1/programs",
-        destPath: "/v1/programs"
-      }
-    ]
-  };
+  const domainToMappings = {};
   return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
 var PACKAGE_NAME = "@wix/auto_sdk_benefit-programs_programs";
@@ -377,6 +298,51 @@ function getProgramByExternalIdAndNamespace(payload) {
   return __getProgramByExternalIdAndNamespace;
 }
 
+// src/benefit-programs-v1-program-programs.types.ts
+var ProgramStatus = /* @__PURE__ */ ((ProgramStatus2) => {
+  ProgramStatus2["UNDEFINED"] = "UNDEFINED";
+  ProgramStatus2["ACTIVE"] = "ACTIVE";
+  ProgramStatus2["PAUSED"] = "PAUSED";
+  ProgramStatus2["ENDED"] = "ENDED";
+  ProgramStatus2["PROVISIONING"] = "PROVISIONING";
+  ProgramStatus2["PAUSING"] = "PAUSING";
+  ProgramStatus2["RESUMING"] = "RESUMING";
+  ProgramStatus2["ENDING"] = "ENDING";
+  return ProgramStatus2;
+})(ProgramStatus || {});
+var IdentityType = /* @__PURE__ */ ((IdentityType2) => {
+  IdentityType2["UNKNOWN"] = "UNKNOWN";
+  IdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  IdentityType2["MEMBER"] = "MEMBER";
+  IdentityType2["WIX_USER"] = "WIX_USER";
+  return IdentityType2;
+})(IdentityType || {});
+var ProvisionProgramRequestProgramStatus = /* @__PURE__ */ ((ProvisionProgramRequestProgramStatus2) => {
+  ProvisionProgramRequestProgramStatus2["ACTIVE"] = "ACTIVE";
+  ProvisionProgramRequestProgramStatus2["PAUSED"] = "PAUSED";
+  return ProvisionProgramRequestProgramStatus2;
+})(ProvisionProgramRequestProgramStatus || {});
+var OrderStatus = /* @__PURE__ */ ((OrderStatus2) => {
+  OrderStatus2["UNKNOWN"] = "UNKNOWN";
+  OrderStatus2["ACTIVE"] = "ACTIVE";
+  OrderStatus2["PAUSED"] = "PAUSED";
+  OrderStatus2["ENDED"] = "ENDED";
+  return OrderStatus2;
+})(OrderStatus || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ASC"] = "ASC";
+  SortOrder2["DESC"] = "DESC";
+  return SortOrder2;
+})(SortOrder || {});
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+
 // src/benefit-programs-v1-program-programs.meta.ts
 function provisionProgram2() {
   const payload = {};
@@ -544,6 +510,12 @@ function getProgramByExternalIdAndNamespace2() {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  IdentityTypeOriginal,
+  OrderStatusOriginal,
+  ProgramStatusOriginal,
+  ProvisionProgramRequestProgramStatusOriginal,
+  SortOrderOriginal,
+  WebhookIdentityTypeOriginal,
   endProgram,
   getProgram,
   getProgramByExternalIdAndNamespace,