Skip to content

Commit ed88bd5

Browse files
AdyenAutomationBotAdyenAutomationBot
committed
[balanceplatform] Automated update from Adyen/adyen-openapi@0a007ce 
1 parent 8f01be8 commit ed88bd5

32 files changed

+1078
-112
lines changed

‎src/services/balancePlatform/index.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import { NetworkTokensApi } from "./networkTokensApi";
2121
import { PaymentInstrumentGroupsApi } from "./paymentInstrumentGroupsApi";
2222
import { PaymentInstrumentsApi } from "./paymentInstrumentsApi";
2323
import { PlatformApi } from "./platformApi";
24+
import { SCAAssociationManagementApi } from "./sCAAssociationManagementApi";
25+
import { SCADeviceManagementApi } from "./sCADeviceManagementApi";
2426
import { TransactionRulesApi } from "./transactionRulesApi";
2527
import { TransferLimitsBalanceAccountLevelApi } from "./transferLimitsBalanceAccountLevelApi";
2628
import { TransferLimitsBalancePlatformLevelApi } from "./transferLimitsBalancePlatformLevelApi";
@@ -91,6 +93,14 @@ export default class BalancePlatformAPI extends Service {
9193
return new PlatformApi(this.client);
9294
}
9395

96+
public get SCAAssociationManagementApi() {
97+
return new SCAAssociationManagementApi(this.client);
98+
}
99+
100+
public get SCADeviceManagementApi() {
101+
return new SCADeviceManagementApi(this.client);
102+
}
103+
94104
public get TransactionRulesApi() {
95105
return new TransactionRulesApi(this.client);
96106
}

