@wix/auto_sdk_benefit-programs_transactions 1.0.0

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

@@ -0,0 +1,614 @@
+export interface Transaction {
+    /**
+     * Transaction ID.
+     * @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;
+    /**
+     * The benefit pool associated with the balance object.
+     * @readonly
+     */
+    pool?: PoolInfo;
+    /** Absolute amount to adjust the balance with. This field is determined by the source and target balances. */
+    amount?: string;
+    /** Source balance. */
+    source?: BalanceType;
+    /** Target balance. */
+    target?: BalanceType;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     * @readonly
+     */
+    idempotencyKey?: string;
+    /**
+     * Related transaction ID. For example, in the case of a cancelled reservation, the related transaction is the benefit redemption.
+     * @readonly
+     */
+    relatedTransactionId?: string | null;
+    /**
+     * Identity of the individual that enrolled in the program associated with this benefit transaction.
+     * @readonly
+     */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * The identity that created this transaction.
+     * @readonly
+     */
+    instructingParty?: CommonIdentificationData;
+    /**
+     * Transaction status.
+     *
+     * `PENDING` is the initial status of a transaction. After the balance is updated, the status changes to `COMPLETED` if the transaction was successful, or `FAILED`, if the balance update fails.
+     */
+    status?: TransactionStatus;
+    /**
+     * Additional transaction details.
+     * @readonly
+     */
+    details?: TransactionDetails;
+    /**
+     * Custom field data for the transaction object.
+     *
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     */
+    extendedFields?: ExtendedFields;
+}
+export interface PoolInfo {
+    /**
+     * Benefit pool ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Pool definition ID from which this benefit pool was instantiated.
+     * @readonly
+     */
+    poolDefinitionId?: string | null;
+    /**
+     * ID for the program definition from which this benefit pool was provisioned.
+     * @readonly
+     */
+    programDefinitionId?: string | null;
+    /**
+     * ID of the program to which this benefit pool belongs.
+     * @readonly
+     */
+    programId?: string | null;
+    /** Total amount of credits available for this benefit pool. */
+    creditAmount?: string | null;
+    /** The external system that is the source of the pool creation. For example, `wix-pricing-plans`, `wix-loyalty`. */
+    namespace?: string | null;
+}
+export declare enum BalanceType {
+    UNDEFINED = "UNDEFINED",
+    /** Available balance. */
+    AVAILABLE = "AVAILABLE",
+    /** Reserved balance. */
+    RESERVED = "RESERVED",
+    /** External balance. */
+    EXTERNAL = "EXTERNAL"
+}
+export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+}
+/** @oneof */
+export interface CommonIdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    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 declare enum TransactionStatus {
+    UNDEFINED = "UNDEFINED",
+    /** Transaction is pending. */
+    PENDING = "PENDING",
+    /** Transaction completed. */
+    COMPLETED = "COMPLETED",
+    /** Transaction failed. */
+    FAILED = "FAILED"
+}
+export interface TransactionDetails {
+    /**
+     * Item associated with the balance change.
+     * The redemption of this item triggered the balance adjustment.
+     * @readonly
+     */
+    item?: Item;
+    /** Quantity of an item related to the balance change. */
+    itemCount?: number | null;
+    /**
+     * Date and time the transaction was made.
+     * @readonly
+     */
+    effectiveDate?: Date | null;
+    /**
+     * Reason for the transaction. For example, `Redemption` or `Manual adjustment`.
+     * @readonly
+     */
+    reason?: string | null;
+}
+export interface Item {
+    /**
+     * Item ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * External item ID.
+     * @readonly
+     */
+    externalId?: string | null;
+    /**
+     * Item category. Distinguishes between different types of items. For example, `posts`, `groups`, `events`.
+     * @readonly
+     */
+    category?: string | null;
+    /** @readonly */
+    itemSetId?: string | null;
+    /**
+     * Item display name.
+     * @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 CreateTransactionRequest {
+    /** Transaction to create. */
+    transaction?: Transaction;
+}
+export interface CreateTransactionResponse {
+    /** Created transaction. */
+    transaction?: Transaction;
+}
+export interface BulkCreateTransactionsRequest {
+    /** Transactions to be created. */
+    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.
+     */
+    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). */
+    _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. */
+    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.
+     */
+    results?: BulkTransactionResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface GetTransactionRequest {
+    /** Id of the transaction to retrieve. */
+    transactionId: string;
+}
+export interface GetTransactionResponse {
+    /** Retrieved transaction. */
+    transaction?: Transaction;
+}
+export interface QueryTransactionsRequest {
+    /** Query to select transactions. */
+    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 in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    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 {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    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 in the results. */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface QueryTransactionsResponse {
+    /** The 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. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+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 {
+    entity?: string;
+}
+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.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    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. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface PoolInfoNonNullableFields {
+    _id: string;
+}
+interface CommonIdentificationDataNonNullableFields {
+    anonymousVisitorId: string;
+    memberId: string;
+    wixUserId: string;
+    identityType: IdentityType;
+}
+export interface TransactionNonNullableFields {
+    pool?: PoolInfoNonNullableFields;
+    amount: string;
+    source: BalanceType;
+    target: BalanceType;
+    idempotencyKey: string;
+    beneficiary?: CommonIdentificationDataNonNullableFields;
+    instructingParty?: CommonIdentificationDataNonNullableFields;
+    status: TransactionStatus;
+}
+export interface GetTransactionResponseNonNullableFields {
+    transaction?: TransactionNonNullableFields;
+}
+export interface QueryTransactionsResponseNonNullableFields {
+    transactions: TransactionNonNullableFields[];
+}
+/**
+ * Retrieves a transaction.
+ * @param transactionId - Id of the transaction to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField transactionId
+ * @permissionId BENEFIT_PROGRAMS.TRANSACTION_READ
+ * @returns Retrieved transaction.
+ * @fqn wix.benefit_programs.v1.transaction.TransactionService.GetTransaction
+ */
+export declare function getTransaction(transactionId: string): Promise<Transaction & TransactionNonNullableFields>;
+/**
+ * Creates a query to retrieve a list of transactions.
+ *
+ * The `queryTransactions()` method builds a query to retrieve a list of transactions and returns a `TransactionsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the [`find()`](/transactions/transactions-query-builder/find) function.
+ *
+ * You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryTransactions()` returns.
+ *
+ * The following `TransactionsQueryBuilder` functions are supported for `queryTransactions()`. For a full description of the transaction object, see the object returned for the [`items`](/transactions/transactions-query-result/items) property in `TransactionsQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId BENEFIT_PROGRAMS.TRANSACTION_READ
+ * @fqn wix.benefit_programs.v1.transaction.TransactionService.QueryTransactions
+ */
+export declare function queryTransactions(): TransactionsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface TransactionsQueryResult extends QueryCursorResult {
+    items: Transaction[];
+    query: TransactionsQueryBuilder;
+    next: () => Promise<TransactionsQueryResult>;
+    prev: () => Promise<TransactionsQueryResult>;
+}
+export interface TransactionsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | 'pool.id' | 'relatedTransactionId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.item.id', value: any) => TransactionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | 'pool.id' | 'relatedTransactionId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.item.id', value: any) => TransactionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate', value: any) => TransactionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate', value: any) => TransactionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate', value: any) => TransactionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate', value: any) => TransactionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'pool.id' | 'relatedTransactionId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.item.id', value: string) => TransactionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | 'pool.id' | 'relatedTransactionId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.item.id', value: any[]) => TransactionsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | 'pool.id' | 'relatedTransactionId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.item.id', value: any) => TransactionsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | 'pool.id' | 'relatedTransactionId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.item.id', value: boolean) => TransactionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'pool.id' | 'relatedTransactionId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.item.id'>) => TransactionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'pool.id' | 'relatedTransactionId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'details.item.id'>) => TransactionsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => TransactionsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => TransactionsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<TransactionsQueryResult>;
+}
+export {};