@wix/auto_sdk_ecom_tax-regions 1.0.5 → 1.0.6

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