@wix/auto_sdk_benefit-programs_programs 1.0.9 → 1.0.10

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

@@ -0,0 +1 @@
+{"version":3,"file":"benefit-programs-v1-program-programs.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.types.ts"],"names":[],"mappings":";;;AA+EA,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,6BAAb,aAAa,QAiBxB;AAwCD,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,4BAAZ,YAAY,QASvB;AAiHD,IAAY,oCAKX;AALD,WAAY,oCAAoC;IAC9C,yBAAyB;IACzB,yDAAiB,CAAA;IACjB,yBAAyB;IACzB,yDAAiB,CAAA;AACnB,CAAC,EALW,oCAAoC,oDAApC,oCAAoC,QAK/C;AA6ID,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;AACjB,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAuED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAwND,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/build/{benefit-programs-v1-program-programs.universal-D8MzGxN_.d.mts → cjs/src/benefit-programs-v1-program-programs.universal.d.ts}

@@ -1,4 +1,5 @@
-interface Program {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface Program {
     /**
      * Program ID.
      * @format GUID
@@ -76,7 +77,7 @@ interface Program {
      */
     programDefinition?: ProgramDefinitionInfo;
 }
-declare enum ProgramStatus {
+export declare enum ProgramStatus {
     /** Undefined program status. */
     UNDEFINED = "UNDEFINED",
     /** Program is active. */
@@ -94,7 +95,7 @@ declare enum ProgramStatus {
     /** Program is being ended. This status exists for a short time during processing. */
     ENDING = "ENDING"
 }
-interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -112,7 +113,7 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     wixUserId?: string;
 }
 /** @oneof */
-interface CommonIdentificationDataIdOneOf {
+export interface CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -129,7 +130,7 @@ interface CommonIdentificationDataIdOneOf {
      */
     wixUserId?: string;
 }
-declare enum IdentityType {
+export declare enum IdentityType {
     /** Unknown type. This value is not used. */
     UNKNOWN = "UNKNOWN",
     /** A site visitor who has not logged in. */
@@ -139,7 +140,7 @@ declare enum IdentityType {
     /** A Wix account holder, such as a site owner or contributor. */
     WIX_USER = "WIX_USER"
 }
-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.
@@ -150,7 +151,7 @@ interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-interface ProgramDefinitionInfo {
+export interface ProgramDefinitionInfo {
     /**
      * Program definition ID.
      * @format GUID
@@ -164,28 +165,28 @@ interface ProgramDefinitionInfo {
      */
     externalId?: string | null;
 }
-interface ProgramProvisioned {
+export interface ProgramProvisioned {
     /** Program which has been provisioned */
     program?: Program;
 }
-interface ProgramRenewed {
+export interface ProgramRenewed {
     /** Program which has been renewed */
     program?: Program;
 }
-interface ProgramEnded {
+export interface ProgramEnded {
     /** Program which has been ended */
     program?: Program;
 }
-interface ProgramPaused {
+export interface ProgramPaused {
     /** Program which has been paused */
     program?: Program;
 }
-interface ProgramResumed {
+export interface ProgramResumed {
     /** Program which has been resumed */
     program?: Program;
 }
 /** In case pool_definition_id is provided should test if it's part of a package. If it is, reject the request */
-interface ProvisionProgramRequest {
+export interface ProvisionProgramRequest {
     /** The program definition or pool definition to use to provision the program. */
     poolDefinitionLookupId: PoolDefinitionLookupId;
     /** Program beneficiary. */
@@ -215,7 +216,7 @@ interface ProvisionProgramRequest {
      */
     externalProgramId: string;
 }
-interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
+export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
     /**
      * Pool definition ID.
      * @format GUID
@@ -228,7 +229,7 @@ interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
     programDefinitionId?: string;
 }
 /** @oneof */
-interface PoolDefinitionLookupIdIdOneOf {
+export interface PoolDefinitionLookupIdIdOneOf {
     /**
      * Pool definition ID.
      * @format GUID
@@ -240,13 +241,13 @@ interface PoolDefinitionLookupIdIdOneOf {
      */
     programDefinitionId?: string;
 }
-declare enum ProvisionProgramRequestProgramStatus {
+export declare enum ProvisionProgramRequestProgramStatus {
     /** Program is active. */
     ACTIVE = "ACTIVE",
     /** Program is paused. */
     PAUSED = "PAUSED"
 }
-interface ProvisionProgramResponse {
+export interface ProvisionProgramResponse {
     /**
      * 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
@@ -255,7 +256,7 @@ interface ProvisionProgramResponse {
     /** Provisioned program. */
     program?: Program;
 }
-interface ProgramAlreadyExists {
+export interface ProgramAlreadyExists {
     /**
      * Key of a program that already exists
      * @format GUID
@@ -268,69 +269,69 @@ interface ProgramAlreadyExists {
     namespace?: string;
 }
 /** Updates the pool credit amount according to the configuration. */
-interface RenewProgramRequest {
+export interface RenewProgramRequest {
     /**
      * ID of the program to renew.
      * @format GUID
      */
     programId: string;
 }
-interface RenewProgramResponse {
+export interface RenewProgramResponse {
     /**
      * 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;
 }
-interface PauseProgramRequest {
+export interface PauseProgramRequest {
     /**
      * ID of the program to pause.
      * @format GUID
      */
     programId: string;
 }
-interface PauseProgramResponse {
+export interface PauseProgramResponse {
     /**
      * 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;
 }
-interface ProgramStatusTransitionNotAllowed {
+export interface ProgramStatusTransitionNotAllowed {
     /** Current status of the program */
     currentStatus?: ProgramStatus;
     /** Status to which the program is being transitioned */
     requestedStatus?: ProgramStatus;
 }
-interface ResumeProgramRequest {
+export interface ResumeProgramRequest {
     /**
      * ID of program to resume.
      * @format GUID
      */
     programId: string;
 }
-interface ResumeProgramResponse {
+export interface ResumeProgramResponse {
     /**
      * 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;
 }
-interface EndProgramRequest {
+export interface EndProgramRequest {
     /**
      * ID of the program to end.
      * @format GUID
      */
     programId: string;
 }
-interface EndProgramResponse {
+export interface EndProgramResponse {
     /**
      * 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;
 }
-interface UpdateProgramStatusRequest {
+export interface UpdateProgramStatusRequest {
     /**
      * Program to update
      * @format GUID
@@ -343,11 +344,11 @@ interface UpdateProgramStatusRequest {
     /** Status to update */
     targetStatus?: ProgramStatus;
 }
-interface UpdateProgramStatusResponse {
+export interface UpdateProgramStatusResponse {
     /** The updated Program */
     program?: Program;
 }
-interface UpsertMigratedProgramRequest {
+export interface UpsertMigratedProgramRequest {
     /**
      * Order id
      * @format GUID
@@ -371,40 +372,40 @@ interface UpsertMigratedProgramRequest {
      */
     planName?: string;
 }
-declare enum OrderStatus {
+export declare enum OrderStatus {
     UNKNOWN = "UNKNOWN",
     ACTIVE = "ACTIVE",
     PAUSED = "PAUSED",
     ENDED = "ENDED"
 }
-interface UpsertMigratedProgramResponse {
+export interface UpsertMigratedProgramResponse {
     /** Inserted or updated program */
     program?: Program;
 }
-interface UpdateProgramRequest {
+export interface UpdateProgramRequest {
     /** Program to update. */
     program: Program;
 }
-interface UpdateProgramResponse {
+export interface UpdateProgramResponse {
     /** Updated program. */
     program?: Program;
 }
-interface GetProgramRequest {
+export interface GetProgramRequest {
     /**
      * ID of the program to retrieve.
      * @format GUID
      */
     programId: string;
 }
-interface GetProgramResponse {
+export interface GetProgramResponse {
     /** Retrieved program. */
     program?: Program;
 }
-interface QueryProgramsRequest {
+export interface QueryProgramsRequest {
     /** 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;
     /**
@@ -420,11 +421,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
@@ -437,13 +438,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
@@ -458,13 +459,13 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryProgramsResponse {
+export interface QueryProgramsResponse {
     /** List of retrieved programs. */
     programs?: Program[];
     /** 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. */
@@ -477,7 +478,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
@@ -489,7 +490,7 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface GetProgramByExternalIdAndNamespaceRequest {
+export interface GetProgramByExternalIdAndNamespaceRequest {
     /**
      * 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
@@ -502,11 +503,11 @@ interface GetProgramByExternalIdAndNamespaceRequest {
      */
     externalId: string;
 }
-interface GetProgramByExternalIdAndNamespaceResponse {
+export interface GetProgramByExternalIdAndNamespaceResponse {
     /** Retrieved program. */
     program?: Program;
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -549,19 +550,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.
@@ -569,14 +570,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
@@ -592,7 +593,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
@@ -617,7 +618,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
@@ -639,14 +640,37 @@ 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 ProvisionProgramOptions {
+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 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.ProvisionProgram
+ */
+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;
     /**
@@ -674,7 +698,85 @@ interface ProvisionProgramOptions {
      */
     externalProgramId: string;
 }
-interface UpdateProgram {
+/**
+ * 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 programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_RENEW
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.RenewProgram
+ */
+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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_PAUSE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.PauseProgram
+ */
+export declare function pauseProgram(programId: string): Promise<NonNullablePaths<PauseProgramResponse, `jobId`>>;
+/**
+ * Resumes the specified program.
+ *
+ * Call this method for paused programs.
+ * @param programId - ID of program to resume.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_RESUME
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.ResumeProgram
+ */
+export declare function resumeProgram(programId: string): Promise<NonNullablePaths<ResumeProgramResponse, `jobId`>>;
+/**
+ * Ends the specified program.
+ * @param programId - ID of the program to end.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_END
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.EndProgram
+ */
+export declare function endProgram(programId: string): Promise<NonNullablePaths<EndProgramResponse, `jobId`>>;
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @applicableIdentity APP
+ * @returns Updated program.
+ * @fqn wix.benefit_programs.v1.program.ProgramService.UpdateProgram
+ */
+export declare function updateProgram(_id: string, program: NonNullablePaths<UpdateProgram, `revision`>): Promise<NonNullablePaths<Program, ProgramNonNullablePaths>>;
+export interface UpdateProgram {
     /**
      * Program ID.
      * @format GUID
@@ -752,6 +854,49 @@ 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
+ * @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
+ * @returns Retrieved program.
+ * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgram
+ */
+export declare function getProgram(programId: string): Promise<NonNullablePaths<Program, ProgramNonNullablePaths>>;
+/**
+ * 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
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
+ * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
+ * @applicableIdentity APP
+ * @fqn wix.benefit_programs.v1.program.ProgramService.QueryPrograms
+ */
+export declare function queryPrograms(): ProgramsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -759,13 +904,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface ProgramsQueryResult extends QueryCursorResult {
+export interface ProgramsQueryResult extends QueryCursorResult {
     items: Program[];
     query: ProgramsQueryBuilder;
     next: () => Promise<ProgramsQueryResult>;
     prev: () => Promise<ProgramsQueryResult>;
 }
-interface ProgramsQueryBuilder {
+export interface ProgramsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -829,12 +974,32 @@ interface ProgramsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<ProgramsQueryResult>;
 }
-interface GetProgramByExternalIdAndNamespaceOptions {
+/**
+ * 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
+ * @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
+ * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgramByExternalIdAndNamespace
+ */
+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.
      * @format GUID
      */
     externalId: string;
 }
-
-export { type DomainEventBodyOneOf as $, type UpdateProgramStatusResponse as A, type UpsertMigratedProgramRequest as B, type CommonIdentificationData as C, type UpsertMigratedProgramResponse as D, type EndProgramResponse as E, type UpdateProgramRequest as F, type GetProgramByExternalIdAndNamespaceOptions as G, type UpdateProgramResponse as H, IdentityType as I, type GetProgramRequest as J, type GetProgramResponse as K, type CursorQuery as L, type CursorQueryPagingMethodOneOf as M, type Sorting as N, OrderStatus as O, type PoolDefinitionLookupId as P, type QueryProgramsRequest as Q, type RenewProgramResponse as R, SortOrder as S, type CursorPaging as T, type UpdateProgram as U, type QueryProgramsResponse as V, WebhookIdentityType as W, type CursorPagingMetadata as X, type Cursors as Y, type GetProgramByExternalIdAndNamespaceRequest as Z, type DomainEvent as _, type ProvisionProgramOptions as a, type EntityCreatedEvent as a0, type RestoreInfo as a1, type EntityUpdatedEvent as a2, type EntityDeletedEvent as a3, type ActionEvent as a4, type MessageEnvelope as a5, type IdentificationData as a6, type IdentificationDataIdOneOf as a7, type ProgramsQueryResult as a8, type ProvisionProgramResponse as b, type PauseProgramResponse as c, type ResumeProgramResponse as d, type Program as e, type ProgramsQueryBuilder as f, type GetProgramByExternalIdAndNamespaceResponse as g, ProgramStatus as h, ProvisionProgramRequestProgramStatus as i, type CommonIdentificationDataIdOneOf as j, type ExtendedFields as k, type ProgramDefinitionInfo as l, type ProgramProvisioned as m, type ProgramRenewed as n, type ProgramEnded as o, type ProgramPaused as p, type ProgramResumed as q, type ProvisionProgramRequest as r, type PoolDefinitionLookupIdIdOneOf as s, type ProgramAlreadyExists as t, type RenewProgramRequest as u, type PauseProgramRequest as v, type ProgramStatusTransitionNotAllowed as w, type ResumeProgramRequest as x, type EndProgramRequest as y, type UpdateProgramStatusRequest as z };
+export {};