@wix/auto_sdk_benefit-programs_programs 1.0.8 → 1.0.9

package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.d.ts

@@ -1,650 +0,0 @@
-export 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.
-     * @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;
-}
-export 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 will be true for a negligible amount of time. */
-    PROVISIONING = "PROVISIONING",
-    /** Program is being paused. This status will be true for a negligible amount of time. */
-    PAUSING = "PAUSING",
-    /** Program is being re-activated after being paused. This status will be true for a negligible amount of time. */
-    RESUMING = "RESUMING",
-    /** Program is being ended. This status will be true for a negligible amount of time. */
-    ENDING = "ENDING"
-}
-export 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 */
-export 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;
-}
-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 {
-    /**
-     * 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>>;
-}
-export interface ProgramDefinitionInfo {
-    /**
-     * Program definition ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string;
-    /**
-     * Program definition external ID.
-     * @format GUID
-     * @readonly
-     */
-    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 {
-    /** 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.
-     * @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 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;
-}
-export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
-    /**
-     * Pool definition ID.
-     * @format GUID
-     */
-    poolDefinitionId?: string;
-    /**
-     * Program definition ID.
-     * @format GUID
-     */
-    programDefinitionId?: string;
-}
-/** @oneof */
-export interface PoolDefinitionLookupIdIdOneOf {
-    /**
-     * Pool definition ID.
-     * @format GUID
-     */
-    poolDefinitionId?: string;
-    /**
-     * Program definition ID.
-     * @format GUID
-     */
-    programDefinitionId?: string;
-}
-export declare enum ProvisionProgramRequestProgramStatus {
-    /** Program is active. */
-    ACTIVE = "ACTIVE",
-    /** Program is paused. */
-    PAUSED = "PAUSED"
-}
-export interface ProvisionProgramResponse {
-    /**
-     * Job ID of the provisioning of the program.
-     * @format GUID
-     */
-    jobId?: string;
-    /** 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 {
-    /**
-     * ID of the program to renew.
-     * @format GUID
-     */
-    programId: string;
-}
-export interface RenewProgramResponse {
-    /**
-     * Job ID of the program renewal.
-     * @format GUID
-     */
-    jobId?: string;
-}
-export interface PauseProgramRequest {
-    /**
-     * ID of the program to pause.
-     * @format GUID
-     */
-    programId: string;
-}
-export interface PauseProgramResponse {
-    /**
-     * Job ID of the pausing of the program.
-     * @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 {
-    /**
-     * ID of program to resume.
-     * @format GUID
-     */
-    programId: string;
-}
-export interface ResumeProgramResponse {
-    /**
-     * Job ID of the resuming of the program.
-     * @format GUID
-     */
-    jobId?: string;
-}
-export interface EndProgramRequest {
-    /**
-     * ID of the program to end.
-     * @format GUID
-     */
-    programId: string;
-}
-export interface EndProgramResponse {
-    /**
-     * Job ID of the ending of the program.
-     * @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 {
-    /** Program to update. */
-    program: Program;
-}
-export interface UpdateProgramResponse {
-    /** Updated program. */
-    program?: Program;
-}
-export interface GetProgramRequest {
-    /**
-     * ID of the program to retrieve.
-     * @format GUID
-     */
-    programId: string;
-}
-export interface GetProgramResponse {
-    /** Retrieved program. */
-    program?: Program;
-}
-export interface QueryProgramsRequest {
-    /** Filter, sort, and paging to apply to the query. */
-    query?: CursorQuery;
-}
-export 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 */
-export 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 {
-    /**
-     * Field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /**
-     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
-     *
-     * Default: `ASC`
-     */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    /** Ascending sort order. */
-    ASC = "ASC",
-    /** Descending sort order. */
-    DESC = "DESC"
-}
-export 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;
-}
-export interface QueryProgramsResponse {
-    /** List of retrieved programs. */
-    programs?: Program[];
-    /** Metadata for the paginated results. */
-    metadata?: CursorPagingMetadata;
-}
-export 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;
-}
-export 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;
-}
-export interface GetProgramByExternalIdAndNamespaceRequest {
-    /**
-     * Namespace for your app or site's benefit programs.
-     * @minLength 1
-     * @maxLength 50
-     */
-    namespace: string;
-    /**
-     * Program's external ID.
-     * @format GUID
-     */
-    externalId: string;
-}
-export 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"
-}

