@sp-api-sdk/finances-transfers-api-2024-06-01 2.0.0

package/dist/types/api-model/base.d.ts

@@ -0,0 +1,66 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}
+interface ServerMap {
+    [key: string]: {
+        url: string;
+        description: string;
+    }[];
+}
+/**
+ *
+ * @export
+ */
+export declare const operationServerMap: ServerMap;
+export {};

package/dist/types/api-model/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/api-model/configuration.d.ts

@@ -0,0 +1,91 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/types/api-model/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/dist/types/api-model/models/assignment-type.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The default payment method type.
+ * @export
+ * @enum {string}
+ */
+export declare const AssignmentType: {
+    readonly DefaultDepositMethod: "DEFAULT_DEPOSIT_METHOD";
+};
+export type AssignmentType = typeof AssignmentType[keyof typeof AssignmentType];

package/dist/types/api-model/models/error-list.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A list of error responses returned when a request is unsuccessful.
+ * @export
+ * @interface ErrorList
+ */
+export interface ErrorList {
+    /**
+     * array of errors
+     * @type {Array<Error>}
+     * @memberof ErrorList
+     */
+    'errors': Array<Error>;
+}

package/dist/types/api-model/models/expiry-date.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The expiration date of the card used for payment. If the payment method is not `card`, the expiration date is `null`.
+ * @export
+ * @interface ExpiryDate
+ */
+export interface ExpiryDate {
+    /**
+     * The month the card expires expressed as a number from `1` to `12`.
+     * @type {string}
+     * @memberof ExpiryDate
+     */
+    'month'?: string;
+    /**
+     * Year
+     * @type {string}
+     * @memberof ExpiryDate
+     */
+    'year'?: string;
+}

package/dist/types/api-model/models/get-payment-methods-response.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { PaymentMethodDetails } from './payment-method-details';
+/**
+ * The response schema for the `getPaymentMethods` operation.
+ * @export
+ * @interface GetPaymentMethodsResponse
+ */
+export interface GetPaymentMethodsResponse {
+    /**
+     * The list of payment methods with payment method details.
+     * @type {Array<PaymentMethodDetails>}
+     * @memberof GetPaymentMethodsResponse
+     */
+    'paymentMethods'?: Array<PaymentMethodDetails>;
+}

package/dist/types/api-model/models/index.d.ts

@@ -0,0 +1,9 @@
+export * from './assignment-type';
+export * from './error-list';
+export * from './expiry-date';
+export * from './get-payment-methods-response';
+export * from './initiate-payout-request';
+export * from './initiate-payout-response';
+export * from './model-error';
+export * from './payment-method-details';
+export * from './payment-method-type';

package/dist/types/api-model/models/initiate-payout-request.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The request schema for the `initiatePayout` operation.
+ * @export
+ * @interface InitiatePayoutRequest
+ */
+export interface InitiatePayoutRequest {
+    /**
+     * 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).
+     * @type {string}
+     * @memberof InitiatePayoutRequest
+     */
+    'marketplaceId': string;
+    /**
+     * 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`.
+     * @type {string}
+     * @memberof InitiatePayoutRequest
+     */
+    'accountType': string;
+}

package/dist/types/api-model/models/initiate-payout-response.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The response schema for the `initiatePayout` operation.
+ * @export
+ * @interface InitiatePayoutResponse
+ */
+export interface InitiatePayoutResponse {
+    /**
+     * The financial event group ID for a successfully initiated payout. You can use this ID to track payout information.
+     * @type {string}
+     * @memberof InitiatePayoutResponse
+     */
+    'payoutReferenceId': string;
+}

package/dist/types/api-model/models/model-error.d.ts

@@ -0,0 +1,36 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Error response returned when the request is unsuccessful.
+ * @export
+ * @interface ModelError
+ */
+export interface ModelError {
+    /**
+     * An error code that identifies the type of error that occurred.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'code': string;
+    /**
+     * A message that describes the error condition.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'message': string;
+    /**
+     * Additional details that can help the caller understand or fix the issue.
+     * @type {string}
+     * @memberof ModelError
+     */
+    'details'?: string;
+}

package/dist/types/api-model/models/payment-method-details.d.ts

@@ -0,0 +1,63 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { AssignmentType } from './assignment-type';
+import type { ExpiryDate } from './expiry-date';
+import type { PaymentMethodType } from './payment-method-type';
+/**
+ * The details of a payment method.
+ * @export
+ * @interface PaymentMethodDetails
+ */
+export interface PaymentMethodDetails {
+    /**
+     * The name of the account holder who is registered for the payment method.
+     * @type {string}
+     * @memberof PaymentMethodDetails
+     */
+    'accountHolderName'?: string;
+    /**
+     * The payment method identifier.
+     * @type {string}
+     * @memberof PaymentMethodDetails
+     */
+    'paymentMethodId'?: string;
+    /**
+     * The last three or four digits of the payment method.
+     * @type {string}
+     * @memberof PaymentMethodDetails
+     */
+    'tail'?: string;
+    /**
+     *
+     * @type {ExpiryDate}
+     * @memberof PaymentMethodDetails
+     */
+    'expiryDate'?: ExpiryDate;
+    /**
+     * The two-letter country code in ISO 3166-1 alpha-2 format. For payment methods in the `card` category, the code is for the country where the card was issued. For payment methods in the `bank account` category, the code is for the country where the account is located.
+     * @type {string}
+     * @memberof PaymentMethodDetails
+     */
+    'countryCode'?: string;
+    /**
+     *
+     * @type {PaymentMethodType}
+     * @memberof PaymentMethodDetails
+     */
+    'paymentMethodType'?: PaymentMethodType;
+    /**
+     *
+     * @type {AssignmentType}
+     * @memberof PaymentMethodDetails
+     */
+    'assignmentType'?: AssignmentType;
+}

package/dist/types/api-model/models/payment-method-type.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The Selling Partner API for Transfers.
+ * 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.
+ *
+ * The version of the OpenAPI document: 2024-06-01
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The type of payment method.
+ * @export
+ * @enum {string}
+ */
+export declare const PaymentMethodType: {
+    readonly BankAccount: "BANK_ACCOUNT";
+    readonly Card: "CARD";
+    readonly SellerWallet: "SELLER_WALLET";
+};
+export type PaymentMethodType = typeof PaymentMethodType[keyof typeof PaymentMethodType];

package/dist/types/client.d.ts

@@ -0,0 +1,6 @@
+import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
+import { DefaultApi } from './api-model';
+export declare const clientRateLimits: RateLimit[];
+export declare class FinancesTransfersApiClient extends DefaultApi {
+    constructor(configuration: ClientConfiguration);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './api-model/api';
+export * from './api-model/models';

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@sp-api-sdk/finances-transfers-api-2024-06-01",
+  "author": "Bertrand Marron <bertrand@bizon.solutions>",
+  "description": "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.",
+  "version": "2.0.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/types/index.d.ts",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "dist"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "dependencies": {
+    "@sp-api-sdk/common": "2.1.7",
+    "axios": "^1.7.9"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bizon/selling-partner-api-sdk.git",
+    "directory": "clients/finances-transfers-api-2024-06-01"
+  },
+  "bugs": {
+    "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
+  },
+  "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/finances-transfers-api-2024-06-01",
+  "keywords": [
+    "amazon",
+    "bizon",
+    "marketplace web services",
+    "mws",
+    "selling partner api",
+    "sp api",
+    "sp sdk",
+    "finances transfers api"
+  ],
+  "gitHead": "14dc1de3723e34f66b078e05f9c7044b22a46c43"
+}