@sp-api-sdk/vendor-direct-fulfillment-payments-api-v1 1.6.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.
Files changed (75) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +58 -0
  3. package/dist/cjs/index.js +6 -0
  4. package/dist/cjs/src/api-model/api/vendor-invoice-api.js +119 -0
  5. package/dist/cjs/src/api-model/api.js +17 -0
  6. package/dist/cjs/src/api-model/base.js +62 -0
  7. package/dist/cjs/src/api-model/common.js +137 -0
  8. package/dist/cjs/src/api-model/configuration.js +42 -0
  9. package/dist/cjs/src/api-model/index.js +19 -0
  10. package/dist/cjs/src/api-model/models/additional-details.js +25 -0
  11. package/dist/cjs/src/api-model/models/address.js +15 -0
  12. package/dist/cjs/src/api-model/models/charge-details.js +30 -0
  13. package/dist/cjs/src/api-model/models/index.js +17 -0
  14. package/dist/cjs/src/api-model/models/invoice-detail.js +15 -0
  15. package/dist/cjs/src/api-model/models/invoice-item.js +15 -0
  16. package/dist/cjs/src/api-model/models/item-quantity.js +15 -0
  17. package/dist/cjs/src/api-model/models/model-error.js +15 -0
  18. package/dist/cjs/src/api-model/models/money.js +15 -0
  19. package/dist/cjs/src/api-model/models/party-identification.js +15 -0
  20. package/dist/cjs/src/api-model/models/submit-invoice-request.js +15 -0
  21. package/dist/cjs/src/api-model/models/submit-invoice-response.js +15 -0
  22. package/dist/cjs/src/api-model/models/tax-detail.js +37 -0
  23. package/dist/cjs/src/api-model/models/tax-registration-detail.js +25 -0
  24. package/dist/cjs/src/api-model/models/transaction-reference.js +15 -0
  25. package/dist/cjs/src/client.js +35 -0
  26. package/dist/cjs/src/error.js +10 -0
  27. package/dist/es/index.js +3 -0
  28. package/dist/es/src/api-model/api/vendor-invoice-api.js +111 -0
  29. package/dist/es/src/api-model/api.js +14 -0
  30. package/dist/es/src/api-model/base.js +56 -0
  31. package/dist/es/src/api-model/common.js +125 -0
  32. package/dist/es/src/api-model/configuration.js +38 -0
  33. package/dist/es/src/api-model/index.js +16 -0
  34. package/dist/es/src/api-model/models/additional-details.js +22 -0
  35. package/dist/es/src/api-model/models/address.js +14 -0
  36. package/dist/es/src/api-model/models/charge-details.js +27 -0
  37. package/dist/es/src/api-model/models/index.js +14 -0
  38. package/dist/es/src/api-model/models/invoice-detail.js +14 -0
  39. package/dist/es/src/api-model/models/invoice-item.js +14 -0
  40. package/dist/es/src/api-model/models/item-quantity.js +14 -0
  41. package/dist/es/src/api-model/models/model-error.js +14 -0
  42. package/dist/es/src/api-model/models/money.js +14 -0
  43. package/dist/es/src/api-model/models/party-identification.js +14 -0
  44. package/dist/es/src/api-model/models/submit-invoice-request.js +14 -0
  45. package/dist/es/src/api-model/models/submit-invoice-response.js +14 -0
  46. package/dist/es/src/api-model/models/tax-detail.js +34 -0
  47. package/dist/es/src/api-model/models/tax-registration-detail.js +22 -0
  48. package/dist/es/src/api-model/models/transaction-reference.js +14 -0
  49. package/dist/es/src/client.js +31 -0
  50. package/dist/es/src/error.js +6 -0
  51. package/dist/types/index.d.ts +3 -0
  52. package/dist/types/src/api-model/api/vendor-invoice-api.d.ts +84 -0
  53. package/dist/types/src/api-model/api.d.ts +12 -0
  54. package/dist/types/src/api-model/base.d.ts +55 -0
  55. package/dist/types/src/api-model/common.d.ts +65 -0
  56. package/dist/types/src/api-model/configuration.d.ts +83 -0
  57. package/dist/types/src/api-model/index.d.ts +14 -0
  58. package/dist/types/src/api-model/models/additional-details.d.ts +44 -0
  59. package/dist/types/src/api-model/models/address.d.ts +84 -0
  60. package/dist/types/src/api-model/models/charge-details.d.ts +51 -0
  61. package/dist/types/src/api-model/models/index.d.ts +14 -0
  62. package/dist/types/src/api-model/models/invoice-detail.d.ts +102 -0
  63. package/dist/types/src/api-model/models/invoice-item.d.ts +82 -0
  64. package/dist/types/src/api-model/models/item-quantity.d.ts +30 -0
  65. package/dist/types/src/api-model/models/model-error.d.ts +36 -0
  66. package/dist/types/src/api-model/models/money.d.ts +30 -0
  67. package/dist/types/src/api-model/models/party-identification.d.ts +38 -0
  68. package/dist/types/src/api-model/models/submit-invoice-request.d.ts +25 -0
  69. package/dist/types/src/api-model/models/submit-invoice-response.d.ts +31 -0
  70. package/dist/types/src/api-model/models/tax-detail.d.ts +63 -0
  71. package/dist/types/src/api-model/models/tax-registration-detail.d.ts +51 -0
  72. package/dist/types/src/api-model/models/transaction-reference.d.ts +24 -0
  73. package/dist/types/src/client.d.ts +13 -0
  74. package/dist/types/src/error.d.ts +3 -0
  75. package/package.json +53 -0
