[balanceplatform] Automated update from Adyen/adyen-openapi@d667e61

Author: AdyenAutomationBot

src/services/balancePlatform/accountHoldersApi.ts

@@ -20,6 +20,7 @@ import { AccountHolderInfo } from "../../typings/balancePlatform/models";
 import { AccountHolderUpdateRequest } from "../../typings/balancePlatform/models";
 import { GetTaxFormResponse } from "../../typings/balancePlatform/models";
 import { PaginatedBalanceAccountsResponse } from "../../typings/balancePlatform/models";
+import { TaxFormSummaryResponse } from "../../typings/balancePlatform/models";
 import { TransactionRulesResponse } from "../../typings/balancePlatform/models";
 
 /**
@@ -128,9 +129,9 @@ export class AccountHoldersApi extends Service {
     * @summary Get a tax form
     * @param id {@link string } The unique identifier of the account holder.
     * @param requestOptions {@link IRequest.Options }
-    * @param formType {@link 'US1099k' | 'US1099nec' } (Required) The type of tax form you want to retrieve. Accepted values are **US1099k** and **US1099nec**
-    * @param year {@link number } (Required) The tax year in YYYY format for the tax form you want to retrieve
-    * @param legalEntityId {@link string } The legal entity reference whose tax form you want to retrieve
+    * @param formType {@link 'US1099k' | 'US1099nec' } (Required) The type of tax form you want to retrieve. Accepted values are **US1099k** and **US1099nec**.
+    * @param year {@link number } (Required) The tax year in **YYYY** format for the tax form you want to retrieve.
+    * @param legalEntityId {@link string } The legal entity reference whose tax form you want to retrieve.
     * @return {@link GetTaxFormResponse }
     */
     public async getTaxForm(id: string, formType: "US1099k" | "US1099nec", year: number, legalEntityId?: string, requestOptions?: IRequest.Options): Promise<GetTaxFormResponse> {
@@ -155,6 +156,33 @@ export class AccountHoldersApi extends Service {
         return ObjectSerializer.deserialize(response, "GetTaxFormResponse");
     }
 
+    /**
+    * @summary Get summary of tax forms for an account holder
+    * @param id {@link string } The unique identifier of the account holder.
+    * @param requestOptions {@link IRequest.Options }
+    * @param formType {@link string } (Required) The type of tax form you want a summary for. Accepted values are **US1099k** and **US1099nec**.
+    * @return {@link TaxFormSummaryResponse }
+    */
+    public async getTaxFormSummary(id: string, formType: string, requestOptions?: IRequest.Options): Promise<TaxFormSummaryResponse> {
+        const endpoint = `${this.baseUrl}/accountHolders/{id}/taxFormSummary`
+            .replace("{" + "id" + "}", encodeURIComponent(String(id)));
+        const resource = new Resource(this, endpoint);
+        
+        const hasDefinedQueryParams = formType;
+        if(hasDefinedQueryParams) {
+            if(!requestOptions) requestOptions = {};
+            if(!requestOptions.params) requestOptions.params = {};
+            if(formType) requestOptions.params["formType"] = formType;
+        }
+        const response = await getJsonResponse<string, TaxFormSummaryResponse>(
+            resource,
+            "",
+            { ...requestOptions, method: "GET" }
+        );
+
+        return ObjectSerializer.deserialize(response, "TaxFormSummaryResponse");
+    }
+
     /**
     * @summary Update an account holder
     * @param id {@link string } The unique identifier of the account holder.

src/typings/balancePlatform/models.ts

@@ -170,11 +170,13 @@ export * from "./sourceAccountTypesRestriction"
 export * from "./stringMatch"
 export * from "./submitScaAssociationRequest"
 export * from "./submitScaAssociationResponse"
+export * from "./summary"
 export * from "./sweepConfigurationV2"
 export * from "./sweepCounterparty"
 export * from "./sweepSchedule"
 export * from "./target"
 export * from "./targetUpdate"
+export * from "./taxFormSummaryResponse"
 export * from "./thresholdRepayment"
 export * from "./timeOfDay"
 export * from "./timeOfDayRestriction"

src/typings/balancePlatform/objectSerializer.ts

@@ -172,11 +172,13 @@ import { SourceAccountTypesRestriction } from "./sourceAccountTypesRestriction";
 import { StringMatch } from "./stringMatch";
 import { SubmitScaAssociationRequest } from "./submitScaAssociationRequest";
 import { SubmitScaAssociationResponse } from "./submitScaAssociationResponse";
+import { Summary } from "./summary";
 import { SweepConfigurationV2 } from "./sweepConfigurationV2";
 import { SweepCounterparty } from "./sweepCounterparty";
 import { SweepSchedule } from "./sweepSchedule";
 import { Target } from "./target";
 import { TargetUpdate } from "./targetUpdate";
+import { TaxFormSummaryResponse } from "./taxFormSummaryResponse";
 import { ThresholdRepayment } from "./thresholdRepayment";
 import { TimeOfDay } from "./timeOfDay";
 import { TimeOfDayRestriction } from "./timeOfDayRestriction";
@@ -555,11 +557,13 @@ let typeMap: {[index: string]: any} = {
     "StringMatch": StringMatch,
     "SubmitScaAssociationRequest": SubmitScaAssociationRequest,
     "SubmitScaAssociationResponse": SubmitScaAssociationResponse,
+    "Summary": Summary,
     "SweepConfigurationV2": SweepConfigurationV2,
     "SweepCounterparty": SweepCounterparty,
     "SweepSchedule": SweepSchedule,
     "Target": Target,
     "TargetUpdate": TargetUpdate,
+    "TaxFormSummaryResponse": TaxFormSummaryResponse,
     "ThresholdRepayment": ThresholdRepayment,
     "TimeOfDay": TimeOfDay,
     "TimeOfDayRestriction": TimeOfDayRestriction,

src/typings/balancePlatform/summary.ts

@@ -0,0 +1,46 @@
+/*
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+
+export class Summary {
+    /**
+    * The unique identifier of the legal entity.
+    */
+    "legalEntityId": string;
+    /**
+    * The tax years for which the legal entity has a tax form.
+    */
+    "taxYears": Array<number>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "legalEntityId",
+            "baseName": "legalEntityId",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "taxYears",
+            "baseName": "taxYears",
+            "type": "Array<number>",
+            "format": "int32"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Summary.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

src/typings/balancePlatform/taxFormSummaryResponse.ts

@@ -0,0 +1,38 @@
+/*
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+import { Summary } from "./summary";
+
+
+export class TaxFormSummaryResponse {
+    /**
+    * A list of tax form summaries, where each summary consists of the legal entity and the tax years in which the legal entity has a tax form.
+    */
+    "data": Array<Summary>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "data",
+            "baseName": "data",
+            "type": "Array<Summary>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return TaxFormSummaryResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+