@wix/auto_sdk_benefit-programs_programs 1.0.21 → 1.0.22

package/build/internal/cjs/{benefit-programs-v1-program-programs.universal-7lcFYs2X.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Program {
     /**
      * Program ID.
@@ -141,6 +143,8 @@ declare enum IdentityType {
     /** A Wix account holder, such as a site owner or contributor. */
     WIX_USER = "WIX_USER"
 }
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
 interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -663,6 +667,66 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type ProvisionProgramApplicationErrors = {
+    code?: 'PROGRAM_ALREADY_EXISTS';
+    description?: string;
+    data?: ProgramAlreadyExists;
+} | {
+    code?: 'IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+};
+type PauseProgramApplicationErrors = {
+    code?: 'PROGRAM_STATUS_TRANSITION_NOT_ALLOWED';
+    description?: string;
+    data?: ProgramStatusTransitionNotAllowed;
+} | {
+    code?: 'ALREADY_EXECUTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+};
+type ResumeProgramApplicationErrors = {
+    code?: 'PROGRAM_STATUS_TRANSITION_NOT_ALLOWED';
+    description?: string;
+    data?: ProgramStatusTransitionNotAllowed;
+} | {
+    code?: 'ALREADY_EXECUTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+};
+type EndProgramApplicationErrors = {
+    code?: 'PROGRAM_STATUS_TRANSITION_NOT_ALLOWED';
+    description?: string;
+    data?: ProgramStatusTransitionNotAllowed;
+};
+/**
+ * Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
+ *
+ * You can provision a program from a program definition or a pool definition:
+ * - **Program definition**: The provisioned program has pools that are created from the pool definitions in the program definition.
+ * - **Pool definition**: The provisioned 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
+ * @requiredField options.externalProgramId
+ * @requiredField options.namespace
+ * @requiredField poolDefinitionLookupId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_PROVISION
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.ProvisionProgram
+ */
+declare function provisionProgram(poolDefinitionLookupId: PoolDefinitionLookupId, options?: NonNullablePaths<ProvisionProgramOptions, `beneficiary` | `externalProgramId` | `namespace`, 2>): Promise<NonNullablePaths<ProvisionProgramResponse, `jobId` | `program.status` | `program.beneficiary.anonymousVisitorId` | `program.beneficiary.memberId` | `program.beneficiary.wixUserId` | `program.programDefinition._id`, 4> & {
+    __applicationErrorsType?: ProvisionProgramApplicationErrors;
+}>;
 interface ProvisionProgramOptions {
     /** Program beneficiary. */
     beneficiary: CommonIdentificationData;
@@ -691,6 +755,21 @@ interface ProvisionProgramOptions {
      */
     externalProgramId: string;
 }
+/**
+ * Renews the specified program.
+ *
+ * The number of available credits in each pool in the program is defined in the corresponding pool's credit configuration.
+ * @param programId - ID of the program to renew.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.idempotencyKey
+ * @requiredField programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_RENEW
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.RenewProgram
+ */
+declare function renewProgram(programId: string, options: NonNullablePaths<RenewProgramOptions, `idempotencyKey`, 2>): Promise<NonNullablePaths<RenewProgramResponse, `jobId`, 2>>;
 interface RenewProgramOptions {
     /**
      * Idempotency key to ensure that the request is processed only once.
@@ -698,6 +777,21 @@ interface RenewProgramOptions {
      */
     idempotencyKey: string;
 }
+/**
+ * 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
+ * @requiredField options
+ * @requiredField options.idempotencyKey
+ * @requiredField programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_PAUSE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.PauseProgram
+ */
+declare function pauseProgram(programId: string, options: NonNullablePaths<PauseProgramOptions, `idempotencyKey`, 2>): Promise<NonNullablePaths<PauseProgramResponse, `jobId`, 2> & {
+    __applicationErrorsType?: PauseProgramApplicationErrors;
+}>;
 interface PauseProgramOptions {
     /**
      * Idempotency key to ensure that the request is processed only once.
@@ -705,6 +799,23 @@ interface PauseProgramOptions {
      */
     idempotencyKey: string;
 }
+/**
+ * Resumes the specified program.
+ *
+ * Call this method for paused programs.
+ * @param programId - ID of program to resume.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.idempotencyKey
+ * @requiredField programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_RESUME
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.ResumeProgram
+ */
+declare function resumeProgram(programId: string, options: NonNullablePaths<ResumeProgramOptions, `idempotencyKey`, 2>): Promise<NonNullablePaths<ResumeProgramResponse, `jobId`, 2> & {
+    __applicationErrorsType?: ResumeProgramApplicationErrors;
+}>;
 interface ResumeProgramOptions {
     /**
      * Idempotency key to ensure that the request is processed only once.
@@ -712,6 +823,39 @@ interface ResumeProgramOptions {
      */
     idempotencyKey: string;
 }
+/**
+ * Ends the specified program.
+ * @param programId - ID of the program to end.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_END
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.EndProgram
+ */
+declare function endProgram(programId: string): Promise<NonNullablePaths<EndProgramResponse, `jobId`, 2> & {
+    __applicationErrorsType?: EndProgramApplicationErrors;
+}>;
+/**
+ * Updates a program.
+ *
+ * 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 ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField program
+ * @requiredField program.revision
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated program.
+ * @fqn wix.benefit_programs.v1.program.ProgramService.UpdateProgram
+ */
+declare function updateProgram(_id: string, program: NonNullablePaths<UpdateProgram, `revision`, 2>): Promise<NonNullablePaths<Program, `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `programDefinition._id`, 3>>;
 interface UpdateProgram {
     /**
      * Program ID.
@@ -790,6 +934,37 @@ interface UpdateProgram {
      */
     programDefinition?: ProgramDefinitionInfo;
 }
+/**
+ * Retrieves a program.
+ * @param programId - ID of the program to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
+ * @applicableIdentity APP
+ * @returns Retrieved program.
+ * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgram
+ */
+declare function getProgram(programId: string): Promise<NonNullablePaths<Program, `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `programDefinition._id`, 3>>;
+/**
+ * Creates a query to retrieve a list of programs.
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * Query Programs 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 `ProgramsQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.QueryPrograms
+ */
+declare function queryPrograms(): ProgramsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -867,6 +1042,19 @@ interface ProgramsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ProgramsQueryResult>;
 }
+/**
+ * Retrieves a program 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_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgramByExternalIdAndNamespace
+ */
+declare function getProgramByExternalIdAndNamespace(namespace: string, options: NonNullablePaths<GetProgramByExternalIdAndNamespaceOptions, `externalId`, 2>): Promise<NonNullablePaths<GetProgramByExternalIdAndNamespaceResponse, `program.status` | `program.beneficiary.anonymousVisitorId` | `program.beneficiary.memberId` | `program.beneficiary.wixUserId` | `program.programDefinition._id`, 4>>;
 interface GetProgramByExternalIdAndNamespaceOptions {
     /**
      * Program's external ID.
@@ -875,4 +1063,4 @@ interface GetProgramByExternalIdAndNamespaceOptions {
     externalId: string;
 }
 
-export { type Cursors as $, type ResumeProgramRequest as A, type EndProgramRequest as B, type CommonIdentificationData as C, type UpdateProgramStatusRequest as D, type EndProgramResponse as E, type UpdateProgramStatusResponse as F, type GetProgramByExternalIdAndNamespaceOptions as G, type UpsertMigratedProgramRequest as H, IdentityType as I, type UpsertMigratedProgramResponse as J, type UpdateProgramRequest as K, type UpdateProgramResponse as L, type GetProgramRequest as M, type GetProgramResponse as N, OrderStatus as O, type PoolDefinitionLookupId as P, type QueryProgramsRequest as Q, type RenewProgramOptions as R, SortOrder as S, type CursorQuery as T, type UpdateProgram as U, type CursorQueryPagingMethodOneOf as V, WebhookIdentityType as W, type Sorting as X, type CursorPaging as Y, type QueryProgramsResponse as Z, type CursorPagingMetadata as _, type ProvisionProgramOptions as a, type GetProgramByExternalIdAndNamespaceRequest as a0, type DomainEvent as a1, type DomainEventBodyOneOf as a2, type EntityCreatedEvent as a3, type RestoreInfo as a4, type EntityUpdatedEvent as a5, type EntityDeletedEvent as a6, type ActionEvent as a7, type MessageEnvelope as a8, type IdentificationData as a9, type IdentificationDataIdOneOf as aa, type ProgramsQueryResult as ab, type ProvisionProgramResponse as b, type RenewProgramResponse as c, type PauseProgramOptions as d, type PauseProgramResponse as e, type ResumeProgramOptions as f, type ResumeProgramResponse as g, type Program as h, type ProgramsQueryBuilder as i, type GetProgramByExternalIdAndNamespaceResponse as j, ProgramStatus as k, ProvisionProgramRequestProgramStatus as l, type CommonIdentificationDataIdOneOf as m, type ExtendedFields as n, type ProgramDefinitionInfo as o, type ProgramProvisioned as p, type ProgramRenewed as q, type ProgramEnded as r, type ProgramPaused as s, type ProgramResumed as t, type ProvisionProgramRequest as u, type PoolDefinitionLookupIdIdOneOf as v, type ProgramAlreadyExists as w, type RenewProgramRequest as x, type PauseProgramRequest as y, type ProgramStatusTransitionNotAllowed as z };
+export { type ActionEvent, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EndProgramApplicationErrors, type EndProgramRequest, type EndProgramResponse, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetProgramByExternalIdAndNamespaceOptions, type GetProgramByExternalIdAndNamespaceRequest, type GetProgramByExternalIdAndNamespaceResponse, type GetProgramRequest, type GetProgramResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type MessageEnvelope, OrderStatus, type OrderStatusWithLiterals, type PauseProgramApplicationErrors, type PauseProgramOptions, type PauseProgramRequest, type PauseProgramResponse, type PoolDefinitionLookupId, type PoolDefinitionLookupIdIdOneOf, type Program, type ProgramAlreadyExists, type ProgramDefinitionInfo, type ProgramEnded, type ProgramPaused, type ProgramProvisioned, type ProgramRenewed, type ProgramResumed, ProgramStatus, type ProgramStatusTransitionNotAllowed, type ProgramStatusWithLiterals, type ProgramsQueryBuilder, type ProgramsQueryResult, type ProvisionProgramApplicationErrors, type ProvisionProgramOptions, type ProvisionProgramRequest, ProvisionProgramRequestProgramStatus, type ProvisionProgramRequestProgramStatusWithLiterals, type ProvisionProgramResponse, type QueryProgramsRequest, type QueryProgramsResponse, type RenewProgramOptions, type RenewProgramRequest, type RenewProgramResponse, type RestoreInfo, type ResumeProgramApplicationErrors, type ResumeProgramOptions, type ResumeProgramRequest, type ResumeProgramResponse, SortOrder, type SortOrderWithLiterals, type Sorting, type UpdateProgram, type UpdateProgramRequest, type UpdateProgramResponse, type UpdateProgramStatusRequest, type UpdateProgramStatusResponse, type UpsertMigratedProgramRequest, type UpsertMigratedProgramResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, endProgram, getProgram, getProgramByExternalIdAndNamespace, pauseProgram, provisionProgram, queryPrograms, renewProgram, resumeProgram, updateProgram };