package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookIdentityType = exports.SortOrder = exports.OrderStatus = exports.ProvisionProgramRequestProgramStatus = exports.IdentityType = exports.ProgramStatus = void 0;
-var ProgramStatus;
-(function (ProgramStatus) {
-    /** Undefined program status. */
-    ProgramStatus["UNDEFINED"] = "UNDEFINED";
-    /** Program is active. */
-    ProgramStatus["ACTIVE"] = "ACTIVE";
-    /** Program is paused. It can be resumed. */
-    ProgramStatus["PAUSED"] = "PAUSED";
-    /** Program has ended. It can't be resumed. */
-    ProgramStatus["ENDED"] = "ENDED";
-    /** Program is being activated for the first time. This status will be true for a negligible amount of time. */
-    ProgramStatus["PROVISIONING"] = "PROVISIONING";
-    /** Program is being paused. This status will be true for a negligible amount of time. */
-    ProgramStatus["PAUSING"] = "PAUSING";
-    /** Program is being re-activated after being paused. This status will be true for a negligible amount of time. */
-    ProgramStatus["RESUMING"] = "RESUMING";
-    /** Program is being ended. This status will be true for a negligible amount of time. */
-    ProgramStatus["ENDING"] = "ENDING";
-})(ProgramStatus || (exports.ProgramStatus = ProgramStatus = {}));
-var IdentityType;
-(function (IdentityType) {
-    /** Unknown type. This value is not used. */
-    IdentityType["UNKNOWN"] = "UNKNOWN";
-    /** A site visitor who has not logged in. */
-    IdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
-    /** A logged-in site member. */
-    IdentityType["MEMBER"] = "MEMBER";
-    /** A Wix account holder, such as a site owner or contributor. */
-    IdentityType["WIX_USER"] = "WIX_USER";
-})(IdentityType || (exports.IdentityType = IdentityType = {}));
-var ProvisionProgramRequestProgramStatus;
-(function (ProvisionProgramRequestProgramStatus) {
-    /** Program is active. */
-    ProvisionProgramRequestProgramStatus["ACTIVE"] = "ACTIVE";
-    /** Program is paused. */
-    ProvisionProgramRequestProgramStatus["PAUSED"] = "PAUSED";
-})(ProvisionProgramRequestProgramStatus || (exports.ProvisionProgramRequestProgramStatus = ProvisionProgramRequestProgramStatus = {}));
-var OrderStatus;
-(function (OrderStatus) {
-    OrderStatus["UNKNOWN"] = "UNKNOWN";
-    OrderStatus["ACTIVE"] = "ACTIVE";
-    OrderStatus["PAUSED"] = "PAUSED";
-    OrderStatus["ENDED"] = "ENDED";
-})(OrderStatus || (exports.OrderStatus = OrderStatus = {}));
-var SortOrder;
-(function (SortOrder) {
-    /** Ascending sort order. */
-    SortOrder["ASC"] = "ASC";
-    /** Descending sort order. */
-    SortOrder["DESC"] = "DESC";
-})(SortOrder || (exports.SortOrder = SortOrder = {}));
-var WebhookIdentityType;
-(function (WebhookIdentityType) {
-    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
-    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
-    WebhookIdentityType["MEMBER"] = "MEMBER";
-    WebhookIdentityType["WIX_USER"] = "WIX_USER";
-    WebhookIdentityType["APP"] = "APP";
-})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
-//# sourceMappingURL=benefit-programs-v1-program-programs.types.js.map