Skip to content

Commit 112be8b

Browse files
authored
Merge pull request #1423 from Adyen/sdk-automation/models
Update all services
2 parents b9e0df2 + f55e06f commit 112be8b

File tree

71 files changed

+252
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+252
-0
lines changed

src/services/checkout/classicCheckoutSDKApi.ts

+4
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ export class ClassicCheckoutSDKApi extends Service {
3535
* @param paymentSetupRequest {@link PaymentSetupRequest }
3636
* @param requestOptions {@link IRequest.Options }
3737
* @return {@link PaymentSetupResponse }
38+
*
39+
* @deprecated since Adyen Checkout API v37
3840
*/
3941
public async paymentSession(paymentSetupRequest: PaymentSetupRequest, requestOptions?: IRequest.Options): Promise<PaymentSetupResponse> {
4042
const endpoint = `${this.baseUrl}/paymentSession`;
@@ -53,6 +55,8 @@ export class ClassicCheckoutSDKApi extends Service {
5355
* @param paymentVerificationRequest {@link PaymentVerificationRequest }
5456
* @param requestOptions {@link IRequest.Options }
5557
* @return {@link PaymentVerificationResponse }
58+
*
59+
* @deprecated since Adyen Checkout API v37
5660
*/
5761
public async verifyPaymentResult(paymentVerificationRequest: PaymentVerificationRequest, requestOptions?: IRequest.Options): Promise<PaymentVerificationResponse> {
5862
const endpoint = `${this.baseUrl}/payments/result`;

src/services/checkout/utilityApi.ts

+2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ export class UtilityApi extends Service {
5555
* @param utilityRequest {@link UtilityRequest }
5656
* @param requestOptions {@link IRequest.Options }
5757
* @return {@link UtilityResponse }
58+
*
59+
* @deprecated since Adyen Checkout API v67
5860
*/
5961
public async originKeys(utilityRequest: UtilityRequest, requestOptions?: IRequest.Options): Promise<UtilityResponse> {
6062
const endpoint = `${this.baseUrl}/originKeys`;

src/services/paymentApi.ts

+2
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,8 @@ export class PaymentAPI extends Service {
172172
* @param donationRequest {@link DonationRequest }
173173
* @param requestOptions {@link IRequest.Options }
174174
* @return {@link ModificationResult }
175+
*
176+
* @deprecated
175177
*/
176178
public async donate(donationRequest: DonationRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
177179
const endpoint = `${this.baseUrl}/donate`;

src/typings/balancePlatform/accountHolder.ts

+3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ export class AccountHolder {
2020
* Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.
2121
*/
2222
'capabilities'?: { [key: string]: AccountHolderCapability; };
23+
/**
24+
* @deprecated
25+
*/
2326
'contactDetails'?: ContactDetails;
2427
/**
2528
* Your description for the account holder.

src/typings/balancePlatform/accountHolderInfo.ts

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class AccountHolderInfo {
1919
* Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.
2020
*/
2121
'capabilities'?: { [key: string]: AccountHolderCapability; };
22+
/**
23+
* @deprecated
24+
*/
2225
'contactDetails'?: ContactDetails;
2326
/**
2427
* Your description for the account holder.

src/typings/balancePlatform/accountHolderUpdateRequest.ts

+3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ export class AccountHolderUpdateRequest {
2020
* Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.
2121
*/
2222
'capabilities'?: { [key: string]: AccountHolderCapability; };
23+
/**
24+
* @deprecated
25+
*/
2326
'contactDetails'?: ContactDetails;
2427
/**
2528
* Your description for the account holder.

src/typings/balancePlatform/paymentInstrument.ts

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ import { IbanAccountIdentification } from './ibanAccountIdentification';
1414
export class PaymentInstrument {
1515
/**
1616
* Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
17+
*
18+
* @deprecated since Configuration API v2
19+
* Please use `bankAccount` object instead
1720
*/
1821
'additionalBankAccountIdentifications'?: Array<IbanAccountIdentification>;
1922
/**

src/typings/balancePlatform/updatePaymentInstrument.ts

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ import { IbanAccountIdentification } from './ibanAccountIdentification';
1414
export class UpdatePaymentInstrument {
1515
/**
1616
* Contains optional, additional business account details. Returned when you create a payment instrument with `type` **bankAccount**.
17+
*
18+
* @deprecated since Configuration API v2
19+
* Please use `bankAccount` object instead
1720
*/
1821
'additionalBankAccountIdentifications'?: Array<IbanAccountIdentification>;
1922
/**

src/typings/checkout/accountInfo.ts

+9
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,16 @@ export class AccountInfo {
4343
'deliveryAddressUsageIndicator'?: AccountInfo.DeliveryAddressUsageIndicatorEnum;
4444
/**
4545
* Shopper\'s home phone number (including the country code).
46+
*
47+
* @deprecated since Adyen Checkout API v68
48+
* Use `ThreeDS2RequestData.homePhone` instead.
4649
*/
4750
'homePhone'?: string;
4851
/**
4952
* Shopper\'s mobile phone number (including the country code).
53+
*
54+
* @deprecated since Adyen Checkout API v68
55+
* Use `ThreeDS2RequestData.mobilePhone` instead.
5056
*/
5157
'mobilePhone'?: string;
5258
/**
@@ -83,6 +89,9 @@ export class AccountInfo {
8389
'suspiciousActivity'?: boolean;
8490
/**
8591
* Shopper\'s work phone number (including the country code).
92+
*
93+
* @deprecated since Adyen Checkout API v68
94+
* Use `ThreeDS2RequestData.workPhone` instead.
8695
*/
8796
'workPhone'?: string;
8897

src/typings/checkout/achDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ export class AchDetails {
3939
'ownerName'?: string;
4040
/**
4141
* This is the `recurringDetailReference` returned in the response when you created the token.
42+
*
43+
* @deprecated since Adyen Checkout API v49
44+
* Use `storedPaymentMethodId` instead.
4245
*/
4346
'recurringDetailReference'?: string;
4447
/**

src/typings/checkout/additionalData3DSecure.ts

+6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
export class AdditionalData3DSecure {
1212
/**
1313
* Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2). > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen selects redirect or native authentication based on your configuration to optimize authorization rates and improve the shopper\'s experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen offers redirect 3D Secure 2 authentication instead, based on your configuration.
14+
*
15+
* @deprecated since Adyen Checkout API v69
16+
* Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.
1417
*/
1518
'allow3DS2'?: string;
1619
/**
@@ -19,6 +22,9 @@ export class AdditionalData3DSecure {
1922
'challengeWindowSize'?: AdditionalData3DSecure.ChallengeWindowSizeEnum;
2023
/**
2124
* Indicates if you want to perform 3D Secure authentication on a transaction. > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don\'t perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations.
25+
*
26+
* @deprecated since Adyen Checkout API v69
27+
* Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead
2228
*/
2329
'executeThreeD'?: string;
2430
/**

src/typings/checkout/afterpayDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ export class AfterpayDetails {
2727
'personalDetails'?: string;
2828
/**
2929
* This is the `recurringDetailReference` returned in the response when you created the token.
30+
*
31+
* @deprecated since Adyen Checkout API v49
32+
* Use `storedPaymentMethodId` instead.
3033
*/
3134
'recurringDetailReference'?: string;
3235
/**

src/typings/checkout/ancvDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class AncvDetails {
1919
'checkoutAttemptId'?: string;
2020
/**
2121
* This is the `recurringDetailReference` returned in the response when you created the token.
22+
*
23+
* @deprecated since Adyen Checkout API v49
24+
* Use `storedPaymentMethodId` instead.
2225
*/
2326
'recurringDetailReference'?: string;
2427
/**

src/typings/checkout/applePayDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ export class ApplePayDetails {
2323
'fundingSource'?: ApplePayDetails.FundingSourceEnum;
2424
/**
2525
* This is the `recurringDetailReference` returned in the response when you created the token.
26+
*
27+
* @deprecated since Adyen Checkout API v49
28+
* Use `storedPaymentMethodId` instead.
2629
*/
2730
'recurringDetailReference'?: string;
2831
/**

src/typings/checkout/applePayDonations.ts

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ export class ApplePayDonations {
2323
'fundingSource'?: ApplePayDonations.FundingSourceEnum;
2424
/**
2525
* This is the `recurringDetailReference` returned in the response when you created the token.
26+
*
27+
* @deprecated since Adyen Checkout API v49
28+
* Use `storedPaymentMethodId` instead.
2629
*/
2730
'recurringDetailReference'?: string;
2831
/**

src/typings/checkout/bacsDirectDebitDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ export class BacsDirectDebitDetails {
2727
'holderName'?: string;
2828
/**
2929
* This is the `recurringDetailReference` returned in the response when you created the token.
30+
*
31+
* @deprecated since Adyen Checkout API v49
32+
* Use `storedPaymentMethodId` instead.
3033
*/
3134
'recurringDetailReference'?: string;
3235
/**

src/typings/checkout/balanceCheckRequest.ts

+3
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,9 @@ export class BalanceCheckRequest {
148148
'threeDS2RequestData'?: ThreeDS2RequestData;
149149
/**
150150
* If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
151+
*
152+
* @deprecated since Adyen Checkout API v69
153+
* Use `authenticationData.authenticationOnly` instead.
151154
*/
152155
'threeDSAuthenticationOnly'?: boolean;
153156
/**

src/typings/checkout/blikDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class BlikDetails {
1919
'checkoutAttemptId'?: string;
2020
/**
2121
* This is the `recurringDetailReference` returned in the response when you created the token.
22+
*
23+
* @deprecated since Adyen Checkout API v49
24+
* Use `storedPaymentMethodId` instead.
2225
*/
2326
'recurringDetailReference'?: string;
2427
/**

src/typings/checkout/cardDetails.ts

+6
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ export class CardDetails {
1717
* The checkout attempt identifier.
1818
*/
1919
'checkoutAttemptId'?: string;
20+
/**
21+
* @deprecated
22+
*/
2023
'cupsecureplus_smscode'?: string;
2124
/**
2225
* The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
@@ -64,6 +67,9 @@ export class CardDetails {
6467
'number'?: string;
6568
/**
6669
* This is the `recurringDetailReference` returned in the response when you created the token.
70+
*
71+
* @deprecated since Adyen Checkout API v49
72+
* Use `storedPaymentMethodId` instead.
6773
*/
6874
'recurringDetailReference'?: string;
6975
/**

src/typings/checkout/cardDonations.ts

+6
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ export class CardDonations {
1717
* The checkout attempt identifier.
1818
*/
1919
'checkoutAttemptId'?: string;
20+
/**
21+
* @deprecated
22+
*/
2023
'cupsecureplus_smscode'?: string;
2124
/**
2225
* The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
@@ -64,6 +67,9 @@ export class CardDonations {
6467
'number'?: string;
6568
/**
6669
* This is the `recurringDetailReference` returned in the response when you created the token.
70+
*
71+
* @deprecated since Adyen Checkout API v49
72+
* Use `storedPaymentMethodId` instead.
6773
*/
6874
'recurringDetailReference'?: string;
6975
/**

src/typings/checkout/cashAppDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ export class CashAppDetails {
3131
'onFileGrantId'?: string;
3232
/**
3333
* This is the `recurringDetailReference` returned in the response when you created the token.
34+
*
35+
* @deprecated since Adyen Checkout API v49
36+
* Use `storedPaymentMethodId` instead.
3437
*/
3538
'recurringDetailReference'?: string;
3639
/**

src/typings/checkout/createCheckoutSessionRequest.ts

+3
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,9 @@ export class CreateCheckoutSessionRequest {
217217
'threeDS2RequestData'?: CheckoutSessionThreeDS2RequestData;
218218
/**
219219
* If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
220+
*
221+
* @deprecated since Adyen Checkout API v69
222+
* Use `authenticationData.authenticationOnly` instead.
220223
*/
221224
'threeDSAuthenticationOnly'?: boolean;
222225
/**

src/typings/checkout/createCheckoutSessionResponse.ts

+3
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,9 @@ export class CreateCheckoutSessionResponse {
225225
'threeDS2RequestData'?: CheckoutSessionThreeDS2RequestData;
226226
/**
227227
* If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
228+
*
229+
* @deprecated since Adyen Checkout API v69
230+
* Use `authenticationData.authenticationOnly` instead.
228231
*/
229232
'threeDSAuthenticationOnly'?: boolean;
230233
/**

src/typings/checkout/donationPaymentRequest.ts

+6
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ export class DonationPaymentRequest {
4646
'checkoutAttemptId'?: string;
4747
/**
4848
* Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
49+
*
50+
* @deprecated since Adyen Checkout API v68
51+
* Use `checkoutAttemptId` instead
4952
*/
5053
'conversionId'?: string;
5154
/**
@@ -159,6 +162,9 @@ export class DonationPaymentRequest {
159162
'threeDS2RequestData'?: ThreeDS2RequestFields;
160163
/**
161164
* If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
165+
*
166+
* @deprecated since Adyen Checkout API v69
167+
* Use `authenticationData.authenticationOnly` instead.
162168
*/
163169
'threeDSAuthenticationOnly'?: boolean;
164170

src/typings/checkout/eftDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ export class EftDetails {
3131
'ownerName'?: string;
3232
/**
3333
* This is the `recurringDetailReference` returned in the response when you created the token.
34+
*
35+
* @deprecated since Adyen Checkout API v49
36+
* Use `storedPaymentMethodId` instead.
3437
*/
3538
'recurringDetailReference'?: string;
3639
/**

src/typings/checkout/genericIssuerPaymentMethodDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class GenericIssuerPaymentMethodDetails {
1919
'issuer': string;
2020
/**
2121
* This is the `recurringDetailReference` returned in the response when you created the token.
22+
*
23+
* @deprecated since Adyen Checkout API v49
24+
* Use `storedPaymentMethodId` instead.
2225
*/
2326
'recurringDetailReference'?: string;
2427
/**

src/typings/checkout/giropayDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ export class GiropayDetails {
1515
'checkoutAttemptId'?: string;
1616
/**
1717
* This is the `recurringDetailReference` returned in the response when you created the token.
18+
*
19+
* @deprecated since Adyen Checkout API v49
20+
* Use `storedPaymentMethodId` instead.
1821
*/
1922
'recurringDetailReference'?: string;
2023
/**

src/typings/checkout/googlePayDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ export class GooglePayDetails {
2727
'googlePayToken': string;
2828
/**
2929
* This is the `recurringDetailReference` returned in the response when you created the token.
30+
*
31+
* @deprecated since Adyen Checkout API v49
32+
* Use `storedPaymentMethodId` instead.
3033
*/
3134
'recurringDetailReference'?: string;
3235
/**

src/typings/checkout/googlePayDonations.ts

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ export class GooglePayDonations {
2727
'googlePayToken': string;
2828
/**
2929
* This is the `recurringDetailReference` returned in the response when you created the token.
30+
*
31+
* @deprecated since Adyen Checkout API v49
32+
* Use `storedPaymentMethodId` instead.
3033
*/
3134
'recurringDetailReference'?: string;
3235
/**

src/typings/checkout/idealDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class IdealDetails {
1919
'issuer'?: string;
2020
/**
2121
* This is the `recurringDetailReference` returned in the response when you created the token.
22+
*
23+
* @deprecated since Adyen Checkout API v49
24+
* Use `storedPaymentMethodId` instead.
2225
*/
2326
'recurringDetailReference'?: string;
2427
/**

src/typings/checkout/idealDonations.ts

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ export class IdealDonations {
1919
'issuer'?: string;
2020
/**
2121
* This is the `recurringDetailReference` returned in the response when you created the token.
22+
*
23+
* @deprecated since Adyen Checkout API v49
24+
* Use `storedPaymentMethodId` instead.
2225
*/
2326
'recurringDetailReference'?: string;
2427
/**

src/typings/checkout/inputDetail.ts

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ export class InputDetail {
2121
'details'?: Array<SubInputDetail>;
2222
/**
2323
* Input details can also be provided recursively (deprecated).
24+
*
25+
* @deprecated
2426
*/
2527
'inputDetails'?: Array<SubInputDetail>;
2628
/**

src/typings/checkout/klarnaDetails.ts

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ export class KlarnaDetails {
2727
'personalDetails'?: string;
2828
/**
2929
* This is the `recurringDetailReference` returned in the response when you created the token.
30+
*
31+
* @deprecated since Adyen Checkout API v49
32+
* Use `storedPaymentMethodId` instead.
3033
*/
3134
'recurringDetailReference'?: string;
3235
/**

0 commit comments

Comments
 (0)