@wix/auto_sdk_ecom_tax-regions 1.0.2 → 1.0.4
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/{internal/cjs/src/billing-v1-tax-region-tax-regions.universal.d.ts → billing-v1-tax-region-tax-regions.universal-0Nssv7EX.d.mts} +53 -261
- package/build/{cjs/src/billing-v1-tax-region-tax-regions.universal.d.ts → billing-v1-tax-region-tax-regions.universal-0Nssv7EX.d.ts} +53 -261
- package/build/index.d.mts +91 -0
- package/build/index.d.ts +91 -0
- package/build/index.js +493 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +460 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/billing-v1-tax-region-tax-regions.universal.d.ts → internal/billing-v1-tax-region-tax-regions.universal-0Nssv7EX.d.mts} +53 -261
- package/build/internal/{es/src/billing-v1-tax-region-tax-regions.universal.d.ts → billing-v1-tax-region-tax-regions.universal-0Nssv7EX.d.ts} +53 -261
- package/build/internal/index.d.mts +91 -0
- package/build/internal/index.d.ts +91 -0
- package/build/internal/index.js +493 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +460 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +206 -0
- package/build/internal/meta.d.ts +206 -0
- package/build/internal/meta.js +312 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +281 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +206 -0
- package/build/meta.d.ts +206 -0
- package/build/meta.js +312 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +281 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-region-tax-regions.context.d.ts +0 -23
- package/build/cjs/src/billing-v1-tax-region-tax-regions.context.js +0 -28
- package/build/cjs/src/billing-v1-tax-region-tax-regions.context.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-region-tax-regions.http.d.ts +0 -44
- package/build/cjs/src/billing-v1-tax-region-tax-regions.http.js +0 -227
- package/build/cjs/src/billing-v1-tax-region-tax-regions.http.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-region-tax-regions.meta.d.ts +0 -23
- package/build/cjs/src/billing-v1-tax-region-tax-regions.meta.js +0 -123
- package/build/cjs/src/billing-v1-tax-region-tax-regions.meta.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-region-tax-regions.public.d.ts +0 -77
- package/build/cjs/src/billing-v1-tax-region-tax-regions.public.js +0 -73
- package/build/cjs/src/billing-v1-tax-region-tax-regions.public.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-region-tax-regions.types.d.ts +0 -446
- package/build/cjs/src/billing-v1-tax-region-tax-regions.types.js +0 -17
- package/build/cjs/src/billing-v1-tax-region-tax-regions.types.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-region-tax-regions.universal.js +0 -311
- package/build/cjs/src/billing-v1-tax-region-tax-regions.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/billing-v1-tax-region-tax-regions.context.d.ts +0 -23
- package/build/es/src/billing-v1-tax-region-tax-regions.context.js +0 -23
- package/build/es/src/billing-v1-tax-region-tax-regions.context.js.map +0 -1
- package/build/es/src/billing-v1-tax-region-tax-regions.http.d.ts +0 -44
- package/build/es/src/billing-v1-tax-region-tax-regions.http.js +0 -219
- package/build/es/src/billing-v1-tax-region-tax-regions.http.js.map +0 -1
- package/build/es/src/billing-v1-tax-region-tax-regions.meta.d.ts +0 -23
- package/build/es/src/billing-v1-tax-region-tax-regions.meta.js +0 -92
- package/build/es/src/billing-v1-tax-region-tax-regions.meta.js.map +0 -1
- package/build/es/src/billing-v1-tax-region-tax-regions.public.d.ts +0 -77
- package/build/es/src/billing-v1-tax-region-tax-regions.public.js +0 -63
- package/build/es/src/billing-v1-tax-region-tax-regions.public.js.map +0 -1
- package/build/es/src/billing-v1-tax-region-tax-regions.types.d.ts +0 -446
- package/build/es/src/billing-v1-tax-region-tax-regions.types.js +0 -14
- package/build/es/src/billing-v1-tax-region-tax-regions.types.js.map +0 -1
- package/build/es/src/billing-v1-tax-region-tax-regions.universal.js +0 -280
- package/build/es/src/billing-v1-tax-region-tax-regions.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.context.d.ts +0 -23
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.context.js +0 -28
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.context.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.http.d.ts +0 -44
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.http.js +0 -227
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.http.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.meta.d.ts +0 -23
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.meta.js +0 -123
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.meta.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.public.d.ts +0 -77
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.public.js +0 -73
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.public.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.types.d.ts +0 -446
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.types.js +0 -17
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.types.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.universal.js +0 -311
- package/build/internal/cjs/src/billing-v1-tax-region-tax-regions.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.context.d.ts +0 -23
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.context.js +0 -23
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.context.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.http.d.ts +0 -44
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.http.js +0 -219
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.http.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.meta.d.ts +0 -23
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.meta.js +0 -92
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.meta.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.public.d.ts +0 -77
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.public.js +0 -63
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.public.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.types.d.ts +0 -446
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.types.js +0 -14
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.types.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.universal.js +0 -280
- package/build/internal/es/src/billing-v1-tax-region-tax-regions.universal.js.map +0 -1
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* A location is defined by `country` and `subdivision`. The tax region also
|
|
4
4
|
* dictates whether or not tax is included in the displayed price.
|
|
5
5
|
*/
|
|
6
|
-
|
|
6
|
+
interface TaxRegion {
|
|
7
7
|
/**
|
|
8
8
|
* Tax region ID.
|
|
9
9
|
* @format GUID
|
|
@@ -49,22 +49,22 @@ export interface TaxRegion {
|
|
|
49
49
|
*/
|
|
50
50
|
_updatedDate?: Date | null;
|
|
51
51
|
}
|
|
52
|
-
|
|
52
|
+
interface CreateTaxRegionRequest {
|
|
53
53
|
/** Tax region to create. */
|
|
54
54
|
taxRegion: TaxRegion;
|
|
55
55
|
}
|
|
56
|
-
|
|
56
|
+
interface CreateTaxRegionResponse {
|
|
57
57
|
/** Created tax region. */
|
|
58
58
|
taxRegion?: TaxRegion;
|
|
59
59
|
}
|
|
60
|
-
|
|
60
|
+
interface ConflictErrorDetails {
|
|
61
61
|
/**
|
|
62
62
|
* Conflict details.
|
|
63
63
|
* @maxLength 1000
|
|
64
64
|
*/
|
|
65
65
|
reasonForConflict?: string;
|
|
66
66
|
}
|
|
67
|
-
|
|
67
|
+
interface BulkCreateTaxRegionRequest {
|
|
68
68
|
/**
|
|
69
69
|
* Tax regions to create.
|
|
70
70
|
* @minSize 1
|
|
@@ -78,7 +78,7 @@ export interface BulkCreateTaxRegionRequest {
|
|
|
78
78
|
*/
|
|
79
79
|
returnEntity?: boolean;
|
|
80
80
|
}
|
|
81
|
-
|
|
81
|
+
interface BulkCreateTaxRegionResponse {
|
|
82
82
|
/**
|
|
83
83
|
* Tax regions created by bulk action.
|
|
84
84
|
* @minSize 1
|
|
@@ -88,7 +88,7 @@ export interface BulkCreateTaxRegionResponse {
|
|
|
88
88
|
/** Bulk action metadata. */
|
|
89
89
|
bulkActionMetadata?: BulkActionMetadata;
|
|
90
90
|
}
|
|
91
|
-
|
|
91
|
+
interface BulkCreateTaxRegionResult {
|
|
92
92
|
/** Item metadata. */
|
|
93
93
|
itemMetadata?: ItemMetadata;
|
|
94
94
|
/**
|
|
@@ -99,7 +99,7 @@ export interface BulkCreateTaxRegionResult {
|
|
|
99
99
|
*/
|
|
100
100
|
item?: TaxRegion;
|
|
101
101
|
}
|
|
102
|
-
|
|
102
|
+
interface ItemMetadata {
|
|
103
103
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
104
104
|
_id?: string | null;
|
|
105
105
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -109,7 +109,7 @@ export interface ItemMetadata {
|
|
|
109
109
|
/** Details about the error in case of failure. */
|
|
110
110
|
error?: ApplicationError;
|
|
111
111
|
}
|
|
112
|
-
|
|
112
|
+
interface ApplicationError {
|
|
113
113
|
/** Error code. */
|
|
114
114
|
code?: string;
|
|
115
115
|
/** Description of the error. */
|
|
@@ -117,7 +117,7 @@ export interface ApplicationError {
|
|
|
117
117
|
/** Data related to the error. */
|
|
118
118
|
data?: Record<string, any> | null;
|
|
119
119
|
}
|
|
120
|
-
|
|
120
|
+
interface BulkActionMetadata {
|
|
121
121
|
/** Number of items that were successfully processed. */
|
|
122
122
|
totalSuccesses?: number;
|
|
123
123
|
/** Number of items that couldn't be processed. */
|
|
@@ -125,39 +125,39 @@ export interface BulkActionMetadata {
|
|
|
125
125
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
126
126
|
undetailedFailures?: number;
|
|
127
127
|
}
|
|
128
|
-
|
|
128
|
+
interface GetTaxRegionRequest {
|
|
129
129
|
/**
|
|
130
130
|
* ID of the tax region to retrieve.
|
|
131
131
|
* @format GUID
|
|
132
132
|
*/
|
|
133
133
|
taxRegionId: string;
|
|
134
134
|
}
|
|
135
|
-
|
|
135
|
+
interface GetTaxRegionResponse {
|
|
136
136
|
/** Retrieved tax region. */
|
|
137
137
|
taxRegion?: TaxRegion;
|
|
138
138
|
}
|
|
139
|
-
|
|
139
|
+
interface UpdateTaxRegionRequest {
|
|
140
140
|
/** Tax region info to update. */
|
|
141
141
|
taxRegion: TaxRegion;
|
|
142
142
|
}
|
|
143
|
-
|
|
143
|
+
interface UpdateTaxRegionResponse {
|
|
144
144
|
/** Updated tax region. */
|
|
145
145
|
taxRegion?: TaxRegion;
|
|
146
146
|
}
|
|
147
|
-
|
|
147
|
+
interface DeleteTaxRegionRequest {
|
|
148
148
|
/**
|
|
149
149
|
* ID of the tax region to delete.
|
|
150
150
|
* @format GUID
|
|
151
151
|
*/
|
|
152
152
|
taxRegionId: string;
|
|
153
153
|
}
|
|
154
|
-
|
|
154
|
+
interface DeleteTaxRegionResponse {
|
|
155
155
|
}
|
|
156
|
-
|
|
156
|
+
interface QueryTaxRegionsRequest {
|
|
157
157
|
/** Query options. */
|
|
158
158
|
query?: CursorQuery;
|
|
159
159
|
}
|
|
160
|
-
|
|
160
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
161
161
|
/**
|
|
162
162
|
* Cursor paging options.
|
|
163
163
|
*
|
|
@@ -179,7 +179,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
179
179
|
sort?: Sorting[];
|
|
180
180
|
}
|
|
181
181
|
/** @oneof */
|
|
182
|
-
|
|
182
|
+
interface CursorQueryPagingMethodOneOf {
|
|
183
183
|
/**
|
|
184
184
|
* Cursor paging options.
|
|
185
185
|
*
|
|
@@ -187,7 +187,7 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
187
187
|
*/
|
|
188
188
|
cursorPaging?: CursorPaging;
|
|
189
189
|
}
|
|
190
|
-
|
|
190
|
+
interface Sorting {
|
|
191
191
|
/**
|
|
192
192
|
* Name of the field to sort by.
|
|
193
193
|
* @maxLength 512
|
|
@@ -196,11 +196,11 @@ export interface Sorting {
|
|
|
196
196
|
/** Sort order. */
|
|
197
197
|
order?: SortOrder;
|
|
198
198
|
}
|
|
199
|
-
|
|
199
|
+
declare enum SortOrder {
|
|
200
200
|
ASC = "ASC",
|
|
201
201
|
DESC = "DESC"
|
|
202
202
|
}
|
|
203
|
-
|
|
203
|
+
interface CursorPaging {
|
|
204
204
|
/**
|
|
205
205
|
* Maximum number of items to return in the results.
|
|
206
206
|
* @max 100
|
|
@@ -215,13 +215,13 @@ export interface CursorPaging {
|
|
|
215
215
|
*/
|
|
216
216
|
cursor?: string | null;
|
|
217
217
|
}
|
|
218
|
-
|
|
218
|
+
interface QueryTaxRegionsResponse {
|
|
219
219
|
/** Retrieved tax regions. */
|
|
220
220
|
taxRegions?: TaxRegion[];
|
|
221
221
|
/** Paging metadata. */
|
|
222
222
|
pagingMetadata?: CursorPagingMetadata;
|
|
223
223
|
}
|
|
224
|
-
|
|
224
|
+
interface CursorPagingMetadata {
|
|
225
225
|
/** Number of items returned in current page. */
|
|
226
226
|
count?: number | null;
|
|
227
227
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -234,7 +234,7 @@ export interface CursorPagingMetadata {
|
|
|
234
234
|
*/
|
|
235
235
|
hasNext?: boolean | null;
|
|
236
236
|
}
|
|
237
|
-
|
|
237
|
+
interface Cursors {
|
|
238
238
|
/**
|
|
239
239
|
* Cursor string pointing to the next page in the list of results.
|
|
240
240
|
* @maxLength 16000
|
|
@@ -246,24 +246,24 @@ export interface Cursors {
|
|
|
246
246
|
*/
|
|
247
247
|
prev?: string | null;
|
|
248
248
|
}
|
|
249
|
-
|
|
249
|
+
interface CreateOrGetTaxRegionWithoutValidationRequest {
|
|
250
250
|
/** Tax region to create. */
|
|
251
251
|
taxRegion?: TaxRegion;
|
|
252
252
|
}
|
|
253
|
-
|
|
253
|
+
interface CreateOrGetTaxRegionWithoutValidationResponse {
|
|
254
254
|
/** Created tax region. */
|
|
255
255
|
taxRegion?: TaxRegion;
|
|
256
256
|
}
|
|
257
|
-
|
|
257
|
+
interface DeleteTaxRegionWithoutDomainEventsRequest {
|
|
258
258
|
/**
|
|
259
259
|
* ID of the tax region to delete.
|
|
260
260
|
* @format GUID
|
|
261
261
|
*/
|
|
262
262
|
taxRegionId?: string;
|
|
263
263
|
}
|
|
264
|
-
|
|
264
|
+
interface DeleteTaxRegionWithoutDomainEventsResponse {
|
|
265
265
|
}
|
|
266
|
-
|
|
266
|
+
interface BulkRestoreTaxRegionsRequest {
|
|
267
267
|
/**
|
|
268
268
|
* Tax region IDs to restore.
|
|
269
269
|
* @format GUID
|
|
@@ -272,7 +272,7 @@ export interface BulkRestoreTaxRegionsRequest {
|
|
|
272
272
|
*/
|
|
273
273
|
taxRegionIds?: string[];
|
|
274
274
|
}
|
|
275
|
-
|
|
275
|
+
interface BulkRestoreTaxRegionsResponse {
|
|
276
276
|
/**
|
|
277
277
|
* Restored tax regions result
|
|
278
278
|
* @minSize 1
|
|
@@ -280,10 +280,10 @@ export interface BulkRestoreTaxRegionsResponse {
|
|
|
280
280
|
*/
|
|
281
281
|
results?: BulkRestoreTaxRegionsResult[];
|
|
282
282
|
}
|
|
283
|
-
|
|
283
|
+
interface BulkRestoreTaxRegionsResult {
|
|
284
284
|
itemMetadata?: ItemMetadata;
|
|
285
285
|
}
|
|
286
|
-
|
|
286
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
287
287
|
createdEvent?: EntityCreatedEvent;
|
|
288
288
|
updatedEvent?: EntityUpdatedEvent;
|
|
289
289
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -326,19 +326,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
326
326
|
entityEventSequence?: string | null;
|
|
327
327
|
}
|
|
328
328
|
/** @oneof */
|
|
329
|
-
|
|
329
|
+
interface DomainEventBodyOneOf {
|
|
330
330
|
createdEvent?: EntityCreatedEvent;
|
|
331
331
|
updatedEvent?: EntityUpdatedEvent;
|
|
332
332
|
deletedEvent?: EntityDeletedEvent;
|
|
333
333
|
actionEvent?: ActionEvent;
|
|
334
334
|
}
|
|
335
|
-
|
|
335
|
+
interface EntityCreatedEvent {
|
|
336
336
|
entity?: string;
|
|
337
337
|
}
|
|
338
|
-
|
|
338
|
+
interface RestoreInfo {
|
|
339
339
|
deletedDate?: Date | null;
|
|
340
340
|
}
|
|
341
|
-
|
|
341
|
+
interface EntityUpdatedEvent {
|
|
342
342
|
/**
|
|
343
343
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
344
344
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -346,14 +346,14 @@ export interface EntityUpdatedEvent {
|
|
|
346
346
|
*/
|
|
347
347
|
currentEntity?: string;
|
|
348
348
|
}
|
|
349
|
-
|
|
349
|
+
interface EntityDeletedEvent {
|
|
350
350
|
/** Entity that was deleted */
|
|
351
351
|
deletedEntity?: string | null;
|
|
352
352
|
}
|
|
353
|
-
|
|
353
|
+
interface ActionEvent {
|
|
354
354
|
body?: string;
|
|
355
355
|
}
|
|
356
|
-
|
|
356
|
+
interface MessageEnvelope {
|
|
357
357
|
/**
|
|
358
358
|
* App instance ID.
|
|
359
359
|
* @format GUID
|
|
@@ -369,7 +369,7 @@ export interface MessageEnvelope {
|
|
|
369
369
|
/** Stringify payload. */
|
|
370
370
|
data?: string;
|
|
371
371
|
}
|
|
372
|
-
|
|
372
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
373
373
|
/**
|
|
374
374
|
* ID of a site visitor that has not logged in to the site.
|
|
375
375
|
* @format GUID
|
|
@@ -394,7 +394,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
394
394
|
identityType?: WebhookIdentityType;
|
|
395
395
|
}
|
|
396
396
|
/** @oneof */
|
|
397
|
-
|
|
397
|
+
interface IdentificationDataIdOneOf {
|
|
398
398
|
/**
|
|
399
399
|
* ID of a site visitor that has not logged in to the site.
|
|
400
400
|
* @format GUID
|
|
@@ -416,32 +416,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
416
416
|
*/
|
|
417
417
|
appId?: string;
|
|
418
418
|
}
|
|
419
|
-
|
|
419
|
+
declare enum WebhookIdentityType {
|
|
420
420
|
UNKNOWN = "UNKNOWN",
|
|
421
421
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
422
422
|
MEMBER = "MEMBER",
|
|
423
423
|
WIX_USER = "WIX_USER",
|
|
424
424
|
APP = "APP"
|
|
425
425
|
}
|
|
426
|
-
|
|
427
|
-
country: string;
|
|
428
|
-
subdivision: string;
|
|
429
|
-
appId: string;
|
|
430
|
-
taxIncludedInPrice: boolean;
|
|
431
|
-
}
|
|
432
|
-
export interface CreateTaxRegionResponseNonNullableFields {
|
|
433
|
-
taxRegion?: TaxRegionNonNullableFields;
|
|
434
|
-
}
|
|
435
|
-
export interface GetTaxRegionResponseNonNullableFields {
|
|
436
|
-
taxRegion?: TaxRegionNonNullableFields;
|
|
437
|
-
}
|
|
438
|
-
export interface UpdateTaxRegionResponseNonNullableFields {
|
|
439
|
-
taxRegion?: TaxRegionNonNullableFields;
|
|
440
|
-
}
|
|
441
|
-
export interface QueryTaxRegionsResponseNonNullableFields {
|
|
442
|
-
taxRegions: TaxRegionNonNullableFields[];
|
|
443
|
-
}
|
|
444
|
-
export interface BaseEventMetadata {
|
|
426
|
+
interface BaseEventMetadata {
|
|
445
427
|
/**
|
|
446
428
|
* App instance ID.
|
|
447
429
|
* @format GUID
|
|
@@ -455,7 +437,7 @@ export interface BaseEventMetadata {
|
|
|
455
437
|
/** The identification type and identity data. */
|
|
456
438
|
identity?: IdentificationData;
|
|
457
439
|
}
|
|
458
|
-
|
|
440
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
459
441
|
/**
|
|
460
442
|
* Unique event ID.
|
|
461
443
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -493,155 +475,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
493
475
|
*/
|
|
494
476
|
entityEventSequence?: string | null;
|
|
495
477
|
}
|
|
496
|
-
|
|
478
|
+
interface TaxRegionCreatedEnvelope {
|
|
497
479
|
entity: TaxRegion;
|
|
498
480
|
metadata: EventMetadata;
|
|
499
481
|
}
|
|
500
|
-
|
|
501
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
502
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
503
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
504
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
505
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
506
|
-
* @permissionScope Picasso private app mega scope
|
|
507
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
508
|
-
* @permissionScope Manage Orders
|
|
509
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
510
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
511
|
-
* @webhook
|
|
512
|
-
* @eventType wix.billing.v1.tax_region_created
|
|
513
|
-
* @serviceIdentifier wix.billing.v1.TaxRegionsService
|
|
514
|
-
* @slug created
|
|
515
|
-
* @documentationMaturity preview
|
|
516
|
-
*/
|
|
517
|
-
export declare function onTaxRegionCreated(handler: (event: TaxRegionCreatedEnvelope) => void | Promise<void>): void;
|
|
518
|
-
export interface TaxRegionDeletedEnvelope {
|
|
482
|
+
interface TaxRegionDeletedEnvelope {
|
|
519
483
|
metadata: EventMetadata;
|
|
520
484
|
}
|
|
521
|
-
|
|
522
|
-
* Triggered when a tax region is deleted.
|
|
523
|
-
* @permissionScope Manage Stores - all permissions
|
|
524
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
525
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
526
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
527
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
528
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
529
|
-
* @permissionScope Picasso private app mega scope
|
|
530
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
531
|
-
* @permissionScope Manage Orders
|
|
532
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
533
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
534
|
-
* @webhook
|
|
535
|
-
* @eventType wix.billing.v1.tax_region_deleted
|
|
536
|
-
* @serviceIdentifier wix.billing.v1.TaxRegionsService
|
|
537
|
-
* @slug deleted
|
|
538
|
-
* @documentationMaturity preview
|
|
539
|
-
*/
|
|
540
|
-
export declare function onTaxRegionDeleted(handler: (event: TaxRegionDeletedEnvelope) => void | Promise<void>): void;
|
|
541
|
-
export interface TaxRegionUpdatedEnvelope {
|
|
485
|
+
interface TaxRegionUpdatedEnvelope {
|
|
542
486
|
entity: TaxRegion;
|
|
543
487
|
metadata: EventMetadata;
|
|
544
488
|
}
|
|
545
|
-
|
|
546
|
-
* Triggered when a tax region is updated.
|
|
547
|
-
* @permissionScope Manage Stores - all permissions
|
|
548
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
549
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
550
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
551
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
552
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
553
|
-
* @permissionScope Picasso private app mega scope
|
|
554
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
555
|
-
* @permissionScope Manage Orders
|
|
556
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
557
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
558
|
-
* @webhook
|
|
559
|
-
* @eventType wix.billing.v1.tax_region_updated
|
|
560
|
-
* @serviceIdentifier wix.billing.v1.TaxRegionsService
|
|
561
|
-
* @slug updated
|
|
562
|
-
* @documentationMaturity preview
|
|
563
|
-
*/
|
|
564
|
-
export declare function onTaxRegionUpdated(handler: (event: TaxRegionUpdatedEnvelope) => void | Promise<void>): void;
|
|
565
|
-
/**
|
|
566
|
-
* Creates a tax region.
|
|
567
|
-
*
|
|
568
|
-
* Tax regions require a tax calculator `appId`. Call List Tax Calculators to retrieve a list of available calculators for a site.
|
|
569
|
-
*
|
|
570
|
-
* Wix uses tax regions to calculate tax.
|
|
571
|
-
* <!-- Subdivisions are supported for the following countries: `AU`, `BR`, `CA`, `FR`, `DE`, `IN`, `IT`, `MX`, `NL`, `ES`, `AE`, `GB`, `US` -->
|
|
572
|
-
* @param taxRegion - Tax region to create.
|
|
573
|
-
* @public
|
|
574
|
-
* @documentationMaturity preview
|
|
575
|
-
* @requiredField taxRegion
|
|
576
|
-
* @requiredField taxRegion.appId
|
|
577
|
-
* @requiredField taxRegion.country
|
|
578
|
-
* @requiredField taxRegion.taxIncludedInPrice
|
|
579
|
-
* @permissionId BILLING.TAX_REGION_CREATE
|
|
580
|
-
* @permissionScope Manage Stores - all permissions
|
|
581
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
582
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
583
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
584
|
-
* @permissionScope Picasso private app mega scope
|
|
585
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
586
|
-
* @permissionScope Manage Orders
|
|
587
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
588
|
-
* @applicableIdentity APP
|
|
589
|
-
* @returns Created tax region.
|
|
590
|
-
* @fqn wix.billing.v1.TaxRegionsService.CreateTaxRegion
|
|
591
|
-
*/
|
|
592
|
-
export declare function createTaxRegion(taxRegion: TaxRegion): Promise<TaxRegion & TaxRegionNonNullableFields>;
|
|
593
|
-
/**
|
|
594
|
-
* Retrieves a tax region.
|
|
595
|
-
* @param taxRegionId - ID of the tax region to retrieve.
|
|
596
|
-
* @public
|
|
597
|
-
* @documentationMaturity preview
|
|
598
|
-
* @requiredField taxRegionId
|
|
599
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
600
|
-
* @permissionScope Manage Stores - all permissions
|
|
601
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
602
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
603
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
604
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
605
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
606
|
-
* @permissionScope Picasso private app mega scope
|
|
607
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
608
|
-
* @permissionScope Manage Orders
|
|
609
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
610
|
-
* @applicableIdentity APP
|
|
611
|
-
* @applicableIdentity VISITOR
|
|
612
|
-
* @returns Retrieved tax region.
|
|
613
|
-
* @fqn wix.billing.v1.TaxRegionsService.GetTaxRegion
|
|
614
|
-
*/
|
|
615
|
-
export declare function getTaxRegion(taxRegionId: string): Promise<TaxRegion & TaxRegionNonNullableFields>;
|
|
616
|
-
/**
|
|
617
|
-
* Updates a tax region.
|
|
618
|
-
*
|
|
619
|
-
* Each time the tax region is updated, `revision` increments by 1.
|
|
620
|
-
* The current `revision` must be passed when updating the tax region.
|
|
621
|
-
* This ensures you're working with the latest tax region and prevents
|
|
622
|
-
* unintended overwrites.
|
|
623
|
-
* @param _id - Tax region ID.
|
|
624
|
-
* @public
|
|
625
|
-
* @documentationMaturity preview
|
|
626
|
-
* @requiredField _id
|
|
627
|
-
* @requiredField taxRegion
|
|
628
|
-
* @requiredField taxRegion.revision
|
|
629
|
-
* @param taxRegion - Tax region info.
|
|
630
|
-
* @permissionId BILLING.TAX_REGION_UPDATE
|
|
631
|
-
* @permissionScope Manage Stores - all permissions
|
|
632
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
633
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
634
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
635
|
-
* @permissionScope Picasso private app mega scope
|
|
636
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
637
|
-
* @permissionScope Manage Orders
|
|
638
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
639
|
-
* @applicableIdentity APP
|
|
640
|
-
* @returns Updated tax region.
|
|
641
|
-
* @fqn wix.billing.v1.TaxRegionsService.UpdateTaxRegion
|
|
642
|
-
*/
|
|
643
|
-
export declare function updateTaxRegion(_id: string | null, taxRegion: UpdateTaxRegion): Promise<TaxRegion & TaxRegionNonNullableFields>;
|
|
644
|
-
export interface UpdateTaxRegion {
|
|
489
|
+
interface UpdateTaxRegion {
|
|
645
490
|
/**
|
|
646
491
|
* Tax region ID.
|
|
647
492
|
* @format GUID
|
|
@@ -687,60 +532,6 @@ export interface UpdateTaxRegion {
|
|
|
687
532
|
*/
|
|
688
533
|
_updatedDate?: Date | null;
|
|
689
534
|
}
|
|
690
|
-
/**
|
|
691
|
-
* Deletes a tax region.
|
|
692
|
-
*
|
|
693
|
-
* When a tax region is deleted, tax is not calculated and zero tax will be returned for addresses in this region.
|
|
694
|
-
* @param taxRegionId - ID of the tax region to delete.
|
|
695
|
-
* @public
|
|
696
|
-
* @documentationMaturity preview
|
|
697
|
-
* @requiredField taxRegionId
|
|
698
|
-
* @permissionId BILLING.TAX_REGION_DELETE
|
|
699
|
-
* @permissionScope Manage Stores - all permissions
|
|
700
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
701
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
702
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
703
|
-
* @permissionScope Picasso private app mega scope
|
|
704
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
705
|
-
* @permissionScope Manage Orders
|
|
706
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
707
|
-
* @applicableIdentity APP
|
|
708
|
-
* @fqn wix.billing.v1.TaxRegionsService.DeleteTaxRegion
|
|
709
|
-
*/
|
|
710
|
-
export declare function deleteTaxRegion(taxRegionId: string): Promise<void>;
|
|
711
|
-
/**
|
|
712
|
-
* Creates a query to retrieve a list of tax regions.
|
|
713
|
-
*
|
|
714
|
-
* The `queryTaxRegions()` function builds a query to retrieve a list of tax regions and returns a `TaxRegionsQueryBuilder` object.
|
|
715
|
-
*
|
|
716
|
-
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
717
|
-
*
|
|
718
|
-
* You can refine the query by chaining `TaxRegionsQueryBuilder` functions onto the query. `TaxRegionsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTaxRegions()` returns.
|
|
719
|
-
*
|
|
720
|
-
* `queryTaxRegions()` runs with the following `TaxRegionsQueryBuilder` default that you can override:
|
|
721
|
-
* + `ascending("_id")`
|
|
722
|
-
*
|
|
723
|
-
* The functions that are chained to `queryTaxRegions()` are applied in the order they are called. For example, if you apply `ascending("country")` and then `ascending("subdivision")`, the results are sorted first by the `"country"`, and then, if there are multiple results with the same `"country"`, the items are sorted by `"subdivision"`.
|
|
724
|
-
*
|
|
725
|
-
* The following `TaxRegionsQueryBuilder` functions are supported for the `queryTaxRegions()` function. For a full description of the tax region object, see the object returned for the `items` property in `TaxRegionsQueryResult`.
|
|
726
|
-
* @public
|
|
727
|
-
* @documentationMaturity preview
|
|
728
|
-
* @permissionScope Manage Stores - all permissions
|
|
729
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
730
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
731
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
732
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
733
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
734
|
-
* @permissionScope Picasso private app mega scope
|
|
735
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
736
|
-
* @permissionScope Manage Orders
|
|
737
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
738
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
739
|
-
* @applicableIdentity APP
|
|
740
|
-
* @applicableIdentity VISITOR
|
|
741
|
-
* @fqn wix.billing.v1.TaxRegionsService.QueryTaxRegions
|
|
742
|
-
*/
|
|
743
|
-
export declare function queryTaxRegions(): TaxRegionsQueryBuilder;
|
|
744
535
|
interface QueryCursorResult {
|
|
745
536
|
cursors: Cursors;
|
|
746
537
|
hasNext: () => boolean;
|
|
@@ -748,13 +539,13 @@ interface QueryCursorResult {
|
|
|
748
539
|
length: number;
|
|
749
540
|
pageSize: number;
|
|
750
541
|
}
|
|
751
|
-
|
|
542
|
+
interface TaxRegionsQueryResult extends QueryCursorResult {
|
|
752
543
|
items: TaxRegion[];
|
|
753
544
|
query: TaxRegionsQueryBuilder;
|
|
754
545
|
next: () => Promise<TaxRegionsQueryResult>;
|
|
755
546
|
prev: () => Promise<TaxRegionsQueryResult>;
|
|
756
547
|
}
|
|
757
|
-
|
|
548
|
+
interface TaxRegionsQueryBuilder {
|
|
758
549
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
759
550
|
* @param value - Value to compare against.
|
|
760
551
|
* @documentationMaturity preview
|
|
@@ -818,4 +609,5 @@ export interface TaxRegionsQueryBuilder {
|
|
|
818
609
|
/** @documentationMaturity preview */
|
|
819
610
|
find: () => Promise<TaxRegionsQueryResult>;
|
|
820
611
|
}
|
|
821
|
-
|
|
612
|
+
|
|
613
|
+
export { type ApplicationError as A, type BulkCreateTaxRegionRequest as B, type CreateTaxRegionRequest as C, type DeleteTaxRegionRequest as D, type EntityCreatedEvent as E, type EntityUpdatedEvent as F, type GetTaxRegionRequest as G, type EntityDeletedEvent as H, type ItemMetadata as I, type ActionEvent as J, type IdentificationData as K, type IdentificationDataIdOneOf as L, type MessageEnvelope as M, type BaseEventMetadata as N, type EventMetadata as O, type TaxRegionCreatedEnvelope as P, type QueryTaxRegionsRequest as Q, type RestoreInfo as R, SortOrder as S, type TaxRegion as T, type UpdateTaxRegion as U, type TaxRegionDeletedEnvelope as V, WebhookIdentityType as W, type TaxRegionUpdatedEnvelope as X, type TaxRegionsQueryResult as Y, type TaxRegionsQueryBuilder as a, type CreateTaxRegionResponse as b, type ConflictErrorDetails as c, type BulkCreateTaxRegionResponse as d, type BulkCreateTaxRegionResult as e, type BulkActionMetadata as f, type GetTaxRegionResponse as g, type UpdateTaxRegionRequest as h, type UpdateTaxRegionResponse as i, type DeleteTaxRegionResponse as j, type CursorQuery as k, type CursorQueryPagingMethodOneOf as l, type Sorting as m, type CursorPaging as n, type QueryTaxRegionsResponse as o, type CursorPagingMetadata as p, type Cursors as q, type CreateOrGetTaxRegionWithoutValidationRequest as r, type CreateOrGetTaxRegionWithoutValidationResponse as s, type DeleteTaxRegionWithoutDomainEventsRequest as t, type DeleteTaxRegionWithoutDomainEventsResponse as u, type BulkRestoreTaxRegionsRequest as v, type BulkRestoreTaxRegionsResponse as w, type BulkRestoreTaxRegionsResult as x, type DomainEvent as y, type DomainEventBodyOneOf as z };
|