@wix/auto_sdk_benefit-programs_program-definitions 1.0.13 → 1.0.15

package/build/internal/{benefit-programs-v1-program-definition-program-definitions.universal-u-PVpH8k.d.ts → es/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts}

@@ -1,4 +1,5 @@
-interface ProgramDefinition {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface ProgramDefinition {
     /**
      * Program definition ID.
      * @format GUID
@@ -51,7 +52,7 @@ interface ProgramDefinition {
      */
     externalId?: string | null;
 }
-interface ExtendedFields {
+export interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -62,23 +63,23 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-interface CreateProgramDefinitionRequest {
+export interface CreateProgramDefinitionRequest {
     /** Program definition to create. */
     programDefinition: ProgramDefinition;
 }
-interface CreateProgramDefinitionResponse {
+export interface CreateProgramDefinitionResponse {
     /** Created program definition. */
     programDefinition?: ProgramDefinition;
 }
-interface UpdateProgramDefinitionRequest {
+export interface UpdateProgramDefinitionRequest {
     /** Program definition to update. */
     programDefinition: ProgramDefinition;
 }
-interface UpdateProgramDefinitionResponse {
+export interface UpdateProgramDefinitionResponse {
     /** Updated program definition. */
     programDefinition?: ProgramDefinition;
 }
-interface DeleteProgramDefinitionRequest {
+export interface DeleteProgramDefinitionRequest {
     /**
      * ID of the program definition to delete.
      * @format GUID
@@ -87,7 +88,7 @@ interface DeleteProgramDefinitionRequest {
     /** Determines when the changes to this program definition will be applied to associated programs and pools. */
     cascadeType?: Cascade;
 }
-declare enum Cascade {
+export declare enum Cascade {
     /** Unknown cascade. */
     UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
     /** Changes are applied to existing programs and pools when they are next renewed. */
@@ -97,20 +98,20 @@ declare enum Cascade {
     /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
     FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
 }
-interface DeleteProgramDefinitionResponse {
+export interface DeleteProgramDefinitionResponse {
 }
-interface GetProgramDefinitionRequest {
+export interface GetProgramDefinitionRequest {
     /**
      * ID of the program definition to retrieve.
      * @format GUID
      */
     programDefinitionId: string;
 }
-interface GetProgramDefinitionResponse {
+export interface GetProgramDefinitionResponse {
     /** Retrieved program definition. */
     programDefinition?: ProgramDefinition;
 }
-interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
+export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
     /**
      * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
      * @minLength 1
@@ -123,15 +124,15 @@ interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
      */
     externalId: string;
 }
-interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
+export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
     /** Retrieved program definition. */
     programDefinition?: ProgramDefinition;
 }
-interface QueryProgramDefinitionsRequest {
+export interface QueryProgramDefinitionsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -147,11 +148,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface CursorQueryPagingMethodOneOf {
+export interface 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;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Field to sort by.
      * @maxLength 512
@@ -164,13 +165,13 @@ interface Sorting {
      */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     /** Ascending sort order. */
     ASC = "ASC",
     /** Descending sort order. */
     DESC = "DESC"
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return.
      * @max 100
@@ -185,13 +186,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryProgramDefinitionsResponse {
+export interface QueryProgramDefinitionsResponse {
     /** List of retrieved program definitions. */
     programDefinitions?: ProgramDefinition[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
 }
-interface CursorPagingMetadata {
+export interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -204,7 +205,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -216,15 +217,15 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface UpsertProgramDefinitionRequest {
+export interface UpsertProgramDefinitionRequest {
     /** Program definition to be created or updated. */
     programDefinition?: ProgramDefinition;
 }
-interface UpsertProgramDefinitionResponse {
+export interface UpsertProgramDefinitionResponse {
     /** Created or updated program definition. */
     programDefinition?: ProgramDefinition;
 }
-interface GetOrCreateProgramDefinitionRequest {
+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.
      * @minLength 1
@@ -237,11 +238,11 @@ interface GetOrCreateProgramDefinitionRequest {
      */
     externalId?: string;
 }
-interface GetOrCreateProgramDefinitionResponse {
+export interface GetOrCreateProgramDefinitionResponse {
     /** The created or updated program definition. */
     programDefinition?: ProgramDefinition;
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -284,19 +285,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+export interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -304,14 +305,14 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -327,7 +328,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -352,7 +353,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -374,14 +375,52 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface UpdateProgramDefinition {
+/**
+ * Creates a program definition.
+ * @param programDefinition - Program definition to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programDefinition
+ * @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
+ */
+export declare function createProgramDefinition(programDefinition: NonNullablePaths<ProgramDefinition, `externalId` | `namespace`>): Promise<ProgramDefinition>;
+/**
+ * Updates a program definition.
+ *
+ * Each time the program definition is updated,
+ * `revision` increments by 1.
+ * The current `revision` must be passed when updating the program definition.
+ * This ensures you're working with the latest program definition
+ * and prevents unintended overwrites.
+ * @param _id - Program definition ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @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
+ */
+export declare function updateProgramDefinition(_id: string, programDefinition: NonNullablePaths<UpdateProgramDefinition, `revision`>): Promise<ProgramDefinition>;
+export interface UpdateProgramDefinition {
     /**
      * Program definition ID.
      * @format GUID
@@ -434,17 +473,95 @@ interface UpdateProgramDefinition {
      */
     externalId?: string | null;
 }
-interface DeleteProgramDefinitionOptions {
+/**
+ * Deletes a program definition.
+ * @param programDefinitionId - ID of the program definition to delete.
+ * @public
+ * @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>;
+export interface DeleteProgramDefinitionOptions {
     /** Determines when the changes to this program definition will be applied to associated programs and pools. */
     cascadeType?: Cascade;
 }
-interface GetProgramDefinitionByExternalIdAndNamespaceOptions {
+/**
+ * Retrieves a program definition.
+ * @param programDefinitionId - ID of the program definition to retrieve.
+ * @public
+ * @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
+ */
+export declare function getProgramDefinition(programDefinitionId: string): Promise<ProgramDefinition>;
+/**
+ * Retrieves a program definition with the specified external ID and namespace.
+ * @param namespace - Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField namespace
+ * @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: NonNullablePaths<GetProgramDefinitionByExternalIdAndNamespaceOptions, `externalId`>): Promise<GetProgramDefinitionByExternalIdAndNamespaceResponse>;
+export interface GetProgramDefinitionByExternalIdAndNamespaceOptions {
     /**
      * Program definition external ID.
      * @format GUID
      */
     externalId: string;
 }
+/**
+ * Creates a query to retrieve a list of program definitions.
+ *
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
+ *
+ * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Program Definitions returns.
+ *
+ * Query Program Definitions has a default paging limit of 50, which you can override.
+ *
+ *  For a full description of the item object, see the object returned for the `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
+ */
+export declare function queryProgramDefinitions(): ProgramDefinitionsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -452,13 +569,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface ProgramDefinitionsQueryResult extends QueryCursorResult {
+export interface ProgramDefinitionsQueryResult extends QueryCursorResult {
     items: ProgramDefinition[];
     query: ProgramDefinitionsQueryBuilder;
     next: () => Promise<ProgramDefinitionsQueryResult>;
     prev: () => Promise<ProgramDefinitionsQueryResult>;
 }
-interface ProgramDefinitionsQueryBuilder {
+export interface ProgramDefinitionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -522,5 +639,4 @@ interface ProgramDefinitionsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ProgramDefinitionsQueryResult>;
 }
-
-export { type EntityDeletedEvent as A, type ActionEvent as B, Cascade as C, type DeleteProgramDefinitionOptions as D, type ExtendedFields as E, type IdentificationDataIdOneOf as F, type GetProgramDefinitionByExternalIdAndNamespaceOptions as G, type ProgramDefinitionsQueryResult as H, type IdentificationData as I, type MessageEnvelope as M, type ProgramDefinition as P, type QueryProgramDefinitionsRequest as Q, type RestoreInfo as R, SortOrder as S, type UpdateProgramDefinition as U, WebhookIdentityType as W, type GetProgramDefinitionByExternalIdAndNamespaceResponse as a, type ProgramDefinitionsQueryBuilder as b, type CreateProgramDefinitionRequest as c, type CreateProgramDefinitionResponse as d, type UpdateProgramDefinitionRequest as e, type UpdateProgramDefinitionResponse as f, type DeleteProgramDefinitionRequest as g, type DeleteProgramDefinitionResponse as h, type GetProgramDefinitionRequest as i, type GetProgramDefinitionResponse as j, type GetProgramDefinitionByExternalIdAndNamespaceRequest as k, type CursorQuery as l, type CursorQueryPagingMethodOneOf as m, type Sorting as n, type CursorPaging as o, type QueryProgramDefinitionsResponse as p, type CursorPagingMetadata as q, type Cursors as r, type UpsertProgramDefinitionRequest as s, type UpsertProgramDefinitionResponse as t, type GetOrCreateProgramDefinitionRequest as u, type GetOrCreateProgramDefinitionResponse as v, type DomainEvent as w, type DomainEventBodyOneOf as x, type EntityCreatedEvent as y, type EntityUpdatedEvent as z };
+export {};