@wix/auto_sdk_ecom_tax-groups 1.0.16 → 1.0.18
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-group-tax-groups.universal.d.ts → billing-v1-tax-group-tax-groups.universal-BytDffOB.d.mts} +50 -296
- package/build/{internal/es/src/billing-v1-tax-group-tax-groups.universal.d.ts → billing-v1-tax-group-tax-groups.universal-BytDffOB.d.ts} +50 -296
- package/build/{cjs/src/billing-v1-tax-group-tax-groups.public.d.ts → index.d.mts} +36 -16
- package/build/{internal/cjs/src/billing-v1-tax-group-tax-groups.public.d.ts → index.d.ts} +36 -16
- package/build/index.js +605 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +570 -0
- package/build/index.mjs.map +1 -0
- package/build/{cjs/src/billing-v1-tax-group-tax-groups.universal.d.ts → internal/billing-v1-tax-group-tax-groups.universal-BytDffOB.d.mts} +50 -296
- package/build/{es/src/billing-v1-tax-group-tax-groups.universal.d.ts → internal/billing-v1-tax-group-tax-groups.universal-BytDffOB.d.ts} +50 -296
- package/build/internal/{es/src/billing-v1-tax-group-tax-groups.public.d.ts → index.d.mts} +36 -16
- package/build/{es/src/billing-v1-tax-group-tax-groups.public.d.ts → internal/index.d.ts} +36 -16
- package/build/internal/index.js +605 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +570 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{cjs/src/billing-v1-tax-group-tax-groups.types.d.ts → meta.d.mts} +56 -164
- package/build/{cjs/src/billing-v1-tax-group-tax-groups.types.d.ts → internal/meta.d.ts} +56 -164
- package/build/internal/meta.js +398 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +365 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{es/src/billing-v1-tax-group-tax-groups.types.d.ts → meta.d.mts} +56 -164
- package/build/{internal/es/src/billing-v1-tax-group-tax-groups.types.d.ts → meta.d.ts} +56 -164
- package/build/meta.js +398 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +365 -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-group-tax-groups.context.d.ts +0 -27
- package/build/cjs/src/billing-v1-tax-group-tax-groups.context.js +0 -32
- package/build/cjs/src/billing-v1-tax-group-tax-groups.context.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-group-tax-groups.http.d.ts +0 -57
- package/build/cjs/src/billing-v1-tax-group-tax-groups.http.js +0 -286
- package/build/cjs/src/billing-v1-tax-group-tax-groups.http.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-group-tax-groups.meta.d.ts +0 -25
- package/build/cjs/src/billing-v1-tax-group-tax-groups.meta.js +0 -161
- package/build/cjs/src/billing-v1-tax-group-tax-groups.meta.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-group-tax-groups.public.js +0 -85
- package/build/cjs/src/billing-v1-tax-group-tax-groups.public.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-group-tax-groups.types.js +0 -17
- package/build/cjs/src/billing-v1-tax-group-tax-groups.types.js.map +0 -1
- package/build/cjs/src/billing-v1-tax-group-tax-groups.universal.js +0 -401
- package/build/cjs/src/billing-v1-tax-group-tax-groups.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-group-tax-groups.context.d.ts +0 -27
- package/build/es/src/billing-v1-tax-group-tax-groups.context.js +0 -27
- package/build/es/src/billing-v1-tax-group-tax-groups.context.js.map +0 -1
- package/build/es/src/billing-v1-tax-group-tax-groups.http.d.ts +0 -57
- package/build/es/src/billing-v1-tax-group-tax-groups.http.js +0 -276
- package/build/es/src/billing-v1-tax-group-tax-groups.http.js.map +0 -1
- package/build/es/src/billing-v1-tax-group-tax-groups.meta.d.ts +0 -25
- package/build/es/src/billing-v1-tax-group-tax-groups.meta.js +0 -128
- package/build/es/src/billing-v1-tax-group-tax-groups.meta.js.map +0 -1
- package/build/es/src/billing-v1-tax-group-tax-groups.public.js +0 -73
- package/build/es/src/billing-v1-tax-group-tax-groups.public.js.map +0 -1
- package/build/es/src/billing-v1-tax-group-tax-groups.types.js +0 -14
- package/build/es/src/billing-v1-tax-group-tax-groups.types.js.map +0 -1
- package/build/es/src/billing-v1-tax-group-tax-groups.universal.js +0 -368
- package/build/es/src/billing-v1-tax-group-tax-groups.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-group-tax-groups.context.d.ts +0 -27
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.context.js +0 -32
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.context.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.http.d.ts +0 -57
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.http.js +0 -286
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.http.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.meta.d.ts +0 -25
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.meta.js +0 -161
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.meta.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.public.js +0 -85
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.public.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.types.js +0 -17
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.types.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.universal.js +0 -401
- package/build/internal/cjs/src/billing-v1-tax-group-tax-groups.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-group-tax-groups.context.d.ts +0 -27
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.context.js +0 -27
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.context.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.http.d.ts +0 -57
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.http.js +0 -276
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.http.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.meta.d.ts +0 -25
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.meta.js +0 -128
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.meta.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.public.js +0 -73
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.public.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.types.js +0 -14
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.types.js.map +0 -1
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.universal.js +0 -368
- package/build/internal/es/src/billing-v1-tax-group-tax-groups.universal.js.map +0 -1
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/**
|
|
3
2
|
* A tax group is a category of specific line items grouped together based on their tax treatment.
|
|
4
3
|
* You can create new tax groups to apply distinct tax rates and rules.
|
|
5
4
|
*/
|
|
6
|
-
|
|
5
|
+
interface TaxGroup {
|
|
7
6
|
/**
|
|
8
7
|
* Tax group ID.
|
|
9
8
|
* @format GUID
|
|
@@ -35,47 +34,47 @@ export interface TaxGroup {
|
|
|
35
34
|
*/
|
|
36
35
|
_updatedDate?: Date | null;
|
|
37
36
|
}
|
|
38
|
-
|
|
37
|
+
interface CreateTaxGroupRequest {
|
|
39
38
|
/** Tax group to create. */
|
|
40
39
|
taxGroup: TaxGroup;
|
|
41
40
|
}
|
|
42
|
-
|
|
41
|
+
interface CreateTaxGroupResponse {
|
|
43
42
|
/** Created tax group. */
|
|
44
43
|
taxGroup?: TaxGroup;
|
|
45
44
|
}
|
|
46
|
-
|
|
45
|
+
interface GetTaxGroupRequest {
|
|
47
46
|
/**
|
|
48
47
|
* ID of the tax group to retrieve.
|
|
49
48
|
* @format GUID
|
|
50
49
|
*/
|
|
51
50
|
taxGroupId: string;
|
|
52
51
|
}
|
|
53
|
-
|
|
52
|
+
interface GetTaxGroupResponse {
|
|
54
53
|
/** Retrieved tax group. */
|
|
55
54
|
taxGroup?: TaxGroup;
|
|
56
55
|
}
|
|
57
|
-
|
|
56
|
+
interface UpdateTaxGroupRequest {
|
|
58
57
|
/** Tax group info to update. */
|
|
59
58
|
taxGroup: TaxGroup;
|
|
60
59
|
}
|
|
61
|
-
|
|
60
|
+
interface UpdateTaxGroupResponse {
|
|
62
61
|
/** Updated tax group. */
|
|
63
62
|
taxGroup?: TaxGroup;
|
|
64
63
|
}
|
|
65
|
-
|
|
64
|
+
interface DeleteTaxGroupRequest {
|
|
66
65
|
/**
|
|
67
66
|
* ID of the tax group to delete.
|
|
68
67
|
* @format GUID
|
|
69
68
|
*/
|
|
70
69
|
taxGroupId: string;
|
|
71
70
|
}
|
|
72
|
-
|
|
71
|
+
interface DeleteTaxGroupResponse {
|
|
73
72
|
}
|
|
74
|
-
|
|
73
|
+
interface QueryTaxGroupsRequest {
|
|
75
74
|
/** Query options. */
|
|
76
75
|
query: QueryV2;
|
|
77
76
|
}
|
|
78
|
-
|
|
77
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
79
78
|
/** Paging options to limit and skip the number of items. */
|
|
80
79
|
paging?: Paging;
|
|
81
80
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -98,13 +97,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
98
97
|
fieldsets?: string[];
|
|
99
98
|
}
|
|
100
99
|
/** @oneof */
|
|
101
|
-
|
|
100
|
+
interface QueryV2PagingMethodOneOf {
|
|
102
101
|
/** Paging options to limit and skip the number of items. */
|
|
103
102
|
paging?: Paging;
|
|
104
103
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
105
104
|
cursorPaging?: CursorPaging;
|
|
106
105
|
}
|
|
107
|
-
|
|
106
|
+
interface Sorting {
|
|
108
107
|
/**
|
|
109
108
|
* Name of the field to sort by.
|
|
110
109
|
* @maxLength 512
|
|
@@ -113,19 +112,19 @@ export interface Sorting {
|
|
|
113
112
|
/** Sort order. */
|
|
114
113
|
order?: SortOrderWithLiterals;
|
|
115
114
|
}
|
|
116
|
-
|
|
115
|
+
declare enum SortOrder {
|
|
117
116
|
ASC = "ASC",
|
|
118
117
|
DESC = "DESC"
|
|
119
118
|
}
|
|
120
119
|
/** @enumType */
|
|
121
|
-
|
|
122
|
-
|
|
120
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
121
|
+
interface Paging {
|
|
123
122
|
/** Number of items to load. */
|
|
124
123
|
limit?: number | null;
|
|
125
124
|
/** Number of items to skip in the current sort order. */
|
|
126
125
|
offset?: number | null;
|
|
127
126
|
}
|
|
128
|
-
|
|
127
|
+
interface CursorPaging {
|
|
129
128
|
/**
|
|
130
129
|
* Maximum number of items to return in the results.
|
|
131
130
|
* @max 100
|
|
@@ -140,13 +139,13 @@ export interface CursorPaging {
|
|
|
140
139
|
*/
|
|
141
140
|
cursor?: string | null;
|
|
142
141
|
}
|
|
143
|
-
|
|
142
|
+
interface QueryTaxGroupsResponse {
|
|
144
143
|
/** Retrieved default tax groups. */
|
|
145
144
|
taxGroups?: TaxGroup[];
|
|
146
145
|
/** Paging metadata. */
|
|
147
146
|
pagingMetadata?: CursorPagingMetadata;
|
|
148
147
|
}
|
|
149
|
-
|
|
148
|
+
interface CursorPagingMetadata {
|
|
150
149
|
/** Number of items returned in current page. */
|
|
151
150
|
count?: number | null;
|
|
152
151
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -159,7 +158,7 @@ export interface CursorPagingMetadata {
|
|
|
159
158
|
*/
|
|
160
159
|
hasNext?: boolean | null;
|
|
161
160
|
}
|
|
162
|
-
|
|
161
|
+
interface Cursors {
|
|
163
162
|
/**
|
|
164
163
|
* Cursor string pointing to the next page in the list of results.
|
|
165
164
|
* @maxLength 16000
|
|
@@ -171,13 +170,13 @@ export interface Cursors {
|
|
|
171
170
|
*/
|
|
172
171
|
prev?: string | null;
|
|
173
172
|
}
|
|
174
|
-
|
|
173
|
+
interface ListDefaultTaxGroupsRequest {
|
|
175
174
|
}
|
|
176
|
-
|
|
175
|
+
interface ListDefaultTaxGroupsResponse {
|
|
177
176
|
/** Retrieved default tax groups. */
|
|
178
177
|
taxGroups?: TaxGroup[];
|
|
179
178
|
}
|
|
180
|
-
|
|
179
|
+
interface ListDefaultTaxGroupsByAppIdsRequest {
|
|
181
180
|
/**
|
|
182
181
|
* App IDs to retrieve default tax groups for.
|
|
183
182
|
* @minSize 1
|
|
@@ -186,7 +185,7 @@ export interface ListDefaultTaxGroupsByAppIdsRequest {
|
|
|
186
185
|
*/
|
|
187
186
|
appIds: string[];
|
|
188
187
|
}
|
|
189
|
-
|
|
188
|
+
interface ListDefaultTaxGroupsByAppIdsResponse {
|
|
190
189
|
/**
|
|
191
190
|
* Retrieved default tax groups.
|
|
192
191
|
* @minSize 1
|
|
@@ -196,13 +195,13 @@ export interface ListDefaultTaxGroupsByAppIdsResponse {
|
|
|
196
195
|
/** Bulk action metadata. */
|
|
197
196
|
bulkActionMetadata?: BulkActionMetadata;
|
|
198
197
|
}
|
|
199
|
-
|
|
198
|
+
interface ListDefaultTaxGroupsByAppIdsResult {
|
|
200
199
|
/** Information about success or failure to retrieve default tax groups. */
|
|
201
200
|
taxGroupMetadata?: ItemMetadata;
|
|
202
201
|
/** Retrieved default tax groups. */
|
|
203
202
|
taxGroup?: TaxGroup;
|
|
204
203
|
}
|
|
205
|
-
|
|
204
|
+
interface ItemMetadata {
|
|
206
205
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
207
206
|
_id?: string | null;
|
|
208
207
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -212,7 +211,7 @@ export interface ItemMetadata {
|
|
|
212
211
|
/** Details about the error in case of failure. */
|
|
213
212
|
error?: ApplicationError;
|
|
214
213
|
}
|
|
215
|
-
|
|
214
|
+
interface ApplicationError {
|
|
216
215
|
/** Error code. */
|
|
217
216
|
code?: string;
|
|
218
217
|
/** Description of the error. */
|
|
@@ -220,7 +219,7 @@ export interface ApplicationError {
|
|
|
220
219
|
/** Data related to the error. */
|
|
221
220
|
data?: Record<string, any> | null;
|
|
222
221
|
}
|
|
223
|
-
|
|
222
|
+
interface BulkActionMetadata {
|
|
224
223
|
/** Number of items that were successfully processed. */
|
|
225
224
|
totalSuccesses?: number;
|
|
226
225
|
/** Number of items that couldn't be processed. */
|
|
@@ -228,7 +227,7 @@ export interface BulkActionMetadata {
|
|
|
228
227
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
229
228
|
undetailedFailures?: number;
|
|
230
229
|
}
|
|
231
|
-
|
|
230
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
232
231
|
createdEvent?: EntityCreatedEvent;
|
|
233
232
|
updatedEvent?: EntityUpdatedEvent;
|
|
234
233
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -263,19 +262,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
263
262
|
entityEventSequence?: string | null;
|
|
264
263
|
}
|
|
265
264
|
/** @oneof */
|
|
266
|
-
|
|
265
|
+
interface DomainEventBodyOneOf {
|
|
267
266
|
createdEvent?: EntityCreatedEvent;
|
|
268
267
|
updatedEvent?: EntityUpdatedEvent;
|
|
269
268
|
deletedEvent?: EntityDeletedEvent;
|
|
270
269
|
actionEvent?: ActionEvent;
|
|
271
270
|
}
|
|
272
|
-
|
|
271
|
+
interface EntityCreatedEvent {
|
|
273
272
|
entity?: string;
|
|
274
273
|
}
|
|
275
|
-
|
|
274
|
+
interface RestoreInfo {
|
|
276
275
|
deletedDate?: Date | null;
|
|
277
276
|
}
|
|
278
|
-
|
|
277
|
+
interface EntityUpdatedEvent {
|
|
279
278
|
/**
|
|
280
279
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
281
280
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -283,14 +282,14 @@ export interface EntityUpdatedEvent {
|
|
|
283
282
|
*/
|
|
284
283
|
currentEntity?: string;
|
|
285
284
|
}
|
|
286
|
-
|
|
285
|
+
interface EntityDeletedEvent {
|
|
287
286
|
/** Entity that was deleted. */
|
|
288
287
|
deletedEntity?: string | null;
|
|
289
288
|
}
|
|
290
|
-
|
|
289
|
+
interface ActionEvent {
|
|
291
290
|
body?: string;
|
|
292
291
|
}
|
|
293
|
-
|
|
292
|
+
interface MessageEnvelope {
|
|
294
293
|
/**
|
|
295
294
|
* App instance ID.
|
|
296
295
|
* @format GUID
|
|
@@ -306,7 +305,7 @@ export interface MessageEnvelope {
|
|
|
306
305
|
/** Stringify payload. */
|
|
307
306
|
data?: string;
|
|
308
307
|
}
|
|
309
|
-
|
|
308
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
310
309
|
/**
|
|
311
310
|
* ID of a site visitor that has not logged in to the site.
|
|
312
311
|
* @format GUID
|
|
@@ -331,7 +330,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
331
330
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
332
331
|
}
|
|
333
332
|
/** @oneof */
|
|
334
|
-
|
|
333
|
+
interface IdentificationDataIdOneOf {
|
|
335
334
|
/**
|
|
336
335
|
* ID of a site visitor that has not logged in to the site.
|
|
337
336
|
* @format GUID
|
|
@@ -353,7 +352,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
353
352
|
*/
|
|
354
353
|
appId?: string;
|
|
355
354
|
}
|
|
356
|
-
|
|
355
|
+
declare enum WebhookIdentityType {
|
|
357
356
|
UNKNOWN = "UNKNOWN",
|
|
358
357
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
359
358
|
MEMBER = "MEMBER",
|
|
@@ -361,8 +360,8 @@ export declare enum WebhookIdentityType {
|
|
|
361
360
|
APP = "APP"
|
|
362
361
|
}
|
|
363
362
|
/** @enumType */
|
|
364
|
-
|
|
365
|
-
|
|
363
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
364
|
+
interface BaseEventMetadata {
|
|
366
365
|
/**
|
|
367
366
|
* App instance ID.
|
|
368
367
|
* @format GUID
|
|
@@ -376,7 +375,7 @@ export interface BaseEventMetadata {
|
|
|
376
375
|
/** The identification type and identity data. */
|
|
377
376
|
identity?: IdentificationData;
|
|
378
377
|
}
|
|
379
|
-
|
|
378
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
380
379
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
381
380
|
_id?: string;
|
|
382
381
|
/**
|
|
@@ -406,159 +405,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
406
405
|
*/
|
|
407
406
|
entityEventSequence?: string | null;
|
|
408
407
|
}
|
|
409
|
-
|
|
408
|
+
interface TaxGroupCreatedEnvelope {
|
|
410
409
|
entity: TaxGroup;
|
|
411
410
|
metadata: EventMetadata;
|
|
412
411
|
}
|
|
413
|
-
|
|
414
|
-
* Triggered when a tax group is created.
|
|
415
|
-
* @permissionScope Manage Stores - all permissions
|
|
416
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
417
|
-
* @permissionScope Manage Stores
|
|
418
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
419
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
420
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
421
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
422
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
423
|
-
* @permissionScope Manage Orders
|
|
424
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
425
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
426
|
-
* @webhook
|
|
427
|
-
* @eventType wix.billing.v1.tax_group_created
|
|
428
|
-
* @serviceIdentifier wix.billing.v1.TaxGroups
|
|
429
|
-
* @slug created
|
|
430
|
-
* @documentationMaturity preview
|
|
431
|
-
*/
|
|
432
|
-
export declare function onTaxGroupCreated(handler: (event: TaxGroupCreatedEnvelope) => void | Promise<void>): void;
|
|
433
|
-
export interface TaxGroupDeletedEnvelope {
|
|
412
|
+
interface TaxGroupDeletedEnvelope {
|
|
434
413
|
metadata: EventMetadata;
|
|
435
414
|
}
|
|
436
|
-
|
|
437
|
-
* Triggered when a tax group is deleted.
|
|
438
|
-
* @permissionScope Manage Stores - all permissions
|
|
439
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
440
|
-
* @permissionScope Manage Stores
|
|
441
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
442
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
443
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
444
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
445
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
446
|
-
* @permissionScope Manage Orders
|
|
447
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
448
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
449
|
-
* @webhook
|
|
450
|
-
* @eventType wix.billing.v1.tax_group_deleted
|
|
451
|
-
* @serviceIdentifier wix.billing.v1.TaxGroups
|
|
452
|
-
* @slug deleted
|
|
453
|
-
* @documentationMaturity preview
|
|
454
|
-
*/
|
|
455
|
-
export declare function onTaxGroupDeleted(handler: (event: TaxGroupDeletedEnvelope) => void | Promise<void>): void;
|
|
456
|
-
export interface TaxGroupUpdatedEnvelope {
|
|
415
|
+
interface TaxGroupUpdatedEnvelope {
|
|
457
416
|
entity: TaxGroup;
|
|
458
417
|
metadata: EventMetadata;
|
|
459
418
|
}
|
|
460
|
-
|
|
461
|
-
* Triggered when a tax group is updated.
|
|
462
|
-
* @permissionScope Manage Stores - all permissions
|
|
463
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
464
|
-
* @permissionScope Manage Stores
|
|
465
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
466
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
467
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
468
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
469
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
470
|
-
* @permissionScope Manage Orders
|
|
471
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
472
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
473
|
-
* @webhook
|
|
474
|
-
* @eventType wix.billing.v1.tax_group_updated
|
|
475
|
-
* @serviceIdentifier wix.billing.v1.TaxGroups
|
|
476
|
-
* @slug updated
|
|
477
|
-
* @documentationMaturity preview
|
|
478
|
-
*/
|
|
479
|
-
export declare function onTaxGroupUpdated(handler: (event: TaxGroupUpdatedEnvelope) => void | Promise<void>): void;
|
|
480
|
-
type TaxGroupNonNullablePaths = `name`;
|
|
481
|
-
/**
|
|
482
|
-
* Creates a tax group.
|
|
483
|
-
*
|
|
484
|
-
* Call Stores Update Product to add the `taxGroupId` to specific products to categorize as a group based on distinct tax treatment.
|
|
485
|
-
* Wix uses tax groups to calculate tax.
|
|
486
|
-
*
|
|
487
|
-
* In addition to tax groups you create, default tax groups are already included in all Wix catalogs.
|
|
488
|
-
* Call List Default Tax Groups to retrieve them. You can also use the Tax Groups Integration service plugin (REST only)
|
|
489
|
-
* to create new default tax groups that can be applied directly to an entire catalog of products.
|
|
490
|
-
* @param taxGroup - Tax group to create.
|
|
491
|
-
* @public
|
|
492
|
-
* @documentationMaturity preview
|
|
493
|
-
* @requiredField taxGroup
|
|
494
|
-
* @requiredField taxGroup.name
|
|
495
|
-
* @permissionId BILLING.TAX_GROUP_CREATE
|
|
496
|
-
* @permissionScope Manage Stores - all permissions
|
|
497
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
498
|
-
* @permissionScope Manage Stores
|
|
499
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
500
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
501
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
502
|
-
* @permissionScope Manage Orders
|
|
503
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
504
|
-
* @applicableIdentity APP
|
|
505
|
-
* @returns Created tax group.
|
|
506
|
-
* @fqn wix.billing.v1.TaxGroups.CreateTaxGroup
|
|
507
|
-
*/
|
|
508
|
-
export declare function createTaxGroup(taxGroup: NonNullablePaths<TaxGroup, `name`>): Promise<NonNullablePaths<TaxGroup, TaxGroupNonNullablePaths>>;
|
|
509
|
-
/**
|
|
510
|
-
* Retrieves a tax group.
|
|
511
|
-
* @param taxGroupId - ID of the tax group to retrieve.
|
|
512
|
-
* @public
|
|
513
|
-
* @documentationMaturity preview
|
|
514
|
-
* @requiredField taxGroupId
|
|
515
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
516
|
-
* @permissionScope Manage Stores - all permissions
|
|
517
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
518
|
-
* @permissionScope Manage Stores
|
|
519
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
520
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
521
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
522
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
523
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
524
|
-
* @permissionScope Manage Orders
|
|
525
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
526
|
-
* @applicableIdentity APP
|
|
527
|
-
* @applicableIdentity VISITOR
|
|
528
|
-
* @returns Retrieved tax group.
|
|
529
|
-
* @fqn wix.billing.v1.TaxGroups.GetTaxGroup
|
|
530
|
-
*/
|
|
531
|
-
export declare function getTaxGroup(taxGroupId: string): Promise<NonNullablePaths<TaxGroup, TaxGroupNonNullablePaths>>;
|
|
532
|
-
/**
|
|
533
|
-
* Updates a tax group.
|
|
534
|
-
*
|
|
535
|
-
* Each time the tax group is updated, `revision` increments by 1.
|
|
536
|
-
* The current `revision` must be passed when updating the tax group.
|
|
537
|
-
* This ensures you're working with the latest tax group and prevents
|
|
538
|
-
* unintended overwrites.
|
|
539
|
-
* @param _id - Tax group ID.
|
|
540
|
-
* @public
|
|
541
|
-
* @documentationMaturity preview
|
|
542
|
-
* @requiredField _id
|
|
543
|
-
* @requiredField taxGroup
|
|
544
|
-
* @requiredField taxGroup.name
|
|
545
|
-
* @requiredField taxGroup.revision
|
|
546
|
-
* @param taxGroup - Tax group info.
|
|
547
|
-
* @permissionId BILLING.TAX_GROUP_UPDATE
|
|
548
|
-
* @permissionScope Manage Stores - all permissions
|
|
549
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
550
|
-
* @permissionScope Manage Stores
|
|
551
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
552
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
553
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
554
|
-
* @permissionScope Manage Orders
|
|
555
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
556
|
-
* @applicableIdentity APP
|
|
557
|
-
* @returns Updated tax group.
|
|
558
|
-
* @fqn wix.billing.v1.TaxGroups.UpdateTaxGroup
|
|
559
|
-
*/
|
|
560
|
-
export declare function updateTaxGroup(_id: string, taxGroup: NonNullablePaths<UpdateTaxGroup, `name` | `revision`>): Promise<NonNullablePaths<TaxGroup, TaxGroupNonNullablePaths>>;
|
|
561
|
-
export interface UpdateTaxGroup {
|
|
419
|
+
interface UpdateTaxGroup {
|
|
562
420
|
/**
|
|
563
421
|
* Tax group ID.
|
|
564
422
|
* @format GUID
|
|
@@ -590,60 +448,6 @@ export interface UpdateTaxGroup {
|
|
|
590
448
|
*/
|
|
591
449
|
_updatedDate?: Date | null;
|
|
592
450
|
}
|
|
593
|
-
/**
|
|
594
|
-
* Deletes a tax group.
|
|
595
|
-
*
|
|
596
|
-
* If a tax group is deleted but the `taxGroupId` is still assigned to a product (see Stores Products API) then the default tax group is used to calculate tax.
|
|
597
|
-
* @param taxGroupId - ID of the tax group to delete.
|
|
598
|
-
* @public
|
|
599
|
-
* @documentationMaturity preview
|
|
600
|
-
* @requiredField taxGroupId
|
|
601
|
-
* @permissionId BILLING.TAX_GROUP_DELETE
|
|
602
|
-
* @permissionScope Manage Stores - all permissions
|
|
603
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
604
|
-
* @permissionScope Manage Stores
|
|
605
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
606
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
607
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
608
|
-
* @permissionScope Manage Orders
|
|
609
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
610
|
-
* @applicableIdentity APP
|
|
611
|
-
* @fqn wix.billing.v1.TaxGroups.DeleteTaxGroup
|
|
612
|
-
*/
|
|
613
|
-
export declare function deleteTaxGroup(taxGroupId: string): Promise<void>;
|
|
614
|
-
/**
|
|
615
|
-
* Creates a query to retrieve a list of tax groups.
|
|
616
|
-
*
|
|
617
|
-
* The `queryTaxGroups()` function builds a query to retrieve a list of tax groups and returns a `TaxGroupsQueryBuilder` object.
|
|
618
|
-
*
|
|
619
|
-
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
620
|
-
*
|
|
621
|
-
* You can refine the query by chaining `TaxGroupsQueryBuilder` functions onto the query. `TaxGroupsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTaxGroups()` returns.
|
|
622
|
-
*
|
|
623
|
-
* `queryTaxGroups()` runs with the following `TaxGroupsQueryBuilder` default that you can override:
|
|
624
|
-
* + `ascending("_id")`
|
|
625
|
-
*
|
|
626
|
-
* The functions that are chained to `queryTaxGroups()` are applied in the order they are called. For example, if you apply `ascending("name")` and then `ascending("_createdDate")`, the results are sorted first by the `"name"`, and then, if there are multiple results with the same `"name"`, the items are sorted by `"_createdDate"`.
|
|
627
|
-
*
|
|
628
|
-
* The following `TaxGroupsQueryBuilder` functions are supported for the `queryTaxGroups()` function. For a full description of the tax group object, see the object returned for the `items` property in `TaxGroupsQueryResult`.
|
|
629
|
-
* @public
|
|
630
|
-
* @documentationMaturity preview
|
|
631
|
-
* @permissionScope Manage Stores - all permissions
|
|
632
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
633
|
-
* @permissionScope Manage Stores
|
|
634
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
635
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
636
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
637
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
638
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
639
|
-
* @permissionScope Manage Orders
|
|
640
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
641
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
642
|
-
* @applicableIdentity APP
|
|
643
|
-
* @applicableIdentity VISITOR
|
|
644
|
-
* @fqn wix.billing.v1.TaxGroups.QueryTaxGroups
|
|
645
|
-
*/
|
|
646
|
-
export declare function queryTaxGroups(): TaxGroupsQueryBuilder;
|
|
647
451
|
interface QueryCursorResult {
|
|
648
452
|
cursors: Cursors;
|
|
649
453
|
hasNext: () => boolean;
|
|
@@ -651,13 +455,13 @@ interface QueryCursorResult {
|
|
|
651
455
|
length: number;
|
|
652
456
|
pageSize: number;
|
|
653
457
|
}
|
|
654
|
-
|
|
458
|
+
interface TaxGroupsQueryResult extends QueryCursorResult {
|
|
655
459
|
items: TaxGroup[];
|
|
656
460
|
query: TaxGroupsQueryBuilder;
|
|
657
461
|
next: () => Promise<TaxGroupsQueryResult>;
|
|
658
462
|
prev: () => Promise<TaxGroupsQueryResult>;
|
|
659
463
|
}
|
|
660
|
-
|
|
464
|
+
interface TaxGroupsQueryBuilder {
|
|
661
465
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
662
466
|
* @param value - Value to compare against.
|
|
663
467
|
* @documentationMaturity preview
|
|
@@ -716,55 +520,5 @@ export interface TaxGroupsQueryBuilder {
|
|
|
716
520
|
/** @documentationMaturity preview */
|
|
717
521
|
find: () => Promise<TaxGroupsQueryResult>;
|
|
718
522
|
}
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
*
|
|
722
|
-
* The default tax groups for a site are inherited by the apps installed on the site.
|
|
723
|
-
* For example, the Wix Stores app includes a `"Products"` tax group by default.
|
|
724
|
-
*
|
|
725
|
-
* Add additional default tax groups with the Tax Groups Integration service plugin (REST only).
|
|
726
|
-
* @public
|
|
727
|
-
* @documentationMaturity preview
|
|
728
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
729
|
-
* @permissionScope Manage Stores - all permissions
|
|
730
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
731
|
-
* @permissionScope Manage Stores
|
|
732
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
733
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
734
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
735
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
736
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
737
|
-
* @permissionScope Manage Orders
|
|
738
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
739
|
-
* @applicableIdentity APP
|
|
740
|
-
* @applicableIdentity VISITOR
|
|
741
|
-
* @fqn wix.billing.v1.TaxGroups.ListDefaultTaxGroups
|
|
742
|
-
*/
|
|
743
|
-
export declare function listDefaultTaxGroups(): Promise<NonNullablePaths<ListDefaultTaxGroupsResponse, {
|
|
744
|
-
[P in TaxGroupNonNullablePaths]: `taxGroups.${number}.${P}`;
|
|
745
|
-
}[TaxGroupNonNullablePaths]>>;
|
|
746
|
-
/**
|
|
747
|
-
* Retrieves default tax groups for specific apps.
|
|
748
|
-
* @param appIds - App IDs to retrieve default tax groups for.
|
|
749
|
-
* @public
|
|
750
|
-
* @documentationMaturity preview
|
|
751
|
-
* @requiredField appIds
|
|
752
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
753
|
-
* @permissionScope Manage Stores - all permissions
|
|
754
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
755
|
-
* @permissionScope Manage Stores
|
|
756
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
757
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
758
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
759
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
760
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
761
|
-
* @permissionScope Manage Orders
|
|
762
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
763
|
-
* @applicableIdentity APP
|
|
764
|
-
* @applicableIdentity VISITOR
|
|
765
|
-
* @fqn wix.billing.v1.TaxGroups.ListDefaultTaxGroupsByAppIds
|
|
766
|
-
*/
|
|
767
|
-
export declare function listDefaultTaxGroupsByAppIds(appIds: string[]): Promise<NonNullablePaths<ListDefaultTaxGroupsByAppIdsResponse, `results` | `results.${number}.taxGroupMetadata.originalIndex` | `results.${number}.taxGroupMetadata.success` | `results.${number}.taxGroupMetadata.error.code` | `results.${number}.taxGroupMetadata.error.description` | {
|
|
768
|
-
[P in TaxGroupNonNullablePaths]: `results.${number}.taxGroup.${P}`;
|
|
769
|
-
}[TaxGroupNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
770
|
-
export {};
|
|
523
|
+
|
|
524
|
+
export { type ApplicationError as A, type BulkActionMetadata as B, type CreateTaxGroupRequest as C, type DeleteTaxGroupRequest as D, type EntityCreatedEvent as E, type IdentificationDataIdOneOf as F, type GetTaxGroupRequest as G, type BaseEventMetadata as H, type ItemMetadata as I, type EventMetadata as J, type TaxGroupsQueryResult as K, type ListDefaultTaxGroupsResponse as L, type MessageEnvelope as M, type Paging as P, type QueryTaxGroupsRequest as Q, type RestoreInfo as R, SortOrder as S, type TaxGroup as T, type UpdateTaxGroup as U, WebhookIdentityType as W, type TaxGroupsQueryBuilder as a, type ListDefaultTaxGroupsByAppIdsResponse as b, type TaxGroupCreatedEnvelope as c, type TaxGroupDeletedEnvelope as d, type TaxGroupUpdatedEnvelope as e, type CreateTaxGroupResponse as f, type GetTaxGroupResponse as g, type UpdateTaxGroupRequest as h, type UpdateTaxGroupResponse as i, type DeleteTaxGroupResponse as j, type QueryV2 as k, type QueryV2PagingMethodOneOf as l, type Sorting as m, type CursorPaging as n, type QueryTaxGroupsResponse as o, type CursorPagingMetadata as p, type Cursors as q, type ListDefaultTaxGroupsRequest as r, type ListDefaultTaxGroupsByAppIdsRequest as s, type ListDefaultTaxGroupsByAppIdsResult as t, type DomainEvent as u, type DomainEventBodyOneOf as v, type EntityUpdatedEvent as w, type EntityDeletedEvent as x, type ActionEvent as y, type IdentificationData as z };
|