@wix/auto_sdk_benefit-programs_transactions 1.0.15 → 1.0.17

package/build/meta.d.mts

@@ -1,345 +0,0 @@
-import { G as GetTransactionRequest$1, p as GetTransactionResponse$1, Q as QueryTransactionsRequest$1, u as QueryTransactionsResponse$1 } from './benefit-programs-v1-transaction-transactions.universal-DjQc6kgD.mjs';
-
-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?: BalanceType;
-    /** Where the credits went to. */
-    target?: BalanceType;
-    /**
-     * 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?: TransactionStatus;
-    /**
-     * 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;
-}
-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 }
-     */
-    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
-     */
-    namespace?: string | null;
-}
-declare enum BalanceType {
-    UNDEFINED = "UNDEFINED",
-    /** In a pool's balance. */
-    AVAILABLE = "AVAILABLE",
-    /** Outside a pool's balance. */
-    EXTERNAL = "EXTERNAL"
-}
-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 */
-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;
-}
-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"
-}
-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;
-}
-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;
-}
-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>>;
-}
-interface GetTransactionRequest {
-    /**
-     * ID of the transaction to retrieve.
-     * @format GUID
-     */
-    transactionId: string;
-}
-interface GetTransactionResponse {
-    /** Retrieved transaction. */
-    transaction?: Transaction;
-}
-interface QueryTransactionsRequest {
-    /** Filter, sort, and paging to apply to the query. */
-    query: CursorQuery;
-}
-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 */
-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;
-}
-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;
-}
-declare enum SortOrder {
-    /** Ascending sort order. */
-    ASC = "ASC",
-    /** Descending sort order. */
-    DESC = "DESC"
-}
-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;
-}
-interface QueryTransactionsResponse {
-    /** List of retrieved transactions. */
-    transactions?: Transaction[];
-    /** Metadata for paginated results. */
-    metadata?: CursorPagingMetadata;
-}
-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;
-}
-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;
-}
-
-type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-declare function getTransaction(): __PublicMethodMetaInfo<'GET', {
-    transactionId: string;
-}, GetTransactionRequest$1, GetTransactionRequest, GetTransactionResponse$1, GetTransactionResponse>;
-declare function queryTransactions(): __PublicMethodMetaInfo<'POST', {}, QueryTransactionsRequest$1, QueryTransactionsRequest, QueryTransactionsResponse$1, QueryTransactionsResponse>;
-
-export { type __PublicMethodMetaInfo, getTransaction, queryTransactions };

package/build/meta.d.ts

@@ -1,345 +0,0 @@
-import { G as GetTransactionRequest$1, p as GetTransactionResponse$1, Q as QueryTransactionsRequest$1, u as QueryTransactionsResponse$1 } from './benefit-programs-v1-transaction-transactions.universal-DjQc6kgD.js';
-
-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?: BalanceType;
-    /** Where the credits went to. */
-    target?: BalanceType;
-    /**
-     * 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?: TransactionStatus;
-    /**
-     * 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;
-}
-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 }
-     */
-    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
-     */
-    namespace?: string | null;
-}
-declare enum BalanceType {
-    UNDEFINED = "UNDEFINED",
-    /** In a pool's balance. */
-    AVAILABLE = "AVAILABLE",
-    /** Outside a pool's balance. */
-    EXTERNAL = "EXTERNAL"
-}
-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 */
-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;
-}
-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"
-}
-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;
-}
-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;
-}
-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>>;
-}
-interface GetTransactionRequest {
-    /**
-     * ID of the transaction to retrieve.
-     * @format GUID
-     */
-    transactionId: string;
-}
-interface GetTransactionResponse {
-    /** Retrieved transaction. */
-    transaction?: Transaction;
-}
-interface QueryTransactionsRequest {
-    /** Filter, sort, and paging to apply to the query. */
-    query: CursorQuery;
-}
-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 */
-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;
-}
-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;
-}
-declare enum SortOrder {
-    /** Ascending sort order. */
-    ASC = "ASC",
-    /** Descending sort order. */
-    DESC = "DESC"
-}
-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;
-}
-interface QueryTransactionsResponse {
-    /** List of retrieved transactions. */
-    transactions?: Transaction[];
-    /** Metadata for paginated results. */
-    metadata?: CursorPagingMetadata;
-}
-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;
-}
-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;
-}
-
-type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-declare function getTransaction(): __PublicMethodMetaInfo<'GET', {
-    transactionId: string;
-}, GetTransactionRequest$1, GetTransactionRequest, GetTransactionResponse$1, GetTransactionResponse>;
-declare function queryTransactions(): __PublicMethodMetaInfo<'POST', {}, QueryTransactionsRequest$1, QueryTransactionsRequest, QueryTransactionsResponse$1, QueryTransactionsResponse>;
-
-export { type __PublicMethodMetaInfo, getTransaction, queryTransactions };