@sp-api-sdk/finances-transfers-api-2024-06-01 4.0.16 → 5.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 (62) hide show
  1. package/README.md +4 -4
  2. package/dist/index.cjs +411 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +458 -0
  5. package/dist/index.d.ts +458 -0
  6. package/dist/index.js +366 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +23 -12
  9. package/dist/cjs/api-model/api/finances-transfers-api.js +0 -188
  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/assignment-type.js +0 -22
  16. package/dist/cjs/api-model/models/error-list.js +0 -15
  17. package/dist/cjs/api-model/models/expiry-date.js +0 -15
  18. package/dist/cjs/api-model/models/get-payment-methods-response.js +0 -15
  19. package/dist/cjs/api-model/models/index.js +0 -25
  20. package/dist/cjs/api-model/models/initiate-payout-request.js +0 -15
  21. package/dist/cjs/api-model/models/initiate-payout-response.js +0 -15
  22. package/dist/cjs/api-model/models/model-error.js +0 -15
  23. package/dist/cjs/api-model/models/payment-method-details.js +0 -15
  24. package/dist/cjs/api-model/models/payment-method-type.js +0 -24
  25. package/dist/cjs/client.js +0 -28
  26. package/dist/cjs/index.js +0 -19
  27. package/dist/es/api-model/api/finances-transfers-api.js +0 -178
  28. package/dist/es/api-model/api.js +0 -14
  29. package/dist/es/api-model/base.js +0 -44
  30. package/dist/es/api-model/common.js +0 -110
  31. package/dist/es/api-model/configuration.js +0 -94
  32. package/dist/es/api-model/index.js +0 -16
  33. package/dist/es/api-model/models/assignment-type.js +0 -19
  34. package/dist/es/api-model/models/error-list.js +0 -14
  35. package/dist/es/api-model/models/expiry-date.js +0 -14
  36. package/dist/es/api-model/models/get-payment-methods-response.js +0 -14
  37. package/dist/es/api-model/models/index.js +0 -9
  38. package/dist/es/api-model/models/initiate-payout-request.js +0 -14
  39. package/dist/es/api-model/models/initiate-payout-response.js +0 -14
  40. package/dist/es/api-model/models/model-error.js +0 -14
  41. package/dist/es/api-model/models/payment-method-details.js +0 -14
  42. package/dist/es/api-model/models/payment-method-type.js +0 -21
  43. package/dist/es/client.js +0 -24
  44. package/dist/es/index.js +0 -3
  45. package/dist/types/api-model/api/finances-transfers-api.d.ts +0 -124
  46. package/dist/types/api-model/api.d.ts +0 -12
  47. package/dist/types/api-model/base.d.ts +0 -42
  48. package/dist/types/api-model/common.d.ts +0 -34
  49. package/dist/types/api-model/configuration.d.ts +0 -98
  50. package/dist/types/api-model/index.d.ts +0 -14
  51. package/dist/types/api-model/models/assignment-type.d.ts +0 -18
  52. package/dist/types/api-model/models/error-list.d.ts +0 -20
  53. package/dist/types/api-model/models/expiry-date.d.ts +0 -24
  54. package/dist/types/api-model/models/get-payment-methods-response.d.ts +0 -21
  55. package/dist/types/api-model/models/index.d.ts +0 -9
  56. package/dist/types/api-model/models/initiate-payout-request.d.ts +0 -24
  57. package/dist/types/api-model/models/initiate-payout-response.d.ts +0 -20
  58. package/dist/types/api-model/models/model-error.d.ts +0 -28
  59. package/dist/types/api-model/models/payment-method-details.d.ts +0 -38
  60. package/dist/types/api-model/models/payment-method-type.d.ts +0 -20
  61. package/dist/types/client.d.ts +0 -6
  62. package/dist/types/index.d.ts +0 -3
