@wix/auto_sdk_benefit-programs_programs 1.0.1 → 1.0.3

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

@@ -25,7 +25,7 @@ export interface Program {
      */
     _updatedDate?: Date | null;
     /**
-     * ID of program definition that provisioned this benefit pool.
+     * ID of the associated program definition.
      * @format GUID
      * @readonly
      * @immutable
@@ -37,7 +37,7 @@ export interface Program {
      */
     status?: ProgramStatus;
     /**
-     * Identity of the individual that enrolled in the program, granting access to its associated benefits.
+     * Program beneficiary.
      * @readonly
      * @immutable
      */
@@ -45,12 +45,12 @@ export interface Program {
     /**
      * Program name.
      *
-     * Suggest setting the same value that was already specified in the program definition's `displayName`.
+     * You may want to use the same name that's used in the associated program definition, if it exists.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      * @immutable
@@ -59,63 +59,52 @@ export interface Program {
     /**
      * Custom field data for the program object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
-     * External program ID.
-     *
-     * Must be unique to every app's namespace.
+     * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
      */
     externalId?: string | null;
     /**
-     * Program definition info
+     * Associated program definition information.
      * @readonly
      */
     programDefinition?: ProgramDefinitionInfo;
-    /**
-     * Intended status of a program after the completion of an action.
-     * @readonly
-     */
-    targetStatus?: ProgramStatus;
 }
 export declare enum ProgramStatus {
     /** Undefined program status. */
     UNDEFINED = "UNDEFINED",
-    /** Active program. */
+    /** Program is active. */
     ACTIVE = "ACTIVE",
-    /** Paused program. */
+    /** Program is paused. It can be resumed. */
     PAUSED = "PAUSED",
-    /**
-     * Inactive program.
-     *
-     * Benefits of a program with an `ENDED` status can't be redeemed or reserved.
-     */
+    /** Program has ended. It can't be resumed. */
     ENDED = "ENDED",
-    /** Process state for programs that are currently being activated but have not yet completed the provisioning process. */
+    /** Program is being activated for the first time. This status will be true for a negligible amount of time. */
     PROVISIONING = "PROVISIONING",
-    /** Process state for programs that are currently pausing. */
+    /** Program is being paused. This status will be true for a negligible amount of time. */
     PAUSING = "PAUSING",
-    /** Process state for programs that are currently resuming. */
+    /** Program is being re-activated after being paused. This status will be true for a negligible amount of time. */
     RESUMING = "RESUMING",
-    /** Process state for programs that are currently ending. */
+    /** Program is being ended. This status will be true for a negligible amount of time. */
     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 hasn't 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 member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * ID of a Wix user.
      * @format GUID
      */
     wixUserId?: string;
@@ -123,17 +112,17 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
 /** @oneof */
 export interface CommonIdentificationDataIdOneOf {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * ID of a site visitor that hasn't 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 member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * ID of a Wix user.
      * @format GUID
      */
     wixUserId?: string;
@@ -161,15 +150,13 @@ export interface ExtendedFields {
 }
 export interface ProgramDefinitionInfo {
     /**
-     * ID of the program definition that provisioned the program associated with this benefit pool.
+     * Program definition ID.
      * @format GUID
      * @readonly
      */
     _id?: string;
     /**
-     * External ID of the program definition that provisioned this program.
-     *
-     * This identifies the source program definition in the external system.
+     * Program definition external ID.
      * @format GUID
      * @readonly
      */
@@ -197,30 +184,18 @@ export interface ProgramResumed {
 }
 /** In case pool_definition_id is provided should test if it's part of a package. If it is, reject the request */
 export interface ProvisionProgramRequest {
-    /**
-     * Used to locate the pool definition for creating its benefit pools within the program.
-     *
-     * This object must contain either `programDefinitionId` or `poolDefinitionId`:
-     * + Use `programDefinitionId` for programs with multiple benefit pools.
-     * + Use `poolDefinitionId` for a program with just 1 benefit pool.
-     */
+    /** The program definition or pool definition to use to provision the program. */
     poolDefinitionLookupId: PoolDefinitionLookupId;
-    /**
-     * Identity of the individual that enrolled in the program, granting access to its associated benefits.
-     *
-     * The beneficiary's identity information is in their access token. To retrieve their identity, pass the access token from your frontend site to your backend, then call the Token Info ([SDK](https://dev.wix.com/docs/sdk/core-modules/essentials/auth#gettokeninfo)|[REST](https://dev.wix.com/docs/rest/app-management/oauth-2/token-info)) method. The returned `subjectType` and `subjectId` correspond to the  identity type and ID of the beneficiary.
-     */
+    /** Program beneficiary. */
     beneficiary: CommonIdentificationData;
     /**
-     * Set the status of the program upon provision.
+     * Initial program status.
      *
      * Default: `ACTIVE`
      */
     programStatus?: ProvisionProgramRequestProgramStatus;
     /**
-     * Application sub-module that is the source of the program creation.
-     *
-     * Use the namespace that was designated to the program definition.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
@@ -228,14 +203,12 @@ export interface ProvisionProgramRequest {
     /**
      * Program name.
      *
-     * Suggest using the same value that was already specified in the program definition's `displayName`.
+     * If you're provisioning the program from a program definition, you may want to use the same name that used for the program definition.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * External program ID.
-     *
-     * Must be unique to every app owner's namespace.
+     * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      */
     externalProgramId: string;
@@ -266,14 +239,14 @@ export interface PoolDefinitionLookupIdIdOneOf {
     programDefinitionId?: string;
 }
 export declare enum ProvisionProgramRequestProgramStatus {
-    /** Active program. */
+    /** Program is active. */
     ACTIVE = "ACTIVE",
-    /** Paused program. */
+    /** Program is paused. */
     PAUSED = "PAUSED"
 }
 export interface ProvisionProgramResponse {
     /**
-     * Job ID of the provisioned program.
+     * Job ID of the provisioning of the program.
      * @format GUID
      */
     jobId?: string;
@@ -302,7 +275,7 @@ export interface RenewProgramRequest {
 }
 export interface RenewProgramResponse {
     /**
-     * Job ID of the renewed program.
+     * Job ID of the program renewal.
      * @format GUID
      */
     jobId?: string;
@@ -316,7 +289,7 @@ export interface PauseProgramRequest {
 }
 export interface PauseProgramResponse {
     /**
-     * Job ID of the paused program.
+     * Job ID of the pausing of the program.
      * @format GUID
      */
     jobId?: string;
@@ -336,21 +309,21 @@ export interface ResumeProgramRequest {
 }
 export interface ResumeProgramResponse {
     /**
-     * Job ID of the resumed program.
+     * Job ID of the resuming of the program.
      * @format GUID
      */
     jobId?: string;
 }
 export interface EndProgramRequest {
     /**
-     * Package of pools
+     * ID of the program to end.
      * @format GUID
      */
     programId: string;
 }
 export interface EndProgramResponse {
     /**
-     * Job ID of the discontinued program.
+     * Job ID of the ending of the program.
      * @format GUID
      */
     jobId?: string;
@@ -407,7 +380,7 @@ export interface UpsertMigratedProgramResponse {
     program?: Program;
 }
 export interface UpdateProgramRequest {
-    /** Program to be updated. */
+    /** Program to update. */
     program: Program;
 }
 export interface UpdateProgramResponse {
@@ -426,24 +399,20 @@ export interface GetProgramResponse {
     program?: Program;
 }
 export interface QueryProgramsRequest {
-    /** Query to select programs. */
+    /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -455,11 +424,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -470,7 +443,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;
@@ -484,7 +457,7 @@ export interface CursorPaging {
     cursor?: string | null;
 }
 export interface QueryProgramsResponse {
-    /** List of programs. */
+    /** List of retrieved programs. */
     programs?: Program[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
@@ -516,17 +489,13 @@ export interface Cursors {
 }
 export interface GetProgramByExternalIdAndNamespaceRequest {
     /**
-     * Application sub-module that is the source of the program creation.
-     *
-     * Use the namespace that was designated to the program definition.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
     /**
-     * External program ID.
-     *
-     * Must be unique to every app's namespace.
+     * Program's external ID.
      * @format GUID
      */
     externalId: string;
@@ -719,12 +688,12 @@ export interface GetProgramByExternalIdAndNamespaceResponseNonNullableFields {
     program?: ProgramNonNullableFields;
 }
 /**
- * Creates active programs consisting of benefits derived from their underlying program definitions and pool definitions.
- * @param poolDefinitionLookupId - Used to locate the pool definition for creating its benefit pools within the program.
+ * Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
  *
- * This object must contain either `programDefinitionId` or `poolDefinitionId`:
- * + Use `programDefinitionId` for programs with multiple benefit pools.
- * + Use `poolDefinitionId` for a program with just 1 benefit pool.
+ * You can provision a program from a program definition or a pool definition:
+ * - **Program definition**: The program has pools that are created from the pool definitions in the program definition.
+ * - **Pool definition**: The program has 1 pool that is created from the pool definition.
+ * @param poolDefinitionLookupId - The program definition or pool definition to use to provision the program.
  * @public
  * @documentationMaturity preview
  * @requiredField options.beneficiary
@@ -739,22 +708,16 @@ export interface GetProgramByExternalIdAndNamespaceResponseNonNullableFields {
  */
 export declare function provisionProgram(poolDefinitionLookupId: PoolDefinitionLookupId, options?: ProvisionProgramOptions): Promise<ProvisionProgramResponse & ProvisionProgramResponseNonNullableFields>;
 export interface ProvisionProgramOptions {
-    /**
-     * Identity of the individual that enrolled in the program, granting access to its associated benefits.
-     *
-     * The beneficiary's identity information is in their access token. To retrieve their identity, pass the access token from your frontend site to your backend, then call the Token Info ([SDK](https://dev.wix.com/docs/sdk/core-modules/essentials/auth#gettokeninfo)|[REST](https://dev.wix.com/docs/rest/app-management/oauth-2/token-info)) method. The returned `subjectType` and `subjectId` correspond to the  identity type and ID of the beneficiary.
-     */
+    /** Program beneficiary. */
     beneficiary: CommonIdentificationData;
     /**
-     * Set the status of the program upon provision.
+     * Initial program status.
      *
      * Default: `ACTIVE`
      */
     programStatus?: ProvisionProgramRequestProgramStatus;
     /**
-     * Application sub-module that is the source of the program creation.
-     *
-     * Use the namespace that was designated to the program definition.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
@@ -762,24 +725,20 @@ export interface ProvisionProgramOptions {
     /**
      * Program name.
      *
-     * Suggest using the same value that was already specified in the program definition's `displayName`.
+     * If you're provisioning the program from a program definition, you may want to use the same name that used for the program definition.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * External program ID.
-     *
-     * Must be unique to every app owner's namespace.
+     * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      */
     externalProgramId: string;
 }
 /**
- * Updates the benefit pools within a program.
- *
- * Adjusts each pool in the program according to its unique credit configuration as specified in the pool definition.
+ * Renews the specified program.
  *
- * Use this method to reset each benefit pool renewal cycle.
+ * Balances are handled for each pool in the program as defined in the pool's credit configuration.
  * @param programId - ID of the program to renew.
  * @public
  * @documentationMaturity preview
@@ -792,9 +751,7 @@ export interface ProvisionProgramOptions {
  */
 export declare function renewProgram(programId: string): Promise<RenewProgramResponse & RenewProgramResponseNonNullableFields>;
 /**
- * Pauses the benefit pools within a program.
- *
- * Changes the program status to `PAUSED`, preventing the redemption or reservation of benefits.
+ * Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
  * @param programId - ID of the program to pause.
  * @public
  * @documentationMaturity preview
@@ -807,9 +764,9 @@ export declare function renewProgram(programId: string): Promise<RenewProgramRes
  */
 export declare function pauseProgram(programId: string): Promise<PauseProgramResponse & PauseProgramResponseNonNullableFields>;
 /**
- * Resumes the benefit pools within a program.
+ * Resumes the specified program.
  *
- * Changes the program status to `ACTIVE`, allowing the redemption or reservation of benefits to continue.
+ * Call this method for paused programs.
  * @param programId - ID of program to resume.
  * @public
  * @documentationMaturity preview
@@ -822,10 +779,10 @@ export declare function pauseProgram(programId: string): Promise<PauseProgramRes
  */
 export declare function resumeProgram(programId: string): Promise<ResumeProgramResponse & ResumeProgramResponseNonNullableFields>;
 /**
- * Prevents the benefit pools in the provided package from being redeemed or reserved.
+ * Ends the specified program.
  *
- * After ending a program, it can't be restarted.
- * @param programId - Package of pools
+ * Benefits in the program's pools can't be redeemed until the program is resumed.
+ * @param programId - ID of the program to end.
  * @public
  * @documentationMaturity preview
  * @requiredField programId
@@ -885,7 +842,7 @@ export interface UpdateProgram {
      */
     _updatedDate?: Date | null;
     /**
-     * ID of program definition that provisioned this benefit pool.
+     * ID of the associated program definition.
      * @format GUID
      * @readonly
      * @immutable
@@ -897,7 +854,7 @@ export interface UpdateProgram {
      */
     status?: ProgramStatus;
     /**
-     * Identity of the individual that enrolled in the program, granting access to its associated benefits.
+     * Program beneficiary.
      * @readonly
      * @immutable
      */
@@ -905,12 +862,12 @@ export interface UpdateProgram {
     /**
      * Program name.
      *
-     * Suggest setting the same value that was already specified in the program definition's `displayName`.
+     * You may want to use the same name that's used in the associated program definition, if it exists.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      * @immutable
@@ -919,27 +876,20 @@ export interface UpdateProgram {
     /**
      * Custom field data for the program object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
-     * External program ID.
-     *
-     * Must be unique to every app's namespace.
+     * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
      */
     externalId?: string | null;
     /**
-     * Program definition info
+     * Associated program definition information.
      * @readonly
      */
     programDefinition?: ProgramDefinitionInfo;
-    /**
-     * Intended status of a program after the completion of an action.
-     * @readonly
-     */
-    targetStatus?: ProgramStatus;
 }
 /**
  * Retrieves a program.
@@ -962,13 +912,15 @@ export declare function getProgram(programId: string): Promise<Program & Program
 /**
  * Creates a query to retrieve a list of programs.
  *
- * The `queryPrograms()` method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
+ * The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
  *
- * The returned object contains the query definition, which is used to run the query using the [`find()`](/programs/programs-query-builder/find) function.
+ * You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that Query Programs returns.
  *
- * You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPrograms()` returns.
+ * Query Programs has a default paging limit of 50, which you can override.
  *
- * The following `ProgramsQueryBuilder` functions are supported for `queryPrograms()`. For a full description of the program object, see the object returned for the [`items`](/programs/programs-query-result/items) property in `ProgramsQueryResult`.
+ *  For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
  * @public
  * @documentationMaturity preview
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
@@ -1060,10 +1012,8 @@ export interface ProgramsQueryBuilder {
     find: () => Promise<ProgramsQueryResult>;
 }
 /**
- * Retrieves a program by program external ID and corresponding namespace.
- * @param namespace - Application sub-module that is the source of the program creation.
- *
- * Use the namespace that was designated to the program definition.
+ * Retrieves a program with the specified external ID and namespace.
+ * @param namespace - Namespace for your app or site's benefit programs.
  * @public
  * @documentationMaturity preview
  * @requiredField namespace
@@ -1082,9 +1032,7 @@ export interface ProgramsQueryBuilder {
 export declare function getProgramByExternalIdAndNamespace(namespace: string, options: GetProgramByExternalIdAndNamespaceOptions): Promise<GetProgramByExternalIdAndNamespaceResponse & GetProgramByExternalIdAndNamespaceResponseNonNullableFields>;
 export interface GetProgramByExternalIdAndNamespaceOptions {
     /**
-     * External program ID.
-     *
-     * Must be unique to every app's namespace.
+     * Program's external ID.
      * @format GUID
      */
     externalId: string;