@finverse/sdk-typescript 0.0.3 → 0.0.4

package/dist/api.d.ts

@@ -381,6 +381,19 @@ export interface CreateCustomerResponse {
      */
     webhook_uris?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface CreatePaymentInstructionResponse
+ */
+export interface CreatePaymentInstructionResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof CreatePaymentInstructionResponse
+     */
+    payment_instruction_id?: string;
+}
 /**
  *
  * @export
@@ -1774,6 +1787,73 @@ export interface PaymentDetails {
      */
     other_info?: OtherInfo;
 }
+/**
+ *
+ * @export
+ * @interface PaymentInstruction
+ */
+export interface PaymentInstruction {
+    /**
+     * The recipient name
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    recipient_name?: string;
+    /**
+     * The sender name
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    sender_name?: string;
+    /**
+     * The sender account Id
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    sender_account_id?: string;
+    /**
+     * When the payment should start
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    start_date?: string | null;
+    /**
+     * When the payment should stop
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    end_date?: string | null;
+    /**
+     * The currency for the payment
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    currency?: string;
+    /**
+     * The payment amount
+     * @type {number}
+     * @memberof PaymentInstruction
+     */
+    amount?: number;
+    /**
+     * How often the payment is executed
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    frequency?: string;
+    /**
+     * Related remarks
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    remarks?: string;
+    /**
+     * A customer provided key to ensure ideompotency
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    idempotence_key?: string;
+}
 /**
  *
  * @export
@@ -2125,6 +2205,13 @@ export interface Transaction {
  * @export
  */
 export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentInstruction: (paymentInstruction: PaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2176,6 +2263,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const CustomerApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentInstruction(paymentInstruction: PaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2227,6 +2321,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const CustomerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentInstruction(paymentInstruction: PaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2279,6 +2380,14 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
  * @interface CustomerApi
  */
 export interface CustomerApiInterface {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    createPaymentInstruction(paymentInstruction: PaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -2338,6 +2447,14 @@ export interface CustomerApiInterface {
  * @extends {BaseAPI}
  */
 export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    createPaymentInstruction(paymentInstruction: PaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request

package/dist/api.js

@@ -40,6 +40,38 @@ exports.LinkTokenRequestUiModeEnum = {
  */
 exports.CustomerApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * Create a new payment instruction to be used when linking to perform debit authorization
+         * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentInstruction: (paymentInstruction, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'paymentInstruction' is not null or undefined
+            common_1.assertParamExists('createPaymentInstruction', 'paymentInstruction', paymentInstruction);
+            const localVarPath = `/payments/instruction`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Oauth2 required
+            // oauth required
+            yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = common_1.serializeDataIfNeeded(paymentInstruction, localVarRequestOptions, configuration);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * generate a link token that can be used to create link
          * @param {LinkTokenRequest} linkTokenRequest token request
@@ -246,6 +278,18 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
 exports.CustomerApiFp = function (configuration) {
     const localVarAxiosParamCreator = exports.CustomerApiAxiosParamCreator(configuration);
     return {
+        /**
+         * Create a new payment instruction to be used when linking to perform debit authorization
+         * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentInstruction(paymentInstruction, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createPaymentInstruction(paymentInstruction, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * generate a link token that can be used to create link
          * @param {LinkTokenRequest} linkTokenRequest token request
@@ -330,6 +374,17 @@ exports.CustomerApiFp = function (configuration) {
 exports.CustomerApiFactory = function (configuration, basePath, axios) {
     const localVarFp = exports.CustomerApiFp(configuration);
     return {
+        /**
+         * Create a new payment instruction to be used when linking to perform debit authorization
+         * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentInstruction(paymentInstruction, options) {
+            return localVarFp
+                .createPaymentInstruction(paymentInstruction, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * generate a link token that can be used to create link
          * @param {LinkTokenRequest} linkTokenRequest token request
@@ -398,6 +453,18 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 class CustomerApi extends base_1.BaseAPI {
+    /**
+     * Create a new payment instruction to be used when linking to perform debit authorization
+     * @param {PaymentInstruction} paymentInstruction Request body for starting a new Link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    createPaymentInstruction(paymentInstruction, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .createPaymentInstruction(paymentInstruction, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finverse/sdk-typescript",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -26,7 +26,7 @@
     "@types/node": "^12.11.5",
     "axios-mock-adapter": "^1.20.0",
     "chai": "^4.3.6",
-    "mocha": "^9.2.1",
+    "mocha": "^9.2.2",
     "ts-node": "^10.7.0",
     "typescript": "^3.6.4"
   },