@wix/auto_sdk_benefit-programs_programs 1.0.0 → 1.0.1

package/build/cjs/src/benefit-programs-v1-program-programs.types.d.ts

@@ -1,7 +1,9 @@
 export interface Program {
     /**
      * Program ID.
+     * @format GUID
      * @readonly
+     * @immutable
      */
     id?: string | null;
     /**
@@ -24,7 +26,9 @@ export interface Program {
     updatedDate?: Date | null;
     /**
      * ID of program definition that provisioned this benefit pool.
+     * @format GUID
      * @readonly
+     * @immutable
      */
     programDefinitionId?: string | null;
     /**
@@ -35,15 +39,22 @@ export interface Program {
     /**
      * Identity of the individual that enrolled in the program, granting access to its associated benefits.
      * @readonly
+     * @immutable
      */
     beneficiary?: CommonIdentificationData;
     /**
      * Program name.
      *
      * Suggest setting the same value that was already specified in the program definition's `displayName`.
+     * @maxLength 64
      */
     displayName?: string | null;
-    /** External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`. */
+    /**
+     * External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * @minLength 1
+     * @maxLength 50
+     * @immutable
+     */
     namespace?: string | null;
     /**
      * Custom field data for the program object.
@@ -55,6 +66,8 @@ export interface Program {
      * External program ID.
      *
      * Must be unique to every app's namespace.
+     * @format GUID
+     * @immutable
      */
     externalId?: string | null;
     /**
@@ -91,20 +104,38 @@ export declare enum ProgramStatus {
     ENDING = "ENDING"
 }
 export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
 }
 /** @oneof */
 export interface CommonIdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
 }
 export declare enum IdentityType {
@@ -131,6 +162,7 @@ export interface ExtendedFields {
 export interface ProgramDefinitionInfo {
     /**
      * ID of the program definition that provisioned the program associated with this benefit pool.
+     * @format GUID
      * @readonly
      */
     id?: string;
@@ -138,6 +170,7 @@ export interface ProgramDefinitionInfo {
      * External ID of the program definition that provisioned this program.
      *
      * This identifies the source program definition in the external system.
+     * @format GUID
      * @readonly
      */
     externalId?: string | null;
@@ -188,32 +221,48 @@ export interface ProvisionProgramRequest {
      * Application sub-module that is the source of the program creation.
      *
      * Use the namespace that was designated to the program definition.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
     /**
      * Program name.
      *
      * Suggest using the same value that was already specified in the program definition's `displayName`.
+     * @maxLength 64
      */
     displayName?: string | null;
     /**
      * External program ID.
      *
      * Must be unique to every app owner's namespace.
+     * @format GUID
      */
     externalProgramId: string;
 }
 export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
-    /** Pool definition ID. */
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
     poolDefinitionId?: string;
-    /** Program definition ID. */
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
     programDefinitionId?: string;
 }
 /** @oneof */
 export interface PoolDefinitionLookupIdIdOneOf {
-    /** Pool definition ID. */
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
     poolDefinitionId?: string;
-    /** Program definition ID. */
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
     programDefinitionId?: string;
 }
 export declare enum ProvisionProgramRequestProgramStatus {
@@ -223,32 +272,53 @@ export declare enum ProvisionProgramRequestProgramStatus {
     PAUSED = "PAUSED"
 }
 export interface ProvisionProgramResponse {
-    /** Job ID of the provisioned program. */
+    /**
+     * Job ID of the provisioned program.
+     * @format GUID
+     */
     jobId?: string;
     /** Provisioned program. */
     program?: Program;
 }
 export interface ProgramAlreadyExists {
-    /** Key of a program that already exists */
+    /**
+     * Key of a program that already exists
+     * @format GUID
+     */
     externalProgramId?: string;
-    /** Key of a program that already exists */
+    /**
+     * Key of a program that already exists
+     * @format GUID
+     */
     namespace?: string;
 }
 /** Updates the pool credit amount according to the configuration. */
 export interface RenewProgramRequest {
-    /** ID of the program to renew. */
+    /**
+     * ID of the program to renew.
+     * @format GUID
+     */
     programId: string;
 }
 export interface RenewProgramResponse {
-    /** Job ID of the renewed program. */
+    /**
+     * Job ID of the renewed program.
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface PauseProgramRequest {
-    /** ID of the program to pause. */
+    /**
+     * ID of the program to pause.
+     * @format GUID
+     */
     programId: string;
 }
 export interface PauseProgramResponse {
-    /** Job ID of the paused program. */
+    /**
+     * Job ID of the paused program.
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface ProgramStatusTransitionNotAllowed {
@@ -258,23 +328,38 @@ export interface ProgramStatusTransitionNotAllowed {
     requestedStatus?: ProgramStatus;
 }
 export interface ResumeProgramRequest {
-    /** ID of program to resume. */
+    /**
+     * ID of program to resume.
+     * @format GUID
+     */
     programId: string;
 }
 export interface ResumeProgramResponse {
-    /** Job ID of the resumed program. */
+    /**
+     * Job ID of the resumed program.
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface EndProgramRequest {
-    /** Package of pools */
+    /**
+     * Package of pools
+     * @format GUID
+     */
     programId: string;
 }
 export interface EndProgramResponse {
-    /** Job ID of the discontinued program. */
+    /**
+     * Job ID of the discontinued program.
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface UpdateProgramStatusRequest {
-    /** Program to update */
+    /**
+     * Program to update
+     * @format GUID
+     */
     programId?: string;
     /** Program revision */
     programRevision?: string;
@@ -288,15 +373,27 @@ export interface UpdateProgramStatusResponse {
     program?: Program;
 }
 export interface UpsertMigratedProgramRequest {
-    /** Order id */
+    /**
+     * Order id
+     * @format GUID
+     */
     orderId?: string;
-    /** Plan id */
+    /**
+     * Plan id
+     * @format GUID
+     */
     planId?: string;
-    /** Order member id */
+    /**
+     * Order member id
+     * @format GUID
+     */
     memberId?: string;
     /** Order status */
     status?: OrderStatus;
-    /** Plan name */
+    /**
+     * Plan name
+     * @maxLength 64
+     */
     planName?: string;
 }
 export declare enum OrderStatus {
@@ -318,7 +415,10 @@ export interface UpdateProgramResponse {
     program?: Program;
 }
 export interface GetProgramRequest {
-    /** ID of the program to retrieve. */
+    /**
+     * ID of the program to retrieve.
+     * @format GUID
+     */
     programId: string;
 }
 export interface GetProgramResponse {
@@ -344,6 +444,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -353,7 +454,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -365,13 +469,17 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     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;
 }
@@ -395,9 +503,15 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface GetProgramByExternalIdAndNamespaceRequest {
@@ -405,12 +519,15 @@ export interface GetProgramByExternalIdAndNamespaceRequest {
      * Application sub-module that is the source of the program creation.
      *
      * Use the namespace that was designated to the program definition.
+     * @minLength 1
+     * @maxLength 50
      */
     namespace: string;
     /**
      * External program ID.
      *
      * Must be unique to every app's namespace.
+     * @format GUID
      */
     externalId: string;
 }
@@ -491,9 +608,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -501,26 +624,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

package/build/cjs/src/benefit-programs-v1-program-programs.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-program-programs.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.types.ts"],"names":[],"mappings":";;;AAuEA,IAAY,aAqBX;AArBD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,sBAAsB;IACtB,kCAAiB,CAAA;IACjB,sBAAsB;IACtB,kCAAiB,CAAA;IACjB;;;;OAIG;IACH,gCAAe,CAAA;IACf,yHAAyH;IACzH,8CAA6B,CAAA;IAC7B,6DAA6D;IAC7D,oCAAmB,CAAA;IACnB,8DAA8D;IAC9D,sCAAqB,CAAA;IACrB,4DAA4D;IAC5D,kCAAiB,CAAA;AACnB,CAAC,EArBW,aAAa,6BAAb,aAAa,QAqBxB;AAsBD,IAAY,YASX;AATD,WAAY,YAAY;IACtB,4CAA4C;IAC5C,mCAAmB,CAAA;IACnB,4CAA4C;IAC5C,uDAAuC,CAAA;IACvC,+BAA+B;IAC/B,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AA+GD,IAAY,oCAKX;AALD,WAAY,oCAAoC;IAC9C,sBAAsB;IACtB,yDAAiB,CAAA;IACjB,sBAAsB;IACtB,yDAAiB,CAAA;AACnB,CAAC,EALW,oCAAoC,oDAApC,oCAAoC,QAK/C;AA6FD,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;AACjB,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAgED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAiLD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"benefit-programs-v1-program-programs.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.types.ts"],"names":[],"mappings":";;;AAoFA,IAAY,aAqBX;AArBD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,sBAAsB;IACtB,kCAAiB,CAAA;IACjB,sBAAsB;IACtB,kCAAiB,CAAA;IACjB;;;;OAIG;IACH,gCAAe,CAAA;IACf,yHAAyH;IACzH,8CAA6B,CAAA;IAC7B,6DAA6D;IAC7D,oCAAmB,CAAA;IACnB,8DAA8D;IAC9D,sCAAqB,CAAA;IACrB,4DAA4D;IAC5D,kCAAiB,CAAA;AACnB,CAAC,EArBW,aAAa,6BAAb,aAAa,QAqBxB;AAwCD,IAAY,YASX;AATD,WAAY,YAAY;IACtB,4CAA4C;IAC5C,mCAAmB,CAAA;IACnB,4CAA4C;IAC5C,uDAAuC,CAAA;IACvC,+BAA+B;IAC/B,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAiID,IAAY,oCAKX;AALD,WAAY,oCAAoC;IAC9C,sBAAsB;IACtB,yDAAiB,CAAA;IACjB,sBAAsB;IACtB,yDAAiB,CAAA;AACnB,CAAC,EALW,oCAAoC,oDAApC,oCAAoC,QAK/C;AA6ID,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;AACjB,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAuED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA4ND,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}