@wix/auto_sdk_benefit-programs_balances 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/benefit-programs-v1-balance-balances.context.d.ts +1 -1
- package/build/cjs/src/benefit-programs-v1-balance-balances.public.d.ts +1 -1
- package/build/cjs/src/benefit-programs-v1-balance-balances.public.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-balance-balances.types.d.ts +186 -40
- package/build/cjs/src/benefit-programs-v1-balance-balances.types.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-balance-balances.universal.d.ts +213 -44
- package/build/cjs/src/benefit-programs-v1-balance-balances.universal.js +8 -1
- package/build/cjs/src/benefit-programs-v1-balance-balances.universal.js.map +1 -1
- package/build/es/src/benefit-programs-v1-balance-balances.context.d.ts +1 -1
- package/build/es/src/benefit-programs-v1-balance-balances.public.d.ts +1 -1
- package/build/es/src/benefit-programs-v1-balance-balances.public.js.map +1 -1
- package/build/es/src/benefit-programs-v1-balance-balances.types.d.ts +186 -40
- package/build/es/src/benefit-programs-v1-balance-balances.types.js.map +1 -1
- package/build/es/src/benefit-programs-v1-balance-balances.universal.d.ts +213 -44
- package/build/es/src/benefit-programs-v1-balance-balances.universal.js +8 -1
- package/build/es/src/benefit-programs-v1-balance-balances.universal.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-balance-balances.context.d.ts +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-balance-balances.public.d.ts +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-balance-balances.public.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-balance-balances.types.d.ts +186 -40
- package/build/internal/cjs/src/benefit-programs-v1-balance-balances.types.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-balance-balances.universal.d.ts +213 -44
- package/build/internal/cjs/src/benefit-programs-v1-balance-balances.universal.js +8 -1
- package/build/internal/cjs/src/benefit-programs-v1-balance-balances.universal.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-balance-balances.context.d.ts +1 -1
- package/build/internal/es/src/benefit-programs-v1-balance-balances.public.d.ts +1 -1
- package/build/internal/es/src/benefit-programs-v1-balance-balances.public.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-balance-balances.types.d.ts +186 -40
- package/build/internal/es/src/benefit-programs-v1-balance-balances.types.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-balance-balances.universal.d.ts +213 -44
- package/build/internal/es/src/benefit-programs-v1-balance-balances.universal.js +8 -1
- package/build/internal/es/src/benefit-programs-v1-balance-balances.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -7,4 +7,4 @@ export declare const changeBalance: MaybeContext<BuildRESTFunction<typeof public
|
|
|
7
7
|
export declare const bulkChangeBalances: MaybeContext<BuildRESTFunction<typeof publicBulkChangeBalances> & typeof publicBulkChangeBalances>;
|
|
8
8
|
export declare const revertBalanceChange: MaybeContext<BuildRESTFunction<typeof publicRevertBalanceChange> & typeof publicRevertBalanceChange>;
|
|
9
9
|
export { IdentityType, SortOrder, ChangeBalanceRequestType, LimitRule, Type, TransactionReversibility, WebhookIdentityType, } from './benefit-programs-v1-balance-balances.universal.js';
|
|
10
|
-
export { Balance, CommonIdentificationData, CommonIdentificationDataIdOneOf, BalanceAmount, PoolInfo, ExtendedFields, GetBalanceRequest, GetBalanceResponse, ListBalancesRequest, CursorPaging, ListBalancesResponse, CursorPagingMetadata, Cursors, QueryBalancesRequest, CursorQuery, CursorQueryPagingMethodOneOf, Sorting, QueryBalancesResponse, BalanceChangeBalanceRequest, BalanceChangeBalanceRequestOperationOneOf, AdjustOptions, SetOptions, SetInitialOptions, TransactionDetails, Item, ChangeBalanceResponse, BalanceExceededLimits, BulkChangeBalancesRequest, ChangeBalanceRequest, ChangeBalanceRequestOperationOneOf, BulkChangeBalancesResponse, ItemMetadata, ApplicationError, BulkChangeBalanceResult, BulkActionMetadata, RevertBalanceChangeRequest, RevertBalanceChangeResponse, ChangeAlreadyReverted, NotEnoughBalance, GetTransactionReversibilityRequest, GetTransactionReversibilityResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, BalanceNonNullableFields, GetBalanceResponseNonNullableFields, ListBalancesResponseNonNullableFields, QueryBalancesResponseNonNullableFields, ChangeBalanceResponseNonNullableFields, BulkChangeBalancesResponseNonNullableFields, ListBalancesOptions, BalancesQueryResult, BalancesQueryBuilder, ChangeBalanceOptions, BulkChangeBalancesOptions, RevertBalanceChangeOptions, } from './benefit-programs-v1-balance-balances.universal.js';
|
|
10
|
+
export { Balance, CommonIdentificationData, CommonIdentificationDataIdOneOf, BalanceAmount, PoolInfo, ExtendedFields, GetBalanceRequest, GetBalanceResponse, ListBalancesRequest, CursorPaging, ListBalancesResponse, CursorPagingMetadata, Cursors, QueryBalancesRequest, CursorQuery, CursorQueryPagingMethodOneOf, Sorting, QueryBalancesResponse, BalanceChangeBalanceRequest, BalanceChangeBalanceRequestOperationOneOf, AdjustOptions, SetOptions, SetInitialOptions, TransactionDetails, Item, ChangeBalanceResponse, BalanceExceededLimits, BulkChangeBalancesRequest, ChangeBalanceRequest, ChangeBalanceRequestOperationOneOf, BulkChangeBalancesResponse, ItemMetadata, ApplicationError, BulkChangeBalanceResult, BulkActionMetadata, RevertBalanceChangeRequest, RevertBalanceChangeResponse, ChangeAlreadyReverted, NotEnoughBalance, GetTransactionReversibilityRequest, GetTransactionReversibilityResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, BalanceNonNullableFields, GetBalanceResponseNonNullableFields, ListBalancesResponseNonNullableFields, QueryBalancesResponseNonNullableFields, ChangeBalanceResponseNonNullableFields, BulkChangeBalancesResponseNonNullableFields, ListBalancesOptions, BalancesQueryResult, BalancesQueryBuilder, ChangeBalanceOptions, ChangeBalanceOptionsOperationOneOf, BulkChangeBalancesOptions, RevertBalanceChangeOptions, } from './benefit-programs-v1-balance-balances.universal.js';
|
|
@@ -69,4 +69,4 @@ interface RevertBalanceChangeSignature {
|
|
|
69
69
|
*/
|
|
70
70
|
(transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions | undefined): Promise<RevertBalanceChangeResponse>;
|
|
71
71
|
}
|
|
72
|
-
export { ActionEvent, AdjustOptions, ApplicationError, Balance, BalanceAmount, BalanceChangeBalanceRequest, BalanceChangeBalanceRequestOperationOneOf, BalanceExceededLimits, BalanceNonNullableFields, BalancesQueryBuilder, BalancesQueryResult, BulkActionMetadata, BulkChangeBalanceResult, BulkChangeBalancesOptions, BulkChangeBalancesRequest, BulkChangeBalancesResponse, BulkChangeBalancesResponseNonNullableFields, ChangeAlreadyReverted, ChangeBalanceOptions, ChangeBalanceRequest, ChangeBalanceRequestOperationOneOf, ChangeBalanceRequestType, ChangeBalanceResponse, ChangeBalanceResponseNonNullableFields, CommonIdentificationData, CommonIdentificationDataIdOneOf, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetBalanceRequest, GetBalanceResponse, GetBalanceResponseNonNullableFields, GetTransactionReversibilityRequest, GetTransactionReversibilityResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, Item, ItemMetadata, LimitRule, ListBalancesOptions, ListBalancesRequest, ListBalancesResponse, ListBalancesResponseNonNullableFields, MessageEnvelope, NotEnoughBalance, PoolInfo, QueryBalancesRequest, QueryBalancesResponse, QueryBalancesResponseNonNullableFields, RestoreInfo, RevertBalanceChangeOptions, RevertBalanceChangeRequest, RevertBalanceChangeResponse, SetInitialOptions, SetOptions, SortOrder, Sorting, TransactionDetails, TransactionReversibility, Type, WebhookIdentityType, } from './benefit-programs-v1-balance-balances.universal.js';
|
|
72
|
+
export { ActionEvent, AdjustOptions, ApplicationError, Balance, BalanceAmount, BalanceChangeBalanceRequest, BalanceChangeBalanceRequestOperationOneOf, BalanceExceededLimits, BalanceNonNullableFields, BalancesQueryBuilder, BalancesQueryResult, BulkActionMetadata, BulkChangeBalanceResult, BulkChangeBalancesOptions, BulkChangeBalancesRequest, BulkChangeBalancesResponse, BulkChangeBalancesResponseNonNullableFields, ChangeAlreadyReverted, ChangeBalanceOptions, ChangeBalanceOptionsOperationOneOf, ChangeBalanceRequest, ChangeBalanceRequestOperationOneOf, ChangeBalanceRequestType, ChangeBalanceResponse, ChangeBalanceResponseNonNullableFields, CommonIdentificationData, CommonIdentificationDataIdOneOf, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ExtendedFields, GetBalanceRequest, GetBalanceResponse, GetBalanceResponseNonNullableFields, GetTransactionReversibilityRequest, GetTransactionReversibilityResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, Item, ItemMetadata, LimitRule, ListBalancesOptions, ListBalancesRequest, ListBalancesResponse, ListBalancesResponseNonNullableFields, MessageEnvelope, NotEnoughBalance, PoolInfo, QueryBalancesRequest, QueryBalancesResponse, QueryBalancesResponseNonNullableFields, RestoreInfo, RevertBalanceChangeOptions, RevertBalanceChangeRequest, RevertBalanceChangeResponse, SetInitialOptions, SetOptions, SortOrder, Sorting, TransactionDetails, TransactionReversibility, Type, WebhookIdentityType, } from './benefit-programs-v1-balance-balances.universal.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefit-programs-v1-balance-balances.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-balance-balances.public.ts"],"names":[],"mappings":";;;AACA,2HAqB6D;AAEhD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,MAAc,EAAE,EAAE,CACxB,IAAA,8DAAmB,EACjB,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gCAOC;AAWD,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,OAA6B,EAAE,EAAE,CACvC,IAAA,gEAAqB,EACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oCAOC;AAWD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,GAAG,EAAE,CACV,IAAA,iEAAsB;IACpB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,sCAMC;AAiBD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CACL,MAAc,EACd,cAAsB,EACtB,OAA8B,EAC9B,EAAE,CACF,IAAA,iEAAsB,EACpB,MAAM,EACN,cAAc,EACd,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,sCAaC;AAmBD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,IAAA,sEAA2B,EACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAcD,SAAgB,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CACL,aAAqB,EACrB,cAAsB,EACtB,OAAoC,EACpC,EAAE,CACF,IAAA,uEAA4B,EAC1B,aAAa,EACb,cAAc,EACd,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAfD,kDAeC;AAkBD,
|
|
1
|
+
{"version":3,"file":"benefit-programs-v1-balance-balances.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-balance-balances.public.ts"],"names":[],"mappings":";;;AACA,2HAqB6D;AAEhD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,MAAc,EAAE,EAAE,CACxB,IAAA,8DAAmB,EACjB,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gCAOC;AAWD,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,OAA6B,EAAE,EAAE,CACvC,IAAA,gEAAqB,EACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oCAOC;AAWD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,GAAG,EAAE,CACV,IAAA,iEAAsB;IACpB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,sCAMC;AAiBD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CACL,MAAc,EACd,cAAsB,EACtB,OAA8B,EAC9B,EAAE,CACF,IAAA,iEAAsB,EACpB,MAAM,EACN,cAAc,EACd,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,sCAaC;AAmBD,SAAgB,kBAAkB,CAChC,UAAsB;IAEtB,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,IAAA,sEAA2B,EACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,gDASC;AAcD,SAAgB,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CACL,aAAqB,EACrB,cAAsB,EACtB,OAAoC,EACpC,EAAE,CACF,IAAA,uEAA4B,EAC1B,aAAa,EACb,cAAc,EACd,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAfD,kDAeC;AAkBD,yHAwE6D;AAjD3D,6JAAA,wBAAwB,OAAA;AAuBxB,iJAAA,YAAY,OAAA;AAGZ,8IAAA,SAAS,OAAA;AAiBT,8IAAA,SAAS,OAAA;AAGT,6JAAA,wBAAwB,OAAA;AACxB,yIAAA,IAAI,OAAA;AACJ,wJAAA,mBAAmB,OAAA"}
|
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
export interface Balance {
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* Balance ID, which is the same as its associated pool ID.
|
|
4
|
+
* @format GUID
|
|
5
|
+
* @immutable
|
|
6
|
+
*/
|
|
3
7
|
id?: string;
|
|
4
8
|
/**
|
|
5
9
|
* Revision number, which increments by 1 each time the balance is updated.
|
|
@@ -39,25 +43,44 @@ export interface Balance {
|
|
|
39
43
|
extendedFields?: ExtendedFields;
|
|
40
44
|
/**
|
|
41
45
|
* Last transaction ID that triggered the change in balance.
|
|
46
|
+
* @format GUID
|
|
42
47
|
* @readonly
|
|
43
48
|
*/
|
|
44
49
|
lastTransactionId?: string | null;
|
|
45
50
|
}
|
|
46
51
|
export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
47
|
-
/**
|
|
52
|
+
/**
|
|
53
|
+
* ID of a site visitor that has not logged in to the site.
|
|
54
|
+
* @format GUID
|
|
55
|
+
*/
|
|
48
56
|
anonymousVisitorId?: string;
|
|
49
|
-
/**
|
|
57
|
+
/**
|
|
58
|
+
* ID of a site visitor that has logged in to the site.
|
|
59
|
+
* @format GUID
|
|
60
|
+
*/
|
|
50
61
|
memberId?: string;
|
|
51
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
64
|
+
* @format GUID
|
|
65
|
+
*/
|
|
52
66
|
wixUserId?: string;
|
|
53
67
|
}
|
|
54
68
|
/** @oneof */
|
|
55
69
|
export interface CommonIdentificationDataIdOneOf {
|
|
56
|
-
/**
|
|
70
|
+
/**
|
|
71
|
+
* ID of a site visitor that has not logged in to the site.
|
|
72
|
+
* @format GUID
|
|
73
|
+
*/
|
|
57
74
|
anonymousVisitorId?: string;
|
|
58
|
-
/**
|
|
75
|
+
/**
|
|
76
|
+
* ID of a site visitor that has logged in to the site.
|
|
77
|
+
* @format GUID
|
|
78
|
+
*/
|
|
59
79
|
memberId?: string;
|
|
60
|
-
/**
|
|
80
|
+
/**
|
|
81
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
82
|
+
* @format GUID
|
|
83
|
+
*/
|
|
61
84
|
wixUserId?: string;
|
|
62
85
|
}
|
|
63
86
|
export declare enum IdentityType {
|
|
@@ -73,6 +96,7 @@ export declare enum IdentityType {
|
|
|
73
96
|
export interface BalanceAmount {
|
|
74
97
|
/**
|
|
75
98
|
* Total credits available in the benefit pool.
|
|
99
|
+
* @decimalValue options { maxScale:4 }
|
|
76
100
|
* @readonly
|
|
77
101
|
*/
|
|
78
102
|
available?: string;
|
|
@@ -82,27 +106,38 @@ export interface PoolInfo {
|
|
|
82
106
|
* Pool ID.
|
|
83
107
|
*
|
|
84
108
|
* Represents the ID of the benefit pool linked to this balance.
|
|
109
|
+
* @format GUID
|
|
85
110
|
* @readonly
|
|
86
111
|
*/
|
|
87
112
|
id?: string;
|
|
88
113
|
/**
|
|
89
114
|
* Pool definition that this benefit pool was instantiated from.
|
|
115
|
+
* @format GUID
|
|
90
116
|
* @readonly
|
|
91
117
|
*/
|
|
92
118
|
poolDefinitionId?: string | null;
|
|
93
119
|
/**
|
|
94
120
|
* Program definition from which this benefit pool's program was provisioned from.
|
|
121
|
+
* @format GUID
|
|
95
122
|
* @readonly
|
|
96
123
|
*/
|
|
97
124
|
programDefinitionId?: string | null;
|
|
98
125
|
/**
|
|
99
126
|
* Active program that this benefit pool belongs to.
|
|
127
|
+
* @format GUID
|
|
100
128
|
* @readonly
|
|
101
129
|
*/
|
|
102
130
|
programId?: string | null;
|
|
103
|
-
/**
|
|
131
|
+
/**
|
|
132
|
+
* Total credits available in this benefit pool
|
|
133
|
+
* @decimalValue options { gte:0, maxScale:4 }
|
|
134
|
+
*/
|
|
104
135
|
creditAmount?: string | null;
|
|
105
|
-
/**
|
|
136
|
+
/**
|
|
137
|
+
* Module that is the source of this benefit pool creation.
|
|
138
|
+
* @minLength 1
|
|
139
|
+
* @maxLength 50
|
|
140
|
+
*/
|
|
106
141
|
namespace?: string | null;
|
|
107
142
|
}
|
|
108
143
|
export interface ExtendedFields {
|
|
@@ -117,7 +152,10 @@ export interface ExtendedFields {
|
|
|
117
152
|
namespaces?: Record<string, Record<string, any>>;
|
|
118
153
|
}
|
|
119
154
|
export interface GetBalanceRequest {
|
|
120
|
-
/**
|
|
155
|
+
/**
|
|
156
|
+
* ID of the pool from which to retrieve the balance.
|
|
157
|
+
* @format GUID
|
|
158
|
+
*/
|
|
121
159
|
poolId: string;
|
|
122
160
|
}
|
|
123
161
|
export interface GetBalanceResponse {
|
|
@@ -125,24 +163,35 @@ export interface GetBalanceResponse {
|
|
|
125
163
|
balance?: Balance;
|
|
126
164
|
}
|
|
127
165
|
export interface ListBalancesRequest {
|
|
128
|
-
/**
|
|
166
|
+
/**
|
|
167
|
+
* IDs of the pools from which to receive the balances.
|
|
168
|
+
* @format GUID
|
|
169
|
+
* @maxSize 100
|
|
170
|
+
*/
|
|
129
171
|
poolIds?: string[];
|
|
130
172
|
/** Cursor paging */
|
|
131
173
|
cursorPaging?: CursorPaging;
|
|
132
174
|
}
|
|
133
175
|
export interface CursorPaging {
|
|
134
|
-
/**
|
|
176
|
+
/**
|
|
177
|
+
* Maximum number of items to return in the results.
|
|
178
|
+
* @max 100
|
|
179
|
+
*/
|
|
135
180
|
limit?: number | null;
|
|
136
181
|
/**
|
|
137
182
|
* Pointer to the next or previous page in the list of results.
|
|
138
183
|
*
|
|
139
184
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
140
185
|
* Not relevant for the first request.
|
|
186
|
+
* @maxLength 16000
|
|
141
187
|
*/
|
|
142
188
|
cursor?: string | null;
|
|
143
189
|
}
|
|
144
190
|
export interface ListBalancesResponse {
|
|
145
|
-
/**
|
|
191
|
+
/**
|
|
192
|
+
* Balances.
|
|
193
|
+
* @maxSize 100
|
|
194
|
+
*/
|
|
146
195
|
balances?: Balance[];
|
|
147
196
|
/** Metadata for paginated results. */
|
|
148
197
|
metadata?: CursorPagingMetadata;
|
|
@@ -161,9 +210,15 @@ export interface CursorPagingMetadata {
|
|
|
161
210
|
hasNext?: boolean | null;
|
|
162
211
|
}
|
|
163
212
|
export interface Cursors {
|
|
164
|
-
/**
|
|
213
|
+
/**
|
|
214
|
+
* Cursor string pointing to the next page in the list of results.
|
|
215
|
+
* @maxLength 16000
|
|
216
|
+
*/
|
|
165
217
|
next?: string | null;
|
|
166
|
-
/**
|
|
218
|
+
/**
|
|
219
|
+
* Cursor pointing to the previous page in the list of results.
|
|
220
|
+
* @maxLength 16000
|
|
221
|
+
*/
|
|
167
222
|
prev?: string | null;
|
|
168
223
|
}
|
|
169
224
|
export interface QueryBalancesRequest {
|
|
@@ -185,6 +240,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
185
240
|
/**
|
|
186
241
|
* Sort object in the following format:
|
|
187
242
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
243
|
+
* @maxSize 5
|
|
188
244
|
*/
|
|
189
245
|
sort?: Sorting[];
|
|
190
246
|
}
|
|
@@ -194,7 +250,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
194
250
|
cursorPaging?: CursorPaging;
|
|
195
251
|
}
|
|
196
252
|
export interface Sorting {
|
|
197
|
-
/**
|
|
253
|
+
/**
|
|
254
|
+
* Name of the field to sort by.
|
|
255
|
+
* @maxLength 512
|
|
256
|
+
*/
|
|
198
257
|
fieldName?: string;
|
|
199
258
|
/** Sort order. */
|
|
200
259
|
order?: SortOrder;
|
|
@@ -216,11 +275,15 @@ export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequest
|
|
|
216
275
|
adjustOptions?: AdjustOptions;
|
|
217
276
|
/** Sets the balance to a specific amount. */
|
|
218
277
|
setOptions?: SetOptions;
|
|
219
|
-
/**
|
|
278
|
+
/**
|
|
279
|
+
* ID of the benefit pool to adjust.
|
|
280
|
+
* @format GUID
|
|
281
|
+
*/
|
|
220
282
|
poolId: string;
|
|
221
283
|
/**
|
|
222
284
|
* Unique identifier, generated by the client.
|
|
223
285
|
* Used to recognize repeated attempts to make the same request.
|
|
286
|
+
* @maxLength 200
|
|
224
287
|
*/
|
|
225
288
|
idempotencyKey: string;
|
|
226
289
|
/**
|
|
@@ -265,7 +328,10 @@ export declare enum ChangeBalanceRequestType {
|
|
|
265
328
|
SET_INITIAL = "SET_INITIAL"
|
|
266
329
|
}
|
|
267
330
|
export interface AdjustOptions {
|
|
268
|
-
/**
|
|
331
|
+
/**
|
|
332
|
+
* Amount to adjust the available balance by. Supports positive and negative values.
|
|
333
|
+
* @decimalValue options { maxScale:4 }
|
|
334
|
+
*/
|
|
269
335
|
value?: string;
|
|
270
336
|
/** Benefit pool owner associated with this balance. */
|
|
271
337
|
beneficiary?: CommonIdentificationData;
|
|
@@ -285,13 +351,17 @@ export interface SetOptions {
|
|
|
285
351
|
* Set the available balance to the provided amount.
|
|
286
352
|
*
|
|
287
353
|
* If the value set to is equal to the current balance, no action or corresponding transaction occurs.
|
|
354
|
+
* @decimalValue options { maxScale:4 }
|
|
288
355
|
*/
|
|
289
356
|
value?: string;
|
|
290
357
|
/** Benefit pool owner associated with this balance. */
|
|
291
358
|
beneficiary?: CommonIdentificationData;
|
|
292
359
|
}
|
|
293
360
|
export interface SetInitialOptions {
|
|
294
|
-
/**
|
|
361
|
+
/**
|
|
362
|
+
* Set the available balance to the provided amount.
|
|
363
|
+
* @decimalValue options { maxScale:4 }
|
|
364
|
+
*/
|
|
295
365
|
value?: string;
|
|
296
366
|
/** Benefit pool owner associated with this balance. */
|
|
297
367
|
beneficiary?: CommonIdentificationData;
|
|
@@ -313,29 +383,37 @@ export interface TransactionDetails {
|
|
|
313
383
|
/**
|
|
314
384
|
* Reason for the transaction. For example, `Redemption` or `Manual adjustment`.
|
|
315
385
|
* @readonly
|
|
386
|
+
* @maxLength 256
|
|
316
387
|
*/
|
|
317
388
|
reason?: string | null;
|
|
318
389
|
}
|
|
319
390
|
export interface Item {
|
|
320
391
|
/**
|
|
321
392
|
* Item ID.
|
|
393
|
+
* @format GUID
|
|
322
394
|
* @readonly
|
|
323
395
|
*/
|
|
324
396
|
id?: string | null;
|
|
325
397
|
/**
|
|
326
398
|
* External item ID.
|
|
399
|
+
* @format GUID
|
|
327
400
|
* @readonly
|
|
328
401
|
*/
|
|
329
402
|
externalId?: string | null;
|
|
330
403
|
/**
|
|
331
404
|
* Item category. Distinguishes between different types of items. For example, `posts`, `groups`, `events`.
|
|
405
|
+
* @maxLength 20
|
|
332
406
|
* @readonly
|
|
333
407
|
*/
|
|
334
408
|
category?: string | null;
|
|
335
|
-
/**
|
|
409
|
+
/**
|
|
410
|
+
* @format GUID
|
|
411
|
+
* @readonly
|
|
412
|
+
*/
|
|
336
413
|
itemSetId?: string | null;
|
|
337
414
|
/**
|
|
338
415
|
* Item display name.
|
|
416
|
+
* @maxLength 64
|
|
339
417
|
* @readonly
|
|
340
418
|
*/
|
|
341
419
|
displayName?: string | null;
|
|
@@ -343,7 +421,10 @@ export interface Item {
|
|
|
343
421
|
export interface ChangeBalanceResponse {
|
|
344
422
|
/** Changed balance. */
|
|
345
423
|
balance?: Balance;
|
|
346
|
-
/**
|
|
424
|
+
/**
|
|
425
|
+
* ID of the transaction resulting from the balance adjustment.
|
|
426
|
+
* @format GUID
|
|
427
|
+
*/
|
|
347
428
|
transactionId?: string | null;
|
|
348
429
|
}
|
|
349
430
|
export interface BalanceExceededLimits {
|
|
@@ -351,26 +432,34 @@ export interface BalanceExceededLimits {
|
|
|
351
432
|
balance?: BalanceAmount;
|
|
352
433
|
/**
|
|
353
434
|
* The requested amount
|
|
435
|
+
* @decimalValue options { maxScale:4 }
|
|
354
436
|
* @readonly
|
|
355
437
|
*/
|
|
356
438
|
requested?: string;
|
|
357
439
|
/**
|
|
358
440
|
* Lower limit
|
|
441
|
+
* @decimalValue options { maxScale:4 }
|
|
359
442
|
* @readonly
|
|
360
443
|
*/
|
|
361
444
|
lowerLimit?: string | null;
|
|
362
445
|
/**
|
|
363
446
|
* Upper limit
|
|
447
|
+
* @decimalValue options { maxScale:4 }
|
|
364
448
|
* @readonly
|
|
365
449
|
*/
|
|
366
450
|
upperLimit?: string | null;
|
|
367
451
|
}
|
|
368
452
|
export interface BulkChangeBalancesRequest {
|
|
369
|
-
/**
|
|
453
|
+
/**
|
|
454
|
+
* Requests
|
|
455
|
+
* @minSize 1
|
|
456
|
+
* @maxSize 100
|
|
457
|
+
*/
|
|
370
458
|
requests?: ChangeBalanceRequest[];
|
|
371
459
|
/**
|
|
372
460
|
* Unique identifier, generated by the client.
|
|
373
461
|
* Used to recognize repeated attempts to make the same request.
|
|
462
|
+
* @maxLength 200
|
|
374
463
|
*/
|
|
375
464
|
idempotencyKey: string;
|
|
376
465
|
/** Whether to return the entity in the response */
|
|
@@ -381,7 +470,10 @@ export declare enum Type {
|
|
|
381
470
|
UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
|
|
382
471
|
}
|
|
383
472
|
export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
|
|
384
|
-
/**
|
|
473
|
+
/**
|
|
474
|
+
* ID of the benefit pool to adjust.
|
|
475
|
+
* @format GUID
|
|
476
|
+
*/
|
|
385
477
|
poolId?: string;
|
|
386
478
|
/**
|
|
387
479
|
* Party requesting the balance change.
|
|
@@ -412,13 +504,20 @@ export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf
|
|
|
412
504
|
export interface ChangeBalanceRequestOperationOneOf {
|
|
413
505
|
}
|
|
414
506
|
export interface BulkChangeBalancesResponse {
|
|
415
|
-
/**
|
|
507
|
+
/**
|
|
508
|
+
* Results
|
|
509
|
+
* @minSize 1
|
|
510
|
+
* @maxSize 100
|
|
511
|
+
*/
|
|
416
512
|
results?: BulkChangeBalanceResult[];
|
|
417
513
|
/** Metadata for the bulk action */
|
|
418
514
|
bulkActionMetadata?: BulkActionMetadata;
|
|
419
515
|
}
|
|
420
516
|
export interface ItemMetadata {
|
|
421
|
-
/**
|
|
517
|
+
/**
|
|
518
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
519
|
+
* @format GUID
|
|
520
|
+
*/
|
|
422
521
|
id?: string | null;
|
|
423
522
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
424
523
|
originalIndex?: number;
|
|
@@ -450,11 +549,15 @@ export interface BulkActionMetadata {
|
|
|
450
549
|
undetailedFailures?: number;
|
|
451
550
|
}
|
|
452
551
|
export interface RevertBalanceChangeRequest {
|
|
453
|
-
/**
|
|
552
|
+
/**
|
|
553
|
+
* ID of the resulting transaction from the balance adjustment.
|
|
554
|
+
* @format GUID
|
|
555
|
+
*/
|
|
454
556
|
transactionId: string;
|
|
455
557
|
/**
|
|
456
558
|
* Unique identifier, generated by the client.
|
|
457
559
|
* Used to recognize repeated attempts to make the same request.
|
|
560
|
+
* @maxLength 200
|
|
458
561
|
*/
|
|
459
562
|
idempotencyKey: string;
|
|
460
563
|
/**
|
|
@@ -471,13 +574,22 @@ export interface RevertBalanceChangeRequest {
|
|
|
471
574
|
instructingParty?: CommonIdentificationData;
|
|
472
575
|
}
|
|
473
576
|
export interface RevertBalanceChangeResponse {
|
|
474
|
-
/**
|
|
577
|
+
/**
|
|
578
|
+
* ID of the resulting transaction from the balance adjustment.
|
|
579
|
+
* @format GUID
|
|
580
|
+
*/
|
|
475
581
|
transactionId?: string | null;
|
|
476
582
|
}
|
|
477
583
|
export interface ChangeAlreadyReverted {
|
|
478
|
-
/**
|
|
584
|
+
/**
|
|
585
|
+
* The id of the transaction which was already reverted
|
|
586
|
+
* @format GUID
|
|
587
|
+
*/
|
|
479
588
|
originalTransactionId?: string;
|
|
480
|
-
/**
|
|
589
|
+
/**
|
|
590
|
+
* The id of the transaction which reverted the original transaction
|
|
591
|
+
* @format GUID
|
|
592
|
+
*/
|
|
481
593
|
revertedTransactionId?: string;
|
|
482
594
|
}
|
|
483
595
|
export interface NotEnoughBalance {
|
|
@@ -485,12 +597,16 @@ export interface NotEnoughBalance {
|
|
|
485
597
|
balance?: BalanceAmount;
|
|
486
598
|
/**
|
|
487
599
|
* The requested amount
|
|
600
|
+
* @decimalValue options { maxScale:4 }
|
|
488
601
|
* @readonly
|
|
489
602
|
*/
|
|
490
603
|
requested?: string;
|
|
491
604
|
}
|
|
492
605
|
export interface GetTransactionReversibilityRequest {
|
|
493
|
-
/**
|
|
606
|
+
/**
|
|
607
|
+
* Id of the transaction to get the reversibility
|
|
608
|
+
* @format GUID
|
|
609
|
+
*/
|
|
494
610
|
transactionId?: string;
|
|
495
611
|
}
|
|
496
612
|
export interface GetTransactionReversibilityResponse {
|
|
@@ -577,9 +693,15 @@ export interface ActionEvent {
|
|
|
577
693
|
bodyAsJson?: string;
|
|
578
694
|
}
|
|
579
695
|
export interface MessageEnvelope {
|
|
580
|
-
/**
|
|
696
|
+
/**
|
|
697
|
+
* App instance ID.
|
|
698
|
+
* @format GUID
|
|
699
|
+
*/
|
|
581
700
|
instanceId?: string | null;
|
|
582
|
-
/**
|
|
701
|
+
/**
|
|
702
|
+
* Event type.
|
|
703
|
+
* @maxLength 150
|
|
704
|
+
*/
|
|
583
705
|
eventType?: string;
|
|
584
706
|
/** The identification type and identity data. */
|
|
585
707
|
identity?: IdentificationData;
|
|
@@ -587,26 +709,50 @@ export interface MessageEnvelope {
|
|
|
587
709
|
data?: string;
|
|
588
710
|
}
|
|
589
711
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
590
|
-
/**
|
|
712
|
+
/**
|
|
713
|
+
* ID of a site visitor that has not logged in to the site.
|
|
714
|
+
* @format GUID
|
|
715
|
+
*/
|
|
591
716
|
anonymousVisitorId?: string;
|
|
592
|
-
/**
|
|
717
|
+
/**
|
|
718
|
+
* ID of a site visitor that has logged in to the site.
|
|
719
|
+
* @format GUID
|
|
720
|
+
*/
|
|
593
721
|
memberId?: string;
|
|
594
|
-
/**
|
|
722
|
+
/**
|
|
723
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
724
|
+
* @format GUID
|
|
725
|
+
*/
|
|
595
726
|
wixUserId?: string;
|
|
596
|
-
/**
|
|
727
|
+
/**
|
|
728
|
+
* ID of an app.
|
|
729
|
+
* @format GUID
|
|
730
|
+
*/
|
|
597
731
|
appId?: string;
|
|
598
732
|
/** @readonly */
|
|
599
733
|
identityType?: WebhookIdentityType;
|
|
600
734
|
}
|
|
601
735
|
/** @oneof */
|
|
602
736
|
export interface IdentificationDataIdOneOf {
|
|
603
|
-
/**
|
|
737
|
+
/**
|
|
738
|
+
* ID of a site visitor that has not logged in to the site.
|
|
739
|
+
* @format GUID
|
|
740
|
+
*/
|
|
604
741
|
anonymousVisitorId?: string;
|
|
605
|
-
/**
|
|
742
|
+
/**
|
|
743
|
+
* ID of a site visitor that has logged in to the site.
|
|
744
|
+
* @format GUID
|
|
745
|
+
*/
|
|
606
746
|
memberId?: string;
|
|
607
|
-
/**
|
|
747
|
+
/**
|
|
748
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
749
|
+
* @format GUID
|
|
750
|
+
*/
|
|
608
751
|
wixUserId?: string;
|
|
609
|
-
/**
|
|
752
|
+
/**
|
|
753
|
+
* ID of an app.
|
|
754
|
+
* @format GUID
|
|
755
|
+
*/
|
|
610
756
|
appId?: string;
|
|
611
757
|
}
|
|
612
758
|
export declare enum WebhookIdentityType {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefit-programs-v1-balance-balances.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-balance-balances.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"benefit-programs-v1-balance-balances.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-balance-balances.types.ts"],"names":[],"mappings":";;;AAyFA,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;AAqLD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA4DD,IAAY,wBAQX;AARD,WAAY,wBAAwB;IAClC,yCAAyC;IACzC,mEAAuC,CAAA;IACvC,uDAAuD;IACvD,6CAAiB,CAAA;IACjB,4CAA4C;IAC5C,uCAAW,CAAA;IACX,uDAA2B,CAAA;AAC7B,CAAC,EARW,wBAAwB,wCAAxB,wBAAwB,QAQnC;AAYD,IAAY,SASX;AATD,WAAY,SAAS;IACnB,yBAAyB;IACzB,sDAAyC,CAAA;IACzC,wDAAwD;IACxD,0BAAa,CAAA;IACb,mMAAmM;IACnM,0CAA6B,CAAA;IAC7B,kTAAkT;IAClT,0CAA6B,CAAA;AAC/B,CAAC,EATW,SAAS,yBAAT,SAAS,QASpB;AAgID,IAAY,IAGX;AAHD,WAAY,IAAI;IACd,yCAAyC;IACzC,+CAAuC,CAAA;AACzC,CAAC,EAHW,IAAI,oBAAJ,IAAI,QAGf;AA+JD,wCAAwC;AACxC,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,4CAA4C;IAC5C,mFAAuD,CAAA;IACvD,gFAAgF;IAChF,yFAA6D,CAAA;AAC/D,CAAC,EALW,wBAAwB,wCAAxB,wBAAwB,QAKnC;AAmJD,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"}
|