‎src/services/balancePlatform/sCAAssociationManagementApi.ts‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
/*
2+
* The version of the OpenAPI document: v2
3+
*
4+
*
5+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6+
* https://openapi-generator.tech
7+
* Do not edit this class manually.
8+
*/
9+
10+
11+
import getJsonResponse from "../../helpers/getJsonResponse";
12+
import Service from "../../service";
13+
import Client from "../../client";
14+
import { IRequest } from "../../typings/requestOptions";
15+
import Resource from "../resource";
16+
17+
import { ObjectSerializer } from "../../typings/balancePlatform/objectSerializer";
18+
import { ApproveAssociationRequest } from "../../typings/balancePlatform/models";
19+
import { ApproveAssociationResponse } from "../../typings/balancePlatform/models";
20+
import { ListAssociationsResponse } from "../../typings/balancePlatform/models";
21+
import { RemoveAssociationRequest } from "../../typings/balancePlatform/models";
22+
import { ScaEntityType } from "../../typings/balancePlatform/models";
23+
24+
/**
25+
* API handler for SCAAssociationManagementApi
26+
*/
27+
export class SCAAssociationManagementApi extends Service {
28+
29+
private readonly API_BASEPATH: string = "https://balanceplatform-api-test.adyen.com/bcl/v2";
30+
private baseUrl: string;
31+
32+
public constructor(client: Client){
33+
super(client);
34+
this.baseUrl = this.createBaseUrl(this.API_BASEPATH);
35+
}
36+
37+
/**
38+
* @summary Approve a pending approval association
39+
* @param approveAssociationRequest {@link ApproveAssociationRequest }
40+
* @param requestOptions {@link IRequest.Options }
41+
* @return {@link ApproveAssociationResponse }
42+
*/
43+
public async approveAssociation(approveAssociationRequest: ApproveAssociationRequest, requestOptions?: IRequest.Options): Promise<ApproveAssociationResponse> {
44+
const endpoint = `${this.baseUrl}/scaAssociations`;
45+
const resource = new Resource(this, endpoint);
46+
47+
const request: ApproveAssociationRequest = ObjectSerializer.serialize(approveAssociationRequest, "ApproveAssociationRequest");
48+
const response = await getJsonResponse<ApproveAssociationRequest, ApproveAssociationResponse>(
49+
resource,
50+
request,
51+
{ ...requestOptions, method: "PATCH" }
52+
);
53+
54+
return ObjectSerializer.deserialize(response, "ApproveAssociationResponse");
55+
}
56+
57+
/**
58+
* @summary Get a list of devices associated with an entity
59+
* @param requestOptions {@link IRequest.Options }
60+
* @param entityType {@link ScaEntityType } (Required) The type of entity you want to retrieve a list of associations for. Possible values: **accountHolder** or **paymentInstrument**.
61+
* @param entityId {@link string } (Required) The unique identifier of the entity.
62+
* @param pageSize {@link number } (Required) The number of items to have on a page. Default: **5**.
63+
* @param pageNumber {@link number } (Required) The index of the page to retrieve. The index of the first page is **0** (zero). Default: **0**.
64+
* @return {@link ListAssociationsResponse }
65+
*/
66+
public async listAssociations(entityType: ScaEntityType, entityId: string, pageSize: number, pageNumber: number, requestOptions?: IRequest.Options): Promise<ListAssociationsResponse> {
67+
const endpoint = `${this.baseUrl}/scaAssociations`;
68+
const resource = new Resource(this, endpoint);
69+
70+
const hasDefinedQueryParams = entityType ?? entityId ?? pageSize ?? pageNumber;
71+
if(hasDefinedQueryParams) {
72+
if(!requestOptions) requestOptions = {};
73+
if(!requestOptions.params) requestOptions.params = {};
74+
if(entityType) requestOptions.params["entityType"] = entityType;
75+
if(entityId) requestOptions.params["entityId"] = entityId;
76+
if(pageSize) requestOptions.params["pageSize"] = pageSize;
77+
if(pageNumber) requestOptions.params["pageNumber"] = pageNumber;
78+
}
79+
const response = await getJsonResponse<string, ListAssociationsResponse>(
80+
resource,
81+
"",
82+
{ ...requestOptions, method: "GET" }
83+
);
84+
85+
return ObjectSerializer.deserialize(response, "ListAssociationsResponse");
86+
}
87+
88+
/**
89+
* @summary Delete association to devices
90+
* @param removeAssociationRequest {@link RemoveAssociationRequest }
91+
* @param requestOptions {@link IRequest.Options }
92+
* @return {@link void }
93+
*/
94+
public async removeAssociation(removeAssociationRequest: RemoveAssociationRequest, requestOptions?: IRequest.Options): Promise<void> {
95+
const endpoint = `${this.baseUrl}/scaAssociations`;
96+
const resource = new Resource(this, endpoint);
97+
98+
const request: RemoveAssociationRequest = ObjectSerializer.serialize(removeAssociationRequest, "RemoveAssociationRequest");
99+
await getJsonResponse<RemoveAssociationRequest, void>(
100+
resource,
101+
request,
102+
{ ...requestOptions, method: "DELETE" }
103+
);
104+
}
105+
106+
}

