@wix/auto_sdk_benefit-programs_programs 1.0.5 → 1.0.7

package/build/es/src/benefit-programs-v1-program-programs.public.d.ts

@@ -1,5 +1,5 @@
 import { HttpClient } from '@wix/sdk-types';
-import { EndProgramResponse, EndProgramResponseNonNullableFields, GetProgramByExternalIdAndNamespaceOptions, GetProgramByExternalIdAndNamespaceResponse, GetProgramByExternalIdAndNamespaceResponseNonNullableFields, PauseProgramResponse, PauseProgramResponseNonNullableFields, PoolDefinitionLookupId, Program, ProgramNonNullableFields, ProgramsQueryBuilder, ProvisionProgramOptions, ProvisionProgramResponse, ProvisionProgramResponseNonNullableFields, RenewProgramResponse, RenewProgramResponseNonNullableFields, ResumeProgramResponse, ResumeProgramResponseNonNullableFields, UpdateProgram } from './benefit-programs-v1-program-programs.universal.js';
+import { EndProgramResponse, GetProgramByExternalIdAndNamespaceOptions, GetProgramByExternalIdAndNamespaceResponse, PauseProgramResponse, PoolDefinitionLookupId, Program, ProgramsQueryBuilder, ProvisionProgramOptions, ProvisionProgramResponse, RenewProgramResponse, ResumeProgramResponse, UpdateProgram } from './benefit-programs-v1-program-programs.universal.js';
 export declare const __metadata: {
     PACKAGE_NAME: string;
 };
