@wix/auto_sdk_benefit-programs_programs 1.0.0

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

@@ -0,0 +1,109 @@
+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';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function provisionProgram(httpClient: HttpClient): ProvisionProgramSignature;
+interface ProvisionProgramSignature {
+    /**
+     * Creates active programs consisting of benefits derived from their underlying program definitions and pool definitions.
+     * @param - Used to locate the pool definition for creating its benefit pools within the program.
+     *
+     * This object must contain either `programDefinitionId` or `poolDefinitionId`:
+     * + Use `programDefinitionId` for programs with multiple benefit pools.
+     * + Use `poolDefinitionId` for a program with just 1 benefit pool.
+     */
+    (poolDefinitionLookupId: PoolDefinitionLookupId, options?: ProvisionProgramOptions | undefined): Promise<ProvisionProgramResponse & ProvisionProgramResponseNonNullableFields>;
+}
+export declare function renewProgram(httpClient: HttpClient): RenewProgramSignature;
+interface RenewProgramSignature {
+    /**
+     * Updates the benefit pools within a program.
+     *
+     * Adjusts each pool in the program according to its unique credit configuration as specified in the pool definition.
+     *
+     * Use this method to reset each benefit pool renewal cycle.
+     * @param - ID of the program to renew.
+     */
+    (programId: string): Promise<RenewProgramResponse & RenewProgramResponseNonNullableFields>;
+}
+export declare function pauseProgram(httpClient: HttpClient): PauseProgramSignature;
+interface PauseProgramSignature {
+    /**
+     * Pauses the benefit pools within a program.
+     *
+     * Changes the program status to `PAUSED`, preventing the redemption or reservation of benefits.
+     * @param - ID of the program to pause.
+     */
+    (programId: string): Promise<PauseProgramResponse & PauseProgramResponseNonNullableFields>;
+}
+export declare function resumeProgram(httpClient: HttpClient): ResumeProgramSignature;
+interface ResumeProgramSignature {
+    /**
+     * Resumes the benefit pools within a program.
+     *
+     * Changes the program status to `ACTIVE`, allowing the redemption or reservation of benefits to continue.
+     * @param - ID of program to resume.
+     */
+    (programId: string): Promise<ResumeProgramResponse & ResumeProgramResponseNonNullableFields>;
+}
+export declare function endProgram(httpClient: HttpClient): EndProgramSignature;
+interface EndProgramSignature {
+    /**
+     * Prevents the benefit pools in the provided package from being redeemed or reserved.
+     *
+     * After ending a program, it can't be restarted.
+     * @param - Package of pools
+     */
+    (programId: string): Promise<EndProgramResponse & EndProgramResponseNonNullableFields>;
+}
+export declare function updateProgram(httpClient: HttpClient): UpdateProgramSignature;
+interface UpdateProgramSignature {
+    /**
+     * 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 - Program ID.
+     * @returns Updated program.
+     */
+    (_id: string | null, program: UpdateProgram): Promise<Program & ProgramNonNullableFields>;
+}
+export declare function getProgram(httpClient: HttpClient): GetProgramSignature;
+interface GetProgramSignature {
+    /**
+     * Retrieves a program.
+     * @param - ID of the program to retrieve.
+     * @returns Retrieved program.
+     */
+    (programId: string): Promise<Program & ProgramNonNullableFields>;
+}
+export declare function queryPrograms(httpClient: HttpClient): QueryProgramsSignature;
+interface QueryProgramsSignature {
+    /**
+     * Creates a query to retrieve a list of programs.
+     *
+     * The `queryPrograms()` 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()`](/programs/programs-query-builder/find) function.
+     *
+     * You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPrograms()` returns.
+     *
+     * The following `ProgramsQueryBuilder` functions are supported for `queryPrograms()`. For a full description of the program object, see the object returned for the [`items`](/programs/programs-query-result/items) property in `ProgramsQueryResult`.
+     */
+    (): ProgramsQueryBuilder;
+}
+export declare function getProgramByExternalIdAndNamespace(httpClient: HttpClient): GetProgramByExternalIdAndNamespaceSignature;
+interface GetProgramByExternalIdAndNamespaceSignature {
+    /**
+     * Retrieves a program by program external ID and corresponding namespace.
+     * @param - Application sub-module that is the source of the program creation.
+     *
+     * Use the namespace that was designated to the program definition.
+     */
+    (namespace: string, options: GetProgramByExternalIdAndNamespaceOptions): Promise<GetProgramByExternalIdAndNamespaceResponse & GetProgramByExternalIdAndNamespaceResponseNonNullableFields>;
+}
+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';

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

@@ -0,0 +1,49 @@
+import { endProgram as universalEndProgram, getProgram as universalGetProgram, getProgramByExternalIdAndNamespace as universalGetProgramByExternalIdAndNamespace, pauseProgram as universalPauseProgram, provisionProgram as universalProvisionProgram, queryPrograms as universalQueryPrograms, renewProgram as universalRenewProgram, resumeProgram as universalResumeProgram, updateProgram as universalUpdateProgram, } from './benefit-programs-v1-program-programs.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/benefit-programs' };
+export function provisionProgram(httpClient) {
+    return (poolDefinitionLookupId, options) => universalProvisionProgram(poolDefinitionLookupId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function renewProgram(httpClient) {
+    return (programId) => universalRenewProgram(programId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function pauseProgram(httpClient) {
+    return (programId) => universalPauseProgram(programId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function resumeProgram(httpClient) {
+    return (programId) => universalResumeProgram(programId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function endProgram(httpClient) {
+    return (programId) => universalEndProgram(programId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updateProgram(httpClient) {
+    return (_id, program) => universalUpdateProgram(_id, program, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getProgram(httpClient) {
+    return (programId) => universalGetProgram(programId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function queryPrograms(httpClient) {
+    return () => universalQueryPrograms(
+    // @ts-ignore
+    { httpClient });
+}
+export function getProgramByExternalIdAndNamespace(httpClient) {
+    return (namespace, options) => universalGetProgramByExternalIdAndNamespace(namespace, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export { IdentityType, OrderStatus, ProgramStatus, ProvisionProgramRequestProgramStatus, SortOrder, WebhookIdentityType, } from './benefit-programs-v1-program-programs.universal.js';
+//# sourceMappingURL=benefit-programs-v1-program-programs.public.js.map

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

@@ -0,0 +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;AAgBD,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,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;AAiBD,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;AAkBD,OAAO,EA2BL,YAAY,EAEZ,WAAW,EAeX,aAAa,EAMb,oCAAoC,EAapC,SAAS,EAUT,mBAAmB,GACpB,MAAM,qDAAqD,CAAC"}