@wix/auto_sdk_benefit-programs_balances 1.0.0

package/build/es/src/benefit-programs-v1-balance-balances.types.d.ts

@@ -0,0 +1,671 @@
+export interface Balance {
+    /** Balance ID, which is the same as its associated pool ID. */
+    id?: string;
+    /**
+     * Revision number, which increments by 1 each time the balance is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the balance.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the balance was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the balance was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Identity of the individual that enrolled in the program associated with this pool balance.
+     * @readonly
+     */
+    beneficiary?: CommonIdentificationData;
+    /**
+     * Benefit pool balance.
+     * @readonly
+     */
+    amount?: BalanceAmount;
+    /**
+     * Pool information.
+     * @readonly
+     */
+    poolInfo?: PoolInfo;
+    /**
+     * Custom field data for the balance 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;
+    /**
+     * Last transaction ID that triggered the change in balance.
+     * @readonly
+     */
+    lastTransactionId?: string | null;
+}
+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 interface BalanceAmount {
+    /**
+     * Total credits available in the benefit pool.
+     * @readonly
+     */
+    available?: string;
+}
+export interface PoolInfo {
+    /**
+     * Pool ID.
+     *
+     * Represents the ID of the benefit pool linked to this balance.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Pool definition that this benefit pool was instantiated from.
+     * @readonly
+     */
+    poolDefinitionId?: string | null;
+    /**
+     * Program definition from which this benefit pool's program was provisioned from.
+     * @readonly
+     */
+    programDefinitionId?: string | null;
+    /**
+     * Active program that this benefit pool belongs to.
+     * @readonly
+     */
+    programId?: string | null;
+    /** Total credits available in this benefit pool */
+    creditAmount?: string | null;
+    /** Module that is the source of this benefit pool creation. */
+    namespace?: 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 GetBalanceRequest {
+    /** ID of the pool from which to retrieve the balance. */
+    poolId: string;
+}
+export interface GetBalanceResponse {
+    /** Retrieved balance. */
+    balance?: Balance;
+}
+export interface ListBalancesRequest {
+    /** IDs of the pools from which to receive the balances. */
+    poolIds?: string[];
+    /** Cursor paging */
+    cursorPaging?: CursorPaging;
+}
+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 ListBalancesResponse {
+    /** Balances. */
+    balances?: Balance[];
+    /** 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 QueryBalancesRequest {
+    /** Query to select balances. */
+    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 QueryBalancesResponse {
+    /** List of balances. */
+    balances?: Balance[];
+    /** Metadata for the paginated results. */
+    metadata?: CursorPagingMetadata;
+}
+export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
+    /** Set the amount of credits to adjust the balance to. */
+    adjustOptions?: AdjustOptions;
+    /** Sets the balance to a specific amount. */
+    setOptions?: SetOptions;
+    /** ID of the benefit pool to adjust. */
+    poolId: string;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     */
+    idempotencyKey: string;
+    /**
+     * Party requesting the balance change.
+     *
+     * Possible values could include:
+     *
+     * + App owner.
+     *
+     * + Pool beneficiary.
+     *
+     * + Site admin.
+     */
+    instructingParty?: CommonIdentificationData;
+    /**
+     * Specify the type of operation to change the balance. Depending on the selected balance change type, you must use the corresponding `adjustOptions` or `setOptions` parameter.
+     *
+     * Use `ADJUST` to specify the number of credits to apply to the current balance of the benefit pool.
+     * For example, if there is a currently 10 credits, and you use `ADJUST` with an amount of 5, the resulting balance will be 15 credits (10+5) after the adjustment.
+     *
+     * Use `SET` to change the entire balance to a specified amount.
+     * For example, if you apply `SET` with an amount of 10 credits, the resulting balance will be 10 credits, regardless of the initial balance.
+     */
+    type?: ChangeBalanceRequestType;
+    /** Transaction details associated with the balance change. */
+    transactionDetails?: TransactionDetails;
+}
+/** @oneof */
+export interface BalanceChangeBalanceRequestOperationOneOf {
+    /** Set the amount of credits to adjust the balance to. */
+    adjustOptions?: AdjustOptions;
+    /** Sets the balance to a specific amount. */
+    setOptions?: SetOptions;
+}
+export declare enum ChangeBalanceRequestType {
+    /** Unknown type of balance operation. */
+    UNKNOWN_OPERATION = "UNKNOWN_OPERATION",
+    /** Adjust the current balance by a specific amount. */
+    ADJUST = "ADJUST",
+    /** Set the balance to a specific amount. */
+    SET = "SET",
+    SET_INITIAL = "SET_INITIAL"
+}
+export interface AdjustOptions {
+    /** Amount to adjust the available balance by. Supports positive and negative values. */
+    value?: string;
+    /** Benefit pool owner associated with this balance. */
+    beneficiary?: CommonIdentificationData;
+}
+export declare enum LimitRule {
+    /** Unknown limit rule */
+    UNKNOWN_LIMIT_RULE = "UNKNOWN_LIMIT_RULE",
+    /** If the limit is exceeded, the operation will fail */
+    FAIL = "FAIL",
+    /** If the limit is exceeded, the operation will succeed but the balance never goes beyond the provided limits. For balance that was already outside of provided limits, it will not be changed. */
+    SOFT_ENFORCE = "SOFT_ENFORCE",
+    /** If the limit is exceeded, the operation will succeed but the balance will be adjusted so that it satisfies the provided limits. If the resulting balance is below the lower_limit, it will be set to the lower_limit. If the resulting balance is above the upper_limit, it will be set to the upper_limit. */
+    HARD_ENFORCE = "HARD_ENFORCE"
+}
+export interface SetOptions {
+    /**
+     * Set the available balance to the provided amount.
+     *
+     * If the value set to is equal to the current balance, no action or corresponding transaction occurs.
+     */
+    value?: string;
+    /** Benefit pool owner associated with this balance. */
+    beneficiary?: CommonIdentificationData;
+}
+export interface SetInitialOptions {
+    /** Set the available balance to the provided amount. */
+    value?: string;
+    /** Benefit pool owner associated with this balance. */
+    beneficiary?: CommonIdentificationData;
+}
+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 ChangeBalanceResponse {
+    /** Changed balance. */
+    balance?: Balance;
+    /** ID of the transaction resulting from the balance adjustment. */
+    transactionId?: string | null;
+}
+export interface BalanceExceededLimits {
+    /** Current balance */
+    balance?: BalanceAmount;
+    /**
+     * The requested amount
+     * @readonly
+     */
+    requested?: string;
+    /**
+     * Lower limit
+     * @readonly
+     */
+    lowerLimit?: string | null;
+    /**
+     * Upper limit
+     * @readonly
+     */
+    upperLimit?: string | null;
+}
+export interface BulkChangeBalancesRequest {
+    /** Requests */
+    requests?: ChangeBalanceRequest[];
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     */
+    idempotencyKey: string;
+    /** Whether to return the entity in the response */
+    returnEntity?: boolean;
+}
+export declare enum Type {
+    /** Unknown type of balance operation. */
+    UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
+}
+export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
+    /** ID of the benefit pool to adjust. */
+    poolId?: string;
+    /**
+     * Party requesting the balance change.
+     *
+     * Possible values could include:
+     *
+     * + App owner.
+     *
+     * + Pool beneficiary.
+     *
+     * + Site admin.
+     */
+    instructingParty?: CommonIdentificationData;
+    /**
+     * Specify the type of operation to change the balance. Depending on the selected balance change type, you must use the corresponding `adjustOptions` or `setOptions` parameter.
+     *
+     * Use `ADJUST` to specify the number of credits to apply to the current balance of the benefit pool.
+     * For example, if there is a currently 10 credits, and you use `ADJUST` with an amount of 5, the resulting balance will be 15 credits (10+5) after the adjustment.
+     *
+     * Use `SET` to change the entire balance to a specified amount.
+     * For example, if you apply `SET` with an amount of 10 credits, the resulting balance will be 10 credits, regardless of the initial balance.
+     */
+    type?: Type;
+    /** Transaction details associated with the balance change. */
+    transactionDetails?: TransactionDetails;
+}
+/** @oneof */
+export interface ChangeBalanceRequestOperationOneOf {
+}
+export interface BulkChangeBalancesResponse {
+    /** Results */
+    results?: BulkChangeBalanceResult[];
+    /** Metadata for the bulk action */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+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 BulkChangeBalanceResult {
+    /** Metadata for the item */
+    itemMetadata?: ItemMetadata;
+    /** Only exists if `returnEntity` was set to `true` in the request */
+    balance?: Balance;
+}
+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 RevertBalanceChangeRequest {
+    /** ID of the resulting transaction from the balance adjustment. */
+    transactionId: string;
+    /**
+     * Unique identifier, generated by the client.
+     * Used to recognize repeated attempts to make the same request.
+     */
+    idempotencyKey: string;
+    /**
+     * Party requesting the balance change.
+     *
+     * Possible values could include:
+     *
+     * + App owner.
+     *
+     * + Pool beneficiary.
+     *
+     * + Site admin.
+     */
+    instructingParty?: CommonIdentificationData;
+}
+export interface RevertBalanceChangeResponse {
+    /** ID of the resulting transaction from the balance adjustment. */
+    transactionId?: string | null;
+}
+export interface ChangeAlreadyReverted {
+    /** The id of the transaction which was already reverted */
+    originalTransactionId?: string;
+    /** The id of the transaction which reverted the original transaction */
+    revertedTransactionId?: string;
+}
+export interface NotEnoughBalance {
+    /** Current balance */
+    balance?: BalanceAmount;
+    /**
+     * The requested amount
+     * @readonly
+     */
+    requested?: string;
+}
+export interface GetTransactionReversibilityRequest {
+    /** Id of the transaction to get the reversibility */
+    transactionId?: string;
+}
+export interface GetTransactionReversibilityResponse {
+    /** The result of transaction reversibility validation */
+    transactionReversibility?: TransactionReversibility;
+}
+/** Transaction reversibility results */
+export declare enum TransactionReversibility {
+    /** Transaction is allowed to be reverted */
+    TRANSACTION_IS_REVERSIBLE = "TRANSACTION_IS_REVERSIBLE",
+    /** Transaction isn't allowed to be reverted, because it was already reverted */
+    TRANSACTION_ALREADY_REVERSED = "TRANSACTION_ALREADY_REVERSED"
+}
+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. */
+    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 CommonIdentificationDataNonNullableFields {
+    anonymousVisitorId: string;
+    memberId: string;
+    wixUserId: string;
+    identityType: IdentityType;
+}
+interface BalanceAmountNonNullableFields {
+    available: string;
+}
+interface PoolInfoNonNullableFields {
+    id: string;
+}
+interface BalanceNonNullableFields {
+    id: string;
+    beneficiary?: CommonIdentificationDataNonNullableFields;
+    amount?: BalanceAmountNonNullableFields;
+    poolInfo?: PoolInfoNonNullableFields;
+}
+export interface GetBalanceResponseNonNullableFields {
+    balance?: BalanceNonNullableFields;
+}
+export interface ListBalancesResponseNonNullableFields {
+    balances: BalanceNonNullableFields[];
+}
+export interface QueryBalancesResponseNonNullableFields {
+    balances: BalanceNonNullableFields[];
+}
+export interface ChangeBalanceResponseNonNullableFields {
+    balance?: BalanceNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkChangeBalanceResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    balance?: BalanceNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkChangeBalancesResponseNonNullableFields {
+    results: BulkChangeBalanceResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export {};