@@ -9,21 +9,21 @@ interface ProvisionProgramSignature {
      * 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 program has pools that are created from the pool definitions in the program definition.
-     * - **Pool definition**: The program has 1 pool that is created from the pool definition.
+     * - **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 - The program definition or pool definition to use to provision the program.
      */
-    (poolDefinitionLookupId: PoolDefinitionLookupId, options?: ProvisionProgramOptions | undefined): Promise<ProvisionProgramResponse & ProvisionProgramResponseNonNullableFields>;
+    (poolDefinitionLookupId: PoolDefinitionLookupId, options?: ProvisionProgramOptions | undefined): Promise<ProvisionProgramResponse>;
 }
 export declare function renewProgram(httpClient: HttpClient): RenewProgramSignature;
 interface RenewProgramSignature {
     /**
      * Renews the specified program.
      *
-     * Balances are handled for each pool in the program as defined in the pool's credit configuration.
+     * The number of available credits in each pool in the program is defined in the corresponding pool's credit configuration.
      * @param - ID of the program to renew.
      */
-    (programId: string): Promise<RenewProgramResponse & RenewProgramResponseNonNullableFields>;
+    (programId: string): Promise<RenewProgramResponse>;
 }
 export declare function pauseProgram(httpClient: HttpClient): PauseProgramSignature;
 interface PauseProgramSignature {
@@ -31,7 +31,7 @@ interface PauseProgramSignature {
      * Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
      * @param - ID of the program to pause.
      */
-    (programId: string): Promise<PauseProgramResponse & PauseProgramResponseNonNullableFields>;
+    (programId: string): Promise<PauseProgramResponse>;
 }
 export declare function resumeProgram(httpClient: HttpClient): ResumeProgramSignature;
 interface ResumeProgramSignature {
@@ -41,17 +41,15 @@ interface ResumeProgramSignature {
      * Call this method for paused programs.
      * @param - ID of program to resume.
      */
-    (programId: string): Promise<ResumeProgramResponse & ResumeProgramResponseNonNullableFields>;
+    (programId: string): Promise<ResumeProgramResponse>;
 }
 export declare function endProgram(httpClient: HttpClient): EndProgramSignature;
 interface EndProgramSignature {
     /**
      * Ends the specified program.
-     *
-     * Benefits in the program's pools can't be redeemed until the program is resumed.
      * @param - ID of the program to end.
      */
-    (programId: string): Promise<EndProgramResponse & EndProgramResponseNonNullableFields>;
+    (programId: string): Promise<EndProgramResponse>;
 }
 export declare function updateProgram(httpClient: HttpClient): UpdateProgramSignature;
 interface UpdateProgramSignature {
@@ -66,7 +64,7 @@ interface UpdateProgramSignature {
      * @param - Program ID.
      * @returns Updated program.
      */
-    (_id: string | null, program: UpdateProgram): Promise<Program & ProgramNonNullableFields>;
+    (_id: string, program: UpdateProgram): Promise<Program>;
 }
 export declare function getProgram(httpClient: HttpClient): GetProgramSignature;
 interface GetProgramSignature {
@@ -75,7 +73,7 @@ interface GetProgramSignature {
      * @param - ID of the program to retrieve.
      * @returns Retrieved program.
      */
-    (programId: string): Promise<Program & ProgramNonNullableFields>;
+    (programId: string): Promise<Program>;
 }
 export declare function queryPrograms(httpClient: HttpClient): QueryProgramsSignature;
 interface QueryProgramsSignature {
@@ -98,8 +96,8 @@ export declare function getProgramByExternalIdAndNamespace(httpClient: HttpClien
 interface GetProgramByExternalIdAndNamespaceSignature {
     /**
      * Retrieves a program with the specified external ID and namespace.
-     * @param - Namespace for your app or site's benefit programs.
+     * @param - 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.
      */
-    (namespace: string, options: GetProgramByExternalIdAndNamespaceOptions): Promise<GetProgramByExternalIdAndNamespaceResponse & GetProgramByExternalIdAndNamespaceResponseNonNullableFields>;
+    (namespace: string, options: GetProgramByExternalIdAndNamespaceOptions): Promise<GetProgramByExternalIdAndNamespaceResponse>;
 }
-export { ActionEvent, CommonIdentificationData, CommonIdentificationDataIdOneOf, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DomainEvent, DomainEventBodyOneOf, EndProgramRequest, EndProgramResponse, EndProgramResponseNonNullableFields, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetProgramByExternalIdAndNamespaceOptions, GetProgramByExternalIdAndNamespaceRequest, GetProgramByExternalIdAndNamespaceResponse, GetProgramByExternalIdAndNamespaceResponseNonNullableFields, GetProgramRequest, GetProgramResponse, GetProgramResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, IdentityType, MessageEnvelope, OrderStatus, PauseProgramRequest, PauseProgramResponse, PauseProgramResponseNonNullableFields, PoolDefinitionLookupId, PoolDefinitionLookupIdIdOneOf, Program, ProgramAlreadyExists, ProgramDefinitionInfo, ProgramEnded, ProgramNonNullableFields, ProgramPaused, ProgramProvisioned, ProgramRenewed, ProgramResumed, ProgramStatus, ProgramStatusTransitionNotAllowed, ProgramsQueryBuilder, ProgramsQueryResult, ProvisionProgramOptions, ProvisionProgramRequest, ProvisionProgramRequestProgramStatus, ProvisionProgramResponse, ProvisionProgramResponseNonNullableFields, QueryProgramsRequest, QueryProgramsResponse, QueryProgramsResponseNonNullableFields, RenewProgramRequest, RenewProgramResponse, RenewProgramResponseNonNullableFields, RestoreInfo, ResumeProgramRequest, ResumeProgramResponse, ResumeProgramResponseNonNullableFields, SortOrder, Sorting, UpdateProgram, UpdateProgramRequest, UpdateProgramResponse, UpdateProgramResponseNonNullableFields, UpdateProgramStatusRequest, UpdateProgramStatusResponse, UpsertMigratedProgramRequest, UpsertMigratedProgramResponse, WebhookIdentityType, } from './benefit-programs-v1-program-programs.universal.js';
+export { ActionEvent, CommonIdentificationData, CommonIdentificationDataIdOneOf, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DomainEvent, DomainEventBodyOneOf, EndProgramRequest, EndProgramResponse, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetProgramByExternalIdAndNamespaceOptions, GetProgramByExternalIdAndNamespaceRequest, GetProgramByExternalIdAndNamespaceResponse, GetProgramRequest, GetProgramResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, MessageEnvelope, OrderStatus, PauseProgramRequest, PauseProgramResponse, PoolDefinitionLookupId, PoolDefinitionLookupIdIdOneOf, Program, ProgramAlreadyExists, ProgramDefinitionInfo, ProgramEnded, ProgramPaused, ProgramProvisioned, ProgramRenewed, ProgramResumed, ProgramStatus, ProgramStatusTransitionNotAllowed, ProgramsQueryBuilder, ProgramsQueryResult, ProvisionProgramOptions, ProvisionProgramRequest, ProvisionProgramRequestProgramStatus, ProvisionProgramResponse, QueryProgramsRequest, QueryProgramsResponse, RenewProgramRequest, RenewProgramResponse, RestoreInfo, ResumeProgramRequest, ResumeProgramResponse, SortOrder, Sorting, UpdateProgram, UpdateProgramRequest, UpdateProgramResponse, UpdateProgramStatusRequest, UpdateProgramStatusResponse, UpsertMigratedProgramRequest, UpsertMigratedProgramResponse, WebhookIdentityType, } from './benefit-programs-v1-program-programs.universal.js';

package/build/es/src/benefit-programs-v1-program-programs.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-program-programs.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.public.ts"],"names":[],"mappings":"AACA,OAAO,EAoBL,UAAU,IAAI,mBAAmB,EACjC,UAAU,IAAI,mBAAmB,EACjC,kCAAkC,IAAI,2CAA2C,EACjF,YAAY,IAAI,qBAAqB,EACrC,gBAAgB,IAAI,yBAAyB,EAC7C,aAAa,IAAI,sBAAsB,EACvC,YAAY,IAAI,qBAAqB,EACrC,aAAa,IAAI,sBAAsB,EACvC,aAAa,IAAI,sBAAsB,GACxC,MAAM,qDAAqD,CAAC;AAE7D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,MAAM,UAAU,gBAAgB,CAC9B,UAAsB;IAEtB,OAAO,CACL,sBAA8C,EAC9C,OAAiC,EACjC,EAAE,CACF,yBAAyB,CACvB,sBAAsB,EACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAmBD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,qBAAqB,CACnB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,qBAAqB,CACnB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAYD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,sBAAsB,CACpB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,mBAAmB,CACjB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,GAAkB,EAAE,OAAsB,EAAE,EAAE,CACpD,sBAAsB,CACpB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAmBD,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,mBAAmB,CACjB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,GAAG,EAAE,CACV,sBAAsB;IACpB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAmBD,MAAM,UAAU,kCAAkC,CAChD,UAAsB;IAEtB,OAAO,CACL,SAAiB,EACjB,OAAkD,EAClD,EAAE,CACF,2CAA2C,CACzC,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,OAAO,EA2BL,YAAY,EAEZ,WAAW,EAeX,aAAa,EAMb,oCAAoC,EAapC,SAAS,EAUT,mBAAmB,GACpB,MAAM,qDAAqD,CAAC"}
+{"version":3,"file":"benefit-programs-v1-program-programs.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.public.ts"],"names":[],"mappings":"AACA,OAAO,EAaL,UAAU,IAAI,mBAAmB,EACjC,UAAU,IAAI,mBAAmB,EACjC,kCAAkC,IAAI,2CAA2C,EACjF,YAAY,IAAI,qBAAqB,EACrC,gBAAgB,IAAI,yBAAyB,EAC7C,aAAa,IAAI,sBAAsB,EACvC,YAAY,IAAI,qBAAqB,EACrC,aAAa,IAAI,sBAAsB,EACvC,aAAa,IAAI,sBAAsB,GACxC,MAAM,qDAAqD,CAAC;AAE7D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,MAAM,UAAU,gBAAgB,CAC9B,UAAsB;IAEtB,OAAO,CACL,sBAA8C,EAC9C,OAGC,EACD,EAAE,CACF,yBAAyB,CACvB,sBAAsB,EACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,qBAAqB,CACnB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAYD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,qBAAqB,CACnB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,sBAAsB,CACpB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAYD,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,mBAAmB,CACjB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAUD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,GAAW,EAAE,OAAoD,EAAE,EAAE,CAC3E,sBAAsB,CACpB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAiBD,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,mBAAmB,CACjB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,aAAa,CAAC,UAAsB;IAClD,OAAO,GAAG,EAAE,CACV,sBAAsB;IACpB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAmBD,MAAM,UAAU,kCAAkC,CAChD,UAAsB;IAEtB,OAAO,CACL,SAAiB,EACjB,OAGC,EACD,EAAE,CACF,2CAA2C,CACzC,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAaD,OAAO,EAwBL,YAAY,EAEZ,WAAW,EAaX,aAAa,EAMb,oCAAoC,EASpC,SAAS,EAST,mBAAmB,GACpB,MAAM,qDAAqD,CAAC"}

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

@@ -50,10 +50,11 @@ export interface Program {
      */
     displayName?: string | null;
     /**
-     * Namespace for your app or site's benefit programs.
+     * 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
      * @maxLength 50
      * @immutable
+     * @readonly
      */
     namespace?: string | null;
     /**
@@ -66,6 +67,7 @@ export interface Program {
      * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
+     * @readonly
      */
     externalId?: string | null;
     /**
@@ -83,13 +85,13 @@ export declare enum ProgramStatus {
     PAUSED = "PAUSED",
     /** Program has ended. It can't be resumed. */
     ENDED = "ENDED",
-    /** Program is being activated for the first time. This status will be true for a negligible amount of time. */
+    /** Program is being activated for the first time. This status exists for a short time during processing. */
     PROVISIONING = "PROVISIONING",
-    /** Program is being paused. This status will be true for a negligible amount of time. */
+    /** Program is being paused. This status exists for a short time during processing. */
     PAUSING = "PAUSING",
-    /** Program is being re-activated after being paused. This status will be true for a negligible amount of time. */
+    /** Program is being re-activated after being paused. This status exists for a short time during processing. */
     RESUMING = "RESUMING",
-    /** Program is being ended. This status will be true for a negligible amount of time. */
+    /** Program is being ended. This status exists for a short time during processing. */
     ENDING = "ENDING"
 }
 export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
@@ -195,7 +197,7 @@ export interface ProvisionProgramRequest {
      */
     programStatus?: ProvisionProgramRequestProgramStatus;
     /**
-     * Namespace for your app or site's benefit programs.
+     * 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
      * @maxLength 50
      */
@@ -203,7 +205,7 @@ export interface ProvisionProgramRequest {
     /**
      * Program name.
      *
-     * If you're provisioning the program from a program definition, you may want to use the same name that used for the program definition.
+     * If you're provisioning the program from a program definition, you may want to use the same name that was used for the program definition.
      * @maxLength 64
      */
     displayName?: string | null;
@@ -246,7 +248,7 @@ export declare enum ProvisionProgramRequestProgramStatus {
 }
 export interface ProvisionProgramResponse {
     /**
-     * Job ID of the provisioning of the program.
+     * Job ID of the provisioning of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -275,7 +277,7 @@ export interface RenewProgramRequest {
 }
 export interface RenewProgramResponse {
     /**
-     * Job ID of the program renewal.
+     * Job ID of the program renewal. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -289,7 +291,7 @@ export interface PauseProgramRequest {
 }
 export interface PauseProgramResponse {
     /**
-     * Job ID of the pausing of the program.
+     * Job ID of the pausing of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -309,7 +311,7 @@ export interface ResumeProgramRequest {
 }
 export interface ResumeProgramResponse {
     /**
-     * Job ID of the resuming of the program.
+     * Job ID of the resuming of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -323,7 +325,7 @@ export interface EndProgramRequest {
 }
 export interface EndProgramResponse {
     /**
-     * Job ID of the ending of the program.
+     * Job ID of the ending of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -489,7 +491,7 @@ export interface Cursors {
 }
 export interface GetProgramByExternalIdAndNamespaceRequest {
     /**
-     * Namespace for your app or site's benefit programs.
+     * 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
      * @maxLength 50
      */
@@ -646,47 +648,3 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface CommonIdentificationDataNonNullableFields {
-    anonymousVisitorId: string;
-    memberId: string;
-    wixUserId: string;
-    identityType: IdentityType;
-}
-interface ProgramDefinitionInfoNonNullableFields {
-    id: string;
-}
-interface ProgramNonNullableFields {
-    status: ProgramStatus;
-    beneficiary?: CommonIdentificationDataNonNullableFields;
-    programDefinition?: ProgramDefinitionInfoNonNullableFields;
-    targetStatus: ProgramStatus;
-}
-export interface ProvisionProgramResponseNonNullableFields {
-    jobId: string;
-    program?: ProgramNonNullableFields;
-}
-export interface RenewProgramResponseNonNullableFields {
-    jobId: string;
-}
-export interface PauseProgramResponseNonNullableFields {
-    jobId: string;
-}
-export interface ResumeProgramResponseNonNullableFields {
-    jobId: string;
-}
-export interface EndProgramResponseNonNullableFields {
-    jobId: string;
-}
-export interface UpdateProgramResponseNonNullableFields {
-    program?: ProgramNonNullableFields;
-}
-export interface GetProgramResponseNonNullableFields {
-    program?: ProgramNonNullableFields;
-}
-export interface QueryProgramsResponseNonNullableFields {
-    programs: ProgramNonNullableFields[];
-}
-export interface GetProgramByExternalIdAndNamespaceResponseNonNullableFields {
-    program?: ProgramNonNullableFields;
-}
-export {};

package/build/es/src/benefit-programs-v1-program-programs.types.js

@@ -8,13 +8,13 @@ export var ProgramStatus;
     ProgramStatus["PAUSED"] = "PAUSED";
     /** Program has ended. It can't be resumed. */
     ProgramStatus["ENDED"] = "ENDED";
-    /** Program is being activated for the first time. This status will be true for a negligible amount of time. */
+    /** Program is being activated for the first time. This status exists for a short time during processing. */
     ProgramStatus["PROVISIONING"] = "PROVISIONING";
-    /** Program is being paused. This status will be true for a negligible amount of time. */
+    /** Program is being paused. This status exists for a short time during processing. */
     ProgramStatus["PAUSING"] = "PAUSING";
-    /** Program is being re-activated after being paused. This status will be true for a negligible amount of time. */
+    /** Program is being re-activated after being paused. This status exists for a short time during processing. */
     ProgramStatus["RESUMING"] = "RESUMING";
-    /** Program is being ended. This status will be true for a negligible amount of time. */
+    /** Program is being ended. This status exists for a short time during processing. */
     ProgramStatus["ENDING"] = "ENDING";
 })(ProgramStatus || (ProgramStatus = {}));
 export var IdentityType;

package/build/es/src/benefit-programs-v1-program-programs.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-program-programs.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.types.ts"],"names":[],"mappings":"AA6EA,MAAM,CAAN,IAAY,aAiBX;AAjBD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,yBAAyB;IACzB,kCAAiB,CAAA;IACjB,4CAA4C;IAC5C,kCAAiB,CAAA;IACjB,8CAA8C;IAC9C,gCAAe,CAAA;IACf,+GAA+G;IAC/G,8CAA6B,CAAA;IAC7B,yFAAyF;IACzF,oCAAmB,CAAA;IACnB,kHAAkH;IAClH,sCAAqB,CAAA;IACrB,wFAAwF;IACxF,kCAAiB,CAAA;AACnB,CAAC,EAjBW,aAAa,KAAb,aAAa,QAiBxB;AAwCD,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,4CAA4C;IAC5C,mCAAmB,CAAA;IACnB,4CAA4C;IAC5C,uDAAuC,CAAA;IACvC,+BAA+B;IAC/B,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AAiHD,MAAM,CAAN,IAAY,oCAKX;AALD,WAAY,oCAAoC;IAC9C,yBAAyB;IACzB,yDAAiB,CAAA;IACjB,yBAAyB;IACzB,yDAAiB,CAAA;AACnB,CAAC,EALW,oCAAoC,KAApC,oCAAoC,QAK/C;AA6ID,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;AACjB,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAuED,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAwND,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-programs.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.types.ts"],"names":[],"mappings":"AA+EA,MAAM,CAAN,IAAY,aAiBX;AAjBD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,yBAAyB;IACzB,kCAAiB,CAAA;IACjB,4CAA4C;IAC5C,kCAAiB,CAAA;IACjB,8CAA8C;IAC9C,gCAAe,CAAA;IACf,4GAA4G;IAC5G,8CAA6B,CAAA;IAC7B,sFAAsF;IACtF,oCAAmB,CAAA;IACnB,+GAA+G;IAC/G,sCAAqB,CAAA;IACrB,qFAAqF;IACrF,kCAAiB,CAAA;AACnB,CAAC,EAjBW,aAAa,KAAb,aAAa,QAiBxB;AAwCD,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,4CAA4C;IAC5C,mCAAmB,CAAA;IACnB,4CAA4C;IAC5C,uDAAuC,CAAA;IACvC,+BAA+B;IAC/B,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AAiHD,MAAM,CAAN,IAAY,oCAKX;AALD,WAAY,oCAAoC;IAC9C,yBAAyB;IACzB,yDAAiB,CAAA;IACjB,yBAAyB;IACzB,yDAAiB,CAAA;AACnB,CAAC,EALW,oCAAoC,KAApC,oCAAoC,QAK/C;AA6ID,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;AACjB,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAuED,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAwND,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-programs.universal.d.ts

@@ -1,3 +1,4 @@
+import { NonNullablePaths } from '@wix/sdk-types';
 export interface Program {
     /**
      * Program ID.
@@ -50,10 +51,11 @@ export interface Program {
      */
     displayName?: string | null;
     /**
-     * Namespace for your app or site's benefit programs.
+     * 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
      * @maxLength 50
      * @immutable
+     * @readonly
      */
     namespace?: string | null;
     /**
@@ -66,6 +68,7 @@ export interface Program {
      * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
+     * @readonly
      */
     externalId?: string | null;
     /**
@@ -83,13 +86,13 @@ export declare enum ProgramStatus {
     PAUSED = "PAUSED",
     /** Program has ended. It can't be resumed. */
     ENDED = "ENDED",
-    /** Program is being activated for the first time. This status will be true for a negligible amount of time. */
+    /** Program is being activated for the first time. This status exists for a short time during processing. */
     PROVISIONING = "PROVISIONING",
-    /** Program is being paused. This status will be true for a negligible amount of time. */
+    /** Program is being paused. This status exists for a short time during processing. */
     PAUSING = "PAUSING",
-    /** Program is being re-activated after being paused. This status will be true for a negligible amount of time. */
+    /** Program is being re-activated after being paused. This status exists for a short time during processing. */
     RESUMING = "RESUMING",
-    /** Program is being ended. This status will be true for a negligible amount of time. */
+    /** Program is being ended. This status exists for a short time during processing. */
     ENDING = "ENDING"
 }
 export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
@@ -195,7 +198,7 @@ export interface ProvisionProgramRequest {
      */
     programStatus?: ProvisionProgramRequestProgramStatus;
     /**
-     * Namespace for your app or site's benefit programs.
+     * 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
      * @maxLength 50
      */
@@ -203,7 +206,7 @@ export interface ProvisionProgramRequest {
     /**
      * Program name.
      *
-     * If you're provisioning the program from a program definition, you may want to use the same name that used for the program definition.
+     * If you're provisioning the program from a program definition, you may want to use the same name that was used for the program definition.
      * @maxLength 64
      */
     displayName?: string | null;
@@ -246,7 +249,7 @@ export declare enum ProvisionProgramRequestProgramStatus {
 }
 export interface ProvisionProgramResponse {
     /**
-     * Job ID of the provisioning of the program.
+     * Job ID of the provisioning of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -275,7 +278,7 @@ export interface RenewProgramRequest {
 }
 export interface RenewProgramResponse {
     /**
-     * Job ID of the program renewal.
+     * Job ID of the program renewal. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -289,7 +292,7 @@ export interface PauseProgramRequest {
 }
 export interface PauseProgramResponse {
     /**
-     * Job ID of the pausing of the program.
+     * Job ID of the pausing of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -309,7 +312,7 @@ export interface ResumeProgramRequest {
 }
 export interface ResumeProgramResponse {
     /**
-     * Job ID of the resuming of the program.
+     * Job ID of the resuming of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -323,7 +326,7 @@ export interface EndProgramRequest {
 }
 export interface EndProgramResponse {
     /**
-     * Job ID of the ending of the program.
+     * Job ID of the ending of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
      * @format GUID
      */
     jobId?: string;
@@ -489,7 +492,7 @@ export interface Cursors {
 }
 export interface GetProgramByExternalIdAndNamespaceRequest {
     /**
-     * Namespace for your app or site's benefit programs.
+     * 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
      * @maxLength 50
      */
@@ -644,55 +647,13 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface CommonIdentificationDataNonNullableFields {
-    anonymousVisitorId: string;
-    memberId: string;
-    wixUserId: string;
-    identityType: IdentityType;
-}
-interface ProgramDefinitionInfoNonNullableFields {
-    _id: string;
-}
-export interface ProgramNonNullableFields {
-    status: ProgramStatus;
-    beneficiary?: CommonIdentificationDataNonNullableFields;
-    programDefinition?: ProgramDefinitionInfoNonNullableFields;
-    targetStatus: ProgramStatus;
-}
-export interface ProvisionProgramResponseNonNullableFields {
-    jobId: string;
-    program?: ProgramNonNullableFields;
-}
-export interface RenewProgramResponseNonNullableFields {
-    jobId: string;
-}
-export interface PauseProgramResponseNonNullableFields {
-    jobId: string;
-}
-export interface ResumeProgramResponseNonNullableFields {
-    jobId: string;
-}
-export interface EndProgramResponseNonNullableFields {
-    jobId: string;
-}
-export interface UpdateProgramResponseNonNullableFields {
-    program?: ProgramNonNullableFields;
-}
-export interface GetProgramResponseNonNullableFields {
-    program?: ProgramNonNullableFields;
-}
-export interface QueryProgramsResponseNonNullableFields {
-    programs: ProgramNonNullableFields[];
-}
-export interface GetProgramByExternalIdAndNamespaceResponseNonNullableFields {
-    program?: ProgramNonNullableFields;
-}
+type ProgramNonNullablePaths = `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `programDefinition._id`;
 /**
  * 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 program has pools that are created from the pool definitions in the program definition.
- * - **Pool definition**: The program has 1 pool that is created from the pool definition.
+ * - **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
@@ -706,7 +667,9 @@ export interface GetProgramByExternalIdAndNamespaceResponseNonNullableFields {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program.ProgramService.ProvisionProgram
  */
-export declare function provisionProgram(poolDefinitionLookupId: PoolDefinitionLookupId, options?: ProvisionProgramOptions): Promise<ProvisionProgramResponse & ProvisionProgramResponseNonNullableFields>;
+export declare function provisionProgram(poolDefinitionLookupId: PoolDefinitionLookupId, options?: NonNullablePaths<ProvisionProgramOptions, `beneficiary` | `externalProgramId` | `namespace`>): Promise<NonNullablePaths<ProvisionProgramResponse, `jobId` | {
+    [P in ProgramNonNullablePaths]: `program.${P}`;
+}[ProgramNonNullablePaths]>>;
 export interface ProvisionProgramOptions {
     /** Program beneficiary. */
     beneficiary: CommonIdentificationData;
@@ -717,7 +680,7 @@ export interface ProvisionProgramOptions {
      */
     programStatus?: ProvisionProgramRequestProgramStatus;
     /**
-     * Namespace for your app or site's benefit programs.
+     * 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
      * @maxLength 50
      */
@@ -725,7 +688,7 @@ export interface ProvisionProgramOptions {
     /**
      * Program name.
      *
-     * If you're provisioning the program from a program definition, you may want to use the same name that used for the program definition.
+     * If you're provisioning the program from a program definition, you may want to use the same name that was used for the program definition.
      * @maxLength 64
      */
     displayName?: string | null;
@@ -738,7 +701,7 @@ export interface ProvisionProgramOptions {
 /**
  * Renews the specified program.
  *
- * Balances are handled for each pool in the program as defined in the pool's credit configuration.
+ * 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
@@ -749,7 +712,7 @@ export interface ProvisionProgramOptions {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program.ProgramService.RenewProgram
  */
-export declare function renewProgram(programId: string): Promise<RenewProgramResponse & RenewProgramResponseNonNullableFields>;
+export declare function renewProgram(programId: string): Promise<NonNullablePaths<RenewProgramResponse, `jobId`>>;
 /**
  * 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.
@@ -762,7 +725,7 @@ export declare function renewProgram(programId: string): Promise<RenewProgramRes
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program.ProgramService.PauseProgram
  */
-export declare function pauseProgram(programId: string): Promise<PauseProgramResponse & PauseProgramResponseNonNullableFields>;
+export declare function pauseProgram(programId: string): Promise<NonNullablePaths<PauseProgramResponse, `jobId`>>;
 /**
  * Resumes the specified program.
  *
@@ -777,11 +740,9 @@ export declare function pauseProgram(programId: string): Promise<PauseProgramRes
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program.ProgramService.ResumeProgram
  */
-export declare function resumeProgram(programId: string): Promise<ResumeProgramResponse & ResumeProgramResponseNonNullableFields>;
+export declare function resumeProgram(programId: string): Promise<NonNullablePaths<ResumeProgramResponse, `jobId`>>;
 /**
  * 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
@@ -792,7 +753,7 @@ export declare function resumeProgram(programId: string): Promise<ResumeProgramR
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program.ProgramService.EndProgram
  */
-export declare function endProgram(programId: string): Promise<EndProgramResponse & EndProgramResponseNonNullableFields>;
+export declare function endProgram(programId: string): Promise<NonNullablePaths<EndProgramResponse, `jobId`>>;
 /**
  * Updates a program.
  *
@@ -814,7 +775,7 @@ export declare function endProgram(programId: string): Promise<EndProgramRespons
  * @returns Updated program.
  * @fqn wix.benefit_programs.v1.program.ProgramService.UpdateProgram
  */
-export declare function updateProgram(_id: string | null, program: UpdateProgram): Promise<Program & ProgramNonNullableFields>;
+export declare function updateProgram(_id: string, program: NonNullablePaths<UpdateProgram, `revision`>): Promise<NonNullablePaths<Program, ProgramNonNullablePaths>>;
 export interface UpdateProgram {
     /**
      * Program ID.
@@ -867,10 +828,11 @@ export interface UpdateProgram {
      */
     displayName?: string | null;
     /**
-     * Namespace for your app or site's benefit programs.
+     * 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
      * @maxLength 50
      * @immutable
+     * @readonly
      */
     namespace?: string | null;
     /**
@@ -883,6 +845,7 @@ export interface UpdateProgram {
      * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
+     * @readonly
      */
     externalId?: string | null;
     /**
@@ -908,7 +871,7 @@ export interface UpdateProgram {
  * @returns Retrieved program.
  * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgram
  */
-export declare function getProgram(programId: string): Promise<Program & ProgramNonNullableFields>;
+export declare function getProgram(programId: string): Promise<NonNullablePaths<Program, ProgramNonNullablePaths>>;
 /**
  * Creates a query to retrieve a list of programs.
  *
@@ -1013,7 +976,7 @@ export interface ProgramsQueryBuilder {
 }
 /**
  * Retrieves a program with the specified external ID and namespace.
- * @param namespace - Namespace for your app or site's benefit programs.
+ * @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
@@ -1029,7 +992,9 @@ export interface ProgramsQueryBuilder {
  * @applicableIdentity APP
  * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgramByExternalIdAndNamespace
  */
-export declare function getProgramByExternalIdAndNamespace(namespace: string, options: GetProgramByExternalIdAndNamespaceOptions): Promise<GetProgramByExternalIdAndNamespaceResponse & GetProgramByExternalIdAndNamespaceResponseNonNullableFields>;
+export declare function getProgramByExternalIdAndNamespace(namespace: string, options: NonNullablePaths<GetProgramByExternalIdAndNamespaceOptions, `externalId`>): Promise<NonNullablePaths<GetProgramByExternalIdAndNamespaceResponse, {
+    [P in ProgramNonNullablePaths]: `program.${P}`;
+}[ProgramNonNullablePaths]>>;
 export interface GetProgramByExternalIdAndNamespaceOptions {
     /**
      * Program's external ID.