@finverse/sdk-typescript 0.0.8 → 0.0.11

package/dist/api.d.ts

@@ -1043,6 +1043,81 @@ export interface IdentityPhoneNumber {
      */
     account_ids?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface IncomeEstimate
+ */
+export interface IncomeEstimate {
+    /**
+     * Income amount
+     * @type {number}
+     * @memberof IncomeEstimate
+     */
+    amount?: number;
+    /**
+     * Currency
+     * @type {string}
+     * @memberof IncomeEstimate
+     */
+    currency?: string;
+}
+/**
+ *
+ * @export
+ * @interface IncomeResponse
+ */
+export interface IncomeResponse {
+    /**
+     *
+     * @type {Array<SingleSourceIncome>}
+     * @memberof IncomeResponse
+     */
+    income?: Array<SingleSourceIncome>;
+    /**
+     *
+     * @type {LoginIdentityShort}
+     * @memberof IncomeResponse
+     */
+    login_identity?: LoginIdentityShort;
+    /**
+     *
+     * @type {InstitutionShort}
+     * @memberof IncomeResponse
+     */
+    institution?: InstitutionShort;
+}
+/**
+ *
+ * @export
+ * @interface IncomeStream
+ */
+export interface IncomeStream {
+    /**
+     * Account this income estimate is associated with
+     * @type {string}
+     * @memberof IncomeStream
+     */
+    account_id?: string;
+    /**
+     *
+     * @type {IncomeEstimate}
+     * @memberof IncomeStream
+     */
+    estimated_monthly_income?: IncomeEstimate;
+    /**
+     * Number of transactions counted towards income
+     * @type {number}
+     * @memberof IncomeStream
+     */
+    transaction_count?: number;
+    /**
+     *
+     * @type {Array<MonthlyIncomeEstimate>}
+     * @memberof IncomeStream
+     */
+    monthly_history?: Array<MonthlyIncomeEstimate>;
+}
 /**
  *
  * @export
@@ -1416,6 +1491,31 @@ export interface ListAccountsResponse {
      */
     institution?: InstitutionShort;
 }
+/**
+ *
+ * @export
+ * @interface ListPaymentInstructionsResponse
+ */
+export interface ListPaymentInstructionsResponse {
+    /**
+     *
+     * @type {Array<PaymentInstruction>}
+     * @memberof ListPaymentInstructionsResponse
+     */
+    payment_instructions?: Array<PaymentInstruction>;
+    /**
+     *
+     * @type {LoginIdentityShort}
+     * @memberof ListPaymentInstructionsResponse
+     */
+    login_identity?: LoginIdentityShort;
+    /**
+     *
+     * @type {InstitutionShort}
+     * @memberof ListPaymentInstructionsResponse
+     */
+    institution?: InstitutionShort;
+}
 /**
  *
  * @export
@@ -1749,6 +1849,31 @@ export interface LoginMethod {
      */
     login_fields?: Array<LoginField>;
 }
+/**
+ *
+ * @export
+ * @interface MonthlyIncomeEstimate
+ */
+export interface MonthlyIncomeEstimate {
+    /**
+     *
+     * @type {IncomeEstimate}
+     * @memberof MonthlyIncomeEstimate
+     */
+    estimated_income?: IncomeEstimate;
+    /**
+     * The numeric month
+     * @type {number}
+     * @memberof MonthlyIncomeEstimate
+     */
+    month?: number;
+    /**
+     * The year
+     * @type {number}
+     * @memberof MonthlyIncomeEstimate
+     */
+    year?: number;
+}
 /**
  *
  * @export
@@ -1835,6 +1960,12 @@ export interface PaymentInstruction {
      * @memberof PaymentInstruction
      */
     recipient_name?: string;
+    /**
+     * The recipient account Id
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    recipient_account_id?: string;
     /**
      * The sender name
      * @type {string}
@@ -1889,6 +2020,12 @@ export interface PaymentInstruction {
      * @memberof PaymentInstruction
      */
     idempotence_key?: string;
