@wix/auto_sdk_ecom_order-invoices 1.0.15 → 1.0.16
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/src/ecom-orders-v1-invoice-order-invoices.types.d.ts → ecom-orders-v1-invoice-order-invoices.universal-Be8NGMCD.d.mts} +43 -43
- package/build/{internal/cjs/src/ecom-orders-v1-invoice-order-invoices.types.d.ts → ecom-orders-v1-invoice-order-invoices.universal-Be8NGMCD.d.ts} +43 -43
- package/build/index.d.mts +19 -0
- package/build/index.d.ts +19 -0
- package/build/index.js +284 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +256 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/ecom-orders-v1-invoice-order-invoices.types.d.ts → ecom-orders-v1-invoice-order-invoices.universal-CuUkLxV0.d.mts} +43 -43
- package/build/{es/src/ecom-orders-v1-invoice-order-invoices.types.d.ts → internal/ecom-orders-v1-invoice-order-invoices.universal-CuUkLxV0.d.ts} +43 -43
- package/build/internal/index.d.mts +53 -0
- package/build/internal/index.d.ts +53 -0
- package/build/internal/index.js +284 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +256 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +127 -0
- package/build/internal/meta.d.ts +127 -0
- package/build/internal/meta.js +209 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +179 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +127 -0
- package/build/meta.d.ts +127 -0
- package/build/meta.js +209 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +179 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.context.d.ts +0 -5
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.context.js +0 -15
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.context.js.map +0 -1
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.http.d.ts +0 -14
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.http.js +0 -114
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.http.js.map +0 -1
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.meta.d.ts +0 -20
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.meta.js +0 -104
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.meta.js.map +0 -1
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.public.d.ts +0 -17
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.public.js +0 -35
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.public.js.map +0 -1
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.types.js +0 -12
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.types.js.map +0 -1
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.universal.d.ts +0 -329
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.universal.js +0 -223
- package/build/cjs/src/ecom-orders-v1-invoice-order-invoices.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/ecom-orders-v1-invoice-order-invoices.context.d.ts +0 -5
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.context.js +0 -11
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.context.js.map +0 -1
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.http.d.ts +0 -14
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.http.js +0 -107
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.http.js.map +0 -1
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.meta.d.ts +0 -20
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.meta.js +0 -74
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.meta.js.map +0 -1
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.public.d.ts +0 -17
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.public.js +0 -27
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.public.js.map +0 -1
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.types.js +0 -9
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.types.js.map +0 -1
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.universal.d.ts +0 -329
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.universal.js +0 -193
- package/build/es/src/ecom-orders-v1-invoice-order-invoices.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/ecom-orders-v1-invoice-order-invoices.context.d.ts +0 -11
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.context.js +0 -15
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.http.d.ts +0 -14
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.http.js +0 -114
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.meta.d.ts +0 -20
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.meta.js +0 -104
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.public.d.ts +0 -45
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.public.js +0 -35
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.types.js +0 -12
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.universal.d.ts +0 -398
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.universal.js +0 -223
- package/build/internal/cjs/src/ecom-orders-v1-invoice-order-invoices.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/ecom-orders-v1-invoice-order-invoices.context.d.ts +0 -11
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.context.js +0 -11
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.context.js.map +0 -1
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.http.d.ts +0 -14
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.http.js +0 -107
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.http.js.map +0 -1
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.meta.d.ts +0 -20
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.meta.js +0 -74
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.meta.js.map +0 -1
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.public.d.ts +0 -45
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.public.js +0 -27
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.public.js.map +0 -1
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.types.js +0 -9
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.types.js.map +0 -1
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.universal.d.ts +0 -398
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.universal.js +0 -193
- package/build/internal/es/src/ecom-orders-v1-invoice-order-invoices.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface Invoice {
|
|
2
2
|
/** Invoice ID. */
|
|
3
|
-
|
|
3
|
+
_id?: string;
|
|
4
4
|
/** ID of the app that set the invoice. */
|
|
5
5
|
appId?: string;
|
|
6
6
|
}
|
|
7
|
-
|
|
7
|
+
interface ListInvoicesForSingleOrderRequest {
|
|
8
8
|
/**
|
|
9
9
|
* Order ID.
|
|
10
10
|
* @minLength 1
|
|
@@ -12,11 +12,11 @@ export interface ListInvoicesForSingleOrderRequest {
|
|
|
12
12
|
*/
|
|
13
13
|
orderId?: string;
|
|
14
14
|
}
|
|
15
|
-
|
|
15
|
+
interface ListInvoicesForSingleOrderResponse {
|
|
16
16
|
/** List of invoices. */
|
|
17
17
|
invoices?: Invoice[];
|
|
18
18
|
}
|
|
19
|
-
|
|
19
|
+
interface ListInvoicesForMultipleOrdersRequest {
|
|
20
20
|
/**
|
|
21
21
|
* Order IDs for which to retrieve invoices.
|
|
22
22
|
* @maxSize 100
|
|
@@ -25,11 +25,11 @@ export interface ListInvoicesForMultipleOrdersRequest {
|
|
|
25
25
|
*/
|
|
26
26
|
orderIds: string[];
|
|
27
27
|
}
|
|
28
|
-
|
|
28
|
+
interface ListInvoicesForMultipleOrdersResponse {
|
|
29
29
|
/** List of order IDs and their associated invoices. */
|
|
30
30
|
invoicesForOrder?: InvoicesForOrder[];
|
|
31
31
|
}
|
|
32
|
-
|
|
32
|
+
interface InvoicesForOrder {
|
|
33
33
|
/** Order ID. */
|
|
34
34
|
orderId?: string;
|
|
35
35
|
/**
|
|
@@ -38,7 +38,7 @@ export interface InvoicesForOrder {
|
|
|
38
38
|
*/
|
|
39
39
|
invoicesInfo?: Invoice[];
|
|
40
40
|
}
|
|
41
|
-
|
|
41
|
+
interface GenerateInvoiceRequest {
|
|
42
42
|
/**
|
|
43
43
|
* Order ID.
|
|
44
44
|
* @minLength 1
|
|
@@ -46,11 +46,11 @@ export interface GenerateInvoiceRequest {
|
|
|
46
46
|
*/
|
|
47
47
|
orderId: string;
|
|
48
48
|
}
|
|
49
|
-
|
|
49
|
+
interface GenerateInvoiceResponse {
|
|
50
50
|
/** Invoice ID. */
|
|
51
51
|
invoiceId?: string;
|
|
52
52
|
}
|
|
53
|
-
|
|
53
|
+
interface BulkGenerateInvoicesRequest {
|
|
54
54
|
/**
|
|
55
55
|
* Order IDs.
|
|
56
56
|
* @minSize 1
|
|
@@ -60,17 +60,17 @@ export interface BulkGenerateInvoicesRequest {
|
|
|
60
60
|
*/
|
|
61
61
|
orderIds: string[];
|
|
62
62
|
}
|
|
63
|
-
|
|
63
|
+
interface BulkGenerateInvoicesResponse {
|
|
64
64
|
results?: BulkInvoiceResult[];
|
|
65
65
|
bulkActionMetadata?: BulkActionMetadata;
|
|
66
66
|
}
|
|
67
|
-
|
|
67
|
+
interface BulkInvoiceResult {
|
|
68
68
|
itemMetadata?: ItemMetadata;
|
|
69
69
|
item?: InvoiceForOrder;
|
|
70
70
|
}
|
|
71
|
-
|
|
71
|
+
interface ItemMetadata {
|
|
72
72
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
73
|
-
|
|
73
|
+
_id?: string | null;
|
|
74
74
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
75
75
|
originalIndex?: number;
|
|
76
76
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -78,7 +78,7 @@ export interface ItemMetadata {
|
|
|
78
78
|
/** Details about the error in case of failure. */
|
|
79
79
|
error?: ApplicationError;
|
|
80
80
|
}
|
|
81
|
-
|
|
81
|
+
interface ApplicationError {
|
|
82
82
|
/** Error code. */
|
|
83
83
|
code?: string;
|
|
84
84
|
/** Description of the error. */
|
|
@@ -86,13 +86,13 @@ export interface ApplicationError {
|
|
|
86
86
|
/** Data related to the error. */
|
|
87
87
|
data?: Record<string, any> | null;
|
|
88
88
|
}
|
|
89
|
-
|
|
89
|
+
interface InvoiceForOrder {
|
|
90
90
|
/** Order ID. */
|
|
91
91
|
orderId?: string;
|
|
92
92
|
/** Invoice ID. */
|
|
93
93
|
invoiceId?: string;
|
|
94
94
|
}
|
|
95
|
-
|
|
95
|
+
interface BulkActionMetadata {
|
|
96
96
|
/** Number of items that were successfully processed. */
|
|
97
97
|
totalSuccesses?: number;
|
|
98
98
|
/** Number of items that couldn't be processed. */
|
|
@@ -100,7 +100,7 @@ export interface BulkActionMetadata {
|
|
|
100
100
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
101
101
|
undetailedFailures?: number;
|
|
102
102
|
}
|
|
103
|
-
|
|
103
|
+
interface AddInvoiceToOrderRequest {
|
|
104
104
|
/**
|
|
105
105
|
* Order ID.
|
|
106
106
|
* @minLength 1
|
|
@@ -110,17 +110,17 @@ export interface AddInvoiceToOrderRequest {
|
|
|
110
110
|
/** Invoice info. */
|
|
111
111
|
invoiceInfo: Invoice;
|
|
112
112
|
}
|
|
113
|
-
|
|
113
|
+
interface AddInvoiceToOrderResponse {
|
|
114
114
|
/** List of order invoices. */
|
|
115
115
|
orderInvoices?: Invoice[];
|
|
116
116
|
}
|
|
117
|
-
|
|
117
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
118
118
|
createdEvent?: EntityCreatedEvent;
|
|
119
119
|
updatedEvent?: EntityUpdatedEvent;
|
|
120
120
|
deletedEvent?: EntityDeletedEvent;
|
|
121
121
|
actionEvent?: ActionEvent;
|
|
122
122
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
123
|
-
|
|
123
|
+
_id?: string;
|
|
124
124
|
/**
|
|
125
125
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
126
126
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -149,38 +149,36 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
149
149
|
entityEventSequence?: string | null;
|
|
150
150
|
}
|
|
151
151
|
/** @oneof */
|
|
152
|
-
|
|
152
|
+
interface DomainEventBodyOneOf {
|
|
153
153
|
createdEvent?: EntityCreatedEvent;
|
|
154
154
|
updatedEvent?: EntityUpdatedEvent;
|
|
155
155
|
deletedEvent?: EntityDeletedEvent;
|
|
156
156
|
actionEvent?: ActionEvent;
|
|
157
157
|
}
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
161
|
-
restoreInfo?: RestoreInfo;
|
|
158
|
+
interface EntityCreatedEvent {
|
|
159
|
+
entity?: string;
|
|
162
160
|
}
|
|
163
|
-
|
|
161
|
+
interface RestoreInfo {
|
|
164
162
|
deletedDate?: Date | null;
|
|
165
163
|
}
|
|
166
|
-
|
|
164
|
+
interface EntityUpdatedEvent {
|
|
167
165
|
/**
|
|
168
166
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
169
167
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
170
168
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
171
169
|
*/
|
|
172
|
-
|
|
170
|
+
currentEntity?: string;
|
|
173
171
|
}
|
|
174
|
-
|
|
172
|
+
interface EntityDeletedEvent {
|
|
175
173
|
/** Entity that was deleted. */
|
|
176
|
-
|
|
174
|
+
deletedEntity?: string | null;
|
|
177
175
|
}
|
|
178
|
-
|
|
179
|
-
|
|
176
|
+
interface ActionEvent {
|
|
177
|
+
body?: string;
|
|
180
178
|
}
|
|
181
|
-
|
|
179
|
+
interface Empty {
|
|
182
180
|
}
|
|
183
|
-
|
|
181
|
+
interface GetOrderInvoiceRequest {
|
|
184
182
|
/**
|
|
185
183
|
* Invoice ID.
|
|
186
184
|
* @minLength 1
|
|
@@ -188,7 +186,7 @@ export interface GetOrderInvoiceRequest {
|
|
|
188
186
|
*/
|
|
189
187
|
invoiceId?: string;
|
|
190
188
|
}
|
|
191
|
-
|
|
189
|
+
interface GetOrderInvoiceResponse {
|
|
192
190
|
/**
|
|
193
191
|
* Order ID.
|
|
194
192
|
* @minLength 1
|
|
@@ -198,7 +196,7 @@ export interface GetOrderInvoiceResponse {
|
|
|
198
196
|
/** Invoice info. */
|
|
199
197
|
invoiceInfo?: Invoice;
|
|
200
198
|
}
|
|
201
|
-
|
|
199
|
+
interface GenerateInvoiceWithNumberRequest {
|
|
202
200
|
/**
|
|
203
201
|
* Order ID.
|
|
204
202
|
* @minLength 1
|
|
@@ -213,7 +211,7 @@ export interface GenerateInvoiceWithNumberRequest {
|
|
|
213
211
|
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
214
212
|
issueDate?: Date | null;
|
|
215
213
|
}
|
|
216
|
-
|
|
214
|
+
interface GenerateInvoiceWithNumberResponse {
|
|
217
215
|
/**
|
|
218
216
|
* Invoice ID.
|
|
219
217
|
* @minLength 1
|
|
@@ -221,7 +219,7 @@ export interface GenerateInvoiceWithNumberResponse {
|
|
|
221
219
|
*/
|
|
222
220
|
invoiceId?: string;
|
|
223
221
|
}
|
|
224
|
-
|
|
222
|
+
interface MessageEnvelope {
|
|
225
223
|
/**
|
|
226
224
|
* App instance ID.
|
|
227
225
|
* @format GUID
|
|
@@ -237,7 +235,7 @@ export interface MessageEnvelope {
|
|
|
237
235
|
/** Stringify payload. */
|
|
238
236
|
data?: string;
|
|
239
237
|
}
|
|
240
|
-
|
|
238
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
241
239
|
/**
|
|
242
240
|
* ID of a site visitor that has not logged in to the site.
|
|
243
241
|
* @format GUID
|
|
@@ -262,7 +260,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
262
260
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
263
261
|
}
|
|
264
262
|
/** @oneof */
|
|
265
|
-
|
|
263
|
+
interface IdentificationDataIdOneOf {
|
|
266
264
|
/**
|
|
267
265
|
* ID of a site visitor that has not logged in to the site.
|
|
268
266
|
* @format GUID
|
|
@@ -284,7 +282,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
284
282
|
*/
|
|
285
283
|
appId?: string;
|
|
286
284
|
}
|
|
287
|
-
|
|
285
|
+
declare enum WebhookIdentityType {
|
|
288
286
|
UNKNOWN = "UNKNOWN",
|
|
289
287
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
290
288
|
MEMBER = "MEMBER",
|
|
@@ -292,4 +290,6 @@ export declare enum WebhookIdentityType {
|
|
|
292
290
|
APP = "APP"
|
|
293
291
|
}
|
|
294
292
|
/** @enumType */
|
|
295
|
-
|
|
293
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
294
|
+
|
|
295
|
+
export { type ApplicationError as A, type BulkGenerateInvoicesRequest as B, type DomainEvent as D, type EntityCreatedEvent as E, type GenerateInvoiceRequest as G, type Invoice as I, type ListInvoicesForMultipleOrdersResponse as L, type MessageEnvelope as M, type RestoreInfo as R, WebhookIdentityType as W, type ListInvoicesForSingleOrderRequest as a, type ListInvoicesForSingleOrderResponse as b, type ListInvoicesForMultipleOrdersRequest as c, type InvoicesForOrder as d, type GenerateInvoiceResponse as e, type BulkGenerateInvoicesResponse as f, type BulkInvoiceResult as g, type ItemMetadata as h, type InvoiceForOrder as i, type BulkActionMetadata as j, type AddInvoiceToOrderRequest as k, type AddInvoiceToOrderResponse as l, type DomainEventBodyOneOf as m, type EntityUpdatedEvent as n, type EntityDeletedEvent as o, type ActionEvent as p, type Empty as q, type GetOrderInvoiceRequest as r, type GetOrderInvoiceResponse as s, type GenerateInvoiceWithNumberRequest as t, type GenerateInvoiceWithNumberResponse as u, type IdentificationData as v, type IdentificationDataIdOneOf as w };
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface Invoice {
|
|
2
2
|
/** Invoice ID. */
|
|
3
|
-
|
|
3
|
+
_id?: string;
|
|
4
4
|
/** ID of the app that set the invoice. */
|
|
5
5
|
appId?: string;
|
|
6
6
|
}
|
|
7
|
-
|
|
7
|
+
interface ListInvoicesForSingleOrderRequest {
|
|
8
8
|
/**
|
|
9
9
|
* Order ID.
|
|
10
10
|
* @minLength 1
|
|
@@ -12,11 +12,11 @@ export interface ListInvoicesForSingleOrderRequest {
|
|
|
12
12
|
*/
|
|
13
13
|
orderId?: string;
|
|
14
14
|
}
|
|
15
|
-
|
|
15
|
+
interface ListInvoicesForSingleOrderResponse {
|
|
16
16
|
/** List of invoices. */
|
|
17
17
|
invoices?: Invoice[];
|
|
18
18
|
}
|
|
19
|
-
|
|
19
|
+
interface ListInvoicesForMultipleOrdersRequest {
|
|
20
20
|
/**
|
|
21
21
|
* Order IDs for which to retrieve invoices.
|
|
22
22
|
* @maxSize 100
|
|
@@ -25,11 +25,11 @@ export interface ListInvoicesForMultipleOrdersRequest {
|
|
|
25
25
|
*/
|
|
26
26
|
orderIds: string[];
|
|
27
27
|
}
|
|
28
|
-
|
|
28
|
+
interface ListInvoicesForMultipleOrdersResponse {
|
|
29
29
|
/** List of order IDs and their associated invoices. */
|
|
30
30
|
invoicesForOrder?: InvoicesForOrder[];
|
|
31
31
|
}
|
|
32
|
-
|
|
32
|
+
interface InvoicesForOrder {
|
|
33
33
|
/** Order ID. */
|
|
34
34
|
orderId?: string;
|
|
35
35
|
/**
|
|
@@ -38,7 +38,7 @@ export interface InvoicesForOrder {
|
|
|
38
38
|
*/
|
|
39
39
|
invoicesInfo?: Invoice[];
|
|
40
40
|
}
|
|
41
|
-
|
|
41
|
+
interface GenerateInvoiceRequest {
|
|
42
42
|
/**
|
|
43
43
|
* Order ID.
|
|
44
44
|
* @minLength 1
|
|
@@ -46,11 +46,11 @@ export interface GenerateInvoiceRequest {
|
|
|
46
46
|
*/
|
|
47
47
|
orderId: string;
|
|
48
48
|
}
|
|
49
|
-
|
|
49
|
+
interface GenerateInvoiceResponse {
|
|
50
50
|
/** Invoice ID. */
|
|
51
51
|
invoiceId?: string;
|
|
52
52
|
}
|
|
53
|
-
|
|
53
|
+
interface BulkGenerateInvoicesRequest {
|
|
54
54
|
/**
|
|
55
55
|
* Order IDs.
|
|
56
56
|
* @minSize 1
|
|
@@ -60,17 +60,17 @@ export interface BulkGenerateInvoicesRequest {
|
|
|
60
60
|
*/
|
|
61
61
|
orderIds: string[];
|
|
62
62
|
}
|
|
63
|
-
|
|
63
|
+
interface BulkGenerateInvoicesResponse {
|
|
64
64
|
results?: BulkInvoiceResult[];
|
|
65
65
|
bulkActionMetadata?: BulkActionMetadata;
|
|
66
66
|
}
|
|
67
|
-
|
|
67
|
+
interface BulkInvoiceResult {
|
|
68
68
|
itemMetadata?: ItemMetadata;
|
|
69
69
|
item?: InvoiceForOrder;
|
|
70
70
|
}
|
|
71
|
-
|
|
71
|
+
interface ItemMetadata {
|
|
72
72
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
73
|
-
|
|
73
|
+
_id?: string | null;
|
|
74
74
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
75
75
|
originalIndex?: number;
|
|
76
76
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -78,7 +78,7 @@ export interface ItemMetadata {
|
|
|
78
78
|
/** Details about the error in case of failure. */
|
|
79
79
|
error?: ApplicationError;
|
|
80
80
|
}
|
|
81
|
-
|
|
81
|
+
interface ApplicationError {
|
|
82
82
|
/** Error code. */
|
|
83
83
|
code?: string;
|
|
84
84
|
/** Description of the error. */
|
|
@@ -86,13 +86,13 @@ export interface ApplicationError {
|
|
|
86
86
|
/** Data related to the error. */
|
|
87
87
|
data?: Record<string, any> | null;
|
|
88
88
|
}
|
|
89
|
-
|
|
89
|
+
interface InvoiceForOrder {
|
|
90
90
|
/** Order ID. */
|
|
91
91
|
orderId?: string;
|
|
92
92
|
/** Invoice ID. */
|
|
93
93
|
invoiceId?: string;
|
|
94
94
|
}
|
|
95
|
-
|
|
95
|
+
interface BulkActionMetadata {
|
|
96
96
|
/** Number of items that were successfully processed. */
|
|
97
97
|
totalSuccesses?: number;
|
|
98
98
|
/** Number of items that couldn't be processed. */
|
|
@@ -100,7 +100,7 @@ export interface BulkActionMetadata {
|
|
|
100
100
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
101
101
|
undetailedFailures?: number;
|
|
102
102
|
}
|
|
103
|
-
|
|
103
|
+
interface AddInvoiceToOrderRequest {
|
|
104
104
|
/**
|
|
105
105
|
* Order ID.
|
|
106
106
|
* @minLength 1
|
|
@@ -110,17 +110,17 @@ export interface AddInvoiceToOrderRequest {
|
|
|
110
110
|
/** Invoice info. */
|
|
111
111
|
invoiceInfo: Invoice;
|
|
112
112
|
}
|
|
113
|
-
|
|
113
|
+
interface AddInvoiceToOrderResponse {
|
|
114
114
|
/** List of order invoices. */
|
|
115
115
|
orderInvoices?: Invoice[];
|
|
116
116
|
}
|
|
117
|
-
|
|
117
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
118
118
|
createdEvent?: EntityCreatedEvent;
|
|
119
119
|
updatedEvent?: EntityUpdatedEvent;
|
|
120
120
|
deletedEvent?: EntityDeletedEvent;
|
|
121
121
|
actionEvent?: ActionEvent;
|
|
122
122
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
123
|
-
|
|
123
|
+
_id?: string;
|
|
124
124
|
/**
|
|
125
125
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
126
126
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -149,38 +149,36 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
149
149
|
entityEventSequence?: string | null;
|
|
150
150
|
}
|
|
151
151
|
/** @oneof */
|
|
152
|
-
|
|
152
|
+
interface DomainEventBodyOneOf {
|
|
153
153
|
createdEvent?: EntityCreatedEvent;
|
|
154
154
|
updatedEvent?: EntityUpdatedEvent;
|
|
155
155
|
deletedEvent?: EntityDeletedEvent;
|
|
156
156
|
actionEvent?: ActionEvent;
|
|
157
157
|
}
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
161
|
-
restoreInfo?: RestoreInfo;
|
|
158
|
+
interface EntityCreatedEvent {
|
|
159
|
+
entity?: string;
|
|
162
160
|
}
|
|
163
|
-
|
|
161
|
+
interface RestoreInfo {
|
|
164
162
|
deletedDate?: Date | null;
|
|
165
163
|
}
|
|
166
|
-
|
|
164
|
+
interface EntityUpdatedEvent {
|
|
167
165
|
/**
|
|
168
166
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
169
167
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
170
168
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
171
169
|
*/
|
|
172
|
-
|
|
170
|
+
currentEntity?: string;
|
|
173
171
|
}
|
|
174
|
-
|
|
172
|
+
interface EntityDeletedEvent {
|
|
175
173
|
/** Entity that was deleted. */
|
|
176
|
-
|
|
174
|
+
deletedEntity?: string | null;
|
|
177
175
|
}
|
|
178
|
-
|
|
179
|
-
|
|
176
|
+
interface ActionEvent {
|
|
177
|
+
body?: string;
|
|
180
178
|
}
|
|
181
|
-
|
|
179
|
+
interface Empty {
|
|
182
180
|
}
|
|
183
|
-
|
|
181
|
+
interface GetOrderInvoiceRequest {
|
|
184
182
|
/**
|
|
185
183
|
* Invoice ID.
|
|
186
184
|
* @minLength 1
|
|
@@ -188,7 +186,7 @@ export interface GetOrderInvoiceRequest {
|
|
|
188
186
|
*/
|
|
189
187
|
invoiceId?: string;
|
|
190
188
|
}
|
|
191
|
-
|
|
189
|
+
interface GetOrderInvoiceResponse {
|
|
192
190
|
/**
|
|
193
191
|
* Order ID.
|
|
194
192
|
* @minLength 1
|
|
@@ -198,7 +196,7 @@ export interface GetOrderInvoiceResponse {
|
|
|
198
196
|
/** Invoice info. */
|
|
199
197
|
invoiceInfo?: Invoice;
|
|
200
198
|
}
|
|
201
|
-
|
|
199
|
+
interface GenerateInvoiceWithNumberRequest {
|
|
202
200
|
/**
|
|
203
201
|
* Order ID.
|
|
204
202
|
* @minLength 1
|
|
@@ -213,7 +211,7 @@ export interface GenerateInvoiceWithNumberRequest {
|
|
|
213
211
|
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
214
212
|
issueDate?: Date | null;
|
|
215
213
|
}
|
|
216
|
-
|
|
214
|
+
interface GenerateInvoiceWithNumberResponse {
|
|
217
215
|
/**
|
|
218
216
|
* Invoice ID.
|
|
219
217
|
* @minLength 1
|
|
@@ -221,7 +219,7 @@ export interface GenerateInvoiceWithNumberResponse {
|
|
|
221
219
|
*/
|
|
222
220
|
invoiceId?: string;
|
|
223
221
|
}
|
|
224
|
-
|
|
222
|
+
interface MessageEnvelope {
|
|
225
223
|
/**
|
|
226
224
|
* App instance ID.
|
|
227
225
|
* @format GUID
|
|
@@ -237,7 +235,7 @@ export interface MessageEnvelope {
|
|
|
237
235
|
/** Stringify payload. */
|
|
238
236
|
data?: string;
|
|
239
237
|
}
|
|
240
|
-
|
|
238
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
241
239
|
/**
|
|
242
240
|
* ID of a site visitor that has not logged in to the site.
|
|
243
241
|
* @format GUID
|
|
@@ -262,7 +260,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
262
260
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
263
261
|
}
|
|
264
262
|
/** @oneof */
|
|
265
|
-
|
|
263
|
+
interface IdentificationDataIdOneOf {
|
|
266
264
|
/**
|
|
267
265
|
* ID of a site visitor that has not logged in to the site.
|
|
268
266
|
* @format GUID
|
|
@@ -284,7 +282,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
284
282
|
*/
|
|
285
283
|
appId?: string;
|
|
286
284
|
}
|
|
287
|
-
|
|
285
|
+
declare enum WebhookIdentityType {
|
|
288
286
|
UNKNOWN = "UNKNOWN",
|
|
289
287
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
290
288
|
MEMBER = "MEMBER",
|
|
@@ -292,4 +290,6 @@ export declare enum WebhookIdentityType {
|
|
|
292
290
|
APP = "APP"
|
|
293
291
|
}
|
|
294
292
|
/** @enumType */
|
|
295
|
-
|
|
293
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
294
|
+
|
|
295
|
+
export { type ApplicationError as A, type BulkGenerateInvoicesRequest as B, type DomainEvent as D, type EntityCreatedEvent as E, type GenerateInvoiceRequest as G, type Invoice as I, type ListInvoicesForMultipleOrdersResponse as L, type MessageEnvelope as M, type RestoreInfo as R, WebhookIdentityType as W, type ListInvoicesForSingleOrderRequest as a, type ListInvoicesForSingleOrderResponse as b, type ListInvoicesForMultipleOrdersRequest as c, type InvoicesForOrder as d, type GenerateInvoiceResponse as e, type BulkGenerateInvoicesResponse as f, type BulkInvoiceResult as g, type ItemMetadata as h, type InvoiceForOrder as i, type BulkActionMetadata as j, type AddInvoiceToOrderRequest as k, type AddInvoiceToOrderResponse as l, type DomainEventBodyOneOf as m, type EntityUpdatedEvent as n, type EntityDeletedEvent as o, type ActionEvent as p, type Empty as q, type GetOrderInvoiceRequest as r, type GetOrderInvoiceResponse as s, type GenerateInvoiceWithNumberRequest as t, type GenerateInvoiceWithNumberResponse as u, type IdentificationData as v, type IdentificationDataIdOneOf as w };
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
+
import { L as ListInvoicesForMultipleOrdersResponse } from './ecom-orders-v1-invoice-order-invoices.universal-Be8NGMCD.mjs';
|
|
3
|
+
export { p as ActionEvent, k as AddInvoiceToOrderRequest, l as AddInvoiceToOrderResponse, A as ApplicationError, j as BulkActionMetadata, B as BulkGenerateInvoicesRequest, f as BulkGenerateInvoicesResponse, g as BulkInvoiceResult, D as DomainEvent, m as DomainEventBodyOneOf, q as Empty, E as EntityCreatedEvent, o as EntityDeletedEvent, n as EntityUpdatedEvent, G as GenerateInvoiceRequest, e as GenerateInvoiceResponse, t as GenerateInvoiceWithNumberRequest, u as GenerateInvoiceWithNumberResponse, r as GetOrderInvoiceRequest, s as GetOrderInvoiceResponse, v as IdentificationData, w as IdentificationDataIdOneOf, I as Invoice, i as InvoiceForOrder, d as InvoicesForOrder, h as ItemMetadata, c as ListInvoicesForMultipleOrdersRequest, a as ListInvoicesForSingleOrderRequest, b as ListInvoicesForSingleOrderResponse, M as MessageEnvelope, R as RestoreInfo, W as WebhookIdentityType } from './ecom-orders-v1-invoice-order-invoices.universal-Be8NGMCD.mjs';
|
|
4
|
+
|
|
5
|
+
declare function listInvoicesForMultipleOrders$1(httpClient: HttpClient): ListInvoicesForMultipleOrdersSignature;
|
|
6
|
+
interface ListInvoicesForMultipleOrdersSignature {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves the IDs of invoices associated with all specified orders.
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* The `listInvoicesForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
|
|
12
|
+
* @param - Order IDs for which to retrieve invoices.
|
|
13
|
+
*/
|
|
14
|
+
(orderIds: string[]): Promise<ListInvoicesForMultipleOrdersResponse>;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
declare const listInvoicesForMultipleOrders: MaybeContext<BuildRESTFunction<typeof listInvoicesForMultipleOrders$1> & typeof listInvoicesForMultipleOrders$1>;
|
|
18
|
+
|
|
19
|
+
export { ListInvoicesForMultipleOrdersResponse, listInvoicesForMultipleOrders };
|
package/build/index.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
+
import { L as ListInvoicesForMultipleOrdersResponse } from './ecom-orders-v1-invoice-order-invoices.universal-Be8NGMCD.js';
|
|
3
|
+
export { p as ActionEvent, k as AddInvoiceToOrderRequest, l as AddInvoiceToOrderResponse, A as ApplicationError, j as BulkActionMetadata, B as BulkGenerateInvoicesRequest, f as BulkGenerateInvoicesResponse, g as BulkInvoiceResult, D as DomainEvent, m as DomainEventBodyOneOf, q as Empty, E as EntityCreatedEvent, o as EntityDeletedEvent, n as EntityUpdatedEvent, G as GenerateInvoiceRequest, e as GenerateInvoiceResponse, t as GenerateInvoiceWithNumberRequest, u as GenerateInvoiceWithNumberResponse, r as GetOrderInvoiceRequest, s as GetOrderInvoiceResponse, v as IdentificationData, w as IdentificationDataIdOneOf, I as Invoice, i as InvoiceForOrder, d as InvoicesForOrder, h as ItemMetadata, c as ListInvoicesForMultipleOrdersRequest, a as ListInvoicesForSingleOrderRequest, b as ListInvoicesForSingleOrderResponse, M as MessageEnvelope, R as RestoreInfo, W as WebhookIdentityType } from './ecom-orders-v1-invoice-order-invoices.universal-Be8NGMCD.js';
|
|
4
|
+
|
|
5
|
+
declare function listInvoicesForMultipleOrders$1(httpClient: HttpClient): ListInvoicesForMultipleOrdersSignature;
|
|
6
|
+
interface ListInvoicesForMultipleOrdersSignature {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves the IDs of invoices associated with all specified orders.
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* The `listInvoicesForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
|
|
12
|
+
* @param - Order IDs for which to retrieve invoices.
|
|
13
|
+
*/
|
|
14
|
+
(orderIds: string[]): Promise<ListInvoicesForMultipleOrdersResponse>;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
declare const listInvoicesForMultipleOrders: MaybeContext<BuildRESTFunction<typeof listInvoicesForMultipleOrders$1> & typeof listInvoicesForMultipleOrders$1>;
|
|
18
|
+
|
|
19
|
+
export { ListInvoicesForMultipleOrdersResponse, listInvoicesForMultipleOrders };
|