@wix/auto_sdk_get-paid_receipts 1.0.3 → 1.0.5
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/receipts-v1-receipt-receipts.http.d.ts +9 -17
- package/build/cjs/src/receipts-v1-receipt-receipts.http.js +9 -17
- package/build/cjs/src/receipts-v1-receipt-receipts.http.js.map +1 -1
- package/build/cjs/src/receipts-v1-receipt-receipts.public.d.ts +14 -20
- package/build/cjs/src/receipts-v1-receipt-receipts.public.js.map +1 -1
- package/build/cjs/src/receipts-v1-receipt-receipts.types.d.ts +33 -34
- package/build/cjs/src/receipts-v1-receipt-receipts.types.js.map +1 -1
- package/build/cjs/src/receipts-v1-receipt-receipts.universal.d.ts +48 -55
- package/build/cjs/src/receipts-v1-receipt-receipts.universal.js +14 -20
- package/build/cjs/src/receipts-v1-receipt-receipts.universal.js.map +1 -1
- package/build/es/src/receipts-v1-receipt-receipts.http.d.ts +9 -17
- package/build/es/src/receipts-v1-receipt-receipts.http.js +9 -17
- package/build/es/src/receipts-v1-receipt-receipts.http.js.map +1 -1
- package/build/es/src/receipts-v1-receipt-receipts.public.d.ts +14 -20
- package/build/es/src/receipts-v1-receipt-receipts.public.js.map +1 -1
- package/build/es/src/receipts-v1-receipt-receipts.types.d.ts +33 -34
- package/build/es/src/receipts-v1-receipt-receipts.types.js.map +1 -1
- package/build/es/src/receipts-v1-receipt-receipts.universal.d.ts +48 -55
- package/build/es/src/receipts-v1-receipt-receipts.universal.js +14 -20
- package/build/es/src/receipts-v1-receipt-receipts.universal.js.map +1 -1
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.http.d.ts +9 -17
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.http.js +9 -17
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.http.js.map +1 -1
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.public.d.ts +14 -20
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.public.js.map +1 -1
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.types.d.ts +33 -34
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.types.js.map +1 -1
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.universal.d.ts +48 -55
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.universal.js +14 -20
- package/build/internal/cjs/src/receipts-v1-receipt-receipts.universal.js.map +1 -1
- package/build/internal/es/src/receipts-v1-receipt-receipts.http.d.ts +9 -17
- package/build/internal/es/src/receipts-v1-receipt-receipts.http.js +9 -17
- package/build/internal/es/src/receipts-v1-receipt-receipts.http.js.map +1 -1
- package/build/internal/es/src/receipts-v1-receipt-receipts.public.d.ts +14 -20
- package/build/internal/es/src/receipts-v1-receipt-receipts.public.js.map +1 -1
- package/build/internal/es/src/receipts-v1-receipt-receipts.types.d.ts +33 -34
- package/build/internal/es/src/receipts-v1-receipt-receipts.types.js.map +1 -1
- package/build/internal/es/src/receipts-v1-receipt-receipts.universal.d.ts +48 -55
- package/build/internal/es/src/receipts-v1-receipt-receipts.universal.js +14 -20
- package/build/internal/es/src/receipts-v1-receipt-receipts.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,28 +1,20 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
2
|
/**
|
|
3
|
-
* Creates a
|
|
3
|
+
* Creates a receipt.
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
* Receipt number will not be
|
|
7
|
-
* document file is created.
|
|
5
|
+
* Required fields: currency, source reference, line items, payment, totals.
|
|
6
|
+
* Receipt number is assigned later and will not be provided in the response.
|
|
8
7
|
*/
|
|
9
8
|
export declare function createReceipt(payload: object): RequestOptionsFactory<any>;
|
|
10
|
-
/** Retrieves a
|
|
9
|
+
/** Retrieves a receipt. */
|
|
11
10
|
export declare function getReceipt(payload: object): RequestOptionsFactory<any>;
|
|
12
|
-
/**
|
|
13
|
-
* Retrieves a list of up to 100 Receipts, given the provided [paging, filtering, and sorting][1].
|
|
14
|
-
*
|
|
15
|
-
* Define queries using WQL - Wix Query Language. To learn how to query Receipts, see [API Query Language][2].
|
|
16
|
-
*
|
|
17
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
18
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
19
|
-
*/
|
|
11
|
+
/** Retrieves a list of up to 100 receipts, given the specified filtering ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)), paging, and sorting ([REST](https://dev.wix.com/api/rest/getting-started/sorting-and-paging)). */
|
|
20
12
|
export declare function queryReceipts(payload: object): RequestOptionsFactory<any>;
|
|
21
|
-
/** Retries generating document
|
|
13
|
+
/** Retries generating a receipt document with `status`:`FAILED`. */
|
|
22
14
|
export declare function regenerateReceiptDocument(payload: object): RequestOptionsFactory<any>;
|
|
23
|
-
/** Sends email
|
|
15
|
+
/** Sends the receipt in an email to the specified recipient. */
|
|
24
16
|
export declare function sendReceiptEmail(payload: object): RequestOptionsFactory<any>;
|
|
25
|
-
/**
|
|
17
|
+
/** Retrieves the latest receipt number for a specified prefix. */
|
|
26
18
|
export declare function getLatestReceiptNumber(payload: object): RequestOptionsFactory<any>;
|
|
27
|
-
/** Updates extended fields of a
|
|
19
|
+
/** Updates extended fields of a receipt, without incrementing revision. */
|
|
28
20
|
export declare function updateExtendedFields(payload: object): RequestOptionsFactory<any>;
|
|
@@ -21,11 +21,10 @@ function resolveWixReceiptsV1ReceiptsUrl(opts) {
|
|
|
21
21
|
}
|
|
22
22
|
const PACKAGE_NAME = '@wix/auto_sdk_get-paid_receipts';
|
|
23
23
|
/**
|
|
24
|
-
* Creates a
|
|
24
|
+
* Creates a receipt.
|
|
25
25
|
*
|
|
26
|
-
*
|
|
27
|
-
* Receipt number will not be
|
|
28
|
-
* document file is created.
|
|
26
|
+
* Required fields: currency, source reference, line items, payment, totals.
|
|
27
|
+
* Receipt number is assigned later and will not be provided in the response.
|
|
29
28
|
*/
|
|
30
29
|
function createReceipt(payload) {
|
|
31
30
|
function __createReceipt({ host }) {
|
|
@@ -90,7 +89,7 @@ function createReceipt(payload) {
|
|
|
90
89
|
return __createReceipt;
|
|
91
90
|
}
|
|
92
91
|
exports.createReceipt = createReceipt;
|
|
93
|
-
/** Retrieves a
|
|
92
|
+
/** Retrieves a receipt. */
|
|
94
93
|
function getReceipt(payload) {
|
|
95
94
|
function __getReceipt({ host }) {
|
|
96
95
|
const metadata = {
|
|
@@ -132,14 +131,7 @@ function getReceipt(payload) {
|
|
|
132
131
|
return __getReceipt;
|
|
133
132
|
}
|
|
134
133
|
exports.getReceipt = getReceipt;
|
|
135
|
-
/**
|
|
136
|
-
* Retrieves a list of up to 100 Receipts, given the provided [paging, filtering, and sorting][1].
|
|
137
|
-
*
|
|
138
|
-
* Define queries using WQL - Wix Query Language. To learn how to query Receipts, see [API Query Language][2].
|
|
139
|
-
*
|
|
140
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
141
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
142
|
-
*/
|
|
134
|
+
/** Retrieves a list of up to 100 receipts, given the specified filtering ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)), paging, and sorting ([REST](https://dev.wix.com/api/rest/getting-started/sorting-and-paging)). */
|
|
143
135
|
function queryReceipts(payload) {
|
|
144
136
|
function __queryReceipts({ host }) {
|
|
145
137
|
const metadata = {
|
|
@@ -181,7 +173,7 @@ function queryReceipts(payload) {
|
|
|
181
173
|
return __queryReceipts;
|
|
182
174
|
}
|
|
183
175
|
exports.queryReceipts = queryReceipts;
|
|
184
|
-
/** Retries generating document
|
|
176
|
+
/** Retries generating a receipt document with `status`:`FAILED`. */
|
|
185
177
|
function regenerateReceiptDocument(payload) {
|
|
186
178
|
function __regenerateReceiptDocument({ host }) {
|
|
187
179
|
const metadata = {
|
|
@@ -201,7 +193,7 @@ function regenerateReceiptDocument(payload) {
|
|
|
201
193
|
return __regenerateReceiptDocument;
|
|
202
194
|
}
|
|
203
195
|
exports.regenerateReceiptDocument = regenerateReceiptDocument;
|
|
204
|
-
/** Sends email
|
|
196
|
+
/** Sends the receipt in an email to the specified recipient. */
|
|
205
197
|
function sendReceiptEmail(payload) {
|
|
206
198
|
function __sendReceiptEmail({ host }) {
|
|
207
199
|
const metadata = {
|
|
@@ -221,7 +213,7 @@ function sendReceiptEmail(payload) {
|
|
|
221
213
|
return __sendReceiptEmail;
|
|
222
214
|
}
|
|
223
215
|
exports.sendReceiptEmail = sendReceiptEmail;
|
|
224
|
-
/**
|
|
216
|
+
/** Retrieves the latest receipt number for a specified prefix. */
|
|
225
217
|
function getLatestReceiptNumber(payload) {
|
|
226
218
|
function __getLatestReceiptNumber({ host }) {
|
|
227
219
|
const metadata = {
|
|
@@ -241,7 +233,7 @@ function getLatestReceiptNumber(payload) {
|
|
|
241
233
|
return __getLatestReceiptNumber;
|
|
242
234
|
}
|
|
243
235
|
exports.getLatestReceiptNumber = getLatestReceiptNumber;
|
|
244
|
-
/** Updates extended fields of a
|
|
236
|
+
/** Updates extended fields of a receipt, without incrementing revision. */
|
|
245
237
|
function updateExtendedFields(payload) {
|
|
246
238
|
function __updateExtendedFields({ host }) {
|
|
247
239
|
const metadata = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"receipts-v1-receipt-receipts.http.js","sourceRoot":"","sources":["../../../src/receipts-v1-receipt-receipts.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,kEAAsF;AACtF,kEAAsF;AACtF,0EAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,+BAA+B,CACtC,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,iCAAiC,CAAC;AAEvD
|
|
1
|
+
{"version":3,"file":"receipts-v1-receipt-receipts.http.js","sourceRoot":"","sources":["../../../src/receipts-v1-receipt-receipts.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,kEAAsF;AACtF,kEAAsF;AACtF,0EAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,+BAA+B,CACtC,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,iCAAiC,CAAC;AAEvD;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;oBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;oBAC/B,EAAE,IAAI,EAAE,gDAAgD,EAAE;oBAC1D,EAAE,IAAI,EAAE,iCAAiC,EAAE;iBAC5C;aACF;YACD;gBACE,WAAW,EAAE,oCAA4B;gBACzC,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,kDAAkD,EAAE;oBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;oBAC7D,EAAE,IAAI,EAAE,kDAAkD,EAAE;oBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;oBAC7D,EAAE,IAAI,EAAE,mDAAmD,EAAE;oBAC7D,EAAE,IAAI,EAAE,oDAAoD,EAAE;iBAC/D;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,wCAAwC;YACnD,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,+BAA+B,CAAC;gBACnC,SAAS,EAAE,cAAc;gBACzB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,gDAAgD,EAAE;wBAC1D,EAAE,IAAI,EAAE,iCAAiC,EAAE;qBAC5C;iBACF;gBACD;oBACE,WAAW,EAAE,oCAA4B;oBACzC,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,kDAAkD,EAAE;wBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,kDAAkD,EAAE;wBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,oDAAoD,EAAE;qBAC/D;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAhED,sCAgEC;AAED,2BAA2B;AAC3B,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,qCAAqC;YAChD,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,+BAA+B,CAAC;gBACnC,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,gDAAgD,EAAE;wBAC1D,EAAE,IAAI,EAAE,iCAAiC,EAAE;qBAC5C;iBACF;gBACD;oBACE,WAAW,EAAE,oCAA4B;oBACzC,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,kDAAkD,EAAE;wBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,kDAAkD,EAAE;wBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,oDAAoD,EAAE;qBAC/D;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA1CD,gCA0CC;AAED,0UAA0U;AAC1U,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,wCAAwC;YACnD,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,+BAA+B,CAAC;gBACnC,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,sBAAsB,EAAE;wBAChC,EAAE,IAAI,EAAE,sBAAsB,EAAE;wBAChC,EAAE,IAAI,EAAE,iDAAiD,EAAE;wBAC3D,EAAE,IAAI,EAAE,kCAAkC,EAAE;qBAC7C;iBACF;gBACD;oBACE,WAAW,EAAE,oCAA4B;oBACzC,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,oDAAoD,EAAE;wBAC9D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,oDAAoD,EAAE;wBAC9D,EAAE,IAAI,EAAE,oDAAoD,EAAE;wBAC9D,EAAE,IAAI,EAAE,qDAAqD,EAAE;qBAChE;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AA1CD,sCA0CC;AAED,oEAAoE;AACpE,SAAgB,yBAAyB,CACvC,OAAe;IAEf,SAAS,2BAA2B,CAAC,EAAE,IAAI,EAAO;QAChD,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,+BAA+B,CAAC;gBACnC,SAAS,EAAE,sDAAsD;gBACjE,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,2BAA2B,CAAC;AACrC,CAAC;AArBD,8DAqBC;AAED,gEAAgE;AAChE,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,2CAA2C;YACtD,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,+BAA+B,CAAC;gBACnC,SAAS,EAAE,qCAAqC;gBAChD,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAnBD,4CAmBC;AAED,kEAAkE;AAClE,SAAgB,sBAAsB,CACpC,OAAe;IAEf,SAAS,wBAAwB,CAAC,EAAE,IAAI,EAAO;QAC7C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,iDAAiD;YAC5D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,+BAA+B,CAAC;gBACnC,SAAS,EAAE,gCAAgC;gBAC3C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,wBAAwB,CAAC;AAClC,CAAC;AArBD,wDAqBC;AAED,2EAA2E;AAC3E,SAAgB,oBAAoB,CAClC,OAAe;IAEf,SAAS,sBAAsB,CAAC,EAAE,IAAI,EAAO;QAC3C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,+CAA+C;YAC1D,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,+BAA+B,CAAC;gBACnC,SAAS,EAAE,0CAA0C;gBACrD,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,gDAAgD,EAAE;wBAC1D,EAAE,IAAI,EAAE,iCAAiC,EAAE;qBAC5C;iBACF;gBACD;oBACE,WAAW,EAAE,oCAA4B;oBACzC,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,kDAAkD,EAAE;wBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,kDAAkD,EAAE;wBAC5D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,mDAAmD,EAAE;wBAC7D,EAAE,IAAI,EAAE,oDAAoD,EAAE;qBAC/D;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,sBAAsB,CAAC;AAChC,CAAC;AA5CD,oDA4CC"}
|
|
@@ -6,64 +6,58 @@ export declare const __metadata: {
|
|
|
6
6
|
export declare function createReceipt(httpClient: HttpClient): CreateReceiptSignature;
|
|
7
7
|
interface CreateReceiptSignature {
|
|
8
8
|
/**
|
|
9
|
-
* Creates a
|
|
9
|
+
* Creates a receipt.
|
|
10
10
|
*
|
|
11
|
-
*
|
|
12
|
-
* Receipt number will not be
|
|
13
|
-
* document file is created.
|
|
11
|
+
* Required fields: currency, source reference, line items, payment, totals.
|
|
12
|
+
* Receipt number is assigned later and will not be provided in the response.
|
|
14
13
|
* @param - Receipt to be created.
|
|
15
|
-
* @returns
|
|
14
|
+
* @returns Created receipt.
|
|
16
15
|
*/
|
|
17
16
|
(receipt: Receipt): Promise<Receipt & ReceiptNonNullableFields>;
|
|
18
17
|
}
|
|
19
18
|
export declare function getReceipt(httpClient: HttpClient): GetReceiptSignature;
|
|
20
19
|
interface GetReceiptSignature {
|
|
21
20
|
/**
|
|
22
|
-
* Retrieves a
|
|
23
|
-
* @param -
|
|
24
|
-
* @returns
|
|
21
|
+
* Retrieves a receipt.
|
|
22
|
+
* @param - Receipt ID.
|
|
23
|
+
* @returns Requested receipt.
|
|
25
24
|
*/
|
|
26
25
|
(receiptId: string): Promise<Receipt & ReceiptNonNullableFields>;
|
|
27
26
|
}
|
|
28
27
|
export declare function queryReceipts(httpClient: HttpClient): QueryReceiptsSignature;
|
|
29
28
|
interface QueryReceiptsSignature {
|
|
30
29
|
/**
|
|
31
|
-
* Retrieves a list of up to 100
|
|
32
|
-
*
|
|
33
|
-
* Define queries using WQL - Wix Query Language. To learn how to query Receipts, see [API Query Language][2].
|
|
34
|
-
*
|
|
35
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
36
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
30
|
+
* Retrieves a list of up to 100 receipts, given the specified filtering ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language)), paging, and sorting ([REST](https://dev.wix.com/api/rest/getting-started/sorting-and-paging)).
|
|
37
31
|
*/
|
|
38
32
|
(): ReceiptsQueryBuilder;
|
|
39
33
|
}
|
|
40
34
|
export declare function regenerateReceiptDocument(httpClient: HttpClient): RegenerateReceiptDocumentSignature;
|
|
41
35
|
interface RegenerateReceiptDocumentSignature {
|
|
42
36
|
/**
|
|
43
|
-
* Retries generating document
|
|
44
|
-
* @param - Receipt
|
|
37
|
+
* Retries generating a receipt document with `status`:`FAILED`.
|
|
38
|
+
* @param - Receipt ID.
|
|
45
39
|
*/
|
|
46
40
|
(receiptId: string): Promise<void>;
|
|
47
41
|
}
|
|
48
42
|
export declare function sendReceiptEmail(httpClient: HttpClient): SendReceiptEmailSignature;
|
|
49
43
|
interface SendReceiptEmailSignature {
|
|
50
44
|
/**
|
|
51
|
-
* Sends email
|
|
52
|
-
* @param -
|
|
45
|
+
* Sends the receipt in an email to the specified recipient.
|
|
46
|
+
* @param - Receipt ID to send.
|
|
53
47
|
*/
|
|
54
48
|
(receiptId: string, options?: SendReceiptEmailOptions | undefined): Promise<void>;
|
|
55
49
|
}
|
|
56
50
|
export declare function getLatestReceiptNumber(httpClient: HttpClient): GetLatestReceiptNumberSignature;
|
|
57
51
|
interface GetLatestReceiptNumberSignature {
|
|
58
52
|
/**
|
|
59
|
-
*
|
|
53
|
+
* Retrieves the latest receipt number for a specified prefix.
|
|
60
54
|
*/
|
|
61
55
|
(options?: GetLatestReceiptNumberOptions | undefined): Promise<GetLatestReceiptNumberResponse>;
|
|
62
56
|
}
|
|
63
57
|
export declare function updateExtendedFields(httpClient: HttpClient): UpdateExtendedFieldsSignature;
|
|
64
58
|
interface UpdateExtendedFieldsSignature {
|
|
65
59
|
/**
|
|
66
|
-
* Updates extended fields of a
|
|
60
|
+
* Updates extended fields of a receipt, without incrementing revision.
|
|
67
61
|
* @param - ID of the entity to update.
|
|
68
62
|
* @param - Identifier for the app whose extended fields are being updated.
|
|
69
63
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"receipts-v1-receipt-receipts.public.js","sourceRoot":"","sources":["../../../src/receipts-v1-receipt-receipts.public.ts"],"names":[],"mappings":";;;AACA,2GAiBqD;AAExC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,OAAgB,EAAE,EAAE,CAC1B,IAAA,yDAAsB,EACpB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sCAOC;
|
|
1
|
+
{"version":3,"file":"receipts-v1-receipt-receipts.public.js","sourceRoot":"","sources":["../../../src/receipts-v1-receipt-receipts.public.ts"],"names":[],"mappings":";;;AACA,2GAiBqD;AAExC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,OAAgB,EAAE,EAAE,CAC1B,IAAA,yDAAsB,EACpB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sCAOC;AAcD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,sDAAmB,EACjB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gCAOC;AAWD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,GAAG,EAAE,CACV,IAAA,yDAAsB;IACpB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,sCAMC;AASD,SAAgB,yBAAyB,CACvC,UAAsB;IAEtB,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,qEAAkC,EAChC,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,8DASC;AAUD,SAAgB,gBAAgB,CAC9B,UAAsB;IAEtB,OAAO,CAAC,SAAiB,EAAE,OAAiC,EAAE,EAAE,CAC9D,IAAA,4DAAyB,EACvB,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,4CAUC;AAaD,SAAgB,sBAAsB,CACpC,UAAsB;IAEtB,OAAO,CAAC,OAAuC,EAAE,EAAE,CACjD,IAAA,kEAA+B,EAC7B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,wDASC;AAWD,SAAgB,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CACL,GAAW,EACX,SAAiB,EACjB,OAAoC,EACpC,EAAE,CACF,IAAA,gEAA6B,EAC3B,GAAG,EACH,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAfD,oDAeC;AAiBD,yGA6FqD;AAxEnD,2IAAA,cAAc,OAAA;AAoCd,6IAAA,gBAAgB,OAAA;AAMhB,0IAAA,aAAa,OAAA;AAQb,sIAAA,SAAS,OAAA;AAOT,4IAAA,eAAe,OAAA;AAWf,oIAAA,OAAO,OAAA;AACP,gJAAA,mBAAmB,OAAA"}
|
|
@@ -1,36 +1,31 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* A
|
|
3
|
-
*
|
|
4
|
-
* Read more about Receipts
|
|
5
|
-
* in this [article](https://support.wix.com/en/article/wix-receipts-adding-and-setting-up-your-receipts).
|
|
2
|
+
* A receipt is a document that confirms a person has received money or property as payment following a sale, transfer of goods, or provision of a service.
|
|
3
|
+
* Read more about receipts in this [article](https://support.wix.com/en/article/wix-receipts-adding-and-setting-up-your-receipts).
|
|
6
4
|
*/
|
|
7
5
|
export interface Receipt {
|
|
8
6
|
/**
|
|
9
|
-
* Receipt
|
|
7
|
+
* Receipt ID.
|
|
10
8
|
* @format GUID
|
|
11
9
|
* @readonly
|
|
12
10
|
* @immutable
|
|
13
11
|
*/
|
|
14
12
|
id?: string | null;
|
|
15
13
|
/**
|
|
16
|
-
* Revision number, which increments by 1 each time the
|
|
14
|
+
* Revision number, which increments by 1 each time the receipt is updated.
|
|
17
15
|
* To prevent conflicting changes,
|
|
18
|
-
* the current revision must be passed when updating the
|
|
19
|
-
*
|
|
20
|
-
* Ignored when creating a Receipt.
|
|
16
|
+
* the current revision must be passed when updating the receipt.
|
|
21
17
|
* @readonly
|
|
22
18
|
*/
|
|
23
19
|
revision?: string | null;
|
|
24
20
|
/**
|
|
25
|
-
* Date and time the
|
|
21
|
+
* Date and time the receipt was created.
|
|
26
22
|
* @readonly
|
|
27
23
|
* @immutable
|
|
28
24
|
*/
|
|
29
25
|
createdDate?: Date | null;
|
|
30
26
|
/**
|
|
31
|
-
* Date and time the
|
|
32
|
-
*
|
|
33
|
-
* document information changes.
|
|
27
|
+
* Date and time the receipt was last updated.
|
|
28
|
+
* Relevant updates include receipt regeneratation and number allocation changes. Updates to financial information are not stored.
|
|
34
29
|
* @readonly
|
|
35
30
|
*/
|
|
36
31
|
updatedDate?: Date | null;
|
|
@@ -41,7 +36,8 @@ export interface Receipt {
|
|
|
41
36
|
numbering?: Numbering;
|
|
42
37
|
/**
|
|
43
38
|
* Regional properties pertaining to the receipt.
|
|
44
|
-
*
|
|
39
|
+
* When regional properties are not provided, defaults are taken from the site's properties, available in the Site Properties API.
|
|
40
|
+
* @immutable
|
|
45
41
|
*/
|
|
46
42
|
regionalProperties?: RegionalProperties;
|
|
47
43
|
/**
|
|
@@ -56,13 +52,13 @@ export interface Receipt {
|
|
|
56
52
|
sourceReference?: SourceReference;
|
|
57
53
|
/**
|
|
58
54
|
* Business details.
|
|
59
|
-
*
|
|
55
|
+
* When business properties are not provided, defaults are taken from the site's properties, available in the Site Properties API.
|
|
60
56
|
*/
|
|
61
57
|
businessDetails?: BusinessDetails;
|
|
62
|
-
/** Customer
|
|
58
|
+
/** Customer details. */
|
|
63
59
|
customer?: Customer;
|
|
64
60
|
/**
|
|
65
|
-
* Line
|
|
61
|
+
* Line item details.
|
|
66
62
|
* @minSize 1
|
|
67
63
|
* @maxSize 300
|
|
68
64
|
*/
|
|
@@ -79,7 +75,7 @@ export interface Receipt {
|
|
|
79
75
|
* @maxSize 10
|
|
80
76
|
*/
|
|
81
77
|
discounts?: Discount[];
|
|
82
|
-
/** Payment. */
|
|
78
|
+
/** Payment details. */
|
|
83
79
|
payment?: Payment;
|
|
84
80
|
/** Summaries of totals including tax, shipping, additional fees and discounts. */
|
|
85
81
|
totals?: Totals;
|
|
@@ -89,38 +85,41 @@ export interface Receipt {
|
|
|
89
85
|
*/
|
|
90
86
|
taxBreakdown?: Tax[];
|
|
91
87
|
/**
|
|
92
|
-
* Receipt
|
|
93
|
-
*
|
|
88
|
+
* Receipt preset ID.
|
|
89
|
+
* Defaults to the default receipt preset ID, available with Get Default Receipt Preset ID.
|
|
94
90
|
* @format GUID
|
|
95
91
|
*/
|
|
96
92
|
presetId?: string | null;
|
|
97
93
|
/** Custom fields. */
|
|
98
94
|
customFields?: CustomFields;
|
|
99
95
|
/**
|
|
100
|
-
*
|
|
96
|
+
* Document details.
|
|
101
97
|
* @readonly
|
|
102
98
|
*/
|
|
103
99
|
document?: Document;
|
|
104
|
-
/**
|
|
100
|
+
/**
|
|
101
|
+
* Custom field data for the payment link.
|
|
102
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
103
|
+
*/
|
|
105
104
|
extendedFields?: ExtendedFields;
|
|
106
105
|
}
|
|
107
106
|
export interface Numbering {
|
|
108
107
|
/** Receipt number. */
|
|
109
108
|
number?: number | null;
|
|
110
109
|
/**
|
|
111
|
-
* Receipt prefix.
|
|
110
|
+
* Receipt prefix that will be displayed before the receipt number.
|
|
112
111
|
* @minLength 1
|
|
113
112
|
* @maxLength 10
|
|
114
113
|
*/
|
|
115
114
|
prefix?: string | null;
|
|
116
115
|
/**
|
|
117
|
-
* Receipt suffix.
|
|
116
|
+
* Receipt suffix that will be displayed after the receipt number.
|
|
118
117
|
* @minLength 1
|
|
119
118
|
* @maxLength 10
|
|
120
119
|
*/
|
|
121
120
|
suffix?: string | null;
|
|
122
121
|
/**
|
|
123
|
-
* Receipt display number
|
|
122
|
+
* Receipt display number, in [prefix][number][suffix] format.
|
|
124
123
|
* @readonly
|
|
125
124
|
* @maxLength 30
|
|
126
125
|
*/
|
|
@@ -988,22 +987,22 @@ export interface CreateReceiptRequest {
|
|
|
988
987
|
receipt: Receipt;
|
|
989
988
|
}
|
|
990
989
|
export interface CreateReceiptResponse {
|
|
991
|
-
/**
|
|
990
|
+
/** Created receipt. */
|
|
992
991
|
receipt?: Receipt;
|
|
993
992
|
}
|
|
994
993
|
export interface GetReceiptRequest {
|
|
995
994
|
/**
|
|
996
|
-
*
|
|
995
|
+
* Receipt ID.
|
|
997
996
|
* @format GUID
|
|
998
997
|
*/
|
|
999
998
|
receiptId: string;
|
|
1000
999
|
}
|
|
1001
1000
|
export interface GetReceiptResponse {
|
|
1002
|
-
/**
|
|
1001
|
+
/** Requested receipt. */
|
|
1003
1002
|
receipt?: Receipt;
|
|
1004
1003
|
}
|
|
1005
1004
|
export interface QueryReceiptsRequest {
|
|
1006
|
-
/**
|
|
1005
|
+
/** Query options. */
|
|
1007
1006
|
query?: CursorQuery;
|
|
1008
1007
|
}
|
|
1009
1008
|
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -1059,7 +1058,7 @@ export interface CursorPaging {
|
|
|
1059
1058
|
cursor?: string | null;
|
|
1060
1059
|
}
|
|
1061
1060
|
export interface QueryReceiptsResponse {
|
|
1062
|
-
/**
|
|
1061
|
+
/** Requested receipts. */
|
|
1063
1062
|
receipts?: Receipt[];
|
|
1064
1063
|
/** Paging metadata. */
|
|
1065
1064
|
pagingMetadata?: CursorPagingMetadata;
|
|
@@ -1091,7 +1090,7 @@ export interface Cursors {
|
|
|
1091
1090
|
}
|
|
1092
1091
|
export interface RegenerateReceiptDocumentRequest {
|
|
1093
1092
|
/**
|
|
1094
|
-
* Receipt
|
|
1093
|
+
* Receipt ID.
|
|
1095
1094
|
* @format GUID
|
|
1096
1095
|
*/
|
|
1097
1096
|
receiptId: string;
|
|
@@ -1100,12 +1099,12 @@ export interface RegenerateReceiptDocumentResponse {
|
|
|
1100
1099
|
}
|
|
1101
1100
|
export interface SendReceiptEmailRequest {
|
|
1102
1101
|
/**
|
|
1103
|
-
*
|
|
1102
|
+
* Receipt ID to send.
|
|
1104
1103
|
* @format GUID
|
|
1105
1104
|
*/
|
|
1106
1105
|
receiptId: string;
|
|
1107
1106
|
/**
|
|
1108
|
-
*
|
|
1107
|
+
* Recipient contact ID.
|
|
1109
1108
|
* @format GUID
|
|
1110
1109
|
*/
|
|
1111
1110
|
contactId?: string | null;
|
|
@@ -1133,7 +1132,7 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
1133
1132
|
namespaceData: Record<string, any> | null;
|
|
1134
1133
|
}
|
|
1135
1134
|
export interface UpdateExtendedFieldsResponse {
|
|
1136
|
-
/** Updated
|
|
1135
|
+
/** Updated receipt. */
|
|
1137
1136
|
receipt?: Receipt;
|
|
1138
1137
|
}
|
|
1139
1138
|
export interface Empty {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"receipts-v1-receipt-receipts.types.js","sourceRoot":"","sources":["../../../src/receipts-v1-receipt-receipts.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"receipts-v1-receipt-receipts.types.js","sourceRoot":"","sources":["../../../src/receipts-v1-receipt-receipts.types.ts"],"names":[],"mappings":";;;AAuMA,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,6DAAyC,CAAA;IACzC,+CAA2B,CAAA;IAC3B,yCAAqB,CAAA;AACvB,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B;AAiHD,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,+BAAf,eAAe,QAc1B;AA8ED,qBAAqB;AACrB,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,uBAAP,OAAO,QAMlB;AAuWD,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qEAAmD,CAAA;IACnD,2CAAyB,CAAA;IACzB,yCAAuB,CAAA;IACvB,mCAAiB,CAAA;AACnB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAgLD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAgFD,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;AACnB,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAkED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}
|