@wix/auto_sdk_ecom_tax-groups 1.0.6 → 1.0.8
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-CiIRXdgk.d.mts} +48 -294
- package/build/{internal/es/src/billing-v1-tax-group-tax-groups.universal.d.ts → billing-v1-tax-group-tax-groups.universal-CiIRXdgk.d.ts} +48 -294
- package/build/{cjs/src/billing-v1-tax-group-tax-groups.public.d.ts → index.d.mts} +34 -16
- package/build/{internal/cjs/src/billing-v1-tax-group-tax-groups.public.d.ts → index.d.ts} +34 -16
- package/build/index.js +602 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +567 -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-CiIRXdgk.d.mts} +48 -294
- package/build/{es/src/billing-v1-tax-group-tax-groups.universal.d.ts → internal/billing-v1-tax-group-tax-groups.universal-CiIRXdgk.d.ts} +48 -294
- package/build/internal/{es/src/billing-v1-tax-group-tax-groups.public.d.ts → index.d.mts} +34 -16
- package/build/{es/src/billing-v1-tax-group-tax-groups.public.d.ts → internal/index.d.ts} +34 -16
- package/build/internal/index.js +602 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +567 -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} +55 -169
- package/build/{cjs/src/billing-v1-tax-group-tax-groups.types.d.ts → internal/meta.d.ts} +55 -169
- 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} +55 -169
- package/build/{internal/es/src/billing-v1-tax-group-tax-groups.types.d.ts → meta.d.ts} +55 -169
- 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 -399
- 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 -366
- 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 -399
- 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 -366
- 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,17 +112,17 @@ export interface Sorting {
|
|
|
113
112
|
/** Sort order. */
|
|
114
113
|
order?: SortOrder;
|
|
115
114
|
}
|
|
116
|
-
|
|
115
|
+
declare enum SortOrder {
|
|
117
116
|
ASC = "ASC",
|
|
118
117
|
DESC = "DESC"
|
|
119
118
|
}
|
|
120
|
-
|
|
119
|
+
interface Paging {
|
|
121
120
|
/** Number of items to load. */
|
|
122
121
|
limit?: number | null;
|
|
123
122
|
/** Number of items to skip in the current sort order. */
|
|
124
123
|
offset?: number | null;
|
|
125
124
|
}
|
|
126
|
-
|
|
125
|
+
interface CursorPaging {
|
|
127
126
|
/**
|
|
128
127
|
* Maximum number of items to return in the results.
|
|
129
128
|
* @max 100
|
|
@@ -138,13 +137,13 @@ export interface CursorPaging {
|
|
|
138
137
|
*/
|
|
139
138
|
cursor?: string | null;
|
|
140
139
|
}
|
|
141
|
-
|
|
140
|
+
interface QueryTaxGroupsResponse {
|
|
142
141
|
/** Retrieved default tax groups. */
|
|
143
142
|
taxGroups?: TaxGroup[];
|
|
144
143
|
/** Paging metadata. */
|
|
145
144
|
pagingMetadata?: CursorPagingMetadata;
|
|
146
145
|
}
|
|
147
|
-
|
|
146
|
+
interface CursorPagingMetadata {
|
|
148
147
|
/** Number of items returned in current page. */
|
|
149
148
|
count?: number | null;
|
|
150
149
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -157,7 +156,7 @@ export interface CursorPagingMetadata {
|
|
|
157
156
|
*/
|
|
158
157
|
hasNext?: boolean | null;
|
|
159
158
|
}
|
|
160
|
-
|
|
159
|
+
interface Cursors {
|
|
161
160
|
/**
|
|
162
161
|
* Cursor string pointing to the next page in the list of results.
|
|
163
162
|
* @maxLength 16000
|
|
@@ -169,13 +168,13 @@ export interface Cursors {
|
|
|
169
168
|
*/
|
|
170
169
|
prev?: string | null;
|
|
171
170
|
}
|
|
172
|
-
|
|
171
|
+
interface ListDefaultTaxGroupsRequest {
|
|
173
172
|
}
|
|
174
|
-
|
|
173
|
+
interface ListDefaultTaxGroupsResponse {
|
|
175
174
|
/** Retrieved default tax groups. */
|
|
176
175
|
taxGroups?: TaxGroup[];
|
|
177
176
|
}
|
|
178
|
-
|
|
177
|
+
interface ListDefaultTaxGroupsByAppIdsRequest {
|
|
179
178
|
/**
|
|
180
179
|
* App IDs to retrieve default tax groups for.
|
|
181
180
|
* @minSize 1
|
|
@@ -184,7 +183,7 @@ export interface ListDefaultTaxGroupsByAppIdsRequest {
|
|
|
184
183
|
*/
|
|
185
184
|
appIds: string[];
|
|
186
185
|
}
|
|
187
|
-
|
|
186
|
+
interface ListDefaultTaxGroupsByAppIdsResponse {
|
|
188
187
|
/**
|
|
189
188
|
* Retrieved default tax groups.
|
|
190
189
|
* @minSize 1
|
|
@@ -194,13 +193,13 @@ export interface ListDefaultTaxGroupsByAppIdsResponse {
|
|
|
194
193
|
/** Bulk action metadata. */
|
|
195
194
|
bulkActionMetadata?: BulkActionMetadata;
|
|
196
195
|
}
|
|
197
|
-
|
|
196
|
+
interface ListDefaultTaxGroupsByAppIdsResult {
|
|
198
197
|
/** Information about success or failure to retrieve default tax groups. */
|
|
199
198
|
taxGroupMetadata?: ItemMetadata;
|
|
200
199
|
/** Retrieved default tax groups. */
|
|
201
200
|
taxGroup?: TaxGroup;
|
|
202
201
|
}
|
|
203
|
-
|
|
202
|
+
interface ItemMetadata {
|
|
204
203
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
205
204
|
_id?: string | null;
|
|
206
205
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -210,7 +209,7 @@ export interface ItemMetadata {
|
|
|
210
209
|
/** Details about the error in case of failure. */
|
|
211
210
|
error?: ApplicationError;
|
|
212
211
|
}
|
|
213
|
-
|
|
212
|
+
interface ApplicationError {
|
|
214
213
|
/** Error code. */
|
|
215
214
|
code?: string;
|
|
216
215
|
/** Description of the error. */
|
|
@@ -218,7 +217,7 @@ export interface ApplicationError {
|
|
|
218
217
|
/** Data related to the error. */
|
|
219
218
|
data?: Record<string, any> | null;
|
|
220
219
|
}
|
|
221
|
-
|
|
220
|
+
interface BulkActionMetadata {
|
|
222
221
|
/** Number of items that were successfully processed. */
|
|
223
222
|
totalSuccesses?: number;
|
|
224
223
|
/** Number of items that couldn't be processed. */
|
|
@@ -226,7 +225,7 @@ export interface BulkActionMetadata {
|
|
|
226
225
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
227
226
|
undetailedFailures?: number;
|
|
228
227
|
}
|
|
229
|
-
|
|
228
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
230
229
|
createdEvent?: EntityCreatedEvent;
|
|
231
230
|
updatedEvent?: EntityUpdatedEvent;
|
|
232
231
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -269,19 +268,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
269
268
|
entityEventSequence?: string | null;
|
|
270
269
|
}
|
|
271
270
|
/** @oneof */
|
|
272
|
-
|
|
271
|
+
interface DomainEventBodyOneOf {
|
|
273
272
|
createdEvent?: EntityCreatedEvent;
|
|
274
273
|
updatedEvent?: EntityUpdatedEvent;
|
|
275
274
|
deletedEvent?: EntityDeletedEvent;
|
|
276
275
|
actionEvent?: ActionEvent;
|
|
277
276
|
}
|
|
278
|
-
|
|
277
|
+
interface EntityCreatedEvent {
|
|
279
278
|
entity?: string;
|
|
280
279
|
}
|
|
281
|
-
|
|
280
|
+
interface RestoreInfo {
|
|
282
281
|
deletedDate?: Date | null;
|
|
283
282
|
}
|
|
284
|
-
|
|
283
|
+
interface EntityUpdatedEvent {
|
|
285
284
|
/**
|
|
286
285
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
287
286
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -289,14 +288,14 @@ export interface EntityUpdatedEvent {
|
|
|
289
288
|
*/
|
|
290
289
|
currentEntity?: string;
|
|
291
290
|
}
|
|
292
|
-
|
|
291
|
+
interface EntityDeletedEvent {
|
|
293
292
|
/** Entity that was deleted */
|
|
294
293
|
deletedEntity?: string | null;
|
|
295
294
|
}
|
|
296
|
-
|
|
295
|
+
interface ActionEvent {
|
|
297
296
|
body?: string;
|
|
298
297
|
}
|
|
299
|
-
|
|
298
|
+
interface MessageEnvelope {
|
|
300
299
|
/**
|
|
301
300
|
* App instance ID.
|
|
302
301
|
* @format GUID
|
|
@@ -312,7 +311,7 @@ export interface MessageEnvelope {
|
|
|
312
311
|
/** Stringify payload. */
|
|
313
312
|
data?: string;
|
|
314
313
|
}
|
|
315
|
-
|
|
314
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
316
315
|
/**
|
|
317
316
|
* ID of a site visitor that has not logged in to the site.
|
|
318
317
|
* @format GUID
|
|
@@ -337,7 +336,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
337
336
|
identityType?: WebhookIdentityType;
|
|
338
337
|
}
|
|
339
338
|
/** @oneof */
|
|
340
|
-
|
|
339
|
+
interface IdentificationDataIdOneOf {
|
|
341
340
|
/**
|
|
342
341
|
* ID of a site visitor that has not logged in to the site.
|
|
343
342
|
* @format GUID
|
|
@@ -359,14 +358,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
359
358
|
*/
|
|
360
359
|
appId?: string;
|
|
361
360
|
}
|
|
362
|
-
|
|
361
|
+
declare enum WebhookIdentityType {
|
|
363
362
|
UNKNOWN = "UNKNOWN",
|
|
364
363
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
365
364
|
MEMBER = "MEMBER",
|
|
366
365
|
WIX_USER = "WIX_USER",
|
|
367
366
|
APP = "APP"
|
|
368
367
|
}
|
|
369
|
-
|
|
368
|
+
interface BaseEventMetadata {
|
|
370
369
|
/**
|
|
371
370
|
* App instance ID.
|
|
372
371
|
* @format GUID
|
|
@@ -380,7 +379,7 @@ export interface BaseEventMetadata {
|
|
|
380
379
|
/** The identification type and identity data. */
|
|
381
380
|
identity?: IdentificationData;
|
|
382
381
|
}
|
|
383
|
-
|
|
382
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
384
383
|
/**
|
|
385
384
|
* Unique event ID.
|
|
386
385
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -418,159 +417,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
418
417
|
*/
|
|
419
418
|
entityEventSequence?: string | null;
|
|
420
419
|
}
|
|
421
|
-
|
|
420
|
+
interface TaxGroupCreatedEnvelope {
|
|
422
421
|
entity: TaxGroup;
|
|
423
422
|
metadata: EventMetadata;
|
|
424
423
|
}
|
|
425
|
-
|
|
426
|
-
* Triggered when a tax group is created.
|
|
427
|
-
* @permissionScope Manage Stores - all permissions
|
|
428
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
429
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
430
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
431
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
432
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
433
|
-
* @permissionScope Picasso private app mega scope
|
|
434
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
435
|
-
* @permissionScope Manage Orders
|
|
436
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
437
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
438
|
-
* @webhook
|
|
439
|
-
* @eventType wix.billing.v1.tax_group_created
|
|
440
|
-
* @serviceIdentifier wix.billing.v1.TaxGroups
|
|
441
|
-
* @slug created
|
|
442
|
-
* @documentationMaturity preview
|
|
443
|
-
*/
|
|
444
|
-
export declare function onTaxGroupCreated(handler: (event: TaxGroupCreatedEnvelope) => void | Promise<void>): void;
|
|
445
|
-
export interface TaxGroupDeletedEnvelope {
|
|
424
|
+
interface TaxGroupDeletedEnvelope {
|
|
446
425
|
metadata: EventMetadata;
|
|
447
426
|
}
|
|
448
|
-
|
|
449
|
-
* Triggered when a tax group is deleted.
|
|
450
|
-
* @permissionScope Manage Stores - all permissions
|
|
451
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
452
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
453
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
454
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
455
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
456
|
-
* @permissionScope Picasso private app mega scope
|
|
457
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
458
|
-
* @permissionScope Manage Orders
|
|
459
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
460
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
461
|
-
* @webhook
|
|
462
|
-
* @eventType wix.billing.v1.tax_group_deleted
|
|
463
|
-
* @serviceIdentifier wix.billing.v1.TaxGroups
|
|
464
|
-
* @slug deleted
|
|
465
|
-
* @documentationMaturity preview
|
|
466
|
-
*/
|
|
467
|
-
export declare function onTaxGroupDeleted(handler: (event: TaxGroupDeletedEnvelope) => void | Promise<void>): void;
|
|
468
|
-
export interface TaxGroupUpdatedEnvelope {
|
|
427
|
+
interface TaxGroupUpdatedEnvelope {
|
|
469
428
|
entity: TaxGroup;
|
|
470
429
|
metadata: EventMetadata;
|
|
471
430
|
}
|
|
472
|
-
|
|
473
|
-
* Triggered when a tax group is updated.
|
|
474
|
-
* @permissionScope Manage Stores - all permissions
|
|
475
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
476
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
477
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
478
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
479
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
480
|
-
* @permissionScope Picasso private app mega scope
|
|
481
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
482
|
-
* @permissionScope Manage Orders
|
|
483
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
484
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
485
|
-
* @webhook
|
|
486
|
-
* @eventType wix.billing.v1.tax_group_updated
|
|
487
|
-
* @serviceIdentifier wix.billing.v1.TaxGroups
|
|
488
|
-
* @slug updated
|
|
489
|
-
* @documentationMaturity preview
|
|
490
|
-
*/
|
|
491
|
-
export declare function onTaxGroupUpdated(handler: (event: TaxGroupUpdatedEnvelope) => void | Promise<void>): void;
|
|
492
|
-
type TaxGroupNonNullablePaths = `name`;
|
|
493
|
-
/**
|
|
494
|
-
* Creates a tax group.
|
|
495
|
-
*
|
|
496
|
-
* Call Stores Update Product to add the `taxGroupId` to specific products to categorize as a group based on distinct tax treatment.
|
|
497
|
-
* Wix uses tax groups to calculate tax.
|
|
498
|
-
*
|
|
499
|
-
* In addition to tax groups you create, default tax groups are already included in all Wix catalogs.
|
|
500
|
-
* Call List Default Tax Groups to retrieve them. You can also use the Tax Groups Integration service plugin (REST only)
|
|
501
|
-
* to create new default tax groups that can be applied directly to an entire catalog of products.
|
|
502
|
-
* @param taxGroup - Tax group to create.
|
|
503
|
-
* @public
|
|
504
|
-
* @documentationMaturity preview
|
|
505
|
-
* @requiredField taxGroup
|
|
506
|
-
* @requiredField taxGroup.name
|
|
507
|
-
* @permissionId BILLING.TAX_GROUP_CREATE
|
|
508
|
-
* @permissionScope Manage Stores - all permissions
|
|
509
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
510
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
511
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
512
|
-
* @permissionScope Picasso private app mega scope
|
|
513
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
514
|
-
* @permissionScope Manage Orders
|
|
515
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
516
|
-
* @applicableIdentity APP
|
|
517
|
-
* @returns Created tax group.
|
|
518
|
-
* @fqn wix.billing.v1.TaxGroups.CreateTaxGroup
|
|
519
|
-
*/
|
|
520
|
-
export declare function createTaxGroup(taxGroup: NonNullablePaths<TaxGroup, `name`>): Promise<NonNullablePaths<TaxGroup, TaxGroupNonNullablePaths>>;
|
|
521
|
-
/**
|
|
522
|
-
* Retrieves a tax group.
|
|
523
|
-
* @param taxGroupId - ID of the tax group to retrieve.
|
|
524
|
-
* @public
|
|
525
|
-
* @documentationMaturity preview
|
|
526
|
-
* @requiredField taxGroupId
|
|
527
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
528
|
-
* @permissionScope Manage Stores - all permissions
|
|
529
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
530
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
531
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
532
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
533
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
534
|
-
* @permissionScope Picasso private app mega scope
|
|
535
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
536
|
-
* @permissionScope Manage Orders
|
|
537
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
538
|
-
* @applicableIdentity APP
|
|
539
|
-
* @applicableIdentity VISITOR
|
|
540
|
-
* @returns Retrieved tax group.
|
|
541
|
-
* @fqn wix.billing.v1.TaxGroups.GetTaxGroup
|
|
542
|
-
*/
|
|
543
|
-
export declare function getTaxGroup(taxGroupId: string): Promise<NonNullablePaths<TaxGroup, TaxGroupNonNullablePaths>>;
|
|
544
|
-
/**
|
|
545
|
-
* Updates a tax group.
|
|
546
|
-
*
|
|
547
|
-
* Each time the tax group is updated, `revision` increments by 1.
|
|
548
|
-
* The current `revision` must be passed when updating the tax group.
|
|
549
|
-
* This ensures you're working with the latest tax group and prevents
|
|
550
|
-
* unintended overwrites.
|
|
551
|
-
* @param _id - Tax group ID.
|
|
552
|
-
* @public
|
|
553
|
-
* @documentationMaturity preview
|
|
554
|
-
* @requiredField _id
|
|
555
|
-
* @requiredField taxGroup
|
|
556
|
-
* @requiredField taxGroup.name
|
|
557
|
-
* @requiredField taxGroup.revision
|
|
558
|
-
* @param taxGroup - Tax group info.
|
|
559
|
-
* @permissionId BILLING.TAX_GROUP_UPDATE
|
|
560
|
-
* @permissionScope Manage Stores - all permissions
|
|
561
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
562
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
563
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
564
|
-
* @permissionScope Picasso private app mega scope
|
|
565
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
566
|
-
* @permissionScope Manage Orders
|
|
567
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
568
|
-
* @applicableIdentity APP
|
|
569
|
-
* @returns Updated tax group.
|
|
570
|
-
* @fqn wix.billing.v1.TaxGroups.UpdateTaxGroup
|
|
571
|
-
*/
|
|
572
|
-
export declare function updateTaxGroup(_id: string, taxGroup: NonNullablePaths<UpdateTaxGroup, `name` | `revision`>): Promise<NonNullablePaths<TaxGroup, TaxGroupNonNullablePaths>>;
|
|
573
|
-
export interface UpdateTaxGroup {
|
|
431
|
+
interface UpdateTaxGroup {
|
|
574
432
|
/**
|
|
575
433
|
* Tax group ID.
|
|
576
434
|
* @format GUID
|
|
@@ -602,60 +460,6 @@ export interface UpdateTaxGroup {
|
|
|
602
460
|
*/
|
|
603
461
|
_updatedDate?: Date | null;
|
|
604
462
|
}
|
|
605
|
-
/**
|
|
606
|
-
* Deletes a tax group.
|
|
607
|
-
*
|
|
608
|
-
* 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.
|
|
609
|
-
* @param taxGroupId - ID of the tax group to delete.
|
|
610
|
-
* @public
|
|
611
|
-
* @documentationMaturity preview
|
|
612
|
-
* @requiredField taxGroupId
|
|
613
|
-
* @permissionId BILLING.TAX_GROUP_DELETE
|
|
614
|
-
* @permissionScope Manage Stores - all permissions
|
|
615
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
616
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
617
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
618
|
-
* @permissionScope Picasso private app mega scope
|
|
619
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
620
|
-
* @permissionScope Manage Orders
|
|
621
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
622
|
-
* @applicableIdentity APP
|
|
623
|
-
* @fqn wix.billing.v1.TaxGroups.DeleteTaxGroup
|
|
624
|
-
*/
|
|
625
|
-
export declare function deleteTaxGroup(taxGroupId: string): Promise<void>;
|
|
626
|
-
/**
|
|
627
|
-
* Creates a query to retrieve a list of tax groups.
|
|
628
|
-
*
|
|
629
|
-
* The `queryTaxGroups()` function builds a query to retrieve a list of tax groups and returns a `TaxGroupsQueryBuilder` object.
|
|
630
|
-
*
|
|
631
|
-
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
632
|
-
*
|
|
633
|
-
* 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.
|
|
634
|
-
*
|
|
635
|
-
* `queryTaxGroups()` runs with the following `TaxGroupsQueryBuilder` default that you can override:
|
|
636
|
-
* + `ascending("_id")`
|
|
637
|
-
*
|
|
638
|
-
* 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"`.
|
|
639
|
-
*
|
|
640
|
-
* 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`.
|
|
641
|
-
* @public
|
|
642
|
-
* @documentationMaturity preview
|
|
643
|
-
* @permissionScope Manage Stores - all permissions
|
|
644
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
645
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
646
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
647
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
648
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
649
|
-
* @permissionScope Picasso private app mega scope
|
|
650
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
651
|
-
* @permissionScope Manage Orders
|
|
652
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
653
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
654
|
-
* @applicableIdentity APP
|
|
655
|
-
* @applicableIdentity VISITOR
|
|
656
|
-
* @fqn wix.billing.v1.TaxGroups.QueryTaxGroups
|
|
657
|
-
*/
|
|
658
|
-
export declare function queryTaxGroups(): TaxGroupsQueryBuilder;
|
|
659
463
|
interface QueryCursorResult {
|
|
660
464
|
cursors: Cursors;
|
|
661
465
|
hasNext: () => boolean;
|
|
@@ -663,13 +467,13 @@ interface QueryCursorResult {
|
|
|
663
467
|
length: number;
|
|
664
468
|
pageSize: number;
|
|
665
469
|
}
|
|
666
|
-
|
|
470
|
+
interface TaxGroupsQueryResult extends QueryCursorResult {
|
|
667
471
|
items: TaxGroup[];
|
|
668
472
|
query: TaxGroupsQueryBuilder;
|
|
669
473
|
next: () => Promise<TaxGroupsQueryResult>;
|
|
670
474
|
prev: () => Promise<TaxGroupsQueryResult>;
|
|
671
475
|
}
|
|
672
|
-
|
|
476
|
+
interface TaxGroupsQueryBuilder {
|
|
673
477
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
674
478
|
* @param value - Value to compare against.
|
|
675
479
|
* @documentationMaturity preview
|
|
@@ -728,55 +532,5 @@ export interface TaxGroupsQueryBuilder {
|
|
|
728
532
|
/** @documentationMaturity preview */
|
|
729
533
|
find: () => Promise<TaxGroupsQueryResult>;
|
|
730
534
|
}
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
*
|
|
734
|
-
* The default tax groups for a site are inherited by the apps installed on the site.
|
|
735
|
-
* For example, the Wix Stores app includes a `"Products"` tax group by default.
|
|
736
|
-
*
|
|
737
|
-
* Add additional default tax groups with the Tax Groups Integration service plugin (REST only).
|
|
738
|
-
* @public
|
|
739
|
-
* @documentationMaturity preview
|
|
740
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
741
|
-
* @permissionScope Manage Stores - all permissions
|
|
742
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
743
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
744
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
745
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
746
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
747
|
-
* @permissionScope Picasso private app mega scope
|
|
748
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
749
|
-
* @permissionScope Manage Orders
|
|
750
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
751
|
-
* @applicableIdentity APP
|
|
752
|
-
* @applicableIdentity VISITOR
|
|
753
|
-
* @fqn wix.billing.v1.TaxGroups.ListDefaultTaxGroups
|
|
754
|
-
*/
|
|
755
|
-
export declare function listDefaultTaxGroups(): Promise<NonNullablePaths<ListDefaultTaxGroupsResponse, {
|
|
756
|
-
[P in TaxGroupNonNullablePaths]: `taxGroups.${number}.${P}`;
|
|
757
|
-
}[TaxGroupNonNullablePaths]>>;
|
|
758
|
-
/**
|
|
759
|
-
* Retrieves default tax groups for specific apps.
|
|
760
|
-
* @param appIds - App IDs to retrieve default tax groups for.
|
|
761
|
-
* @public
|
|
762
|
-
* @documentationMaturity preview
|
|
763
|
-
* @requiredField appIds
|
|
764
|
-
* @permissionId BILLING.TAX_GROUP_READ
|
|
765
|
-
* @permissionScope Manage Stores - all permissions
|
|
766
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
767
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
768
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
769
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
770
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
771
|
-
* @permissionScope Picasso private app mega scope
|
|
772
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
773
|
-
* @permissionScope Manage Orders
|
|
774
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
775
|
-
* @applicableIdentity APP
|
|
776
|
-
* @applicableIdentity VISITOR
|
|
777
|
-
* @fqn wix.billing.v1.TaxGroups.ListDefaultTaxGroupsByAppIds
|
|
778
|
-
*/
|
|
779
|
-
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` | {
|
|
780
|
-
[P in TaxGroupNonNullablePaths]: `results.${number}.taxGroup.${P}`;
|
|
781
|
-
}[TaxGroupNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
782
|
-
export {};
|
|
535
|
+
|
|
536
|
+
export { type ApplicationError as A, type BulkActionMetadata as B, type CreateTaxGroupRequest as C, type DeleteTaxGroupRequest as D, type EntityCreatedEvent as E, type TaxGroupCreatedEnvelope as F, type GetTaxGroupRequest as G, type TaxGroupDeletedEnvelope as H, type ItemMetadata as I, type TaxGroupUpdatedEnvelope 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 CreateTaxGroupResponse as c, type GetTaxGroupResponse as d, type UpdateTaxGroupRequest as e, type UpdateTaxGroupResponse as f, type DeleteTaxGroupResponse as g, type QueryV2 as h, type QueryV2PagingMethodOneOf as i, type Sorting as j, type CursorPaging as k, type QueryTaxGroupsResponse as l, type CursorPagingMetadata as m, type Cursors as n, type ListDefaultTaxGroupsRequest as o, type ListDefaultTaxGroupsByAppIdsRequest as p, type ListDefaultTaxGroupsByAppIdsResult as q, type DomainEvent as r, type DomainEventBodyOneOf as s, type EntityUpdatedEvent as t, type EntityDeletedEvent as u, type ActionEvent as v, type IdentificationData as w, type IdentificationDataIdOneOf as x, type BaseEventMetadata as y, type EventMetadata as z };
|