@wix/auto_sdk_benefit-programs_programs 1.0.0 → 1.0.2

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

@@ -1,7 +1,9 @@
 export interface Program {
     /**
      * Program ID.
+     * @format GUID
      * @readonly
+     * @immutable
      */
     _id?: string | null;
     /**
@@ -23,8 +25,10 @@ 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
      */
     programDefinitionId?: string | null;
     /**
@@ -33,78 +37,94 @@ export interface Program {
      */
     status?: ProgramStatus;
     /**
-     * Identity of the individual that enrolled in the program, granting access to its associated benefits.
+     * Program beneficiary.
      * @readonly
+     * @immutable
      */
     beneficiary?: CommonIdentificationData;
     /**
      * 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
+     */
     namespace?: string | null;
     /**
      * 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;
 }
 /** @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;
 }
 export declare enum IdentityType {
@@ -130,14 +150,14 @@ 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
      */
     externalId?: string | null;
@@ -164,91 +184,114 @@ 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
      */
     namespace: string;
     /**
      * Program name.
      *
-     * Suggest using 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 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;
 }
 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 {
-    /** 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;
     /** 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 program renewal.
+     * @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 pausing of the program.
+     * @format GUID
+     */
     jobId?: string;
 }
 export interface ProgramStatusTransitionNotAllowed {
@@ -258,23 +301,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 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;
 }
 export interface UpdateProgramStatusRequest {
-    /** Program to update */
+    /**
+     * Program to update
+     * @format GUID
+     */
     programId?: string;
     /** Program revision */
     programRevision?: string;
@@ -288,15 +346,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 {
@@ -310,7 +380,7 @@ export interface UpsertMigratedProgramResponse {
     program?: Program;
 }
 export interface UpdateProgramRequest {
-    /** Program to be updated. */
+    /** Program to update. */
     program: Program;
 }
 export interface UpdateProgramResponse {
@@ -318,7 +388,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 {
@@ -326,7 +399,7 @@ 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 {
@@ -344,6 +417,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 +427,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,18 +442,22 @@ 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;
 }
 export interface QueryProgramsResponse {
-    /** List of programs. */
+    /** List of retrieved programs. */
     programs?: Program[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
@@ -395,9 +476,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 +492,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;
 }
@@ -489,9 +579,15 @@ export interface ActionEvent {
     body?: 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;
@@ -499,26 +595,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 {
@@ -572,12 +692,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 associated pools that are created from the pool definitions associated with the program definition.
+ * - **Pool definition**: The program has 1 associated 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
@@ -592,43 +712,37 @@ 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
      */
     namespace: string;
     /**
      * Program name.
      *
-     * Suggest using 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 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.
+ * Renews the specified program.
  *
- * Adjusts each pool in the program according to its unique credit configuration as specified in the pool definition.
- *
- * 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
@@ -641,9 +755,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
@@ -656,9 +768,7 @@ export declare function renewProgram(programId: string): Promise<RenewProgramRes
  */
 export declare function pauseProgram(programId: string): Promise<PauseProgramResponse & PauseProgramResponseNonNullableFields>;
 /**
- * Resumes the benefit pools within a program.
- *
- * Changes the program status to `ACTIVE`, allowing the redemption or reservation of benefits to continue.
+ * Resumes the specified program. Call this method for paused programs.
  * @param programId - ID of program to resume.
  * @public
  * @documentationMaturity preview
@@ -671,10 +781,8 @@ 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.
- *
- * After ending a program, it can't be restarted.
- * @param programId - Package of pools
+ * Ends 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 end.
  * @public
  * @documentationMaturity preview
  * @requiredField programId
@@ -710,7 +818,9 @@ export declare function updateProgram(_id: string | null, program: UpdateProgram
 export interface UpdateProgram {
     /**
      * Program ID.
+     * @format GUID
      * @readonly
+     * @immutable
      */
     _id?: string | null;
     /**
@@ -732,8 +842,10 @@ 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
      */
     programDefinitionId?: string | null;
     /**
@@ -742,40 +854,42 @@ export interface UpdateProgram {
      */
     status?: ProgramStatus;
     /**
-     * Identity of the individual that enrolled in the program, granting access to its associated benefits.
+     * Program beneficiary.
      * @readonly
+     * @immutable
      */
     beneficiary?: CommonIdentificationData;
     /**
      * 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
+     */
     namespace?: string | null;
     /**
      * 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.
@@ -788,6 +902,8 @@ export interface UpdateProgram {
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
  * @applicableIdentity APP
  * @returns Retrieved program.
  * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgram
@@ -796,19 +912,23 @@ 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
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program.ProgramService.QueryPrograms
@@ -892,7 +1012,7 @@ export interface ProgramsQueryBuilder {
     find: () => Promise<ProgramsQueryResult>;
 }
 /**
- * Retrieves a program by program external ID and corresponding namespace.
+ * Retrieves a program with the specified external ID and namespace.
  * @param namespace - Application sub-module that is the source of the program creation.
  *
  * Use the namespace that was designated to the program definition.
@@ -906,6 +1026,8 @@ export interface ProgramsQueryBuilder {
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgramByExternalIdAndNamespace
  */
@@ -915,6 +1037,7 @@ export interface GetProgramByExternalIdAndNamespaceOptions {
      * External program ID.
      *
      * Must be unique to every app's namespace.
+     * @format GUID
      */
     externalId: string;
 }