@@ -0,0 +1,44 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Payments
3
+ * The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment vendor\'s invoice data.
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A field where selling party can provide additional information for tax related or any other purposes.
14
+ * @export
15
+ * @interface AdditionalDetails
16
+ */
17
+ export interface AdditionalDetails {
18
+ /**
19
+ * The type of the additional information provided by the selling party.
20
+ * @type {string}
21
+ * @memberof AdditionalDetails
22
+ */
23
+ type: AdditionalDetailsTypeEnum;
24
+ /**
25
+ * The detail of the additional information provided by the selling party.
26
+ * @type {string}
27
+ * @memberof AdditionalDetails
28
+ */
29
+ detail: string;
30
+ /**
31
+ * The language code of the additional information detail.
32
+ * @type {string}
33
+ * @memberof AdditionalDetails
34
+ */
35
+ languageCode?: string;
36
+ }
37
+ /**
38
+ * @export
39
+ * @enum {string}
40
+ */
41
+ export declare enum AdditionalDetailsTypeEnum {
42
+ Sur = "SUR",
43
+ Ocr = "OCR"
44
+ }
@@ -0,0 +1,84 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Payments
3
+ * The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment vendor\'s invoice data.
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Address of the party.
14
+ * @export
15
+ * @interface Address
16
+ */
17
+ export interface Address {
18
+ /**
19
+ * The name of the person, business or institution at that address.
20
+ * @type {string}
21
+ * @memberof Address
22
+ */
23
+ name: string;
24
+ /**
25
+ * First line of the address.
26
+ * @type {string}
27
+ * @memberof Address
28
+ */
29
+ addressLine1: string;
30
+ /**
31
+ * Additional street address information, if required.
32
+ * @type {string}
33
+ * @memberof Address
34
+ */
35
+ addressLine2?: string;
36
+ /**
37
+ * Additional street address information, if required.
38
+ * @type {string}
39
+ * @memberof Address
40
+ */
41
+ addressLine3?: string;
42
+ /**
43
+ * The city where the person, business or institution is located.
44
+ * @type {string}
45
+ * @memberof Address
46
+ */
47
+ city: string;
48
+ /**
49
+ * The county where person, business or institution is located.
50
+ * @type {string}
51
+ * @memberof Address
52
+ */
53
+ county?: string;
54
+ /**
55
+ * The district where person, business or institution is located.
56
+ * @type {string}
57
+ * @memberof Address
58
+ */
59
+ district?: string;
60
+ /**
61
+ * The state or region where person, business or institution is located.
62
+ * @type {string}
63
+ * @memberof Address
64
+ */
65
+ stateOrRegion: string;
66
+ /**
67
+ * The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
68
+ * @type {string}
69
+ * @memberof Address
70
+ */
71
+ postalCode: string;
72
+ /**
73
+ * The two digit country code in ISO 3166-1 alpha-2 format.
74
+ * @type {string}
75
+ * @memberof Address
76
+ */
77
+ countryCode: string;
78
+ /**
79
+ * The phone number of the person, business or institution located at that address.
80
+ * @type {string}
81
+ * @memberof Address
82
+ */
83
+ phone?: string;
84
+ }
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Payments
3
+ * The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment vendor\'s invoice data.
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Money } from './money';
13
+ import { TaxDetail } from './tax-detail';
14
+ /**
15
+ * Monetary and tax details of the charge.
16
+ * @export
17
+ * @interface ChargeDetails
18
+ */
19
+ export interface ChargeDetails {
20
+ /**
21
+ * Type of charge applied.
22
+ * @type {string}
23
+ * @memberof ChargeDetails
24
+ */
25
+ type: ChargeDetailsTypeEnum;
26
+ /**
27
+ *
28
+ * @type {Money}
29
+ * @memberof ChargeDetails
30
+ */
31
+ chargeAmount: Money;
32
+ /**
33
+ * Individual tax details per line item.
34
+ * @type {Array<TaxDetail>}
35
+ * @memberof ChargeDetails
36
+ */
37
+ taxDetails?: Array<TaxDetail>;
38
+ }
39
+ /**
40
+ * @export
41
+ * @enum {string}
42
+ */
43
+ export declare enum ChargeDetailsTypeEnum {
44
+ Giftwrap = "GIFTWRAP",
45
+ Fulfillment = "FULFILLMENT",
46
+ Marketinginsert = "MARKETINGINSERT",
47
+ Packaging = "PACKAGING",
48
+ Loading = "LOADING",
49
+ Freightout = "FREIGHTOUT",
50
+ TaxCollectedAtSource = "TAX_COLLECTED_AT_SOURCE"
51
+ }
@@ -0,0 +1,14 @@
1
+ export * from './additional-details';
2
+ export * from './address';
3
+ export * from './charge-details';
4
+ export * from './invoice-detail';
5
+ export * from './invoice-item';
6
+ export * from './item-quantity';
7
+ export * from './model-error';
8
+ export * from './money';
9
+ export * from './party-identification';
10
+ export * from './submit-invoice-request';
11
+ export * from './submit-invoice-response';
12
+ export * from './tax-detail';
13
+ export * from './tax-registration-detail';
14
+ export * from './transaction-reference';
@@ -0,0 +1,102 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Payments
3
+ * The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment vendor\'s invoice data.
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AdditionalDetails } from './additional-details';
13
+ import { ChargeDetails } from './charge-details';
14
+ import { InvoiceItem } from './invoice-item';
15
+ import { Money } from './money';
16
+ import { PartyIdentification } from './party-identification';
17
+ import { TaxDetail } from './tax-detail';
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface InvoiceDetail
22
+ */
23
+ export interface InvoiceDetail {
24
+ /**
25
+ * The unique invoice number.
26
+ * @type {string}
27
+ * @memberof InvoiceDetail
28
+ */
29
+ invoiceNumber: string;
30
+ /**
31
+ * Invoice date.
32
+ * @type {string}
33
+ * @memberof InvoiceDetail
34
+ */
35
+ invoiceDate: string;
36
+ /**
37
+ * An additional unique reference number used for regulatory or other purposes.
38
+ * @type {string}
39
+ * @memberof InvoiceDetail
40
+ */
41
+ referenceNumber?: string;
42
+ /**
43
+ *
44
+ * @type {PartyIdentification}
45
+ * @memberof InvoiceDetail
46
+ */
47
+ remitToParty: PartyIdentification;
48
+ /**
49
+ *
50
+ * @type {PartyIdentification}
51
+ * @memberof InvoiceDetail
52
+ */
53
+ shipFromParty: PartyIdentification;
54
+ /**
55
+ *
56
+ * @type {PartyIdentification}
57
+ * @memberof InvoiceDetail
58
+ */
59
+ billToParty?: PartyIdentification;
60
+ /**
61
+ * Ship-to country code.
62
+ * @type {string}
63
+ * @memberof InvoiceDetail
64
+ */
65
+ shipToCountryCode?: string;
66
+ /**
67
+ * The payment terms for the invoice.
68
+ * @type {string}
69
+ * @memberof InvoiceDetail
70
+ */
71
+ paymentTermsCode?: string;
72
+ /**
73
+ *
74
+ * @type {Money}
75
+ * @memberof InvoiceDetail
76
+ */
77
+ invoiceTotal: Money;
78
+ /**
79
+ * Individual tax details per line item.
80
+ * @type {Array<TaxDetail>}
81
+ * @memberof InvoiceDetail
82
+ */
83
+ taxTotals?: Array<TaxDetail>;
84
+ /**
85
+ * Additional details provided by the selling party, for tax related or other purposes.
86
+ * @type {Array<AdditionalDetails>}
87
+ * @memberof InvoiceDetail
88
+ */
89
+ additionalDetails?: Array<AdditionalDetails>;
90
+ /**
91
+ * Total charge amount details for all line items.
92
+ * @type {Array<ChargeDetails>}
93
+ * @memberof InvoiceDetail
94
+ */
95
+ chargeDetails?: Array<ChargeDetails>;
96
+ /**
97
+ * Provides the details of the items in this invoice.
98
+ * @type {Array<InvoiceItem>}
99
+ * @memberof InvoiceDetail
100
+ */
101
+ items: Array<InvoiceItem>;
102
+ }
@@ -0,0 +1,82 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Payments
3
+ * The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment vendor\'s invoice data.
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ChargeDetails } from './charge-details';
13
+ import { ItemQuantity } from './item-quantity';
14
+ import { Money } from './money';
15
+ import { TaxDetail } from './tax-detail';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface InvoiceItem
20
+ */
21
+ export interface InvoiceItem {
22
+ /**
23
+ * Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.
24
+ * @type {string}
25
+ * @memberof InvoiceItem
26
+ */
27
+ itemSequenceNumber: string;
28
+ /**
29
+ * Buyer\'s standard identification number (ASIN) of an item.
30
+ * @type {string}
31
+ * @memberof InvoiceItem
32
+ */
33
+ buyerProductIdentifier?: string;
34
+ /**
35
+ * The vendor selected product identification of the item.
36
+ * @type {string}
37
+ * @memberof InvoiceItem
38
+ */
39
+ vendorProductIdentifier?: string;
40
+ /**
41
+ *
42
+ * @type {ItemQuantity}
43
+ * @memberof InvoiceItem
44
+ */
45
+ invoicedQuantity: ItemQuantity;
46
+ /**
47
+ *
48
+ * @type {Money}
49
+ * @memberof InvoiceItem
50
+ */
51
+ netCost: Money;
52
+ /**
53
+ * The purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.
54
+ * @type {string}
55
+ * @memberof InvoiceItem
56
+ */
57
+ purchaseOrderNumber: string;
58
+ /**
59
+ * The vendor\'s order number for this order.
60
+ * @type {string}
61
+ * @memberof InvoiceItem
62
+ */
63
+ vendorOrderNumber?: string;
64
+ /**
65
+ * HSN tax code. The HSN number cannot contain alphabets.
66
+ * @type {string}
67
+ * @memberof InvoiceItem
68
+ */
69
+ hsnCode?: string;
70
+ /**
71
+ * Individual tax details per line item.
72
+ * @type {Array<TaxDetail>}
73
+ * @memberof InvoiceItem
74
+ */
75
+ taxDetails?: Array<TaxDetail>;
76
+ /**
77
+ * Individual charge details per line item.
78
+ * @type {Array<ChargeDetails>}
79
+ * @memberof InvoiceItem
80
+ */
81
+ chargeDetails?: Array<ChargeDetails>;
82
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Payments
3
+ * The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment vendor\'s invoice data.
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Details of item quantity.
14
+ * @export
15
+ * @interface ItemQuantity
16
+ */
17
+ export interface ItemQuantity {
18
+ /**
19
+ * Quantity of units available for a specific item.
20
+ * @type {number}
21
+ * @memberof ItemQuantity
22
+ */
23
+ amount: number;
24
+ /**
25
+ * Unit of measure for the available quantity.
26
+ * @type {string}
27
+ * @memberof ItemQuantity
28
+ */
29
+ unitOfMeasure: string;
30
+ }
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Selling Partner API for Direct Fulfillment Payments
3
+ * The Selling Partner API for Direct Fulfillment Payments provides programmatic access to a direct fulfillment vendor\'s invoice data.
4
+ *
5
+ * The version of the OpenAPI document: v1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Error response returned when the request is unsuccessful.
14
+ * @export
15
+ * @interface ModelError
16
+ */
17
+ export interface ModelError {
18
+ /**
19
+ * An error code that identifies the type of error that occurred.
20
+ * @type {string}
21
+ * @memberof ModelError
22
+ */
23
+ code: string;
24
+ /**
25
+ * A message that describes the error condition.
26
+ * @type {string}
27
+ * @memberof ModelError
28
+ */
29
+ message: string;
30
+ /**
31
+ * Additional details that can help the caller understand or fix the issue.
32
+ * @type {string}
33
+ * @memberof ModelError
34
+ */
35
+ details?: string;
36
+ }