@wix/auto_sdk_ecom_tax-regions 1.0.13 → 1.0.15
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-BXT3KsX3.d.mts} +55 -247
- package/build/{cjs/src/billing-v1-tax-region-tax-regions.universal.d.ts → billing-v1-tax-region-tax-regions.universal-BXT3KsX3.d.ts} +55 -247
- package/build/index.d.mts +93 -0
- package/build/index.d.ts +93 -0
- package/build/index.js +496 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +463 -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-BXT3KsX3.d.mts} +55 -247
- package/build/internal/{es/src/billing-v1-tax-region-tax-regions.universal.d.ts → billing-v1-tax-region-tax-regions.universal-BXT3KsX3.d.ts} +55 -247
- package/build/internal/index.d.mts +93 -0
- package/build/internal/index.d.ts +93 -0
- package/build/internal/index.js +496 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +463 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +208 -0
- package/build/internal/meta.d.ts +208 -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 +208 -0
- package/build/meta.d.ts +208 -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 +12 -11
- 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 -423
- 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 -313
- 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 -423
- 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 -282
- 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 -423
- 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 -313
- 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 -423
- 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 -282
- 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,13 +196,13 @@ export interface Sorting {
|
|
|
197
196
|
/** Sort order. */
|
|
198
197
|
order?: SortOrderWithLiterals;
|
|
199
198
|
}
|
|
200
|
-
|
|
199
|
+
declare enum SortOrder {
|
|
201
200
|
ASC = "ASC",
|
|
202
201
|
DESC = "DESC"
|
|
203
202
|
}
|
|
204
203
|
/** @enumType */
|
|
205
|
-
|
|
206
|
-
|
|
204
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
205
|
+
interface CursorPaging {
|
|
207
206
|
/**
|
|
208
207
|
* Maximum number of items to return in the results.
|
|
209
208
|
* @max 100
|
|
@@ -218,13 +217,13 @@ export interface CursorPaging {
|
|
|
218
217
|
*/
|
|
219
218
|
cursor?: string | null;
|
|
220
219
|
}
|
|
221
|
-
|
|
220
|
+
interface QueryTaxRegionsResponse {
|
|
222
221
|
/** Retrieved tax regions. */
|
|
223
222
|
taxRegions?: TaxRegion[];
|
|
224
223
|
/** Paging metadata. */
|
|
225
224
|
pagingMetadata?: CursorPagingMetadata;
|
|
226
225
|
}
|
|
227
|
-
|
|
226
|
+
interface CursorPagingMetadata {
|
|
228
227
|
/** Number of items returned in current page. */
|
|
229
228
|
count?: number | null;
|
|
230
229
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -237,7 +236,7 @@ export interface CursorPagingMetadata {
|
|
|
237
236
|
*/
|
|
238
237
|
hasNext?: boolean | null;
|
|
239
238
|
}
|
|
240
|
-
|
|
239
|
+
interface Cursors {
|
|
241
240
|
/**
|
|
242
241
|
* Cursor string pointing to the next page in the list of results.
|
|
243
242
|
* @maxLength 16000
|
|
@@ -249,24 +248,24 @@ export interface Cursors {
|
|
|
249
248
|
*/
|
|
250
249
|
prev?: string | null;
|
|
251
250
|
}
|
|
252
|
-
|
|
251
|
+
interface CreateOrGetTaxRegionWithoutValidationRequest {
|
|
253
252
|
/** Tax region to create. */
|
|
254
253
|
taxRegion?: TaxRegion;
|
|
255
254
|
}
|
|
256
|
-
|
|
255
|
+
interface CreateOrGetTaxRegionWithoutValidationResponse {
|
|
257
256
|
/** Created tax region. */
|
|
258
257
|
taxRegion?: TaxRegion;
|
|
259
258
|
}
|
|
260
|
-
|
|
259
|
+
interface DeleteTaxRegionWithoutDomainEventsRequest {
|
|
261
260
|
/**
|
|
262
261
|
* ID of the tax region to delete.
|
|
263
262
|
* @format GUID
|
|
264
263
|
*/
|
|
265
264
|
taxRegionId?: string;
|
|
266
265
|
}
|
|
267
|
-
|
|
266
|
+
interface DeleteTaxRegionWithoutDomainEventsResponse {
|
|
268
267
|
}
|
|
269
|
-
|
|
268
|
+
interface BulkRestoreTaxRegionsRequest {
|
|
270
269
|
/**
|
|
271
270
|
* Tax region IDs to restore.
|
|
272
271
|
* @format GUID
|
|
@@ -275,7 +274,7 @@ export interface BulkRestoreTaxRegionsRequest {
|
|
|
275
274
|
*/
|
|
276
275
|
taxRegionIds?: string[];
|
|
277
276
|
}
|
|
278
|
-
|
|
277
|
+
interface BulkRestoreTaxRegionsResponse {
|
|
279
278
|
/**
|
|
280
279
|
* Restored tax regions result
|
|
281
280
|
* @minSize 1
|
|
@@ -283,10 +282,10 @@ export interface BulkRestoreTaxRegionsResponse {
|
|
|
283
282
|
*/
|
|
284
283
|
results?: BulkRestoreTaxRegionsResult[];
|
|
285
284
|
}
|
|
286
|
-
|
|
285
|
+
interface BulkRestoreTaxRegionsResult {
|
|
287
286
|
itemMetadata?: ItemMetadata;
|
|
288
287
|
}
|
|
289
|
-
|
|
288
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
290
289
|
createdEvent?: EntityCreatedEvent;
|
|
291
290
|
updatedEvent?: EntityUpdatedEvent;
|
|
292
291
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -321,19 +320,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
321
320
|
entityEventSequence?: string | null;
|
|
322
321
|
}
|
|
323
322
|
/** @oneof */
|
|
324
|
-
|
|
323
|
+
interface DomainEventBodyOneOf {
|
|
325
324
|
createdEvent?: EntityCreatedEvent;
|
|
326
325
|
updatedEvent?: EntityUpdatedEvent;
|
|
327
326
|
deletedEvent?: EntityDeletedEvent;
|
|
328
327
|
actionEvent?: ActionEvent;
|
|
329
328
|
}
|
|
330
|
-
|
|
329
|
+
interface EntityCreatedEvent {
|
|
331
330
|
entity?: string;
|
|
332
331
|
}
|
|
333
|
-
|
|
332
|
+
interface RestoreInfo {
|
|
334
333
|
deletedDate?: Date | null;
|
|
335
334
|
}
|
|
336
|
-
|
|
335
|
+
interface EntityUpdatedEvent {
|
|
337
336
|
/**
|
|
338
337
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
339
338
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -341,14 +340,14 @@ export interface EntityUpdatedEvent {
|
|
|
341
340
|
*/
|
|
342
341
|
currentEntity?: string;
|
|
343
342
|
}
|
|
344
|
-
|
|
343
|
+
interface EntityDeletedEvent {
|
|
345
344
|
/** Entity that was deleted. */
|
|
346
345
|
deletedEntity?: string | null;
|
|
347
346
|
}
|
|
348
|
-
|
|
347
|
+
interface ActionEvent {
|
|
349
348
|
body?: string;
|
|
350
349
|
}
|
|
351
|
-
|
|
350
|
+
interface MessageEnvelope {
|
|
352
351
|
/**
|
|
353
352
|
* App instance ID.
|
|
354
353
|
* @format GUID
|
|
@@ -364,7 +363,7 @@ export interface MessageEnvelope {
|
|
|
364
363
|
/** Stringify payload. */
|
|
365
364
|
data?: string;
|
|
366
365
|
}
|
|
367
|
-
|
|
366
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
368
367
|
/**
|
|
369
368
|
* ID of a site visitor that has not logged in to the site.
|
|
370
369
|
* @format GUID
|
|
@@ -389,7 +388,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
389
388
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
390
389
|
}
|
|
391
390
|
/** @oneof */
|
|
392
|
-
|
|
391
|
+
interface IdentificationDataIdOneOf {
|
|
393
392
|
/**
|
|
394
393
|
* ID of a site visitor that has not logged in to the site.
|
|
395
394
|
* @format GUID
|
|
@@ -411,7 +410,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
411
410
|
*/
|
|
412
411
|
appId?: string;
|
|
413
412
|
}
|
|
414
|
-
|
|
413
|
+
declare enum WebhookIdentityType {
|
|
415
414
|
UNKNOWN = "UNKNOWN",
|
|
416
415
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
417
416
|
MEMBER = "MEMBER",
|
|
@@ -419,8 +418,8 @@ export declare enum WebhookIdentityType {
|
|
|
419
418
|
APP = "APP"
|
|
420
419
|
}
|
|
421
420
|
/** @enumType */
|
|
422
|
-
|
|
423
|
-
|
|
421
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
422
|
+
interface BaseEventMetadata {
|
|
424
423
|
/**
|
|
425
424
|
* App instance ID.
|
|
426
425
|
* @format GUID
|
|
@@ -434,7 +433,7 @@ export interface BaseEventMetadata {
|
|
|
434
433
|
/** The identification type and identity data. */
|
|
435
434
|
identity?: IdentificationData;
|
|
436
435
|
}
|
|
437
|
-
|
|
436
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
438
437
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
439
438
|
_id?: string;
|
|
440
439
|
/**
|
|
@@ -464,156 +463,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
464
463
|
*/
|
|
465
464
|
entityEventSequence?: string | null;
|
|
466
465
|
}
|
|
467
|
-
|
|
466
|
+
interface TaxRegionCreatedEnvelope {
|
|
468
467
|
entity: TaxRegion;
|
|
469
468
|
metadata: EventMetadata;
|
|
470
469
|
}
|
|
471
|
-
|
|
472
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
473
|
-
* @permissionScope Manage Stores
|
|
474
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
475
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
476
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
477
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
478
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
479
|
-
* @permissionScope Manage Orders
|
|
480
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
481
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
482
|
-
* @webhook
|
|
483
|
-
* @eventType wix.billing.v1.tax_region_created
|
|
484
|
-
* @serviceIdentifier wix.billing.v1.TaxRegionsService
|
|
485
|
-
* @slug created
|
|
486
|
-
* @documentationMaturity preview
|
|
487
|
-
*/
|
|
488
|
-
export declare function onTaxRegionCreated(handler: (event: TaxRegionCreatedEnvelope) => void | Promise<void>): void;
|
|
489
|
-
export interface TaxRegionDeletedEnvelope {
|
|
470
|
+
interface TaxRegionDeletedEnvelope {
|
|
490
471
|
metadata: EventMetadata;
|
|
491
472
|
}
|
|
492
|
-
|
|
493
|
-
* Triggered when a tax region is deleted.
|
|
494
|
-
* @permissionScope Manage Stores - all permissions
|
|
495
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
496
|
-
* @permissionScope Manage Stores
|
|
497
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
498
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
499
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
500
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
501
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
502
|
-
* @permissionScope Manage Orders
|
|
503
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
504
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
505
|
-
* @webhook
|
|
506
|
-
* @eventType wix.billing.v1.tax_region_deleted
|
|
507
|
-
* @serviceIdentifier wix.billing.v1.TaxRegionsService
|
|
508
|
-
* @slug deleted
|
|
509
|
-
* @documentationMaturity preview
|
|
510
|
-
*/
|
|
511
|
-
export declare function onTaxRegionDeleted(handler: (event: TaxRegionDeletedEnvelope) => void | Promise<void>): void;
|
|
512
|
-
export interface TaxRegionUpdatedEnvelope {
|
|
473
|
+
interface TaxRegionUpdatedEnvelope {
|
|
513
474
|
entity: TaxRegion;
|
|
514
475
|
metadata: EventMetadata;
|
|
515
476
|
}
|
|
516
|
-
|
|
517
|
-
* Triggered when a tax region is updated.
|
|
518
|
-
* @permissionScope Manage Stores - all permissions
|
|
519
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
520
|
-
* @permissionScope Manage Stores
|
|
521
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
522
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
523
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
524
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
525
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
526
|
-
* @permissionScope Manage Orders
|
|
527
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
528
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
529
|
-
* @webhook
|
|
530
|
-
* @eventType wix.billing.v1.tax_region_updated
|
|
531
|
-
* @serviceIdentifier wix.billing.v1.TaxRegionsService
|
|
532
|
-
* @slug updated
|
|
533
|
-
* @documentationMaturity preview
|
|
534
|
-
*/
|
|
535
|
-
export declare function onTaxRegionUpdated(handler: (event: TaxRegionUpdatedEnvelope) => void | Promise<void>): void;
|
|
536
|
-
type TaxRegionNonNullablePaths = `country` | `subdivision` | `appId` | `taxIncludedInPrice`;
|
|
537
|
-
/**
|
|
538
|
-
* Creates a tax region.
|
|
539
|
-
*
|
|
540
|
-
* Tax regions require a tax calculator `appId`. Call List Tax Calculators to retrieve a list of available calculators for a site.
|
|
541
|
-
*
|
|
542
|
-
* Wix uses tax regions to calculate tax.
|
|
543
|
-
* <!-- Subdivisions are supported for the following countries: `AU`, `BR`, `CA`, `FR`, `DE`, `IN`, `IT`, `MX`, `NL`, `ES`, `AE`, `GB`, `US` -->
|
|
544
|
-
* @param taxRegion - Tax region to create.
|
|
545
|
-
* @public
|
|
546
|
-
* @documentationMaturity preview
|
|
547
|
-
* @requiredField taxRegion
|
|
548
|
-
* @requiredField taxRegion.appId
|
|
549
|
-
* @requiredField taxRegion.country
|
|
550
|
-
* @requiredField taxRegion.taxIncludedInPrice
|
|
551
|
-
* @permissionId BILLING.TAX_REGION_CREATE
|
|
552
|
-
* @permissionScope Manage Stores - all permissions
|
|
553
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
554
|
-
* @permissionScope Manage Stores
|
|
555
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
556
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
557
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
558
|
-
* @permissionScope Manage Orders
|
|
559
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
560
|
-
* @applicableIdentity APP
|
|
561
|
-
* @returns Created tax region.
|
|
562
|
-
* @fqn wix.billing.v1.TaxRegionsService.CreateTaxRegion
|
|
563
|
-
*/
|
|
564
|
-
export declare function createTaxRegion(taxRegion: NonNullablePaths<TaxRegion, `appId` | `country` | `taxIncludedInPrice`>): Promise<NonNullablePaths<TaxRegion, TaxRegionNonNullablePaths>>;
|
|
565
|
-
/**
|
|
566
|
-
* Retrieves a tax region.
|
|
567
|
-
* @param taxRegionId - ID of the tax region to retrieve.
|
|
568
|
-
* @public
|
|
569
|
-
* @documentationMaturity preview
|
|
570
|
-
* @requiredField taxRegionId
|
|
571
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
572
|
-
* @permissionScope Manage Stores - all permissions
|
|
573
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
574
|
-
* @permissionScope Manage Stores
|
|
575
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
576
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
577
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
578
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
579
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
580
|
-
* @permissionScope Manage Orders
|
|
581
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
582
|
-
* @applicableIdentity APP
|
|
583
|
-
* @applicableIdentity VISITOR
|
|
584
|
-
* @returns Retrieved tax region.
|
|
585
|
-
* @fqn wix.billing.v1.TaxRegionsService.GetTaxRegion
|
|
586
|
-
*/
|
|
587
|
-
export declare function getTaxRegion(taxRegionId: string): Promise<NonNullablePaths<TaxRegion, TaxRegionNonNullablePaths>>;
|
|
588
|
-
/**
|
|
589
|
-
* Updates a tax region.
|
|
590
|
-
*
|
|
591
|
-
* Each time the tax region is updated, `revision` increments by 1.
|
|
592
|
-
* The current `revision` must be passed when updating the tax region.
|
|
593
|
-
* This ensures you're working with the latest tax region and prevents
|
|
594
|
-
* unintended overwrites.
|
|
595
|
-
* @param _id - Tax region ID.
|
|
596
|
-
* @public
|
|
597
|
-
* @documentationMaturity preview
|
|
598
|
-
* @requiredField _id
|
|
599
|
-
* @requiredField taxRegion
|
|
600
|
-
* @requiredField taxRegion.revision
|
|
601
|
-
* @param taxRegion - Tax region info.
|
|
602
|
-
* @permissionId BILLING.TAX_REGION_UPDATE
|
|
603
|
-
* @permissionScope Manage Stores - all permissions
|
|
604
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
605
|
-
* @permissionScope Manage Stores
|
|
606
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
607
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
608
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
609
|
-
* @permissionScope Manage Orders
|
|
610
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
611
|
-
* @applicableIdentity APP
|
|
612
|
-
* @returns Updated tax region.
|
|
613
|
-
* @fqn wix.billing.v1.TaxRegionsService.UpdateTaxRegion
|
|
614
|
-
*/
|
|
615
|
-
export declare function updateTaxRegion(_id: string, taxRegion: NonNullablePaths<UpdateTaxRegion, `revision`>): Promise<NonNullablePaths<TaxRegion, TaxRegionNonNullablePaths>>;
|
|
616
|
-
export interface UpdateTaxRegion {
|
|
477
|
+
interface UpdateTaxRegion {
|
|
617
478
|
/**
|
|
618
479
|
* Tax region ID.
|
|
619
480
|
* @format GUID
|
|
@@ -659,60 +520,6 @@ export interface UpdateTaxRegion {
|
|
|
659
520
|
*/
|
|
660
521
|
_updatedDate?: Date | null;
|
|
661
522
|
}
|
|
662
|
-
/**
|
|
663
|
-
* Deletes a tax region.
|
|
664
|
-
*
|
|
665
|
-
* When a tax region is deleted, tax is not calculated and zero tax will be returned for addresses in this region.
|
|
666
|
-
* @param taxRegionId - ID of the tax region to delete.
|
|
667
|
-
* @public
|
|
668
|
-
* @documentationMaturity preview
|
|
669
|
-
* @requiredField taxRegionId
|
|
670
|
-
* @permissionId BILLING.TAX_REGION_DELETE
|
|
671
|
-
* @permissionScope Manage Stores - all permissions
|
|
672
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
673
|
-
* @permissionScope Manage Stores
|
|
674
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
675
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
676
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
677
|
-
* @permissionScope Manage Orders
|
|
678
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
679
|
-
* @applicableIdentity APP
|
|
680
|
-
* @fqn wix.billing.v1.TaxRegionsService.DeleteTaxRegion
|
|
681
|
-
*/
|
|
682
|
-
export declare function deleteTaxRegion(taxRegionId: string): Promise<void>;
|
|
683
|
-
/**
|
|
684
|
-
* Creates a query to retrieve a list of tax regions.
|
|
685
|
-
*
|
|
686
|
-
* The `queryTaxRegions()` function builds a query to retrieve a list of tax regions and returns a `TaxRegionsQueryBuilder` object.
|
|
687
|
-
*
|
|
688
|
-
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
689
|
-
*
|
|
690
|
-
* 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.
|
|
691
|
-
*
|
|
692
|
-
* `queryTaxRegions()` runs with the following `TaxRegionsQueryBuilder` default that you can override:
|
|
693
|
-
* + `ascending("_id")`
|
|
694
|
-
*
|
|
695
|
-
* 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"`.
|
|
696
|
-
*
|
|
697
|
-
* 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`.
|
|
698
|
-
* @public
|
|
699
|
-
* @documentationMaturity preview
|
|
700
|
-
* @permissionScope Manage Stores - all permissions
|
|
701
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
702
|
-
* @permissionScope Manage Stores
|
|
703
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
704
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
705
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
706
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
707
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
708
|
-
* @permissionScope Manage Orders
|
|
709
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
710
|
-
* @permissionId BILLING.TAX_REGION_READ
|
|
711
|
-
* @applicableIdentity APP
|
|
712
|
-
* @applicableIdentity VISITOR
|
|
713
|
-
* @fqn wix.billing.v1.TaxRegionsService.QueryTaxRegions
|
|
714
|
-
*/
|
|
715
|
-
export declare function queryTaxRegions(): TaxRegionsQueryBuilder;
|
|
716
523
|
interface QueryCursorResult {
|
|
717
524
|
cursors: Cursors;
|
|
718
525
|
hasNext: () => boolean;
|
|
@@ -720,13 +527,13 @@ interface QueryCursorResult {
|
|
|
720
527
|
length: number;
|
|
721
528
|
pageSize: number;
|
|
722
529
|
}
|
|
723
|
-
|
|
530
|
+
interface TaxRegionsQueryResult extends QueryCursorResult {
|
|
724
531
|
items: TaxRegion[];
|
|
725
532
|
query: TaxRegionsQueryBuilder;
|
|
726
533
|
next: () => Promise<TaxRegionsQueryResult>;
|
|
727
534
|
prev: () => Promise<TaxRegionsQueryResult>;
|
|
728
535
|
}
|
|
729
|
-
|
|
536
|
+
interface TaxRegionsQueryBuilder {
|
|
730
537
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
731
538
|
* @param value - Value to compare against.
|
|
732
539
|
* @documentationMaturity preview
|
|
@@ -790,4 +597,5 @@ export interface TaxRegionsQueryBuilder {
|
|
|
790
597
|
/** @documentationMaturity preview */
|
|
791
598
|
find: () => Promise<TaxRegionsQueryResult>;
|
|
792
599
|
}
|
|
793
|
-
|
|
600
|
+
|
|
601
|
+
export { type ApplicationError as A, type BulkCreateTaxRegionRequest as B, type CreateTaxRegionRequest as C, type DeleteTaxRegionRequest as D, type BulkRestoreTaxRegionsResult as E, type DomainEvent as F, type GetTaxRegionRequest as G, type DomainEventBodyOneOf as H, type ItemMetadata as I, type EntityCreatedEvent as J, type EntityUpdatedEvent as K, type EntityDeletedEvent as L, type ActionEvent as M, type MessageEnvelope as N, type IdentificationData as O, type IdentificationDataIdOneOf as P, type QueryTaxRegionsRequest as Q, type RestoreInfo as R, SortOrder as S, type TaxRegion as T, type UpdateTaxRegion as U, type BaseEventMetadata as V, WebhookIdentityType as W, type EventMetadata as X, type TaxRegionsQueryResult as Y, type TaxRegionsQueryBuilder as a, type TaxRegionCreatedEnvelope as b, type TaxRegionDeletedEnvelope as c, type TaxRegionUpdatedEnvelope as d, type CreateTaxRegionResponse as e, type ConflictErrorDetails as f, type BulkCreateTaxRegionResponse as g, type BulkCreateTaxRegionResult as h, type BulkActionMetadata as i, type GetTaxRegionResponse as j, type UpdateTaxRegionRequest as k, type UpdateTaxRegionResponse as l, type DeleteTaxRegionResponse as m, type CursorQuery as n, type CursorQueryPagingMethodOneOf as o, type Sorting as p, type CursorPaging as q, type QueryTaxRegionsResponse as r, type CursorPagingMetadata as s, type Cursors as t, type CreateOrGetTaxRegionWithoutValidationRequest as u, type CreateOrGetTaxRegionWithoutValidationResponse as v, type DeleteTaxRegionWithoutDomainEventsRequest as w, type DeleteTaxRegionWithoutDomainEventsResponse as x, type BulkRestoreTaxRegionsRequest as y, type BulkRestoreTaxRegionsResponse as z };
|