@wix/auto_sdk_benefit-programs_program-definitions 1.0.8 → 1.0.10

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

@@ -1,385 +0,0 @@
-export interface ProgramDefinition {
-    /**
-     * Program definition ID.
-     * @format GUID
-     * @immutable
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * Revision number, which increments by 1 each time the program definition is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the program definition.
-     *
-     * Ignored when creating a program definition.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * Date and time the program definition was created.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /**
-     * Date and time the program definition was updated.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /**
-     * Program definition name.
-     * @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.
-     * @immutable
-     * @readonly
-     * @minLength 1
-     * @maxLength 50
-     */
-    namespace?: string | null;
-    /**
-     * Custom field data for the program definition 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 definition defined by you. You can use `externalId` to filter queries.
-     * @format GUID
-     * @immutable
-     * @readonly
-     */
-    externalId?: string | null;
-}
-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 CreateProgramDefinitionRequest {
-    /** Program definition to create. */
-    programDefinition: ProgramDefinition;
-}
-export interface CreateProgramDefinitionResponse {
-    /** Created program definition. */
-    programDefinition?: ProgramDefinition;
-}
-export interface UpdateProgramDefinitionRequest {
-    /** Program definition to update. */
-    programDefinition: ProgramDefinition;
-}
-export interface UpdateProgramDefinitionResponse {
-    /** Updated program definition. */
-    programDefinition?: ProgramDefinition;
-}
-export interface DeleteProgramDefinitionRequest {
-    /**
-     * ID of the program definition to delete.
-     * @format GUID
-     */
-    programDefinitionId: string;
-    /** Determines when the changes to this program definition will be applied to associated programs and pools. */
-    cascadeType?: Cascade;
-}
-export declare enum Cascade {
-    /** Unknown cascade. */
-    UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
-    /** Changes are applied to existing programs and pools when they are next renewed. */
-    NEXT_RENEWAL = "NEXT_RENEWAL",
-    /** Changes are applied to associated programs and pools immediately. */
-    IMMEDIATELY = "IMMEDIATELY",
-    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
-    FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
-}
-export interface DeleteProgramDefinitionResponse {
-}
-export interface GetProgramDefinitionRequest {
-    /**
-     * ID of the program definition to retrieve.
-     * @format GUID
-     */
-    programDefinitionId: string;
-}
-export interface GetProgramDefinitionResponse {
-    /** Retrieved program definition. */
-    programDefinition?: ProgramDefinition;
-}
-export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
-    /**
-     * 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 definition external ID.
-     * @format GUID
-     */
-    externalId: string;
-}
-export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
-    /** Retrieved program definition. */
-    programDefinition?: ProgramDefinition;
-}
-export interface QueryProgramDefinitionsRequest {
-    /** 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 QueryProgramDefinitionsResponse {
-    /** List of retrieved program definitions. */
-    programDefinitions?: ProgramDefinition[];
-    /** 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 UpsertProgramDefinitionRequest {
-    /** Program definition to be created or updated. */
-    programDefinition?: ProgramDefinition;
-}
-export interface UpsertProgramDefinitionResponse {
-    /** Created or updated program definition. */
-    programDefinition?: ProgramDefinition;
-}
-export interface GetOrCreateProgramDefinitionRequest {
-    /**
-     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
-     * @minLength 1
-     * @maxLength 50
-     */
-    namespace?: string;
-    /**
-     * External program definition ID.
-     * @format GUID
-     */
-    externalId?: string;
-}
-export interface GetOrCreateProgramDefinitionResponse {
-    /** The created or updated program definition. */
-    programDefinition?: ProgramDefinition;
-}
-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/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookIdentityType = exports.SortOrder = exports.Cascade = void 0;
-var Cascade;
-(function (Cascade) {
-    /** Unknown cascade. */
-    Cascade["UNKNOWN_CASCADE"] = "UNKNOWN_CASCADE";
-    /** Changes are applied to existing programs and pools when they are next renewed. */
-    Cascade["NEXT_RENEWAL"] = "NEXT_RENEWAL";
-    /** Changes are applied to associated programs and pools immediately. */
-    Cascade["IMMEDIATELY"] = "IMMEDIATELY";
-    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
-    Cascade["FUTURE_PROVISIONS"] = "FUTURE_PROVISIONS";
-})(Cascade || (exports.Cascade = Cascade = {}));
-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-definition-program-definitions.types.js.map

package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.types.ts"],"names":[],"mappings":";;;AAgGA,IAAY,OASX;AATD,WAAY,OAAO;IACjB,uBAAuB;IACvB,8CAAmC,CAAA;IACnC,qFAAqF;IACrF,wCAA6B,CAAA;IAC7B,wEAAwE;IACxE,sCAA2B,CAAA;IAC3B,6HAA6H;IAC7H,kDAAuC,CAAA;AACzC,CAAC,EATW,OAAO,uBAAP,OAAO,QASlB;AA6ED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAkOD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}