‎src/services/balancePlatform/sCADeviceManagementApi.ts‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
/*
2+
* The version of the OpenAPI document: v2
3+
*
4+
*
5+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6+
* https://openapi-generator.tech
7+
* Do not edit this class manually.
8+
*/
9+
10+
11+
import getJsonResponse from "../../helpers/getJsonResponse";
12+
import Service from "../../service";
13+
import Client from "../../client";
14+
import { IRequest } from "../../typings/requestOptions";
15+
import Resource from "../resource";
16+
17+
import { ObjectSerializer } from "../../typings/balancePlatform/objectSerializer";
18+
import { BeginScaDeviceRegistrationRequest } from "../../typings/balancePlatform/models";
19+
import { BeginScaDeviceRegistrationResponse } from "../../typings/balancePlatform/models";
20+
import { FinishScaDeviceRegistrationRequest } from "../../typings/balancePlatform/models";
21+
import { FinishScaDeviceRegistrationResponse } from "../../typings/balancePlatform/models";
22+
import { SubmitScaAssociationRequest } from "../../typings/balancePlatform/models";
23+
import { SubmitScaAssociationResponse } from "../../typings/balancePlatform/models";
24+
25+
/**
26+
* API handler for SCADeviceManagementApi
27+
*/
28+
export class SCADeviceManagementApi extends Service {
29+
30+
private readonly API_BASEPATH: string = "https://balanceplatform-api-test.adyen.com/bcl/v2";
31+
private baseUrl: string;
32+
33+
public constructor(client: Client){
34+
super(client);
35+
this.baseUrl = this.createBaseUrl(this.API_BASEPATH);
36+
}
37+
38+
/**
39+
* @summary Begin SCA device registration
40+
* @param beginScaDeviceRegistrationRequest {@link BeginScaDeviceRegistrationRequest }
41+
* @param requestOptions {@link IRequest.Options }
42+
* @return {@link BeginScaDeviceRegistrationResponse }
43+
*/
44+
public async beginScaDeviceRegistration(beginScaDeviceRegistrationRequest: BeginScaDeviceRegistrationRequest, requestOptions?: IRequest.Options): Promise<BeginScaDeviceRegistrationResponse> {
45+
const endpoint = `${this.baseUrl}/scaDevices`;
46+
const resource = new Resource(this, endpoint);
47+
48+
const request: BeginScaDeviceRegistrationRequest = ObjectSerializer.serialize(beginScaDeviceRegistrationRequest, "BeginScaDeviceRegistrationRequest");
49+
const response = await getJsonResponse<BeginScaDeviceRegistrationRequest, BeginScaDeviceRegistrationResponse>(
50+
resource,
51+
request,
52+
{ ...requestOptions, method: "POST" }
53+
);
54+
55+
return ObjectSerializer.deserialize(response, "BeginScaDeviceRegistrationResponse");
56+
}
57+
58+
/**
59+
* @summary Finish registration process for a SCA device
60+
* @param deviceId {@link string } The unique identifier of the SCA device that you are associating with a resource.
61+
* @param finishScaDeviceRegistrationRequest {@link FinishScaDeviceRegistrationRequest }
62+
* @param requestOptions {@link IRequest.Options }
63+
* @return {@link FinishScaDeviceRegistrationResponse }
64+
*/
65+
public async finishScaDeviceRegistration(deviceId: string, finishScaDeviceRegistrationRequest: FinishScaDeviceRegistrationRequest, requestOptions?: IRequest.Options): Promise<FinishScaDeviceRegistrationResponse> {
66+
const endpoint = `${this.baseUrl}/scaDevices/{deviceId}`
67+
.replace("{" + "deviceId" + "}", encodeURIComponent(String(deviceId)));
68+
const resource = new Resource(this, endpoint);
69+
70+
const request: FinishScaDeviceRegistrationRequest = ObjectSerializer.serialize(finishScaDeviceRegistrationRequest, "FinishScaDeviceRegistrationRequest");
71+
const response = await getJsonResponse<FinishScaDeviceRegistrationRequest, FinishScaDeviceRegistrationResponse>(
72+
resource,
73+
request,
74+
{ ...requestOptions, method: "PATCH" }
75+
);
76+
77+
return ObjectSerializer.deserialize(response, "FinishScaDeviceRegistrationResponse");
78+
}
79+
80+
/**
81+
* @summary Create a new SCA association for a device
82+
* @param deviceId {@link string } The unique identifier of the SCA device that you are associating with a resource.
83+
* @param submitScaAssociationRequest {@link SubmitScaAssociationRequest }
84+
* @param requestOptions {@link IRequest.Options }
85+
* @return {@link SubmitScaAssociationResponse }
86+
*/
87+
public async submitScaAssociation(deviceId: string, submitScaAssociationRequest: SubmitScaAssociationRequest, requestOptions?: IRequest.Options): Promise<SubmitScaAssociationResponse> {
88+
const endpoint = `${this.baseUrl}/scaDevices/{deviceId}/scaAssociations`
89+
.replace("{" + "deviceId" + "}", encodeURIComponent(String(deviceId)));
90+
const resource = new Resource(this, endpoint);
91+
92+
const request: SubmitScaAssociationRequest = ObjectSerializer.serialize(submitScaAssociationRequest, "SubmitScaAssociationRequest");
93+
const response = await getJsonResponse<SubmitScaAssociationRequest, SubmitScaAssociationResponse>(
94+
resource,
95+
request,
96+
{ ...requestOptions, method: "POST" }
97+
);
98+
99+
return ObjectSerializer.deserialize(response, "SubmitScaAssociationResponse");
100+
}
101+
102+
}

