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