+    /**
+     * Status of the payment
+     * @type {string}
+     * @memberof PaymentInstruction
+     */
+    payment_status?: string;
 }
 export declare const PaymentInstructionPaymentTypeEnum: {
     readonly DebitAuthorization: "DEBIT_AUTHORIZATION";
@@ -2025,6 +2162,62 @@ export interface RelinkRequest {
      */
     store_credential: boolean;
 }
+/**
+ *
+ * @export
+ * @interface SingleSourceIncome
+ */
+export interface SingleSourceIncome {
+    /**
+     *
+     * @type {Array<IncomeStream>}
+     * @memberof SingleSourceIncome
+     */
+    income_streams?: Array<IncomeStream>;
+    /**
+     *
+     * @type {SingleSourceIncomeIncomeTotal}
+     * @memberof SingleSourceIncome
+     */
+    income_total?: SingleSourceIncomeIncomeTotal;
+    /**
+     * Where the income estimate was sourced from
+     * @type {string}
+     * @memberof SingleSourceIncome
+     */
+    source?: string;
+    /**
+     * Unknown
+     * @type {string}
+     * @memberof SingleSourceIncome
+     */
+    source_id?: string;
+}
+/**
+ *
+ * @export
+ * @interface SingleSourceIncomeIncomeTotal
+ */
+export interface SingleSourceIncomeIncomeTotal {
+    /**
+     *
+     * @type {IncomeEstimate}
+     * @memberof SingleSourceIncomeIncomeTotal
+     */
+    estmated_monthly_income?: IncomeEstimate;
+    /**
+     * Number of transactions counted towards income
+     * @type {number}
+     * @memberof SingleSourceIncomeIncomeTotal
+     */
+    transaction_count?: number;
+    /**
+     *
+     * @type {Array<MonthlyIncomeEstimate>}
+     * @memberof SingleSourceIncomeIncomeTotal
+     */
+    monthly_history?: Array<MonthlyIncomeEstimate>;
+}
 /**
  *
  * @export
@@ -2835,6 +3028,12 @@ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     getIdentity: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get income figures for a login identity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIncomeByLoginIdentityId: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a specific loginIdentity
      * @param {*} [options] Override http request option.
@@ -2867,6 +3066,12 @@ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     listAccounts: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get list of payment instructions to be used when linking to perfom debit authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPaymentInstructions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -2936,6 +3141,12 @@ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getIdentity(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIdentityResponse>>;
+    /**
+     * Get income figures for a login identity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIncomeByLoginIdentityId(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IncomeResponse>>;
     /**
      * Get a specific loginIdentity
      * @param {*} [options] Override http request option.
@@ -2968,6 +3179,12 @@ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listAccounts(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponse>>;
+    /**
+     * Get list of payment instructions to be used when linking to perfom debit authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPaymentInstructions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentInstructionsResponse>>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -3037,6 +3254,12 @@ export declare const LoginIdentityApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getIdentity(options?: any): AxiosPromise<GetIdentityResponse>;
+    /**
+     * Get income figures for a login identity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getIncomeByLoginIdentityId(options?: any): AxiosPromise<IncomeResponse>;
     /**
      * Get a specific loginIdentity
      * @param {*} [options] Override http request option.
@@ -3069,6 +3292,12 @@ export declare const LoginIdentityApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     listAccounts(options?: any): AxiosPromise<ListAccountsResponse>;
+    /**
+     * Get list of payment instructions to be used when linking to perfom debit authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPaymentInstructions(options?: any): AxiosPromise<ListPaymentInstructionsResponse>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -3145,6 +3374,13 @@ export interface LoginIdentityApiInterface {
      * @memberof LoginIdentityApiInterface
      */
     getIdentity(options?: AxiosRequestConfig): AxiosPromise<GetIdentityResponse>;
+    /**
+     * Get income figures for a login identity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LoginIdentityApiInterface
+     */
+    getIncomeByLoginIdentityId(options?: AxiosRequestConfig): AxiosPromise<IncomeResponse>;
     /**
      * Get a specific loginIdentity
      * @param {*} [options] Override http request option.
@@ -3182,6 +3418,13 @@ export interface LoginIdentityApiInterface {
      * @memberof LoginIdentityApiInterface
      */
     listAccounts(options?: AxiosRequestConfig): AxiosPromise<ListAccountsResponse>;
+    /**
+     * Get list of payment instructions to be used when linking to perfom debit authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LoginIdentityApiInterface
+     */
+    listPaymentInstructions(options?: AxiosRequestConfig): AxiosPromise<ListPaymentInstructionsResponse>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -3262,6 +3505,13 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
      * @memberof LoginIdentityApi
      */
     getIdentity(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIdentityResponse>>;
+    /**
+     * Get income figures for a login identity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LoginIdentityApi
+     */
+    getIncomeByLoginIdentityId(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IncomeResponse>>;
     /**
      * Get a specific loginIdentity
      * @param {*} [options] Override http request option.
@@ -3299,6 +3549,13 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
      * @memberof LoginIdentityApi
      */
     listAccounts(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAccountsResponse>>;
+    /**
+     * Get list of payment instructions to be used when linking to perfom debit authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LoginIdentityApi
+     */
+    listPaymentInstructions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentInstructionsResponse>>;
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)

package/dist/api.js

@@ -1134,6 +1134,33 @@ exports.LoginIdentityApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get income figures for a login identity
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getIncomeByLoginIdentityId: (options = {}) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/income`;
+            // 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: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Oauth2 required
+            // oauth required
+            yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
+            common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Get a specific loginIdentity
          * @param {*} [options] Override http request option.
@@ -1275,6 +1302,33 @@ exports.LoginIdentityApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get list of payment instructions to be used when linking to perfom debit authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPaymentInstructions: (options = {}) => __awaiter(this, void 0, void 0, function* () {
+            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: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Oauth2 required
+            // oauth required
+            yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
+            common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
          * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -1454,6 +1508,17 @@ exports.LoginIdentityApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get income figures for a login identity
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getIncomeByLoginIdentityId(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getIncomeByLoginIdentityId(options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Get a specific loginIdentity
          * @param {*} [options] Override http request option.
@@ -1511,6 +1576,17 @@ exports.LoginIdentityApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get list of payment instructions to be used when linking to perfom debit authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPaymentInstructions(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listPaymentInstructions(options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
          * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -1610,6 +1686,14 @@ exports.LoginIdentityApiFactory = function (configuration, basePath, axios) {
         getIdentity(options) {
             return localVarFp.getIdentity(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get income figures for a login identity
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getIncomeByLoginIdentityId(options) {
+            return localVarFp.getIncomeByLoginIdentityId(options).then((request) => request(axios, basePath));
+        },
         /**
          * Get a specific loginIdentity
          * @param {*} [options] Override http request option.
@@ -1652,6 +1736,14 @@ exports.LoginIdentityApiFactory = function (configuration, basePath, axios) {
         listAccounts(options) {
             return localVarFp.listAccounts(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get list of payment instructions to be used when linking to perfom debit authorization
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPaymentInstructions(options) {
+            return localVarFp.listPaymentInstructions(options).then((request) => request(axios, basePath));
+        },
         /**
          * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
          * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
@@ -1764,6 +1856,17 @@ class LoginIdentityApi extends base_1.BaseAPI {
             .getIdentity(options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get income figures for a login identity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LoginIdentityApi
+     */
+    getIncomeByLoginIdentityId(options) {
+        return exports.LoginIdentityApiFp(this.configuration)
+            .getIncomeByLoginIdentityId(options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get a specific loginIdentity
      * @param {*} [options] Override http request option.
@@ -1821,6 +1924,17 @@ class LoginIdentityApi extends base_1.BaseAPI {
             .listAccounts(options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get list of payment instructions to be used when linking to perfom debit authorization
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LoginIdentityApi
+     */
+    listPaymentInstructions(options) {
+        return exports.LoginIdentityApiFp(this.configuration)
+            .listPaymentInstructions(options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
      * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finverse/sdk-typescript",
-  "version": "0.0.8",
+  "version": "0.0.11",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [