@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20230512.1 → 1.20230518.1

package/.openapi-generator/FILES

@@ -2999,6 +2999,8 @@ models/vbaauth-vbaresponse.ts
 models/vbaauth.ts
 models/vbacommission-rate-subscriber-list-vbaresponse.ts
 models/vbacommission-rate-subscriber.ts
+models/vbafunding-request-claim-summary-list-vbaresponse.ts
+models/vbafunding-request-claim-summary.ts
 models/vbagateway-subscription-detail-list-vbaresponse.ts
 models/vbagateway-subscription-detail-vbaresponse.ts
 models/vbagateway-subscription-detail.ts

package/api/funding-request-claims-api.ts

@@ -28,6 +28,8 @@ import { FundingRequestClaimListVBAResponse } from '../models';
 import { FundingRequestClaimVBAResponse } from '../models';
 // @ts-ignore
 import { MultiCodeResponseListVBAResponse } from '../models';
+// @ts-ignore
+import { VBAFundingRequestClaimSummaryListVBAResponse } from '../models';
 /**
  * FundingRequestClaimsApi - axios parameter creator
  * @export
@@ -249,6 +251,64 @@ export const FundingRequestClaimsApiAxiosParamCreator = function (configuration?
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Lists all FundingRequestClaim Summary for the given requestKey.  The Summary view has additional computed fields that are ot present on the FundingRequestClaim object.
+         * @summary List FundingRequestClaim Summary
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} requestKey Request Key
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listFundingRequestClaimSummary: async (vbasoftwareDatabase: string, requestKey: number, page?: number, pageSize?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'vbasoftwareDatabase' is not null or undefined
+            assertParamExists('listFundingRequestClaimSummary', 'vbasoftwareDatabase', vbasoftwareDatabase)
+            // verify required parameter 'requestKey' is not null or undefined
+            assertParamExists('listFundingRequestClaimSummary', 'requestKey', requestKey)
+            const localVarPath = `/funding-requests/{requestKey}/claims-summary`
+                .replace(`{${"requestKey"}}`, encodeURIComponent(String(requestKey)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication apiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (vbasoftwareDatabase !== undefined && vbasoftwareDatabase !== null) {
+                localVarHeaderParameter['vbasoftware-database'] = String(vbasoftwareDatabase);
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -439,6 +499,20 @@ export const FundingRequestClaimsApiFp = function(configuration?: Configuration)
             const localVarAxiosArgs = await localVarAxiosParamCreator.listFundingRequestClaim(vbasoftwareDatabase, requestKey, page, pageSize, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Lists all FundingRequestClaim Summary for the given requestKey.  The Summary view has additional computed fields that are ot present on the FundingRequestClaim object.
+         * @summary List FundingRequestClaim Summary
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} requestKey Request Key
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listFundingRequestClaimSummary(vbasoftwareDatabase: string, requestKey: number, page?: number, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VBAFundingRequestClaimSummaryListVBAResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listFundingRequestClaimSummary(vbasoftwareDatabase, requestKey, page, pageSize, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Create or Update multiple FundingRequestClaim at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
          * @summary Create or Update Batch FundingRequestClaim
@@ -528,6 +602,19 @@ export const FundingRequestClaimsApiFactory = function (configuration?: Configur
         listFundingRequestClaim(vbasoftwareDatabase: string, requestKey: number, page?: number, pageSize?: number, options?: any): AxiosPromise<FundingRequestClaimListVBAResponse> {
             return localVarFp.listFundingRequestClaim(vbasoftwareDatabase, requestKey, page, pageSize, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists all FundingRequestClaim Summary for the given requestKey.  The Summary view has additional computed fields that are ot present on the FundingRequestClaim object.
+         * @summary List FundingRequestClaim Summary
+         * @param {string} vbasoftwareDatabase Target database
+         * @param {number} requestKey Request Key
+         * @param {number} [page] Page
+         * @param {number} [pageSize] Page Size
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listFundingRequestClaimSummary(vbasoftwareDatabase: string, requestKey: number, page?: number, pageSize?: number, options?: any): AxiosPromise<VBAFundingRequestClaimSummaryListVBAResponse> {
+            return localVarFp.listFundingRequestClaimSummary(vbasoftwareDatabase, requestKey, page, pageSize, options).then((request) => request(axios, basePath));
+        },
         /**
          * Create or Update multiple FundingRequestClaim at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
          * @summary Create or Update Batch FundingRequestClaim
@@ -614,6 +701,19 @@ export interface FundingRequestClaimsApiInterface {
      */
     listFundingRequestClaim(vbasoftwareDatabase: string, requestKey: number, page?: number, pageSize?: number, options?: AxiosRequestConfig): AxiosPromise<FundingRequestClaimListVBAResponse>;
 
+    /**
+     * Lists all FundingRequestClaim Summary for the given requestKey.  The Summary view has additional computed fields that are ot present on the FundingRequestClaim object.
+     * @summary List FundingRequestClaim Summary
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} requestKey Request Key
+     * @param {number} [page] Page
+     * @param {number} [pageSize] Page Size
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FundingRequestClaimsApiInterface
+     */
+    listFundingRequestClaimSummary(vbasoftwareDatabase: string, requestKey: number, page?: number, pageSize?: number, options?: AxiosRequestConfig): AxiosPromise<VBAFundingRequestClaimSummaryListVBAResponse>;
+
     /**
      * Create or Update multiple FundingRequestClaim at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
      * @summary Create or Update Batch FundingRequestClaim
@@ -708,6 +808,21 @@ export class FundingRequestClaimsApi extends BaseAPI implements FundingRequestCl
         return FundingRequestClaimsApiFp(this.configuration).listFundingRequestClaim(vbasoftwareDatabase, requestKey, page, pageSize, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Lists all FundingRequestClaim Summary for the given requestKey.  The Summary view has additional computed fields that are ot present on the FundingRequestClaim object.
+     * @summary List FundingRequestClaim Summary
+     * @param {string} vbasoftwareDatabase Target database
+     * @param {number} requestKey Request Key
+     * @param {number} [page] Page
+     * @param {number} [pageSize] Page Size
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FundingRequestClaimsApi
+     */
+    public listFundingRequestClaimSummary(vbasoftwareDatabase: string, requestKey: number, page?: number, pageSize?: number, options?: AxiosRequestConfig) {
+        return FundingRequestClaimsApiFp(this.configuration).listFundingRequestClaimSummary(vbasoftwareDatabase, requestKey, page, pageSize, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Create or Update multiple FundingRequestClaim at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.
      * @summary Create or Update Batch FundingRequestClaim

package/models/funding.ts

@@ -21,7 +21,7 @@
  */
 export interface Funding {
     /**
-     * ID of the Funding record.
+     * ID of the Funding record.  Note: The database will apply a default value of `0` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `0` to meet the API requirements and ensure that the functionality occurs as expected.
      * @type {number}
      * @memberof Funding
      */
@@ -50,6 +50,18 @@ export interface Funding {
      * @memberof Funding
      */
     'deposit_Key'?: number | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof Funding
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof Funding
+     */
+    'entry_User'?: string | null;
     /**
      * Status of the Funding.
      * @type {string}
@@ -104,5 +116,17 @@ export interface Funding {
      * @memberof Funding
      */
     'received_Date'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof Funding
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof Funding
+     */
+    'update_User'?: string | null;
 }
 

package/models/index.ts

@@ -2202,6 +2202,8 @@ export * from './vbaauth';
 export * from './vbaauth-vbaresponse';
 export * from './vbacommission-rate-subscriber';
 export * from './vbacommission-rate-subscriber-list-vbaresponse';
+export * from './vbafunding-request-claim-summary';
+export * from './vbafunding-request-claim-summary-list-vbaresponse';
 export * from './vbagateway-subscription';
 export * from './vbagateway-subscription-detail';
 export * from './vbagateway-subscription-detail-list-vbaresponse';

package/models/vbafunding-request-claim-summary-list-vbaresponse.ts

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VBASoftware
+ * APIs for VBASoftware
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { Debug } from './debug';
+import { VBAFundingRequestClaimSummary } from './vbafunding-request-claim-summary';
+import { VBAProblemDetails } from './vbaproblem-details';
+
+/**
+ * 
+ * @export
+ * @interface VBAFundingRequestClaimSummaryListVBAResponse
+ */
+export interface VBAFundingRequestClaimSummaryListVBAResponse {
+    /**
+     * 
+     * @type {Array<VBAFundingRequestClaimSummary>}
+     * @memberof VBAFundingRequestClaimSummaryListVBAResponse
+     */
+    'data'?: Array<VBAFundingRequestClaimSummary> | null;
+    /**
+     * 
+     * @type {VBAProblemDetails}
+     * @memberof VBAFundingRequestClaimSummaryListVBAResponse
+     */
+    'error'?: VBAProblemDetails;
+    /**
+     * 
+     * @type {Debug}
+     * @memberof VBAFundingRequestClaimSummaryListVBAResponse
+     */
+    'debug'?: Debug;
+}
+

package/models/vbafunding-request-claim-summary.ts

@@ -0,0 +1,90 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * VBASoftware
+ * APIs for VBASoftware
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * 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 VBAFundingRequestClaimSummary
+ */
+export interface VBAFundingRequestClaimSummary {
+    /**
+     * Gets or sets the claim number.
+     * @type {number}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'claimNumber'?: number;
+    /**
+     * Gets or sets the batch number.
+     * @type {number}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'batchNumber'?: number;
+    /**
+     * Gets or sets the batch claim.
+     * @type {number}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'batchClaim'?: number;
+    /**
+     * Gets or sets the claim paid amount.
+     * @type {number}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'claimPaidAmount'?: number;
+    /**
+     * Gets or sets the claim funded status.
+     * @type {string}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'claimFundedStatus'?: string | null;
+    /**
+     * Gets or sets the claim status.
+     * @type {string}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'claimStatus'?: string | null;
+    /**
+     * Gets or sets a value indicating whether the claim is funded.
+     * @type {boolean}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'funded'?: boolean;
+    /**
+     * Gets or sets the funded date.
+     * @type {string}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'fundedDate'?: string | null;
+    /**
+     * Gets or sets the processed date.
+     * @type {string}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'processedDate'?: string | null;
+    /**
+     * Gets or sets the request amount.
+     * @type {number}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'requestAmount'?: number;
+    /**
+     * Gets or sets the funded amount.
+     * @type {number}
+     * @memberof VBAFundingRequestClaimSummary
+     */
+    'fundedAmount'?: number;
+}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vbasoftware/vbapi-vbasoftware-typescript-axios",
-  "version": "1.20230512.1",
+  "version": "1.20230518.1",
   "description": "APIs for VBASoftware APIs",
   "main": "index.js",
   "scripts": {