@wix/auto_sdk_benefit-programs_programs 1.0.18 → 1.0.19

package/build/{internal/cjs/src/benefit-programs-v1-program-programs.types.d.ts → meta.d.ts}

@@ -1,4 +1,6 @@
-export interface Program {
+import { u as ProvisionProgramRequest$1, b as ProvisionProgramResponse$1, x as RenewProgramRequest$1, c as RenewProgramResponse$1, y as PauseProgramRequest$1, e as PauseProgramResponse$1, A as ResumeProgramRequest$1, g as ResumeProgramResponse$1, B as EndProgramRequest$1, E as EndProgramResponse$1, K as UpdateProgramRequest$1, L as UpdateProgramResponse$1, M as GetProgramRequest$1, N as GetProgramResponse$1, Q as QueryProgramsRequest$1, Z as QueryProgramsResponse$1, a0 as GetProgramByExternalIdAndNamespaceRequest$1, j as GetProgramByExternalIdAndNamespaceResponse$1 } from './benefit-programs-v1-program-programs.universal-CoT_YS3k.js';
+
+interface Program {
     /**
      * Program ID.
      * @format GUID
@@ -76,7 +78,7 @@ export interface Program {
      */
     programDefinition?: ProgramDefinitionInfo;
 }
-export declare enum ProgramStatus {
+declare enum ProgramStatus {
     /** Undefined program status. */
     UNDEFINED = "UNDEFINED",
     /** Program is active. */
@@ -95,8 +97,8 @@ export declare enum ProgramStatus {
     ENDING = "ENDING"
 }
 /** @enumType */
-export type ProgramStatusWithLiterals = ProgramStatus | 'UNDEFINED' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'PROVISIONING' | 'PAUSING' | 'RESUMING' | 'ENDING';
-export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+type ProgramStatusWithLiterals = ProgramStatus | 'UNDEFINED' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'PROVISIONING' | 'PAUSING' | 'RESUMING' | 'ENDING';
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -114,7 +116,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
     wixUserId?: string;
 }
 /** @oneof */
-export interface CommonIdentificationDataIdOneOf {
+interface CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -131,19 +133,7 @@ export interface CommonIdentificationDataIdOneOf {
      */
     wixUserId?: string;
 }
-export declare enum IdentityType {
-    /** Unknown type. This value is not used. */
-    UNKNOWN = "UNKNOWN",
-    /** A site visitor who has not logged in. */
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    /** A logged-in site member. */
-    MEMBER = "MEMBER",
-    /** A Wix account holder, such as a site owner or contributor. */
-    WIX_USER = "WIX_USER"
-}
-/** @enumType */
-export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
-export interface ExtendedFields {
+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.
@@ -154,7 +144,7 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface ProgramDefinitionInfo {
+interface ProgramDefinitionInfo {
     /**
      * Program definition ID.
      * @format GUID
@@ -168,28 +158,8 @@ export interface ProgramDefinitionInfo {
      */
     externalId?: string | null;
 }
-export interface ProgramProvisioned {
-    /** Program which has been provisioned */
-    program?: Program;
-}
-export interface ProgramRenewed {
-    /** Program which has been renewed */
-    program?: Program;
-}
-export interface ProgramEnded {
-    /** Program which has been ended */
-    program?: Program;
-}
-export interface ProgramPaused {
-    /** Program which has been paused */
-    program?: Program;
-}
-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 */
-export interface ProvisionProgramRequest {
+interface ProvisionProgramRequest {
     /** The program definition or pool definition to use to provision the program. */
     poolDefinitionLookupId: PoolDefinitionLookupId;
     /** Program beneficiary. */
@@ -219,7 +189,7 @@ export interface ProvisionProgramRequest {
      */
     externalProgramId: string;
 }
-export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
+interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
     /**
      * Pool definition ID.
      * @format GUID
@@ -232,7 +202,7 @@ export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
     programDefinitionId?: string;
 }
 /** @oneof */
-export interface PoolDefinitionLookupIdIdOneOf {
+interface PoolDefinitionLookupIdIdOneOf {
     /**
      * Pool definition ID.
      * @format GUID
@@ -244,15 +214,15 @@ export interface PoolDefinitionLookupIdIdOneOf {
      */
     programDefinitionId?: string;
 }
-export declare enum ProvisionProgramRequestProgramStatus {
+declare enum ProvisionProgramRequestProgramStatus {
     /** Program is active. */
     ACTIVE = "ACTIVE",
     /** Program is paused. */
     PAUSED = "PAUSED"
 }
 /** @enumType */
-export type ProvisionProgramRequestProgramStatusWithLiterals = ProvisionProgramRequestProgramStatus | 'ACTIVE' | 'PAUSED';
-export interface ProvisionProgramResponse {
+type ProvisionProgramRequestProgramStatusWithLiterals = ProvisionProgramRequestProgramStatus | 'ACTIVE' | '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
@@ -261,20 +231,8 @@ export interface ProvisionProgramResponse {
     /** Provisioned program. */
     program?: Program;
 }
-export interface ProgramAlreadyExists {
-    /**
-     * Key of a program that already exists
-     * @format GUID
-     */
-    externalProgramId?: string;
-    /**
-     * Key of a program that already exists
-     * @format GUID
-     */
-    namespace?: string;
-}
 /** Updates the pool credit amount according to the configuration. */
-export interface RenewProgramRequest {
+interface RenewProgramRequest {
     /**
      * ID of the program to renew.
      * @format GUID
@@ -284,16 +242,16 @@ export interface RenewProgramRequest {
      * Idempotency key to ensure that the request is processed only once.
      * @maxLength 64
      */
-    idempotencyKey?: string;
+    idempotencyKey: string;
 }
-export interface RenewProgramResponse {
+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;
 }
-export interface PauseProgramRequest {
+interface PauseProgramRequest {
     /**
      * ID of the program to pause.
      * @format GUID
@@ -303,22 +261,16 @@ export interface PauseProgramRequest {
      * Idempotency key to ensure that the request is processed only once.
      * @maxLength 64
      */
-    idempotencyKey?: string;
+    idempotencyKey: string;
 }
-export interface PauseProgramResponse {
+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;
 }
-export interface ProgramStatusTransitionNotAllowed {
-    /** Current status of the program */
-    currentStatus?: ProgramStatusWithLiterals;
-    /** Status to which the program is being transitioned */
-    requestedStatus?: ProgramStatusWithLiterals;
-}
-export interface ResumeProgramRequest {
+interface ResumeProgramRequest {
     /**
      * ID of program to resume.
      * @format GUID
@@ -328,106 +280,53 @@ export interface ResumeProgramRequest {
      * Idempotency key to ensure that the request is processed only once.
      * @maxLength 64
      */
-    idempotencyKey?: string;
+    idempotencyKey: string;
 }
-export interface ResumeProgramResponse {
+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;
 }
-export interface EndProgramRequest {
+interface EndProgramRequest {
     /**
      * ID of the program to end.
      * @format GUID
      */
     programId: string;
 }
-export interface EndProgramResponse {
+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;
 }
-export interface UpdateProgramStatusRequest {
-    /**
-     * Program to update
-     * @format GUID
-     */
-    programId?: string;
-    /** Program revision */
-    programRevision?: string;
-    /** Status to update */
-    status?: ProgramStatusWithLiterals;
-    /** Status to update */
-    targetStatus?: ProgramStatusWithLiterals;
-}
-export interface UpdateProgramStatusResponse {
-    /** The updated Program */
-    program?: Program;
-}
-export interface UpsertMigratedProgramRequest {
-    /**
-     * Order id
-     * @format GUID
-     */
-    orderId?: string;
-    /**
-     * Plan id
-     * @format GUID
-     */
-    planId?: string;
-    /**
-     * Order member id
-     * @format GUID
-     */
-    memberId?: string;
-    /** Order status */
-    status?: OrderStatusWithLiterals;
-    /**
-     * Plan name
-     * @maxLength 64
-     */
-    planName?: string;
-}
-export declare enum OrderStatus {
-    UNKNOWN = "UNKNOWN",
-    ACTIVE = "ACTIVE",
-    PAUSED = "PAUSED",
-    ENDED = "ENDED"
-}
-/** @enumType */
-export type OrderStatusWithLiterals = OrderStatus | 'UNKNOWN' | 'ACTIVE' | 'PAUSED' | 'ENDED';
-export interface UpsertMigratedProgramResponse {
-    /** Inserted or updated program */
-    program?: Program;
-}
-export interface UpdateProgramRequest {
+interface UpdateProgramRequest {
     /** Program to update. */
     program: Program;
 }
-export interface UpdateProgramResponse {
+interface UpdateProgramResponse {
     /** Updated program. */
     program?: Program;
 }
-export interface GetProgramRequest {
+interface GetProgramRequest {
     /**
      * ID of the program to retrieve.
      * @format GUID
      */
     programId: string;
 }
-export interface GetProgramResponse {
+interface GetProgramResponse {
     /** Retrieved program. */
     program?: Program;
 }
-export interface QueryProgramsRequest {
+interface QueryProgramsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -443,11 +342,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+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;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Field to sort by.
      * @maxLength 512
@@ -460,15 +359,15 @@ export interface Sorting {
      */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     /** Ascending sort order. */
     ASC = "ASC",
     /** Descending sort order. */
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface CursorPaging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
     /**
      * Maximum number of items to return.
      * @max 100
@@ -483,13 +382,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryProgramsResponse {
+interface QueryProgramsResponse {
     /** List of retrieved programs. */
     programs?: Program[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
 }
-export interface 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. */
@@ -502,7 +401,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -514,7 +413,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface GetProgramByExternalIdAndNamespaceRequest {
+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
@@ -527,143 +426,33 @@ export interface GetProgramByExternalIdAndNamespaceRequest {
      */
     externalId: string;
 }
-export interface GetProgramByExternalIdAndNamespaceResponse {
+interface GetProgramByExternalIdAndNamespaceResponse {
     /** Retrieved program. */
     program?: Program;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-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.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+
+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 };