@wix/auto_sdk_benefit-programs_transactions 1.0.21 → 1.0.23

package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.d.ts

@@ -1,602 +0,0 @@
-export interface Transaction {
-    /**
-     * Transaction ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * Revision number, which increments by 1 each time the transaction is updated.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * Date and time the transaction was created.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /**
-     * Date and time the transaction was updated.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /**
-     * Pool associated with this transaction.
-     * @readonly
-     */
-    pool?: PoolInfo;
-    /**
-     * Amount the balance was adjusted in this transaction.
-     * @decimalValue options { gte:0, maxScale:4 }
-     */
-    amount?: string;
-    /** Where the credits came from. */
-    source?: BalanceTypeWithLiterals;
-    /** Where the credits went to. */
-    target?: BalanceTypeWithLiterals;
-    /**
-     * Unique identifier, generated by the client.
-     * Used to recognize repeated attempts to make the same request.
-     * @maxLength 200
-     * @readonly
-     */
-    idempotencyKey?: string;
-    /**
-     * ID of the related transaction. For example, if this transaction is a refund for a benefit redemption, the related transaction is the benefit redemption transaction.
-     * @format GUID
-     * @readonly
-     */
-    relatedTransactionId?: string | null;
-    /**
-     * Beneficiary of the pool associated with this transaction.
-     * @readonly
-     * @immutable
-     */
-    beneficiary?: CommonIdentificationData;
-    /**
-     * Identity that created the transaction.
-     * @readonly
-     * @immutable
-     */
-    instructingParty?: CommonIdentificationData;
-    /** Transaction status. */
-    status?: TransactionStatusWithLiterals;
-    /**
-     * Additional transaction details.
-     * @readonly
-     */
-    details?: TransactionDetails;
-    /**
-     * Custom field data for the transaction 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;
-}
-export interface PoolInfo {
-    /**
-     * Pool ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string;
-    /**
-     * ID of the pool definition the pool was created from.
-     * @format GUID
-     * @readonly
-     */
-    poolDefinitionId?: string | null;
-    /**
-     * ID of the program definition containing the pool definition the pool was created from.
-     * @format GUID
-     * @readonly
-     */
-    programDefinitionId?: string | null;
-    /**
-     * ID of the program that contains the pool.
-     * @format GUID
-     * @readonly
-     */
-    programId?: string | null;
-    /**
-     * Available credits.
-     * @decimalValue options { gte:0, maxScale:4 }
-     * @readonly
-     */
-    creditAmount?: 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
-     * @readonly
-     */
-    namespace?: string | null;
-}
-export declare enum BalanceType {
-    UNDEFINED = "UNDEFINED",
-    /** In a pool's balance. */
-    AVAILABLE = "AVAILABLE",
-    /** Outside a pool's balance. */
-    EXTERNAL = "EXTERNAL"
-}
-/** @enumType */
-export type BalanceTypeWithLiterals = BalanceType | 'UNDEFINED' | 'AVAILABLE' | 'EXTERNAL';
-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"
-}
-/** @enumType */
-export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
-export declare enum TransactionStatus {
-    UNDEFINED = "UNDEFINED",
-    /** Transaction is pending. This is the initial transaction status. */
-    PENDING = "PENDING",
-    /** Transaction completed successfully. */
-    COMPLETED = "COMPLETED",
-    /** Transaction failed. */
-    FAILED = "FAILED"
-}
-/** @enumType */
-export type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'PENDING' | 'COMPLETED' | 'FAILED';
-export interface TransactionDetails {
-    /**
-     * Item associated with the transaction.
-     * @readonly
-     */
-    item?: Item;
-    /** Amount of items associated with the transaction. */
-    itemCount?: number | null;
-    /**
-     * Date and time the transaction was created.
-     * @readonly
-     */
-    effectiveDate?: Date | null;
-    /**
-     * Reason for the transaction. For example, `Redemption`.
-     * @readonly
-     * @maxLength 256
-     */
-    reason?: string | null;
-}
-export interface Item {
-    /**
-     * Item ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * Item external ID.
-     * @format GUID
-     * @readonly
-     */
-    externalId?: string | null;
-    /**
-     * Item category.
-     * @maxLength 20
-     * @readonly
-     */
-    category?: string | null;
-    /**
-     * Item set ID.
-     * @format GUID
-     * @readonly
-     */
-    itemSetId?: string | null;
-    /**
-     * Item name.
-     * @maxLength 64
-     * @readonly
-     */
-    displayName?: 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 RequestedValues {
-    /**
-     * Amount the balance was adjusted in this transaction.
-     * @decimalValue options { gte:0, maxScale:4 }
-     */
-    amount?: string;
-    /** Where the credits came from. */
-    source?: BalanceTypeWithLiterals;
-    /** Where the credits went to. */
-    target?: BalanceTypeWithLiterals;
-}
-export interface CreateTransactionRequest {
-    /** Transaction to create. */
-    transaction?: Transaction;
-}
-export interface CreateTransactionResponse {
-    /** Created transaction. */
-    transaction?: Transaction;
-}
-export interface BulkCreateTransactionsRequest {
-    /**
-     * Transactions to be created.
-     * @minSize 1
-     * @maxSize 100
-     */
-    transactions?: Transaction[];
-    /**
-     * Whether to return the full item entities.
-     *
-     * Default: `false`
-     */
-    returnEntity?: boolean;
-}
-export interface BulkCreateTransactionsResponse {
-    /**
-     * List of results for each transaction.
-     *
-     * Includes the transaction and whether the operation was successful.
-     * @minSize 1
-     * @maxSize 100
-     */
-    results?: BulkTransactionResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkTransactionResult {
-    /** Metadata for the item. */
-    itemMetadata?: ItemMetadata;
-    /** Created transaction. */
-    transaction?: Transaction;
-}
-export interface ItemMetadata {
-    /**
-     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
-     * @format GUID
-     */
-    id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
-export interface UpdateTransactionRequest {
-    /** Transaction to update. */
-    transaction?: Transaction;
-}
-export interface UpdateTransactionResponse {
-    /** Updated transaction. */
-    transaction?: Transaction;
-}
-export interface BulkUpdateTransactionsRequest {
-    /**
-     * Transactions to update.
-     * @minSize 1
-     * @maxSize 100
-     */
-    transactions?: MaskedTransaction[];
-    /**
-     * Whether to return full transaction entities.
-     *
-     * Default: `false`
-     */
-    returnEntity?: boolean;
-}
-export interface MaskedTransaction {
-    /** Transaction to be updated. */
-    transaction?: Transaction;
-    /** Explicit list of fields to update. */
-    fieldMask?: string[];
-}
-export interface BulkUpdateTransactionsResponse {
-    /**
-     * List of results for each Transaction.
-     *
-     * Includes the Transaction and whether the update was successful.
-     * @minSize 1
-     * @maxSize 100
-     */
-    results?: BulkTransactionResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface GetTransactionRequest {
-    /**
-     * ID of the transaction to retrieve.
-     * @format GUID
-     */
-    transactionId: string;
-}
-export interface GetTransactionResponse {
-    /** Retrieved transaction. */
-    transaction?: Transaction;
-}
-export interface QueryTransactionsRequest {
-    /** 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?: SortOrderWithLiterals;
-}
-export declare enum SortOrder {
-    /** Ascending sort order. */
-    ASC = "ASC",
-    /** Descending sort order. */
-    DESC = "DESC"
-}
-/** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | '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 QueryTransactionsResponse {
-    /** List of retrieved transactions. */
-    transactions?: Transaction[];
-    /** Metadata for 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 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';

package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookIdentityType = exports.SortOrder = exports.TransactionStatus = exports.IdentityType = exports.BalanceType = void 0;
-var BalanceType;
-(function (BalanceType) {
-    BalanceType["UNDEFINED"] = "UNDEFINED";
-    /** In a pool's balance. */
-    BalanceType["AVAILABLE"] = "AVAILABLE";
-    /** Outside a pool's balance. */
-    BalanceType["EXTERNAL"] = "EXTERNAL";
-})(BalanceType || (exports.BalanceType = BalanceType = {}));
-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 TransactionStatus;
-(function (TransactionStatus) {
-    TransactionStatus["UNDEFINED"] = "UNDEFINED";
-    /** Transaction is pending. This is the initial transaction status. */
-    TransactionStatus["PENDING"] = "PENDING";
-    /** Transaction completed successfully. */
-    TransactionStatus["COMPLETED"] = "COMPLETED";
-    /** Transaction failed. */
-    TransactionStatus["FAILED"] = "FAILED";
-})(TransactionStatus || (exports.TransactionStatus = TransactionStatus = {}));
-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-transaction-transactions.types.js.map

package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"benefit-programs-v1-transaction-transactions.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-transaction-transactions.types.ts"],"names":[],"mappings":";;;AAoHA,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB,2BAA2B;IAC3B,sCAAuB,CAAA;IACvB,gCAAgC;IAChC,oCAAqB,CAAA;AACvB,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AA+CD,IAAY,YASX;AATD,WAAY,YAAY;IACtB,4CAA4C;IAC5C,mCAAmB,CAAA;IACnB,4CAA4C;IAC5C,uDAAuC,CAAA;IACvC,+BAA+B;IAC/B,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAUD,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,sEAAsE;IACtE,wCAAmB,CAAA;IACnB,0CAA0C;IAC1C,4CAAuB,CAAA;IACvB,0BAA0B;IAC1B,sCAAiB,CAAA;AACnB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B;AAwQD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAgMD,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"}