@wix/auto_sdk_benefit-programs_programs 1.0.7 → 1.0.9

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

@@ -1,4 +1,6 @@
-export interface Program {
+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_.mjs';
+
+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. */
@@ -94,7 +96,7 @@ export declare enum ProgramStatus {
     /** Program is being ended. This status exists for a short time during processing. */
     ENDING = "ENDING"
 }
-export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -112,7 +114,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
@@ -129,17 +131,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"
-}
-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.
@@ -150,7 +142,7 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface ProgramDefinitionInfo {
+interface ProgramDefinitionInfo {
     /**
      * Program definition ID.
      * @format GUID
@@ -164,28 +156,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. */
@@ -215,7 +187,7 @@ export interface ProvisionProgramRequest {
      */
     externalProgramId: string;
 }
-export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
+interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
     /**
      * Pool definition ID.
      * @format GUID
@@ -228,7 +200,7 @@ export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
     programDefinitionId?: string;
 }
 /** @oneof */
-export interface PoolDefinitionLookupIdIdOneOf {
+interface PoolDefinitionLookupIdIdOneOf {
     /**
      * Pool definition ID.
      * @format GUID
@@ -240,13 +212,13 @@ export interface PoolDefinitionLookupIdIdOneOf {
      */
     programDefinitionId?: string;
 }
-export declare enum ProvisionProgramRequestProgramStatus {
+declare enum ProvisionProgramRequestProgramStatus {
     /** Program is active. */
     ACTIVE = "ACTIVE",
     /** Program is paused. */
     PAUSED = "PAUSED"
 }
-export interface ProvisionProgramResponse {
+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,156 +227,87 @@ 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
      */
     programId: 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
      */
     programId: 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?: ProgramStatus;
-    /** Status to which the program is being transitioned */
-    requestedStatus?: ProgramStatus;
-}
-export interface ResumeProgramRequest {
+interface ResumeProgramRequest {
     /**
      * ID of program to resume.
      * @format GUID
      */
     programId: 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?: ProgramStatus;
-    /** Status to update */
-    targetStatus?: ProgramStatus;
-}
-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?: OrderStatus;
-    /**
-     * Plan name
-     * @maxLength 64
-     */
-    planName?: string;
-}
-export declare enum OrderStatus {
-    UNKNOWN = "UNKNOWN",
-    ACTIVE = "ACTIVE",
-    PAUSED = "PAUSED",
-    ENDED = "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;
     /**
@@ -420,11 +323,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
@@ -437,13 +340,13 @@ export interface Sorting {
      */
     order?: SortOrder;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     /** Ascending sort order. */
     ASC = "ASC",
     /** Descending sort order. */
     DESC = "DESC"
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Maximum number of items to return.
      * @max 100
@@ -458,13 +361,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. */
@@ -477,7 +380,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
@@ -489,7 +392,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
@@ -502,149 +405,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;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * 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 defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    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?: WebhookIdentityType;
-}
-/** @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"
-}
+
+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 };