@wix/auto_sdk_benefit-programs_transactions 1.0.22 → 1.0.24

package/build/{internal/cjs/src/benefit-programs-v1-transaction-transactions.universal.d.ts → benefit-programs-v1-transaction-transactions.universal-CC4UPjY4.d.mts}

@@ -1,5 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface Transaction {
+interface Transaction {
     /**
      * Transaction ID.
      * @format GUID
@@ -74,7 +73,7 @@ export interface Transaction {
      */
     extendedFields?: ExtendedFields;
 }
-export interface PoolInfo {
+interface PoolInfo {
     /**
      * Pool ID.
      * @format GUID
@@ -108,12 +107,12 @@ export interface PoolInfo {
     /**
      * 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
+     * @maxLength 20
      * @readonly
      */
     namespace?: string | null;
 }
-export declare enum BalanceType {
+declare enum BalanceType {
     UNDEFINED = "UNDEFINED",
     /** In a pool's balance. */
     AVAILABLE = "AVAILABLE",
@@ -121,8 +120,8 @@ export declare enum BalanceType {
     EXTERNAL = "EXTERNAL"
 }
 /** @enumType */
-export type BalanceTypeWithLiterals = BalanceType | 'UNDEFINED' | 'AVAILABLE' | 'EXTERNAL';
-export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+type BalanceTypeWithLiterals = BalanceType | 'UNDEFINED' | 'AVAILABLE' | 'EXTERNAL';
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -140,7 +139,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
     wixUserId?: string;
 }
 /** @oneof */
-export interface CommonIdentificationDataIdOneOf {
+interface CommonIdentificationDataIdOneOf {
     /**
      * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
@@ -157,7 +156,7 @@ export interface CommonIdentificationDataIdOneOf {
      */
     wixUserId?: string;
 }
-export declare enum IdentityType {
+declare enum IdentityType {
     /** Unknown type. This value is not used. */
     UNKNOWN = "UNKNOWN",
     /** A site visitor who has not logged in. */
@@ -167,9 +166,7 @@ export declare enum IdentityType {
     /** 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 {
+declare enum TransactionStatus {
     UNDEFINED = "UNDEFINED",
     /** Transaction is pending. This is the initial transaction status. */
     PENDING = "PENDING",
@@ -179,8 +176,8 @@ export declare enum TransactionStatus {
     FAILED = "FAILED"
 }
 /** @enumType */
-export type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'PENDING' | 'COMPLETED' | 'FAILED';
-export interface TransactionDetails {
+type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'PENDING' | 'COMPLETED' | 'FAILED';
+interface TransactionDetails {
     /**
      * Item associated with the transaction.
      * @readonly
@@ -200,7 +197,7 @@ export interface TransactionDetails {
      */
     reason?: string | null;
 }
-export interface Item {
+interface Item {
     /**
      * Item ID.
      * @format GUID
@@ -232,7 +229,7 @@ export interface Item {
      */
     displayName?: string | null;
 }
-export interface ExtendedFields {
+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.
@@ -243,7 +240,7 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface RequestedValues {
+interface RequestedValues {
     /**
      * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
@@ -254,15 +251,15 @@ export interface RequestedValues {
     /** Where the credits went to. */
     target?: BalanceTypeWithLiterals;
 }
-export interface CreateTransactionRequest {
+interface CreateTransactionRequest {
     /** Transaction to create. */
     transaction?: Transaction;
 }
-export interface CreateTransactionResponse {
+interface CreateTransactionResponse {
     /** Created transaction. */
     transaction?: Transaction;
 }
-export interface BulkCreateTransactionsRequest {
+interface BulkCreateTransactionsRequest {
     /**
      * Transactions to be created.
      * @minSize 1
@@ -276,7 +273,7 @@ export interface BulkCreateTransactionsRequest {
      */
     returnEntity?: boolean;
 }
-export interface BulkCreateTransactionsResponse {
+interface BulkCreateTransactionsResponse {
     /**
      * List of results for each transaction.
      *
@@ -288,13 +285,13 @@ export interface BulkCreateTransactionsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface BulkTransactionResult {
+interface BulkTransactionResult {
     /** Metadata for the item. */
     itemMetadata?: ItemMetadata;
     /** Created transaction. */
     transaction?: Transaction;
 }
-export interface ItemMetadata {
+interface ItemMetadata {
     /**
      * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
      * @format GUID
@@ -307,7 +304,7 @@ export interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-export interface ApplicationError {
+interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -315,7 +312,7 @@ export interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-export interface BulkActionMetadata {
+interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -323,15 +320,15 @@ export interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-export interface UpdateTransactionRequest {
+interface UpdateTransactionRequest {
     /** Transaction to update. */
     transaction?: Transaction;
 }
-export interface UpdateTransactionResponse {
+interface UpdateTransactionResponse {
     /** Updated transaction. */
     transaction?: Transaction;
 }
-export interface BulkUpdateTransactionsRequest {
+interface BulkUpdateTransactionsRequest {
     /**
      * Transactions to update.
      * @minSize 1
@@ -345,13 +342,13 @@ export interface BulkUpdateTransactionsRequest {
      */
     returnEntity?: boolean;
 }
-export interface MaskedTransaction {
+interface MaskedTransaction {
     /** Transaction to be updated. */
     transaction?: Transaction;
     /** Explicit list of fields to update. */
     fieldMask?: string[];
 }
-export interface BulkUpdateTransactionsResponse {
+interface BulkUpdateTransactionsResponse {
     /**
      * List of results for each Transaction.
      *
@@ -363,22 +360,22 @@ export interface BulkUpdateTransactionsResponse {
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface GetTransactionRequest {
+interface GetTransactionRequest {
     /**
      * ID of the transaction to retrieve.
      * @format GUID
      */
     transactionId: string;
 }
-export interface GetTransactionResponse {
+interface GetTransactionResponse {
     /** Retrieved transaction. */
     transaction?: Transaction;
 }
-export interface QueryTransactionsRequest {
+interface QueryTransactionsRequest {
     /** Filter, sort, and paging to apply to the query. */
     query: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -394,11 +391,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+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 {
+interface Sorting {
     /**
      * Field to sort by.
      * @maxLength 512
@@ -411,15 +408,15 @@ export interface Sorting {
      */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     /** Ascending sort order. */
     ASC = "ASC",
     /** Descending sort order. */
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface CursorPaging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
     /**
      * Maximum number of items to return.
      * @max 100
@@ -434,13 +431,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryTransactionsResponse {
+interface QueryTransactionsResponse {
     /** List of retrieved transactions. */
     transactions?: Transaction[];
     /** Metadata for paginated results. */
     metadata?: CursorPagingMetadata;
 }
-export interface 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. */
@@ -453,7 +450,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -465,7 +462,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -500,19 +497,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -520,14 +517,14 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -543,7 +540,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -568,7 +565,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -590,7 +587,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -598,51 +595,7 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-type TransactionNonNullablePaths = `pool._id` | `amount` | `source` | `target` | `idempotencyKey` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `instructingParty.anonymousVisitorId` | `instructingParty.memberId` | `instructingParty.wixUserId` | `status`;
-/**
- * Retrieves a transaction.
- * @param transactionId - ID of the transaction to retrieve.
- * @public
- * @documentationMaturity preview
- * @requiredField transactionId
- * @permissionId BENEFIT_PROGRAMS.TRANSACTION_READ
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
- * @permissionScope Manage Events
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @applicableIdentity APP
- * @returns Retrieved transaction.
- * @fqn wix.benefit_programs.v1.transaction.TransactionService.GetTransaction
- */
-export declare function getTransaction(transactionId: string): Promise<NonNullablePaths<Transaction, TransactionNonNullablePaths>>;
-/**
- * Creates a query to retrieve a list of transactions.
- *
- * The Query Transactions 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()` method.
- *
- * You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Transactions returns.
- *
- * Query Transactions has a default paging limit of 50, which you can override.
- *
- *  For a full description of the item object, see the object returned for the `items` property in `TransactionsQueryResult`.
- * @public
- * @documentationMaturity preview
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
- * @permissionScope Manage Events
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionId BENEFIT_PROGRAMS.TRANSACTION_READ
- * @applicableIdentity APP
- * @fqn wix.benefit_programs.v1.transaction.TransactionService.QueryTransactions
- */
-export declare function queryTransactions(): TransactionsQueryBuilder;
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -650,13 +603,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface TransactionsQueryResult extends QueryCursorResult {
+interface TransactionsQueryResult extends QueryCursorResult {
     items: Transaction[];
     query: TransactionsQueryBuilder;
     next: () => Promise<TransactionsQueryResult>;
     prev: () => Promise<TransactionsQueryResult>;
 }
-export interface TransactionsQueryBuilder {
+interface TransactionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -720,4 +673,5 @@ export interface TransactionsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<TransactionsQueryResult>;
 }
-export {};
+
+export { type ApplicationError as A, BalanceType as B, type CommonIdentificationData as C, type DomainEvent as D, type ExtendedFields as E, type EntityUpdatedEvent as F, type GetTransactionRequest as G, type EntityDeletedEvent as H, IdentityType as I, type ActionEvent as J, type MessageEnvelope as K, type IdentificationData as L, type MaskedTransaction as M, type IdentificationDataIdOneOf as N, type TransactionsQueryResult as O, type PoolInfo as P, type QueryTransactionsRequest as Q, type RequestedValues as R, SortOrder as S, type Transaction as T, type UpdateTransactionRequest as U, WebhookIdentityType as W, type TransactionsQueryBuilder as a, TransactionStatus as b, type CommonIdentificationDataIdOneOf as c, type TransactionDetails as d, type Item as e, type CreateTransactionRequest as f, type CreateTransactionResponse as g, type BulkCreateTransactionsRequest as h, type BulkCreateTransactionsResponse as i, type BulkTransactionResult as j, type ItemMetadata as k, type BulkActionMetadata as l, type UpdateTransactionResponse as m, type BulkUpdateTransactionsRequest as n, type BulkUpdateTransactionsResponse as o, type GetTransactionResponse as p, type CursorQuery as q, type CursorQueryPagingMethodOneOf as r, type Sorting as s, type CursorPaging as t, type QueryTransactionsResponse as u, type CursorPagingMetadata as v, type Cursors as w, type DomainEventBodyOneOf as x, type EntityCreatedEvent as y, type RestoreInfo as z };