@wix/auto_sdk_benefit-programs_program-definitions 1.0.0 → 1.0.2

package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts

@@ -1,6 +1,8 @@
 export interface ProgramDefinition {
     /**
      * Program definition ID.
+     * @format GUID
+     * @immutable
      * @readonly
      */
     id?: string | null;
@@ -22,16 +24,28 @@ export interface ProgramDefinition {
      * @readonly
      */
     updatedDate?: Date | null;
-    /** Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition. */
+    /**
+     * Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition.
+     * @maxLength 64
+     */
     displayName?: string | null;
-    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    /**
+     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * @immutable
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string | null;
     /**
      * Custom field data for the program definition object.
      * [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 definition ID designated by the app owner. */
+    /**
+     * External program definition ID designated by the app owner.
+     * @format GUID
+     * @immutable
+     */
     externalId?: string | null;
 }
 export interface ExtendedFields {
@@ -62,7 +76,10 @@ export interface UpdateProgramDefinitionResponse {
     programDefinition?: ProgramDefinition;
 }
 export interface DeleteProgramDefinitionRequest {
-    /** ID of the ProgramDefinition to delete. */
+    /**
+     * ID of the ProgramDefinition to delete.
+     * @format GUID
+     */
     programDefinitionId: string;
     /**
      * Specifies the timing of ending the active benefit pools associated with this program definition.
@@ -95,7 +112,10 @@ export declare enum Cascade {
 export interface DeleteProgramDefinitionResponse {
 }
 export interface GetProgramDefinitionRequest {
-    /** ID of the program definition to retrieve. */
+    /**
+     * ID of the program definition to retrieve.
+     * @format GUID
+     */
     programDefinitionId: string;
 }
 export interface GetProgramDefinitionResponse {
@@ -103,9 +123,16 @@ export interface GetProgramDefinitionResponse {
     programDefinition?: ProgramDefinition;
 }
 export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
-    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    /**
+     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace: string;
-    /** External program definition ID. */
+    /**
+     * External program definition ID.
+     * @format GUID
+     */
     externalId: string;
 }
 export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
@@ -131,6 +158,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -140,7 +168,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;
@@ -152,13 +183,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;
 }
@@ -182,9 +217,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 UpsertProgramDefinitionRequest {
@@ -196,9 +237,16 @@ export interface UpsertProgramDefinitionResponse {
     programDefinition?: ProgramDefinition;
 }
 export interface GetOrCreateProgramDefinitionRequest {
-    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    /**
+     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string;
-    /** External program definition ID. */
+    /**
+     * External program definition ID.
+     * @format GUID
+     */
     externalId?: string;
 }
 export interface GetOrCreateProgramDefinitionResponse {
@@ -278,9 +326,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;
@@ -288,26 +342,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/es/src/benefit-programs-v1-program-definition-program-definitions.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.types.ts"],"names":[],"mappings":"AA+EA,MAAM,CAAN,IAAY,OAqBX;AArBD,WAAY,OAAO;IACjB,uBAAuB;IACvB,8CAAmC,CAAA;IACnC;;;;OAIG;IACH,wCAA6B,CAAA;IAC7B;;;;OAIG;IACH,sCAA2B,CAAA;IAC3B;;;;OAIG;IACH,kDAAuC,CAAA;AACzC,CAAC,EArBW,OAAO,KAAP,OAAO,QAqBlB;AA+DD,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAmLD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.types.ts"],"names":[],"mappings":"AAgGA,MAAM,CAAN,IAAY,OAqBX;AArBD,WAAY,OAAO;IACjB,uBAAuB;IACvB,8CAAmC,CAAA;IACnC;;;;OAIG;IACH,wCAA6B,CAAA;IAC7B;;;;OAIG;IACH,sCAA2B,CAAA;IAC3B;;;;OAIG;IACH,kDAAuC,CAAA;AACzC,CAAC,EArBW,OAAO,KAAP,OAAO,QAqBlB;AA6ED,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAkOD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}

package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts

@@ -1,6 +1,8 @@
 export interface ProgramDefinition {
     /**
      * Program definition ID.
+     * @format GUID
+     * @immutable
      * @readonly
      */
     _id?: string | null;
@@ -22,16 +24,28 @@ export interface ProgramDefinition {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition. */
+    /**
+     * Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition.
+     * @maxLength 64
+     */
     displayName?: string | null;
-    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    /**
+     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * @immutable
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string | null;
     /**
      * Custom field data for the program definition object.
      * [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 definition ID designated by the app owner. */
+    /**
+     * External program definition ID designated by the app owner.
+     * @format GUID
+     * @immutable
+     */
     externalId?: string | null;
 }
 export interface ExtendedFields {
@@ -62,7 +76,10 @@ export interface UpdateProgramDefinitionResponse {
     programDefinition?: ProgramDefinition;
 }
 export interface DeleteProgramDefinitionRequest {
-    /** ID of the ProgramDefinition to delete. */
+    /**
+     * ID of the ProgramDefinition to delete.
+     * @format GUID
+     */
     programDefinitionId: string;
     /**
      * Specifies the timing of ending the active benefit pools associated with this program definition.
@@ -95,7 +112,10 @@ export declare enum Cascade {
 export interface DeleteProgramDefinitionResponse {
 }
 export interface GetProgramDefinitionRequest {
-    /** ID of the program definition to retrieve. */
+    /**
+     * ID of the program definition to retrieve.
+     * @format GUID
+     */
     programDefinitionId: string;
 }
 export interface GetProgramDefinitionResponse {
@@ -103,9 +123,16 @@ export interface GetProgramDefinitionResponse {
     programDefinition?: ProgramDefinition;
 }
 export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
-    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    /**
+     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace: string;
-    /** External program definition ID. */
+    /**
+     * External program definition ID.
+     * @format GUID
+     */
     externalId: string;
 }
 export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
@@ -131,6 +158,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -140,7 +168,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;
@@ -152,13 +183,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;
 }
@@ -182,9 +217,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 UpsertProgramDefinitionRequest {
@@ -196,9 +237,16 @@ export interface UpsertProgramDefinitionResponse {
     programDefinition?: ProgramDefinition;
 }
 export interface GetOrCreateProgramDefinitionRequest {
-    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    /**
+     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string;
-    /** External program definition ID. */
+    /**
+     * External program definition ID.
+     * @format GUID
+     */
     externalId?: string;
 }
 export interface GetOrCreateProgramDefinitionResponse {
@@ -276,9 +324,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;
@@ -286,26 +340,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 {
@@ -324,6 +402,9 @@ export declare enum WebhookIdentityType {
  * @requiredField programDefinition.externalId
  * @requiredField programDefinition.namespace
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_CREATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @returns Created program definition.
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.CreateProgramDefinition
  */
@@ -343,6 +424,9 @@ export declare function createProgramDefinition(programDefinition: ProgramDefini
  * @requiredField programDefinition
  * @requiredField programDefinition.revision
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_UPDATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @returns Updated program definition.
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.UpdateProgramDefinition
  */
@@ -350,6 +434,8 @@ export declare function updateProgramDefinition(_id: string | null, programDefin
 export interface UpdateProgramDefinition {
     /**
      * Program definition ID.
+     * @format GUID
+     * @immutable
      * @readonly
      */
     _id?: string | null;
@@ -371,16 +457,28 @@ export interface UpdateProgramDefinition {
      * @readonly
      */
     _updatedDate?: Date | null;
-    /** Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition. */
+    /**
+     * Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition.
+     * @maxLength 64
+     */
     displayName?: string | null;
-    /** Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs. */
+    /**
+     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * @immutable
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string | null;
     /**
      * Custom field data for the program definition object.
      * [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 definition ID designated by the app owner. */
+    /**
+     * External program definition ID designated by the app owner.
+     * @format GUID
+     * @immutable
+     */
     externalId?: string | null;
 }
 /**
@@ -390,6 +488,9 @@ export interface UpdateProgramDefinition {
  * @documentationMaturity preview
  * @requiredField programDefinitionId
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_DELETE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.DeleteProgramDefinition
  */
 export declare function deleteProgramDefinition(programDefinitionId: string, options?: DeleteProgramDefinitionOptions): Promise<void>;
@@ -407,6 +508,13 @@ export interface DeleteProgramDefinitionOptions {
  * @documentationMaturity preview
  * @requiredField programDefinitionId
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
+ * @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
+ * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @returns Retrieved program definition.
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinition
@@ -423,12 +531,22 @@ export declare function getProgramDefinition(programDefinitionId: string): Promi
  * @requiredField options
  * @requiredField options.externalId
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
+ * @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
+ * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinitionByExternalIdAndNamespace
  */
 export declare function getProgramDefinitionByExternalIdAndNamespace(namespace: string, options: GetProgramDefinitionByExternalIdAndNamespaceOptions): Promise<GetProgramDefinitionByExternalIdAndNamespaceResponse>;
 export interface GetProgramDefinitionByExternalIdAndNamespaceOptions {
-    /** External program definition ID. */
+    /**
+     * External program definition ID.
+     * @format GUID
+     */
     externalId: string;
 }
 /**
@@ -443,7 +561,14 @@ export interface GetProgramDefinitionByExternalIdAndNamespaceOptions {
  * The following `ProgramDefinitionsQueryBuilder` functions are supported for `queryProgramDefinitions()`. For a full description of the program definition object, see the object returned for the [`items`](/program-definitions/program-definitions-query-result/items) property in `ProgramDefinitionsQueryResult`.
  * @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_DEFINITION_READ
+ * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.QueryProgramDefinitions
  */

package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js

@@ -49,6 +49,9 @@ export var WebhookIdentityType;
  * @requiredField programDefinition.externalId
  * @requiredField programDefinition.namespace
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_CREATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @returns Created program definition.
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.CreateProgramDefinition
  */
@@ -91,6 +94,9 @@ export async function createProgramDefinition(programDefinition) {
  * @requiredField programDefinition
  * @requiredField programDefinition.revision
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_UPDATE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @returns Updated program definition.
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.UpdateProgramDefinition
  */
@@ -125,6 +131,9 @@ export async function updateProgramDefinition(_id, programDefinition) {
  * @documentationMaturity preview
  * @requiredField programDefinitionId
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_DELETE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.DeleteProgramDefinition
  */
 export async function deleteProgramDefinition(programDefinitionId, options) {
@@ -160,6 +169,13 @@ export async function deleteProgramDefinition(programDefinitionId, options) {
  * @documentationMaturity preview
  * @requiredField programDefinitionId
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
+ * @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
+ * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @returns Retrieved program definition.
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinition
@@ -199,6 +215,13 @@ export async function getProgramDefinition(programDefinitionId) {
  * @requiredField options
  * @requiredField options.externalId
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
+ * @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
+ * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinitionByExternalIdAndNamespace
  */
@@ -241,7 +264,14 @@ export async function getProgramDefinitionByExternalIdAndNamespace(namespace, op
  * The following `ProgramDefinitionsQueryBuilder` functions are supported for `queryProgramDefinitions()`. For a full description of the program definition object, see the object returned for the [`items`](/program-definitions/program-definitions-query-result/items) property in `ProgramDefinitionsQueryResult`.
  * @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_DEFINITION_READ
+ * @applicableIdentity APP
  * @applicableIdentity VISITOR
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.QueryProgramDefinitions
  */