@wix/auto_sdk_benefit-programs_programs 1.0.8 → 1.0.9

package/build/meta.d.ts

@@ -0,0 +1,437 @@
+import { r as ProvisionProgramRequest$1, b as ProvisionProgramResponse$1, u as RenewProgramRequest$1, R as RenewProgramResponse$1, v as PauseProgramRequest$1, c as PauseProgramResponse$1, x as ResumeProgramRequest$1, d as ResumeProgramResponse$1, y as EndProgramRequest$1, E as EndProgramResponse$1, F as UpdateProgramRequest$1, H as UpdateProgramResponse$1, J as GetProgramRequest$1, K as GetProgramResponse$1, Q as QueryProgramsRequest$1, V as QueryProgramsResponse$1, Z as GetProgramByExternalIdAndNamespaceRequest$1, g as GetProgramByExternalIdAndNamespaceResponse$1 } from './benefit-programs-v1-program-programs.universal-D8MzGxN_.js';
+
+interface Program {
+    /**
+     * Program ID.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the program is updated.
+     * To prevent conflicting changes, the current revision must be specified when updating the program.
+     *
+     * Ignored when creating a program.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the program was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the program was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * ID of the associated program definition.
+     * @format GUID
+     * @readonly
+     * @immutable
+     */
+    programDefinitionId?: string | null;
+    /**
+     * Program status.
+     * @readonly
+     */
+    status?: ProgramStatus;
+    /**
+     * Program beneficiary.
+     * @readonly
+     * @immutable
+     */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * Program name.
+     *
+     * You may want to use the same name that's used in the associated program definition, if it exists.
+     * @maxLength 64
+     */
+    displayName?: string | null;
+    /**
+     * 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;
+    /**
+     * Custom field data for the program object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+    /**
+     * ID for the program defined by you. You can use `externalId` to filter queries.
+     * @format GUID
+     * @immutable
+     * @readonly
+     */
+    externalId?: string | null;
+    /**
+     * Associated program definition information.
+     * @readonly
+     */
+    programDefinition?: ProgramDefinitionInfo;
+}
+declare enum ProgramStatus {
+    /** Undefined program status. */
+    UNDEFINED = "UNDEFINED",
+    /** Program is active. */
+    ACTIVE = "ACTIVE",
+    /** Program is paused. It can be resumed. */
+    PAUSED = "PAUSED",
+    /** Program has ended. It can't be resumed. */
+    ENDED = "ENDED",
+    /** 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 exists for a short time during processing. */
+    PAUSING = "PAUSING",
+    /** 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 exists for a short time during processing. */
+    ENDING = "ENDING"
+}
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+/** @oneof */
+interface CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+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.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface ProgramDefinitionInfo {
+    /**
+     * Program definition ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Program definition external ID.
+     * @format GUID
+     * @readonly
+     */
+    externalId?: string | null;
+}
+/** In case pool_definition_id is provided should test if it's part of a package. If it is, reject the request */
+interface ProvisionProgramRequest {
+    /** The program definition or pool definition to use to provision the program. */
+    poolDefinitionLookupId: PoolDefinitionLookupId;
+    /** Program beneficiary. */
+    beneficiary: CommonIdentificationData;
+    /**
+     * Initial program status.
+     *
+     * Default: `ACTIVE`
+     */
+    programStatus?: ProvisionProgramRequestProgramStatus;
+    /**
+     * 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
+     */
+    namespace: string;
+    /**
+     * Program name.
+     *
+     * 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;
+    /**
+     * ID for the program defined by you. You can use `externalId` to filter queries.
+     * @format GUID
+     */
+    externalProgramId: string;
+}
+interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
+    programDefinitionId?: string;
+}
+/** @oneof */
+interface PoolDefinitionLookupIdIdOneOf {
+    /**
+     * Pool definition ID.
+     * @format GUID
+     */
+    poolDefinitionId?: string;
+    /**
+     * Program definition ID.
+     * @format GUID
+     */
+    programDefinitionId?: string;
+}
+declare enum ProvisionProgramRequestProgramStatus {
+    /** Program is active. */
+    ACTIVE = "ACTIVE",
+    /** Program is paused. */
+    PAUSED = "PAUSED"
+}
+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
+     */
+    jobId?: string;
+    /** Provisioned program. */
+    program?: Program;
+}
+/** Updates the pool credit amount according to the configuration. */
+interface RenewProgramRequest {
+    /**
+     * ID of the program to renew.
+     * @format GUID
+     */
+    programId: string;
+}
+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 {
+    /**
+     * ID of the program to pause.
+     * @format GUID
+     */
+    programId: string;
+}
+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 ResumeProgramRequest {
+    /**
+     * ID of program to resume.
+     * @format GUID
+     */
+    programId: string;
+}
+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 {
+    /**
+     * ID of the program to end.
+     * @format GUID
+     */
+    programId: string;
+}
+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 UpdateProgramRequest {
+    /** Program to update. */
+    program: Program;
+}
+interface UpdateProgramResponse {
+    /** Updated program. */
+    program?: Program;
+}
+interface GetProgramRequest {
+    /**
+     * ID of the program to retrieve.
+     * @format GUID
+     */
+    programId: string;
+}
+interface GetProgramResponse {
+    /** Retrieved program. */
+    program?: Program;
+}
+interface QueryProgramsRequest {
+    /** Filter, sort, and paging to apply to the query. */
+    query?: CursorQuery;
+}
+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;
+    /**
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+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 {
+    /**
+     * Field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    /** Ascending sort order. */
+    ASC = "ASC",
+    /** Descending sort order. */
+    DESC = "DESC"
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryProgramsResponse {
+    /** List of retrieved programs. */
+    programs?: Program[];
+    /** Metadata for the paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+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
+     * @maxLength 50
+     */
+    namespace: string;
+    /**
+     * Program's external ID.
+     * @format GUID
+     */
+    externalId: string;
+}
+interface GetProgramByExternalIdAndNamespaceResponse {
+    /** Retrieved program. */
+    program?: Program;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function provisionProgram(): __PublicMethodMetaInfo<'POST', {}, ProvisionProgramRequest$1, ProvisionProgramRequest, ProvisionProgramResponse$1, ProvisionProgramResponse>;
+declare function renewProgram(): __PublicMethodMetaInfo<'POST', {}, RenewProgramRequest$1, RenewProgramRequest, RenewProgramResponse$1, RenewProgramResponse>;
+declare function pauseProgram(): __PublicMethodMetaInfo<'POST', {}, PauseProgramRequest$1, PauseProgramRequest, PauseProgramResponse$1, PauseProgramResponse>;
+declare function resumeProgram(): __PublicMethodMetaInfo<'POST', {}, ResumeProgramRequest$1, ResumeProgramRequest, ResumeProgramResponse$1, ResumeProgramResponse>;
+declare function endProgram(): __PublicMethodMetaInfo<'POST', {}, EndProgramRequest$1, EndProgramRequest, EndProgramResponse$1, EndProgramResponse>;
+declare function updateProgram(): __PublicMethodMetaInfo<'PATCH', {
+    programId: string;
+}, UpdateProgramRequest$1, UpdateProgramRequest, UpdateProgramResponse$1, UpdateProgramResponse>;
+declare function getProgram(): __PublicMethodMetaInfo<'GET', {
+    programId: string;
+}, GetProgramRequest$1, GetProgramRequest, GetProgramResponse$1, GetProgramResponse>;
+declare function queryPrograms(): __PublicMethodMetaInfo<'POST', {}, QueryProgramsRequest$1, QueryProgramsRequest, QueryProgramsResponse$1, QueryProgramsResponse>;
+declare function getProgramByExternalIdAndNamespace(): __PublicMethodMetaInfo<'GET', {}, GetProgramByExternalIdAndNamespaceRequest$1, GetProgramByExternalIdAndNamespaceRequest, GetProgramByExternalIdAndNamespaceResponse$1, GetProgramByExternalIdAndNamespaceResponse>;
+
+export { type __PublicMethodMetaInfo, endProgram, getProgram, getProgramByExternalIdAndNamespace, pauseProgram, provisionProgram, queryPrograms, renewProgram, resumeProgram, updateProgram };