‎src/typings/balancePlatform/amount.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
export class Amount {
1212
/**
13-
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).
13+
* The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
1414
*/
1515
"currency": string;
1616
/**
17-
* The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
17+
* The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
1818
*/
1919
"value": number;
2020

‎src/typings/balancePlatform/approveAssociationRequest.ts‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/*
2+
* The version of the OpenAPI document: v2
3+
*
4+
*
5+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6+
* https://openapi-generator.tech
7+
* Do not edit this class manually.
8+
*/
9+
10+
import { AssociationStatus } from "./associationStatus";
11+
import { ScaEntityType } from "./scaEntityType";
12+
13+
14+
export class ApproveAssociationRequest {
15+
/**
16+
* The unique identifier of the entity.
17+
*/
18+
"entityId": string;
19+
"entityType": ScaEntityType;
20+
/**
21+
* List of device ids associated to the entity that will be approved.
22+
*/
23+
"scaDeviceIds": Array<string>;
24+
"status": AssociationStatus;
25+
26+
static readonly discriminator: string | undefined = undefined;
27+
28+
static readonly mapping: {[index: string]: string} | undefined = undefined;
29+
30+
static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
31+
{
32+
"name": "entityId",
33+
"baseName": "entityId",
34+
"type": "string",
35+
"format": ""
36+
},
37+
{
38+
"name": "entityType",
39+
"baseName": "entityType",
40+
"type": "ScaEntityType",
41+
"format": ""
42+
},
43+
{
44+
"name": "scaDeviceIds",
45+
"baseName": "scaDeviceIds",
46+
"type": "Array<string>",
47+
"format": ""
48+
},
49+
{
50+
"name": "status",
51+
"baseName": "status",
52+
"type": "AssociationStatus",
53+
"format": ""
54+
} ];
55+
56+
static getAttributeTypeMap() {
57+
return ApproveAssociationRequest.attributeTypeMap;
58+
}
59+
60+
public constructor() {
61+
}
62+
}
63+
64+
export namespace ApproveAssociationRequest {
65+
}

‎src/typings/balancePlatform/approveAssociationResponse.ts‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* The version of the OpenAPI document: v2
3+
*
4+
*
5+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
6+
* https://openapi-generator.tech
7+
* Do not edit this class manually.
8+
*/
9+
10+
import { Association } from "./association";
11+
12+
13+
export class ApproveAssociationResponse {
14+
/**
15+
* The list of associations.
16+
*/
17+
"scaAssociations": Array<Association>;
18+
19+
static readonly discriminator: string | undefined = undefined;
20+
21+
static readonly mapping: {[index: string]: string} | undefined = undefined;
22+
23+
static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
24+
{
25+
"name": "scaAssociations",
26+
"baseName": "scaAssociations",
27+
"type": "Array<Association>",
28+
"format": ""
29+
} ];
30+
31+
static getAttributeTypeMap() {
32+
return ApproveAssociationResponse.attributeTypeMap;
33+
}
34+
35+
public constructor() {
36+
}
37+
}
38+

0 commit comments

Comments
 (0)