@wix/auto_sdk_benefit-programs_programs 1.0.7 → 1.0.9

package/build/index.d.mts

@@ -0,0 +1,113 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { P as PoolDefinitionLookupId, a as ProvisionProgramOptions, b as ProvisionProgramResponse, R as RenewProgramResponse, c as PauseProgramResponse, d as ResumeProgramResponse, E as EndProgramResponse, U as UpdateProgram, e as Program, f as ProgramsQueryBuilder, G as GetProgramByExternalIdAndNamespaceOptions, g as GetProgramByExternalIdAndNamespaceResponse } from './benefit-programs-v1-program-programs.universal-D8MzGxN_.mjs';
+export { a4 as ActionEvent, C as CommonIdentificationData, j as CommonIdentificationDataIdOneOf, T as CursorPaging, X as CursorPagingMetadata, L as CursorQuery, M as CursorQueryPagingMethodOneOf, Y as Cursors, _ as DomainEvent, $ as DomainEventBodyOneOf, y as EndProgramRequest, a0 as EntityCreatedEvent, a3 as EntityDeletedEvent, a2 as EntityUpdatedEvent, k as ExtendedFields, Z as GetProgramByExternalIdAndNamespaceRequest, J as GetProgramRequest, K as GetProgramResponse, a6 as IdentificationData, a7 as IdentificationDataIdOneOf, I as IdentityType, a5 as MessageEnvelope, O as OrderStatus, v as PauseProgramRequest, s as PoolDefinitionLookupIdIdOneOf, t as ProgramAlreadyExists, l as ProgramDefinitionInfo, o as ProgramEnded, p as ProgramPaused, m as ProgramProvisioned, n as ProgramRenewed, q as ProgramResumed, h as ProgramStatus, w as ProgramStatusTransitionNotAllowed, a8 as ProgramsQueryResult, r as ProvisionProgramRequest, i as ProvisionProgramRequestProgramStatus, Q as QueryProgramsRequest, V as QueryProgramsResponse, u as RenewProgramRequest, a1 as RestoreInfo, x as ResumeProgramRequest, S as SortOrder, N as Sorting, F as UpdateProgramRequest, H as UpdateProgramResponse, z as UpdateProgramStatusRequest, A as UpdateProgramStatusResponse, B as UpsertMigratedProgramRequest, D as UpsertMigratedProgramResponse, W as WebhookIdentityType } from './benefit-programs-v1-program-programs.universal-D8MzGxN_.mjs';
+
+declare function provisionProgram$1(httpClient: HttpClient): ProvisionProgramSignature;
+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 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>;
+}
+declare function renewProgram$1(httpClient: HttpClient): RenewProgramSignature;
+interface RenewProgramSignature {
+    /**
+     * 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 - ID of the program to renew.
+     */
+    (programId: string): Promise<RenewProgramResponse>;
+}
+declare function pauseProgram$1(httpClient: HttpClient): PauseProgramSignature;
+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>;
+}
+declare function resumeProgram$1(httpClient: HttpClient): ResumeProgramSignature;
+interface ResumeProgramSignature {
+    /**
+     * Resumes the specified program.
+     *
+     * Call this method for paused programs.
+     * @param - ID of program to resume.
+     */
+    (programId: string): Promise<ResumeProgramResponse>;
+}
+declare function endProgram$1(httpClient: HttpClient): EndProgramSignature;
+interface EndProgramSignature {
+    /**
+     * Ends the specified program.
+     * @param - ID of the program to end.
+     */
+    (programId: string): Promise<EndProgramResponse>;
+}
+declare function updateProgram$1(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, program: UpdateProgram): Promise<Program>;
+}
+declare function getProgram$1(httpClient: HttpClient): GetProgramSignature;
+interface GetProgramSignature {
+    /**
+     * Retrieves a program.
+     * @param - ID of the program to retrieve.
+     * @returns Retrieved program.
+     */
+    (programId: string): Promise<Program>;
+}
+declare function queryPrograms$1(httpClient: HttpClient): QueryProgramsSignature;
+interface QueryProgramsSignature {
+    /**
+     * 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`.
+     */
+    (): ProgramsQueryBuilder;
+}
+declare function getProgramByExternalIdAndNamespace$1(httpClient: HttpClient): GetProgramByExternalIdAndNamespaceSignature;
+interface GetProgramByExternalIdAndNamespaceSignature {
+    /**
+     * Retrieves a program with the specified external ID and namespace.
+     * @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>;
+}
+
+declare const provisionProgram: MaybeContext<BuildRESTFunction<typeof provisionProgram$1> & typeof provisionProgram$1>;
+declare const renewProgram: MaybeContext<BuildRESTFunction<typeof renewProgram$1> & typeof renewProgram$1>;
+declare const pauseProgram: MaybeContext<BuildRESTFunction<typeof pauseProgram$1> & typeof pauseProgram$1>;
+declare const resumeProgram: MaybeContext<BuildRESTFunction<typeof resumeProgram$1> & typeof resumeProgram$1>;
+declare const endProgram: MaybeContext<BuildRESTFunction<typeof endProgram$1> & typeof endProgram$1>;
+declare const updateProgram: MaybeContext<BuildRESTFunction<typeof updateProgram$1> & typeof updateProgram$1>;
+declare const getProgram: MaybeContext<BuildRESTFunction<typeof getProgram$1> & typeof getProgram$1>;
+declare const queryPrograms: MaybeContext<BuildRESTFunction<typeof queryPrograms$1> & typeof queryPrograms$1>;
+declare const getProgramByExternalIdAndNamespace: MaybeContext<BuildRESTFunction<typeof getProgramByExternalIdAndNamespace$1> & typeof getProgramByExternalIdAndNamespace$1>;
+
+export { EndProgramResponse, GetProgramByExternalIdAndNamespaceOptions, GetProgramByExternalIdAndNamespaceResponse, PauseProgramResponse, PoolDefinitionLookupId, Program, ProgramsQueryBuilder, ProvisionProgramOptions, ProvisionProgramResponse, RenewProgramResponse, ResumeProgramResponse, UpdateProgram, endProgram, getProgram, getProgramByExternalIdAndNamespace, pauseProgram, provisionProgram, queryPrograms, renewProgram, resumeProgram, updateProgram };

package/build/index.d.ts

@@ -0,0 +1,113 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { P as PoolDefinitionLookupId, a as ProvisionProgramOptions, b as ProvisionProgramResponse, R as RenewProgramResponse, c as PauseProgramResponse, d as ResumeProgramResponse, E as EndProgramResponse, U as UpdateProgram, e as Program, f as ProgramsQueryBuilder, G as GetProgramByExternalIdAndNamespaceOptions, g as GetProgramByExternalIdAndNamespaceResponse } from './benefit-programs-v1-program-programs.universal-D8MzGxN_.js';
+export { a4 as ActionEvent, C as CommonIdentificationData, j as CommonIdentificationDataIdOneOf, T as CursorPaging, X as CursorPagingMetadata, L as CursorQuery, M as CursorQueryPagingMethodOneOf, Y as Cursors, _ as DomainEvent, $ as DomainEventBodyOneOf, y as EndProgramRequest, a0 as EntityCreatedEvent, a3 as EntityDeletedEvent, a2 as EntityUpdatedEvent, k as ExtendedFields, Z as GetProgramByExternalIdAndNamespaceRequest, J as GetProgramRequest, K as GetProgramResponse, a6 as IdentificationData, a7 as IdentificationDataIdOneOf, I as IdentityType, a5 as MessageEnvelope, O as OrderStatus, v as PauseProgramRequest, s as PoolDefinitionLookupIdIdOneOf, t as ProgramAlreadyExists, l as ProgramDefinitionInfo, o as ProgramEnded, p as ProgramPaused, m as ProgramProvisioned, n as ProgramRenewed, q as ProgramResumed, h as ProgramStatus, w as ProgramStatusTransitionNotAllowed, a8 as ProgramsQueryResult, r as ProvisionProgramRequest, i as ProvisionProgramRequestProgramStatus, Q as QueryProgramsRequest, V as QueryProgramsResponse, u as RenewProgramRequest, a1 as RestoreInfo, x as ResumeProgramRequest, S as SortOrder, N as Sorting, F as UpdateProgramRequest, H as UpdateProgramResponse, z as UpdateProgramStatusRequest, A as UpdateProgramStatusResponse, B as UpsertMigratedProgramRequest, D as UpsertMigratedProgramResponse, W as WebhookIdentityType } from './benefit-programs-v1-program-programs.universal-D8MzGxN_.js';
+
+declare function provisionProgram$1(httpClient: HttpClient): ProvisionProgramSignature;
+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 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>;
+}
+declare function renewProgram$1(httpClient: HttpClient): RenewProgramSignature;
+interface RenewProgramSignature {
+    /**
+     * 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 - ID of the program to renew.
+     */
+    (programId: string): Promise<RenewProgramResponse>;
+}
+declare function pauseProgram$1(httpClient: HttpClient): PauseProgramSignature;
+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>;
+}
+declare function resumeProgram$1(httpClient: HttpClient): ResumeProgramSignature;
+interface ResumeProgramSignature {
+    /**
+     * Resumes the specified program.
+     *
+     * Call this method for paused programs.
+     * @param - ID of program to resume.
+     */
+    (programId: string): Promise<ResumeProgramResponse>;
+}
+declare function endProgram$1(httpClient: HttpClient): EndProgramSignature;
+interface EndProgramSignature {
+    /**
+     * Ends the specified program.
+     * @param - ID of the program to end.
+     */
+    (programId: string): Promise<EndProgramResponse>;
+}
+declare function updateProgram$1(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, program: UpdateProgram): Promise<Program>;
+}
+declare function getProgram$1(httpClient: HttpClient): GetProgramSignature;
+interface GetProgramSignature {
+    /**
+     * Retrieves a program.
+     * @param - ID of the program to retrieve.
+     * @returns Retrieved program.
+     */
+    (programId: string): Promise<Program>;
+}
+declare function queryPrograms$1(httpClient: HttpClient): QueryProgramsSignature;
+interface QueryProgramsSignature {
+    /**
+     * 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`.
+     */
+    (): ProgramsQueryBuilder;
+}
+declare function getProgramByExternalIdAndNamespace$1(httpClient: HttpClient): GetProgramByExternalIdAndNamespaceSignature;
+interface GetProgramByExternalIdAndNamespaceSignature {
+    /**
+     * Retrieves a program with the specified external ID and namespace.
+     * @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>;
+}
+
+declare const provisionProgram: MaybeContext<BuildRESTFunction<typeof provisionProgram$1> & typeof provisionProgram$1>;
+declare const renewProgram: MaybeContext<BuildRESTFunction<typeof renewProgram$1> & typeof renewProgram$1>;
+declare const pauseProgram: MaybeContext<BuildRESTFunction<typeof pauseProgram$1> & typeof pauseProgram$1>;
+declare const resumeProgram: MaybeContext<BuildRESTFunction<typeof resumeProgram$1> & typeof resumeProgram$1>;
+declare const endProgram: MaybeContext<BuildRESTFunction<typeof endProgram$1> & typeof endProgram$1>;
+declare const updateProgram: MaybeContext<BuildRESTFunction<typeof updateProgram$1> & typeof updateProgram$1>;
+declare const getProgram: MaybeContext<BuildRESTFunction<typeof getProgram$1> & typeof getProgram$1>;
+declare const queryPrograms: MaybeContext<BuildRESTFunction<typeof queryPrograms$1> & typeof queryPrograms$1>;
+declare const getProgramByExternalIdAndNamespace: MaybeContext<BuildRESTFunction<typeof getProgramByExternalIdAndNamespace$1> & typeof getProgramByExternalIdAndNamespace$1>;
+
+export { EndProgramResponse, GetProgramByExternalIdAndNamespaceOptions, GetProgramByExternalIdAndNamespaceResponse, PauseProgramResponse, PoolDefinitionLookupId, Program, ProgramsQueryBuilder, ProvisionProgramOptions, ProvisionProgramResponse, RenewProgramResponse, ResumeProgramResponse, UpdateProgram, endProgram, getProgram, getProgramByExternalIdAndNamespace, pauseProgram, provisionProgram, queryPrograms, renewProgram, resumeProgram, updateProgram };