@sp-api-sdk/vendor-invoices-api-v1 2.1.1 → 2.2.1

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.
@@ -30,8 +30,8 @@ const base_1 = require("../base");
30
30
  const VendorPaymentsApiAxiosParamCreator = function (configuration) {
31
31
  return {
32
32
  /**
33
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
34
- * @param {SubmitInvoicesRequest} body
33
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
34
+ * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit.
35
35
  * @param {*} [options] Override http request option.
36
36
  * @throws {RequiredError}
37
37
  */
@@ -69,8 +69,8 @@ const VendorPaymentsApiFp = function (configuration) {
69
69
  const localVarAxiosParamCreator = (0, exports.VendorPaymentsApiAxiosParamCreator)(configuration);
70
70
  return {
71
71
  /**
72
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
73
- * @param {SubmitInvoicesRequest} body
72
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
73
+ * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit.
74
74
  * @param {*} [options] Override http request option.
75
75
  * @throws {RequiredError}
76
76
  */
@@ -91,7 +91,7 @@ const VendorPaymentsApiFactory = function (configuration, basePath, axios) {
91
91
  const localVarFp = (0, exports.VendorPaymentsApiFp)(configuration);
92
92
  return {
93
93
  /**
94
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
94
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
95
95
  * @param {VendorPaymentsApiSubmitInvoicesRequest} requestParameters Request parameters.
96
96
  * @param {*} [options] Override http request option.
97
97
  * @throws {RequiredError}
@@ -110,7 +110,7 @@ exports.VendorPaymentsApiFactory = VendorPaymentsApiFactory;
110
110
  */
111
111
  class VendorPaymentsApi extends base_1.BaseAPI {
112
112
  /**
113
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
113
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
114
114
  * @param {VendorPaymentsApiSubmitInvoicesRequest} requestParameters Request parameters.
115
115
  * @param {*} [options] Override http request option.
116
116
  * @throws {RequiredError}
@@ -24,8 +24,8 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
24
24
  export const VendorPaymentsApiAxiosParamCreator = function (configuration) {
25
25
  return {
26
26
  /**
27
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
28
- * @param {SubmitInvoicesRequest} body
27
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
28
+ * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit.
29
29
  * @param {*} [options] Override http request option.
30
30
  * @throws {RequiredError}
31
31
  */
@@ -62,8 +62,8 @@ export const VendorPaymentsApiFp = function (configuration) {
62
62
  const localVarAxiosParamCreator = VendorPaymentsApiAxiosParamCreator(configuration);
63
63
  return {
64
64
  /**
65
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
66
- * @param {SubmitInvoicesRequest} body
65
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
66
+ * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit.
67
67
  * @param {*} [options] Override http request option.
68
68
  * @throws {RequiredError}
69
69
  */
@@ -83,7 +83,7 @@ export const VendorPaymentsApiFactory = function (configuration, basePath, axios
83
83
  const localVarFp = VendorPaymentsApiFp(configuration);
84
84
  return {
85
85
  /**
86
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
86
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
87
87
  * @param {VendorPaymentsApiSubmitInvoicesRequest} requestParameters Request parameters.
88
88
  * @param {*} [options] Override http request option.
89
89
  * @throws {RequiredError}
@@ -101,7 +101,7 @@ export const VendorPaymentsApiFactory = function (configuration, basePath, axios
101
101
  */
102
102
  export class VendorPaymentsApi extends BaseAPI {
103
103
  /**
104
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
104
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
105
105
  * @param {VendorPaymentsApiSubmitInvoicesRequest} requestParameters Request parameters.
106
106
  * @param {*} [options] Override http request option.
107
107
  * @throws {RequiredError}
@@ -21,8 +21,8 @@ import type { SubmitInvoicesResponse } from '../models';
21
21
  */
22
22
  export declare const VendorPaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
23
23
  /**
24
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
25
- * @param {SubmitInvoicesRequest} body
24
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
25
+ * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit.
26
26
  * @param {*} [options] Override http request option.
27
27
  * @throws {RequiredError}
28
28
  */
@@ -34,8 +34,8 @@ export declare const VendorPaymentsApiAxiosParamCreator: (configuration?: Config
34
34
  */
35
35
  export declare const VendorPaymentsApiFp: (configuration?: Configuration) => {
36
36
  /**
37
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
38
- * @param {SubmitInvoicesRequest} body
37
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
38
+ * @param {SubmitInvoicesRequest} body The request body containing the invoice data to submit.
39
39
  * @param {*} [options] Override http request option.
40
40
  * @throws {RequiredError}
41
41
  */
@@ -47,7 +47,7 @@ export declare const VendorPaymentsApiFp: (configuration?: Configuration) => {
47
47
  */
48
48
  export declare const VendorPaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
49
49
  /**
50
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
50
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
51
51
  * @param {VendorPaymentsApiSubmitInvoicesRequest} requestParameters Request parameters.
52
52
  * @param {*} [options] Override http request option.
53
53
  * @throws {RequiredError}
@@ -61,7 +61,7 @@ export declare const VendorPaymentsApiFactory: (configuration?: Configuration, b
61
61
  */
62
62
  export interface VendorPaymentsApiSubmitInvoicesRequest {
63
63
  /**
64
- *
64
+ * The request body containing the invoice data to submit.
65
65
  * @type {SubmitInvoicesRequest}
66
66
  * @memberof VendorPaymentsApiSubmitInvoices
67
67
  */
@@ -75,7 +75,7 @@ export interface VendorPaymentsApiSubmitInvoicesRequest {
75
75
  */
76
76
  export declare class VendorPaymentsApi extends BaseAPI {
77
77
  /**
78
- * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
78
+ * Submit new invoices to Amazon. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
79
79
  * @param {VendorPaymentsApiSubmitInvoicesRequest} requestParameters Request parameters.
80
80
  * @param {*} [options] Override http request option.
81
81
  * @throws {RequiredError}
@@ -9,7 +9,6 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- /// <reference types="node" />
13
12
  import type { Configuration } from "./configuration";
14
13
  import type { RequestArgs } from "./base";
15
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
@@ -40,31 +40,31 @@ export interface Address {
40
40
  */
41
41
  'addressLine3'?: string;
42
42
  /**
43
- * The city where the person, business or institution is located.
43
+ * The city where the person, business, or institution is located.
44
44
  * @type {string}
45
45
  * @memberof Address
46
46
  */
47
47
  'city'?: string;
48
48
  /**
49
- * The county where person, business or institution is located.
49
+ * The county where person, business, or institution is located.
50
50
  * @type {string}
51
51
  * @memberof Address
52
52
  */
53
53
  'county'?: string;
54
54
  /**
55
- * The district where person, business or institution is located.
55
+ * The district where person, business, or institution is located.
56
56
  * @type {string}
57
57
  * @memberof Address
58
58
  */
59
59
  'district'?: string;
60
60
  /**
61
- * The state or region where person, business or institution is located.
61
+ * The state or region where person, business, or institution is located.
62
62
  * @type {string}
63
63
  * @memberof Address
64
64
  */
65
65
  'stateOrRegion'?: string;
66
66
  /**
67
- * The postal or zip code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
67
+ * The postal or zip code of that address. It contains a series of letters, digits, or both, sometimes including spaces or punctuation.
68
68
  * @type {string}
69
69
  * @memberof Address
70
70
  */
@@ -10,31 +10,31 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * References required in order to process a credit note. This information is required only if InvoiceType is CreditNote.
13
+ * References required in order to process a credit note. This information is required only if `InvoiceType` is `CreditNote`.
14
14
  * @export
15
15
  * @interface CreditNoteDetails
16
16
  */
17
17
  export interface CreditNoteDetails {
18
18
  /**
19
- * Original Invoice Number when sending a credit note relating to an existing invoice. One Invoice only to be processed per Credit Note. This is mandatory for AP Credit Notes.
19
+ * Original invoice number when sending a credit note relating to an existing invoice. One invoice only to be processed per credit note. This is mandatory for AP credit notes.
20
20
  * @type {string}
21
21
  * @memberof CreditNoteDetails
22
22
  */
23
23
  'referenceInvoiceNumber'?: string;
24
24
  /**
25
- * Debit Note Number as generated by Amazon. Recommended for Returns and COOP Credit Notes.
25
+ * Debit note number as generated by Amazon. Recommended for returns and COOP credit notes.
26
26
  * @type {string}
27
27
  * @memberof CreditNoteDetails
28
28
  */
29
29
  'debitNoteNumber'?: string;
30
30
  /**
31
- * Identifies the Returns Notice Number. Mandatory for all Returns Credit Notes.
31
+ * Identifies the returns notice number. Mandatory for all returns credit notes.
32
32
  * @type {string}
33
33
  * @memberof CreditNoteDetails
34
34
  */
35
35
  'returnsReferenceNumber'?: string;
36
36
  /**
37
- * Defines a date and time according to ISO8601.
37
+ * Defines a date and time according to <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a>.
38
38
  * @type {string}
39
39
  * @memberof CreditNoteDetails
40
40
  */
@@ -46,7 +46,7 @@ export interface CreditNoteDetails {
46
46
  */
47
47
  'rmaId'?: string;
48
48
  /**
49
- * Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the Debit Note number may lead to a rejection of the Credit Note.
49
+ * Identifies the COOP reference used for COOP agreement. Failure to provide the COOP reference number or the debit note number may lead to a rejection of the credit note.
50
50
  * @type {string}
51
51
  * @memberof CreditNoteDetails
52
52
  */
@@ -52,13 +52,13 @@ export interface InvoiceItem {
52
52
  */
53
53
  'netCost': Money;
54
54
  /**
55
- * The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when invoiceType is Invoice, and is not required when invoiceType is CreditNote.
55
+ * The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when `invoiceType` is `Invoice`, and is not required when `invoiceType` is `CreditNote`.
56
56
  * @type {string}
57
57
  * @memberof InvoiceItem
58
58
  */
59
59
  'purchaseOrderNumber'?: string;
60
60
  /**
61
- * HSN Tax code. The HSN number cannot contain alphabets.
61
+ * The HSN Tax code. The HSN number cannot contain alphabets.
62
62
  * @type {string}
63
63
  * @memberof InvoiceItem
64
64
  */
@@ -18,7 +18,7 @@ import type { PartyIdentification } from './party-identification';
18
18
  import type { PaymentTerms } from './payment-terms';
19
19
  import type { TaxDetails } from './tax-details';
20
20
  /**
21
- *
21
+ * Represents an invoice or credit note document with details about the transaction, parties involved, and line items.
22
22
  * @export
23
23
  * @interface Invoice
24
24
  */
@@ -42,7 +42,7 @@ export interface Invoice {
42
42
  */
43
43
  'referenceNumber'?: string;
44
44
  /**
45
- * Defines a date and time according to ISO8601.
45
+ * Defines a date and time according to <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a>.
46
46
  * @type {string}
47
47
  * @memberof Invoice
48
48
  */
@@ -28,7 +28,7 @@ export interface ItemQuantity {
28
28
  */
29
29
  'unitOfMeasure': ItemQuantityUnitOfMeasureEnum;
30
30
  /**
31
- * The case size, if the unit of measure value is Cases.
31
+ * The case size, if the unit of measure value is `Cases`.
32
32
  * @type {number}
33
33
  * @memberof ItemQuantity
34
34
  */
@@ -12,7 +12,7 @@
12
12
  import type { Address } from './address';
13
13
  import type { TaxRegistrationDetails } from './tax-registration-details';
14
14
  /**
15
- *
15
+ * Name, address, and tax details of a party.
16
16
  * @export
17
17
  * @interface PartyIdentification
18
18
  */
@@ -28,7 +28,7 @@ export interface PaymentTerms {
28
28
  */
29
29
  'discountPercent'?: string;
30
30
  /**
31
- * The number of calendar days from the Base date (Invoice date) until the discount is no longer valid.
31
+ * The number of calendar days from the base date (Invoice date) until the discount is no longer valid.
32
32
  * @type {number}
33
33
  * @memberof PaymentTerms
34
34
  */
@@ -11,13 +11,13 @@
11
11
  */
12
12
  import type { Invoice } from './invoice';
13
13
  /**
14
- * The request schema for the submitInvoices operation.
14
+ * The request schema for the `submitInvoices` operation.
15
15
  * @export
16
16
  * @interface SubmitInvoicesRequest
17
17
  */
18
18
  export interface SubmitInvoicesRequest {
19
19
  /**
20
- *
20
+ * An array of Invoice objects representing the invoices or credit notes to be submitted.
21
21
  * @type {Array<Invoice>}
22
22
  * @memberof SubmitInvoicesRequest
23
23
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { TransactionId } from './transaction-id';
13
13
  /**
14
- * The response schema for the submitInvoices operation.
14
+ * The response schema for the `submitInvoices` operation.
15
15
  * @export
16
16
  * @interface SubmitInvoicesResponse
17
17
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- *
13
+ * Response containing the transaction ID.
14
14
  * @export
15
15
  * @interface TransactionId
16
16
  */
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/vendor-invoices-api-v1",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Retail Procurement Payments provides programmatic access to vendors payments data.",
5
- "version": "2.1.1",
5
+ "version": "2.2.1",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.0.9",
21
+ "@sp-api-sdk/common": "2.0.11",
22
22
  "axios": "^1.7.2"
23
23
  },
24
24
  "repository": {
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "vendor invoices api"
42
42
  ],
43
- "gitHead": "cce8c720364baf071322463e8e3ed29c322cc93a"
43
+ "gitHead": "6f3dfd53cad528b970ec29dfd12b0105b351464b"
44
44
  }