@@ -1,9 +0,0 @@
1
- export * from './assignment-type';
2
- export * from './error-list';
3
- export * from './expiry-date';
4
- export * from './get-payment-methods-response';
5
- export * from './initiate-payout-request';
6
- export * from './initiate-payout-response';
7
- export * from './model-error';
8
- export * from './payment-method-details';
9
- export * from './payment-method-type';
@@ -1,14 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Transfers.
5
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
6
- *
7
- * The version of the OpenAPI document: 2024-06-01
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 Transfers.
5
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
6
- *
7
- * The version of the OpenAPI document: 2024-06-01
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 Transfers.
5
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
6
- *
7
- * The version of the OpenAPI document: 2024-06-01
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 Transfers.
5
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
6
- *
7
- * The version of the OpenAPI document: 2024-06-01
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,21 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * The Selling Partner API for Transfers.
5
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
6
- *
7
- * The version of the OpenAPI document: 2024-06-01
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
- /**
15
- * The type of payment method.
16
- */
17
- export const PaymentMethodType = {
18
- BankAccount: 'BANK_ACCOUNT',
19
- Card: 'CARD',
20
- SellerWallet: 'SELLER_WALLET'
21
- };
package/dist/es/client.js DELETED
@@ -1,24 +0,0 @@
1
- import { createAxiosInstance } from '@sp-api-sdk/common';
2
- import { Configuration, FinancesTransfersApi } from './api-model';
3
- export const clientRateLimits = [
4
- {
5
- method: 'post',
6
- // eslint-disable-next-line prefer-regex-literals
7
- urlRegex: new RegExp('^/finances/transfers/2024-06-01/payouts$'),
8
- rate: 0.017,
9
- burst: 2,
10
- },
11
- {
12
- method: 'get',
13
- // eslint-disable-next-line prefer-regex-literals
14
- urlRegex: new RegExp('^/finances/transfers/2024-06-01/paymentMethods$'),
15
- rate: 0.5,
16
- burst: 30,
17
- },
18
- ];
19
- export class FinancesTransfersApiClient extends FinancesTransfersApi {
20
- constructor(configuration) {
21
- const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
22
- super(new Configuration(), endpoint, axios);
23
- }
24
- }
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,124 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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 { GetPaymentMethodsResponse } from '../models';
17
- import type { InitiatePayoutRequest } from '../models';
18
- import type { InitiatePayoutResponse } from '../models';
19
- /**
20
- * FinancesTransfersApi - axios parameter creator
21
- */
22
- export declare const FinancesTransfersApiAxiosParamCreator: (configuration?: Configuration) => {
23
- /**
24
- * Returns the list of payment methods for the seller, which can be filtered by method type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might 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-in-the-sp-api).
25
- * @param {string} marketplaceId The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
26
- * @param {Set<GetPaymentMethodsPaymentMethodTypesEnum>} [paymentMethodTypes] A comma-separated list of the payment method types you want to include in the response.
27
- * @param {*} [options] Override http request option.
28
- * @throws {RequiredError}
29
- */
30
- getPaymentMethods: (marketplaceId: string, paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
31
- /**
32
- * Initiates an on-demand payout to the seller\'s default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might 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-in-the-sp-api).
33
- * @param {InitiatePayoutRequest} body The request body for the &#x60;initiatePayout&#x60; operation.
34
- * @param {*} [options] Override http request option.
35
- * @throws {RequiredError}
36
- */
37
- initiatePayout: (body: InitiatePayoutRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
- };
39
- /**
40
- * FinancesTransfersApi - functional programming interface
41
- */
42
- export declare const FinancesTransfersApiFp: (configuration?: Configuration) => {
43
- /**
44
- * Returns the list of payment methods for the seller, which can be filtered by method type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might 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-in-the-sp-api).
45
- * @param {string} marketplaceId The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
46
- * @param {Set<GetPaymentMethodsPaymentMethodTypesEnum>} [paymentMethodTypes] A comma-separated list of the payment method types you want to include in the response.
47
- * @param {*} [options] Override http request option.
48
- * @throws {RequiredError}
49
- */
50
- getPaymentMethods(marketplaceId: string, paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentMethodsResponse>>;
51
- /**
52
- * Initiates an on-demand payout to the seller\'s default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might 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-in-the-sp-api).
53
- * @param {InitiatePayoutRequest} body The request body for the &#x60;initiatePayout&#x60; operation.
54
- * @param {*} [options] Override http request option.
55
- * @throws {RequiredError}
56
- */
57
- initiatePayout(body: InitiatePayoutRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiatePayoutResponse>>;
58
- };
59
- /**
60
- * FinancesTransfersApi - factory interface
61
- */
62
- export declare const FinancesTransfersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63
- /**
64
- * Returns the list of payment methods for the seller, which can be filtered by method type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might 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-in-the-sp-api).
65
- * @param {FinancesTransfersApiGetPaymentMethodsRequest} requestParameters Request parameters.
66
- * @param {*} [options] Override http request option.
67
- * @throws {RequiredError}
68
- */
69
- getPaymentMethods(requestParameters: FinancesTransfersApiGetPaymentMethodsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPaymentMethodsResponse>;
70
- /**
71
- * Initiates an on-demand payout to the seller\'s default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might 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-in-the-sp-api).
72
- * @param {FinancesTransfersApiInitiatePayoutRequest} requestParameters Request parameters.
73
- * @param {*} [options] Override http request option.
74
- * @throws {RequiredError}
75
- */
76
- initiatePayout(requestParameters: FinancesTransfersApiInitiatePayoutRequest, options?: RawAxiosRequestConfig): AxiosPromise<InitiatePayoutResponse>;
77
- };
78
- /**
79
- * Request parameters for getPaymentMethods operation in FinancesTransfersApi.
80
- */
81
- export interface FinancesTransfersApiGetPaymentMethodsRequest {
82
- /**
83
- * The identifier of the marketplace from which you want to retrieve payment methods. For the list of possible marketplace identifiers, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
84
- */
85
- readonly marketplaceId: string;
86
- /**
87
- * A comma-separated list of the payment method types you want to include in the response.
88
- */
89
- readonly paymentMethodTypes?: Set<GetPaymentMethodsPaymentMethodTypesEnum>;
90
- }
91
- /**
92
- * Request parameters for initiatePayout operation in FinancesTransfersApi.
93
- */
94
- export interface FinancesTransfersApiInitiatePayoutRequest {
95
- /**
96
- * The request body for the &#x60;initiatePayout&#x60; operation.
97
- */
98
- readonly body: InitiatePayoutRequest;
99
- }
100
- /**
101
- * FinancesTransfersApi - object-oriented interface
102
- */
103
- export declare class FinancesTransfersApi extends BaseAPI {
104
- /**
105
- * Returns the list of payment methods for the seller, which can be filtered by method type. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | .5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might 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-in-the-sp-api).
106
- * @param {FinancesTransfersApiGetPaymentMethodsRequest} requestParameters Request parameters.
107
- * @param {*} [options] Override http request option.
108
- * @throws {RequiredError}
109
- */
110
- getPaymentMethods(requestParameters: FinancesTransfersApiGetPaymentMethodsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPaymentMethodsResponse, any, {}>>;
111
- /**
112
- * Initiates an on-demand payout to the seller\'s default deposit method in Seller Central for the given `marketplaceId` and `accountType`, if eligible. You can only initiate one on-demand payout for each marketplace and account type within a 24-hour period. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.017 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might 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-in-the-sp-api).
113
- * @param {FinancesTransfersApiInitiatePayoutRequest} requestParameters Request parameters.
114
- * @param {*} [options] Override http request option.
115
- * @throws {RequiredError}
116
- */
117
- initiatePayout(requestParameters: FinancesTransfersApiInitiatePayoutRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InitiatePayoutResponse, any, {}>>;
118
- }
119
- export declare const GetPaymentMethodsPaymentMethodTypesEnum: {
120
- readonly BankAccount: "BANK_ACCOUNT";
121
- readonly Card: "CARD";
122
- readonly SellerWallet: "SELLER_WALLET";
123
- };
124
- export type GetPaymentMethodsPaymentMethodTypesEnum = typeof GetPaymentMethodsPaymentMethodTypesEnum[keyof typeof GetPaymentMethodsPaymentMethodTypesEnum];
@@ -1,12 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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-transfers-api';
@@ -1,42 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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 Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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 Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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 Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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,18 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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
- * The default payment method type.
14
- */
15
- export declare const AssignmentType: {
16
- readonly DefaultDepositMethod: "DEFAULT_DEPOSIT_METHOD";
17
- };
18
- export type AssignmentType = typeof AssignmentType[keyof typeof AssignmentType];
@@ -1,20 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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 list of error responses returned when a request is unsuccessful.
14
- */
15
- export interface ErrorList {
16
- /**
17
- * array of errors
18
- */
19
- 'errors': Array<Error>;
20
- }
@@ -1,24 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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
- * The expiration date of the card used for payment. If the payment method is not `card`, the expiration date is `null`.
14
- */
15
- export interface ExpiryDate {
16
- /**
17
- * The month the card expires expressed as a number from `1` to `12`.
18
- */
19
- 'month'?: string;
20
- /**
21
- * Year
22
- */
23
- 'year'?: string;
24
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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 { PaymentMethodDetails } from './payment-method-details';
13
- /**
14
- * The response schema for the `getPaymentMethods` operation.
15
- */
16
- export interface GetPaymentMethodsResponse {
17
- /**
18
- * The list of payment methods with payment method details.
19
- */
20
- 'paymentMethods'?: Array<PaymentMethodDetails>;
21
- }
@@ -1,9 +0,0 @@
1
- export * from './assignment-type';
2
- export * from './error-list';
3
- export * from './expiry-date';
4
- export * from './get-payment-methods-response';
5
- export * from './initiate-payout-request';
6
- export * from './initiate-payout-response';
7
- export * from './model-error';
8
- export * from './payment-method-details';
9
- export * from './payment-method-type';
@@ -1,24 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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
- * The request schema for the `initiatePayout` operation.
14
- */
15
- export interface InitiatePayoutRequest {
16
- /**
17
- * The identifier of the Amazon marketplace. For the list of all marketplace IDs, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
18
- */
19
- 'marketplaceId': string;
20
- /**
21
- * The account type in the selected marketplace for which a payout must be initiated. For supported EU marketplaces, the only account type is `Standard Orders`.
22
- */
23
- 'accountType': string;
24
- }
@@ -1,20 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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
- * The response schema for the `initiatePayout` operation.
14
- */
15
- export interface InitiatePayoutResponse {
16
- /**
17
- * The financial event group ID for a successfully initiated payout. You can use this ID to track payout information.
18
- */
19
- 'payoutReferenceId': string;
20
- }
@@ -1,28 +0,0 @@
1
- /**
2
- * The Selling Partner API for Transfers.
3
- * The Selling Partner API for Transfers enables selling partners to retrieve payment methods and initiate payouts for their seller accounts. This API supports the following marketplaces: DE, FR, IT, ES, SE, NL, PL, and BE.
4
- *
5
- * The version of the OpenAPI document: 2024-06-01
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
- */
15
- export interface ModelError {
16
- /**
17
- * An error code that identifies the type of error that occurred.
18
- */
19
- 'code': string;
20
- /**
21
- * A message that describes the error condition.
22
- */
23
- 'message': string;
24
- /**
25
- * Additional details that can help the caller understand or fix the issue.
26
- */
27
- 'details'?: string;
28
- }