@sp-api-sdk/finances-api-2024-06-19 3.3.3 → 4.0.0

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 (95) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +349 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +791 -0
  5. package/dist/index.d.ts +791 -0
  6. package/dist/index.js +304 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/finances-api.js +0 -150
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/amazon-pay-context.js +0 -15
  16. package/dist/cjs/api-model/models/breakdown.js +0 -15
  17. package/dist/cjs/api-model/models/business-context.js +0 -19
  18. package/dist/cjs/api-model/models/context-all-of.js +0 -15
  19. package/dist/cjs/api-model/models/context.js +0 -15
  20. package/dist/cjs/api-model/models/currency.js +0 -15
  21. package/dist/cjs/api-model/models/deferred-context.js +0 -15
  22. package/dist/cjs/api-model/models/error-list.js +0 -15
  23. package/dist/cjs/api-model/models/index.js +0 -36
  24. package/dist/cjs/api-model/models/item-related-identifier.js +0 -22
  25. package/dist/cjs/api-model/models/item.js +0 -15
  26. package/dist/cjs/api-model/models/list-transactions-response.js +0 -15
  27. package/dist/cjs/api-model/models/marketplace-details.js +0 -15
  28. package/dist/cjs/api-model/models/model-error.js +0 -15
  29. package/dist/cjs/api-model/models/payments-context.js +0 -15
  30. package/dist/cjs/api-model/models/product-context.js +0 -15
  31. package/dist/cjs/api-model/models/related-identifier.js +0 -28
  32. package/dist/cjs/api-model/models/selling-partner-metadata.js +0 -15
  33. package/dist/cjs/api-model/models/time-range-context.js +0 -15
  34. package/dist/cjs/api-model/models/transaction.js +0 -15
  35. package/dist/cjs/api-model/models/transactions-payload.js +0 -15
  36. package/dist/cjs/client.js +0 -21
  37. package/dist/cjs/index.js +0 -19
  38. package/dist/es/api-model/api/finances-api.js +0 -140
  39. package/dist/es/api-model/api.js +0 -14
  40. package/dist/es/api-model/base.js +0 -44
  41. package/dist/es/api-model/common.js +0 -110
  42. package/dist/es/api-model/configuration.js +0 -94
  43. package/dist/es/api-model/index.js +0 -16
  44. package/dist/es/api-model/models/amazon-pay-context.js +0 -14
  45. package/dist/es/api-model/models/breakdown.js +0 -14
  46. package/dist/es/api-model/models/business-context.js +0 -16
  47. package/dist/es/api-model/models/context-all-of.js +0 -14
  48. package/dist/es/api-model/models/context.js +0 -14
  49. package/dist/es/api-model/models/currency.js +0 -14
  50. package/dist/es/api-model/models/deferred-context.js +0 -14
  51. package/dist/es/api-model/models/error-list.js +0 -14
  52. package/dist/es/api-model/models/index.js +0 -20
  53. package/dist/es/api-model/models/item-related-identifier.js +0 -19
  54. package/dist/es/api-model/models/item.js +0 -14
  55. package/dist/es/api-model/models/list-transactions-response.js +0 -14
  56. package/dist/es/api-model/models/marketplace-details.js +0 -14
  57. package/dist/es/api-model/models/model-error.js +0 -14
  58. package/dist/es/api-model/models/payments-context.js +0 -14
  59. package/dist/es/api-model/models/product-context.js +0 -14
  60. package/dist/es/api-model/models/related-identifier.js +0 -25
  61. package/dist/es/api-model/models/selling-partner-metadata.js +0 -14
  62. package/dist/es/api-model/models/time-range-context.js +0 -14
  63. package/dist/es/api-model/models/transaction.js +0 -14
  64. package/dist/es/api-model/models/transactions-payload.js +0 -14
  65. package/dist/es/client.js +0 -17
  66. package/dist/es/index.js +0 -3
  67. package/dist/types/api-model/api/finances-api.d.ts +0 -109
  68. package/dist/types/api-model/api.d.ts +0 -12
  69. package/dist/types/api-model/base.d.ts +0 -42
  70. package/dist/types/api-model/common.d.ts +0 -34
  71. package/dist/types/api-model/configuration.d.ts +0 -98
  72. package/dist/types/api-model/index.d.ts +0 -14
  73. package/dist/types/api-model/models/amazon-pay-context.d.ts +0 -28
  74. package/dist/types/api-model/models/breakdown.d.ts +0 -26
  75. package/dist/types/api-model/models/business-context.d.ts +0 -24
  76. package/dist/types/api-model/models/context-all-of.d.ts +0 -14
  77. package/dist/types/api-model/models/context.d.ts +0 -23
  78. package/dist/types/api-model/models/currency.d.ts +0 -24
  79. package/dist/types/api-model/models/deferred-context.d.ts +0 -24
  80. package/dist/types/api-model/models/error-list.d.ts +0 -20
  81. package/dist/types/api-model/models/index.d.ts +0 -20
  82. package/dist/types/api-model/models/item-related-identifier.d.ts +0 -31
  83. package/dist/types/api-model/models/item.d.ts +0 -37
  84. package/dist/types/api-model/models/list-transactions-response.d.ts +0 -18
  85. package/dist/types/api-model/models/marketplace-details.d.ts +0 -24
  86. package/dist/types/api-model/models/model-error.d.ts +0 -28
  87. package/dist/types/api-model/models/payments-context.d.ts +0 -32
  88. package/dist/types/api-model/models/product-context.d.ts +0 -32
  89. package/dist/types/api-model/models/related-identifier.d.ts +0 -37
  90. package/dist/types/api-model/models/selling-partner-metadata.d.ts +0 -28
  91. package/dist/types/api-model/models/time-range-context.d.ts +0 -24
  92. package/dist/types/api-model/models/transaction.d.ts +0 -62
  93. package/dist/types/api-model/models/transactions-payload.d.ts +0 -25
  94. package/dist/types/client.d.ts +0 -6
  95. package/dist/types/index.d.ts +0 -3
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,20 +0,0 @@
1
- export * from './amazon-pay-context';
2
- export * from './breakdown';
3
- export * from './business-context';
4
- export * from './context';
5
- export * from './context-all-of';
6
- export * from './currency';
7
- export * from './deferred-context';
8
- export * from './error-list';
9
- export * from './item';
10
- export * from './item-related-identifier';
11
- export * from './list-transactions-response';
12
- export * from './marketplace-details';
13
- export * from './model-error';
14
- export * from './payments-context';
15
- export * from './product-context';
16
- export * from './related-identifier';
17
- export * from './selling-partner-metadata';
18
- export * from './time-range-context';
19
- export * from './transaction';
20
- export * from './transactions-payload';
@@ -1,19 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export const ItemRelatedIdentifierItemRelatedIdentifierNameEnum = {
15
- OrderAdjustmentItemId: 'ORDER_ADJUSTMENT_ITEM_ID',
16
- CouponId: 'COUPON_ID',
17
- RemovalShipmentItemId: 'REMOVAL_SHIPMENT_ITEM_ID',
18
- TransactionId: 'TRANSACTION_ID'
19
- };
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,25 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export const RelatedIdentifierRelatedIdentifierNameEnum = {
15
- OrderId: 'ORDER_ID',
16
- ShipmentId: 'SHIPMENT_ID',
17
- FinancialEventGroupId: 'FINANCIAL_EVENT_GROUP_ID',
18
- RefundId: 'REFUND_ID',
19
- InvoiceId: 'INVOICE_ID',
20
- DisbursementId: 'DISBURSEMENT_ID',
21
- TransferId: 'TRANSFER_ID',
22
- DeferredTransactionId: 'DEFERRED_TRANSACTION_ID',
23
- ReleaseTransactionId: 'RELEASE_TRANSACTION_ID',
24
- SettlementId: 'SETTLEMENT_ID'
25
- };
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Finances
5
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
6
- *
7
- * The version of the OpenAPI document: 2024-06-19
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- export {};
package/dist/es/client.js DELETED
@@ -1,17 +0,0 @@
1
- import { createAxiosInstance } from '@sp-api-sdk/common';
2
- import { Configuration, FinancesApi } from './api-model';
3
- export const clientRateLimits = [
4
- {
5
- method: 'get',
6
- // eslint-disable-next-line prefer-regex-literals
7
- urlRegex: new RegExp('^/finances/2024-06-19/transactions$'),
8
- rate: 0.5,
9
- burst: 10,
10
- },
11
- ];
12
- export class FinancesApiClient extends FinancesApi {
13
- constructor(configuration) {
14
- const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
15
- super(new Configuration(), endpoint, axios);
16
- }
17
- }
package/dist/es/index.js DELETED
@@ -1,3 +0,0 @@
1
- export * from './client';
2
- export * from './api-model/api';
3
- export * from './api-model/models';
@@ -1,109 +0,0 @@
1
- /**
2
- * The Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
4
- *
5
- * The version of the OpenAPI document: 2024-06-19
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 type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import { type RequestArgs, BaseAPI } from '../base';
16
- import type { ListTransactionsResponse } from '../models';
17
- /**
18
- * FinancesApi - axios parameter creator
19
- */
20
- export declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
21
- /**
22
- * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
23
- * @param {string} [postedAfter] The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier.
24
- * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
25
- * @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
26
- * @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
27
- * @param {string} [relatedIdentifierName] The name of the `relatedIdentifier`. **Possible values:** * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. * `ORDER_ID`: the order ID associated with the transaction. **Note:** FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes.
28
- * @param {string} [relatedIdentifierValue] The value of the `relatedIdentifier`.
29
- * @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
30
- * @param {*} [options] Override http request option.
31
- * @throws {RequiredError}
32
- */
33
- listTransactions: (postedAfter?: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
34
- };
35
- /**
36
- * FinancesApi - functional programming interface
37
- */
38
- export declare const FinancesApiFp: (configuration?: Configuration) => {
39
- /**
40
- * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
41
- * @param {string} [postedAfter] The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier.
42
- * @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
43
- * @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
44
- * @param {string} [transactionStatus] The status of the transaction. **Possible values:** * &#x60;DEFERRED&#x60;: the transaction is currently deferred. * &#x60;RELEASED&#x60;: the transaction is currently released. * &#x60;DEFERRED_RELEASED&#x60;: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to &#x60;DEFERRED_RELEASED&#x60; when the transaction is released.
45
- * @param {string} [relatedIdentifierName] The name of the &#x60;relatedIdentifier&#x60;. **Possible values:** * &#x60;FINANCIAL_EVENT_GROUP_ID&#x60;: the financial event group ID associated with the transaction. * &#x60;ORDER_ID&#x60;: the order ID associated with the transaction. **Note:** FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only &#x60;relatedIdentifier&#x60; with filtering capabilities at the moment. While other &#x60;relatedIdentifier&#x60; values will be included in the response when available, they cannot be used for filtering purposes.
46
- * @param {string} [relatedIdentifierValue] The value of the &#x60;relatedIdentifier&#x60;.
47
- * @param {string} [nextToken] The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- */
51
- listTransactions(postedAfter?: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
52
- };
53
- /**
54
- * FinancesApi - factory interface
55
- */
56
- export declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
57
- /**
58
- * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
59
- * @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
60
- * @param {*} [options] Override http request option.
61
- * @throws {RequiredError}
62
- */
63
- listTransactions(requestParameters?: FinancesApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactionsResponse>;
64
- };
65
- /**
66
- * Request parameters for listTransactions operation in FinancesApi.
67
- */
68
- export interface FinancesApiListTransactionsRequest {
69
- /**
70
- * The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier.
71
- */
72
- readonly postedAfter?: string;
73
- /**
74
- * The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than &#x60;PostedAfter&#x60; and more than two minutes before the request was submitted. If &#x60;PostedAfter&#x60; and &#x60;PostedBefore&#x60; are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
75
- */
76
- readonly postedBefore?: string;
77
- /**
78
- * The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
79
- */
80
- readonly marketplaceId?: string;
81
- /**
82
- * The status of the transaction. **Possible values:** * &#x60;DEFERRED&#x60;: the transaction is currently deferred. * &#x60;RELEASED&#x60;: the transaction is currently released. * &#x60;DEFERRED_RELEASED&#x60;: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to &#x60;DEFERRED_RELEASED&#x60; when the transaction is released.
83
- */
84
- readonly transactionStatus?: string;
85
- /**
86
- * The name of the &#x60;relatedIdentifier&#x60;. **Possible values:** * &#x60;FINANCIAL_EVENT_GROUP_ID&#x60;: the financial event group ID associated with the transaction. * &#x60;ORDER_ID&#x60;: the order ID associated with the transaction. **Note:** FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only &#x60;relatedIdentifier&#x60; with filtering capabilities at the moment. While other &#x60;relatedIdentifier&#x60; values will be included in the response when available, they cannot be used for filtering purposes.
87
- */
88
- readonly relatedIdentifierName?: string;
89
- /**
90
- * The value of the &#x60;relatedIdentifier&#x60;.
91
- */
92
- readonly relatedIdentifierValue?: string;
93
- /**
94
- * The response includes &#x60;nextToken&#x60; when the number of results exceeds the specified &#x60;pageSize&#x60; value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until &#x60;nextToken&#x60; is null. Note that this operation can return empty pages.
95
- */
96
- readonly nextToken?: string;
97
- }
98
- /**
99
- * FinancesApi - object-oriented interface
100
- */
101
- export declare class FinancesApi extends BaseAPI {
102
- /**
103
- * Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
104
- * @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
105
- * @param {*} [options] Override http request option.
106
- * @throws {RequiredError}
107
- */
108
- listTransactions(requestParameters?: FinancesApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListTransactionsResponse, any, {}>>;
109
- }
@@ -1,12 +0,0 @@
1
- /**
2
- * The Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
4
- *
5
- * The version of the OpenAPI document: 2024-06-19
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
- export * from './api/finances-api';
@@ -1,42 +0,0 @@
1
- /**
2
- * The Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
4
- *
5
- * The version of the OpenAPI document: 2024-06-19
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 type { Configuration } from './configuration';
13
- import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- export declare const BASE_PATH: string;
15
- export declare const COLLECTION_FORMATS: {
16
- csv: string;
17
- ssv: string;
18
- tsv: string;
19
- pipes: string;
20
- };
21
- export interface RequestArgs {
22
- url: string;
23
- options: RawAxiosRequestConfig;
24
- }
25
- export declare class BaseAPI {
26
- protected basePath: string;
27
- protected axios: AxiosInstance;
28
- protected configuration: Configuration | undefined;
29
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
30
- }
31
- export declare class RequiredError extends Error {
32
- field: string;
33
- constructor(field: string, msg?: string);
34
- }
35
- interface ServerMap {
36
- [key: string]: {
37
- url: string;
38
- description: string;
39
- }[];
40
- }
41
- export declare const operationServerMap: ServerMap;
42
- export {};
@@ -1,34 +0,0 @@
1
- /**
2
- * The Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
4
- *
5
- * The version of the OpenAPI document: 2024-06-19
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 type { Configuration } from "./configuration";
13
- import type { RequestArgs } from "./base";
14
- import type { AxiosInstance, AxiosResponse } from 'axios';
15
- export declare const DUMMY_BASE_URL = "https://example.com";
16
- /**
17
- *
18
- * @throws {RequiredError}
19
- */
20
- export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
21
- export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
22
- export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
23
- export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
24
- export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
25
- export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
26
- /**
27
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
30
- */
31
- export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
32
- export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
33
- export declare const toPathString: (url: URL) => string;
34
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -1,98 +0,0 @@
1
- /**
2
- * The Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
4
- *
5
- * The version of the OpenAPI document: 2024-06-19
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
- interface AWSv4Configuration {
13
- options?: {
14
- region?: string;
15
- service?: string;
16
- };
17
- credentials?: {
18
- accessKeyId?: string;
19
- secretAccessKey?: string;
20
- sessionToken?: string;
21
- };
22
- }
23
- export interface ConfigurationParameters {
24
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
25
- username?: string;
26
- password?: string;
27
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
- awsv4?: AWSv4Configuration;
29
- basePath?: string;
30
- serverIndex?: number;
31
- baseOptions?: any;
32
- formDataCtor?: new () => any;
33
- }
34
- export declare class Configuration {
35
- /**
36
- * parameter for apiKey security
37
- * @param name security name
38
- */
39
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
40
- /**
41
- * parameter for basic security
42
- */
43
- username?: string;
44
- /**
45
- * parameter for basic security
46
- */
47
- password?: string;
48
- /**
49
- * parameter for oauth2 security
50
- * @param name security name
51
- * @param scopes oauth2 scope
52
- */
53
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
- /**
55
- * parameter for aws4 signature security
56
- * @param {Object} AWS4Signature - AWS4 Signature security
57
- * @param {string} options.region - aws region
58
- * @param {string} options.service - name of the service.
59
- * @param {string} credentials.accessKeyId - aws access key id
60
- * @param {string} credentials.secretAccessKey - aws access key
61
- * @param {string} credentials.sessionToken - aws session token
62
- * @memberof Configuration
63
- */
64
- awsv4?: AWSv4Configuration;
65
- /**
66
- * override base path
67
- */
68
- basePath?: string;
69
- /**
70
- * override server index
71
- */
72
- serverIndex?: number;
73
- /**
74
- * base options for axios calls
75
- */
76
- baseOptions?: any;
77
- /**
78
- * The FormData constructor that will be used to create multipart form data
79
- * requests. You can inject this here so that execution environments that
80
- * do not support the FormData class can still run the generated client.
81
- *
82
- * @type {new () => FormData}
83
- */
84
- formDataCtor?: new () => any;
85
- constructor(param?: ConfigurationParameters);
86
- /**
87
- * Check if the given MIME is a JSON MIME.
88
- * JSON MIME examples:
89
- * application/json
90
- * application/json; charset=UTF8
91
- * APPLICATION/JSON
92
- * application/vnd.company+json
93
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
94
- * @return True if the given MIME is JSON, false otherwise.
95
- */
96
- isJsonMime(mime: string): boolean;
97
- }
98
- export {};
@@ -1,14 +0,0 @@
1
- /**
2
- * The Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
4
- *
5
- * The version of the OpenAPI document: 2024-06-19
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
- export * from "./api";
13
- export * from "./configuration";
14
- export * from "./models";
@@ -1,28 +0,0 @@
1
- /**
2
- * The Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
4
- *
5
- * The version of the OpenAPI document: 2024-06-19
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
- * Additional information related to Amazon Pay.
14
- */
15
- export interface AmazonPayContext {
16
- /**
17
- * The name of the store that is related to the transaction.
18
- */
19
- 'storeName'?: string;
20
- /**
21
- * The transaction\'s order type.
22
- */
23
- 'orderType'?: string;
24
- /**
25
- * Channel details of related transaction.
26
- */
27
- 'channel'?: string;
28
- }
@@ -1,26 +0,0 @@
1
- /**
2
- * The Selling Partner API for Finances
3
- * The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
4
- *
5
- * The version of the OpenAPI document: 2024-06-19
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 type { Currency } from './currency';
13
- /**
14
- * Details about the movement of money in the financial transaction. Breakdowns are further categorized into breakdown types, breakdown amounts, and further breakdowns.
15
- */
16
- export interface Breakdown {
17
- /**
18
- * The type of charge.
19
- */
20
- 'breakdownType'?: string;
21
- 'breakdownAmount'?: Currency;
22
- /**
23
- * A list of breakdowns that detail how the total amount is calculated for the transaction.
24
- */
25
- 'breakdowns'?: Array<Breakdown>;
26
- }