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