Skip to content

Commit ccae6c7

Browse files
gcatanesegcatanese
committed
Deprecate PaymentAPI in service
1 parent 6ccb08c commit ccae6c7

File tree

1 file changed

+58
-26
lines changed

1 file changed

+58
-26
lines changed

‎src/services/paymentApi.ts

Lines changed: 58 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ import { IRequest } from "../typings/requestOptions";
3131
import Resource from "./resource";
3232
import { ObjectSerializer } from "../typings/payment/models";
3333

34+
/**
35+
* This class is deprecated and will be NO LONGER updated
36+
*
37+
* The service has been moved to a different package 'payment'
38+
* @deprecated Use services/payment/PaymentAPI
39+
*/
3440
export class PaymentAPI extends Service {
3541

3642
private readonly API_BASEPATH: string = "https://pal-test.adyen.com/pal/servlet/Payment/v68";
@@ -42,6 +48,8 @@ export class PaymentAPI extends Service {
4248
}
4349

4450
/**
51+
* @deprecated Use services/payment/PaymentAPI
52+
*
4553
* @summary Change the authorised amount
4654
* @param adjustAuthorisationRequest {@link AdjustAuthorisationRequest }
4755
* @param requestOptions {@link IRequest.Options }
@@ -50,16 +58,18 @@ export class PaymentAPI extends Service {
5058
public async adjustAuthorisation(adjustAuthorisationRequest: AdjustAuthorisationRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
5159
const endpoint = `${this.baseUrl}/adjustAuthorisation`;
5260
const resource = new Resource(this, endpoint);
53-
const request: AdjustAuthorisationRequest = ObjectSerializer.serialize(adjustAuthorisationRequest, "AdjustAuthorisationRequest");
61+
const request: AdjustAuthorisationRequest = ObjectSerializer.serialize(adjustAuthorisationRequest, "AdjustAuthorisationRequest", "");
5462
const response = await getJsonResponse<AdjustAuthorisationRequest, ModificationResult>(
5563
resource,
5664
request,
5765
{ ...requestOptions, method: "POST" }
5866
);
59-
return ObjectSerializer.deserialize(response, "ModificationResult");
67+
return ObjectSerializer.deserialize(response, "ModificationResult", "");
6068
}
6169

6270
/**
71+
* @deprecated Use services/payment/PaymentAPI
72+
*
6373
* @summary Create an authorisation
6474
* @param paymentRequest {@link PaymentRequest }
6575
* @param requestOptions {@link IRequest.Options }
@@ -68,16 +78,18 @@ export class PaymentAPI extends Service {
6878
public async authorise(paymentRequest: PaymentRequest, requestOptions?: IRequest.Options): Promise<PaymentResult> {
6979
const endpoint = `${this.baseUrl}/authorise`;
7080
const resource = new Resource(this, endpoint);
71-
const request: PaymentRequest = ObjectSerializer.serialize(paymentRequest, "PaymentRequest");
81+
const request: PaymentRequest = ObjectSerializer.serialize(paymentRequest, "PaymentRequest", "");
7282
const response = await getJsonResponse<PaymentRequest, PaymentResult>(
7383
resource,
7484
request,
7585
{ ...requestOptions, method: "POST" }
7686
);
77-
return ObjectSerializer.deserialize(response, "PaymentResult");
87+
return ObjectSerializer.deserialize(response, "PaymentResult", "");
7888
}
7989

8090
/**
91+
* @deprecated Use services/payment/PaymentAPI
92+
*
8193
* @summary Complete a 3DS authorisation
8294
* @param paymentRequest3d {@link PaymentRequest3d }
8395
* @param requestOptions {@link IRequest.Options }
@@ -86,16 +98,18 @@ export class PaymentAPI extends Service {
8698
public async authorise3d(paymentRequest3d: PaymentRequest3d, requestOptions?: IRequest.Options): Promise<PaymentResult> {
8799
const endpoint = `${this.baseUrl}/authorise3d`;
88100
const resource = new Resource(this, endpoint);
89-
const request: PaymentRequest3d = ObjectSerializer.serialize(paymentRequest3d, "PaymentRequest3d");
101+
const request: PaymentRequest3d = ObjectSerializer.serialize(paymentRequest3d, "PaymentRequest3d", "");
90102
const response = await getJsonResponse<PaymentRequest3d, PaymentResult>(
91103
resource,
92104
request,
93105
{ ...requestOptions, method: "POST" }
94106
);
95-
return ObjectSerializer.deserialize(response, "PaymentResult");
107+
return ObjectSerializer.deserialize(response, "PaymentResult", "");
96108
}
97109

98110
/**
111+
* @deprecated Use services/payment/PaymentAPI
112+
*
99113
* @summary Complete a 3DS2 authorisation
100114
* @param paymentRequest3ds2 {@link PaymentRequest3ds2 }
101115
* @param requestOptions {@link IRequest.Options }
@@ -104,16 +118,18 @@ export class PaymentAPI extends Service {
104118
public async authorise3ds2(paymentRequest3ds2: PaymentRequest3ds2, requestOptions?: IRequest.Options): Promise<PaymentResult> {
105119
const endpoint = `${this.baseUrl}/authorise3ds2`;
106120
const resource = new Resource(this, endpoint);
107-
const request: PaymentRequest3ds2 = ObjectSerializer.serialize(paymentRequest3ds2, "PaymentRequest3ds2");
121+
const request: PaymentRequest3ds2 = ObjectSerializer.serialize(paymentRequest3ds2, "PaymentRequest3ds2", "");
108122
const response = await getJsonResponse<PaymentRequest3ds2, PaymentResult>(
109123
resource,
110124
request,
111125
{ ...requestOptions, method: "POST" }
112126
);
113-
return ObjectSerializer.deserialize(response, "PaymentResult");
127+
return ObjectSerializer.deserialize(response, "PaymentResult", "");
114128
}
115129

116130
/**
131+
* @deprecated Use services/payment/PaymentAPI
132+
*
117133
* @summary Cancel an authorisation
118134
* @param cancelRequest {@link CancelRequest }
119135
* @param requestOptions {@link IRequest.Options }
@@ -122,16 +138,18 @@ export class PaymentAPI extends Service {
122138
public async cancel(cancelRequest: CancelRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
123139
const endpoint = `${this.baseUrl}/cancel`;
124140
const resource = new Resource(this, endpoint);
125-
const request: CancelRequest = ObjectSerializer.serialize(cancelRequest, "CancelRequest");
141+
const request: CancelRequest = ObjectSerializer.serialize(cancelRequest, "CancelRequest", "");
126142
const response = await getJsonResponse<CancelRequest, ModificationResult>(
127143
resource,
128144
request,
129145
{ ...requestOptions, method: "POST" }
130146
);
131-
return ObjectSerializer.deserialize(response, "ModificationResult");
147+
return ObjectSerializer.deserialize(response, "ModificationResult", "");
132148
}
133149

134150
/**
151+
* @deprecated Use services/payment/PaymentAPI
152+
*
135153
* @summary Cancel or refund a payment
136154
* @param cancelOrRefundRequest {@link CancelOrRefundRequest }
137155
* @param requestOptions {@link IRequest.Options }
@@ -140,16 +158,18 @@ export class PaymentAPI extends Service {
140158
public async cancelOrRefund(cancelOrRefundRequest: CancelOrRefundRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
141159
const endpoint = `${this.baseUrl}/cancelOrRefund`;
142160
const resource = new Resource(this, endpoint);
143-
const request: CancelOrRefundRequest = ObjectSerializer.serialize(cancelOrRefundRequest, "CancelOrRefundRequest");
161+
const request: CancelOrRefundRequest = ObjectSerializer.serialize(cancelOrRefundRequest, "CancelOrRefundRequest", "");
144162
const response = await getJsonResponse<CancelOrRefundRequest, ModificationResult>(
145163
resource,
146164
request,
147165
{ ...requestOptions, method: "POST" }
148166
);
149-
return ObjectSerializer.deserialize(response, "ModificationResult");
167+
return ObjectSerializer.deserialize(response, "ModificationResult", "");
150168
}
151169

152170
/**
171+
* @deprecated Use services/payment/PaymentAPI
172+
*
153173
* @summary Capture an authorisation
154174
* @param captureRequest {@link CaptureRequest }
155175
* @param requestOptions {@link IRequest.Options }
@@ -158,16 +178,18 @@ export class PaymentAPI extends Service {
158178
public async capture(captureRequest: CaptureRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
159179
const endpoint = `${this.baseUrl}/capture`;
160180
const resource = new Resource(this, endpoint);
161-
const request: CaptureRequest = ObjectSerializer.serialize(captureRequest, "CaptureRequest");
181+
const request: CaptureRequest = ObjectSerializer.serialize(captureRequest, "CaptureRequest", "");
162182
const response = await getJsonResponse<CaptureRequest, ModificationResult>(
163183
resource,
164184
request,
165185
{ ...requestOptions, method: "POST" }
166186
);
167-
return ObjectSerializer.deserialize(response, "ModificationResult");
187+
return ObjectSerializer.deserialize(response, "ModificationResult", "");
168188
}
169189

170190
/**
191+
* @deprecated Use services/payment/PaymentAPI
192+
*
171193
* @summary Create a donation
172194
* @param donationRequest {@link DonationRequest }
173195
* @param requestOptions {@link IRequest.Options }
@@ -178,16 +200,18 @@ export class PaymentAPI extends Service {
178200
public async donate(donationRequest: DonationRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
179201
const endpoint = `${this.baseUrl}/donate`;
180202
const resource = new Resource(this, endpoint);
181-
const request: DonationRequest = ObjectSerializer.serialize(donationRequest, "DonationRequest");
203+
const request: DonationRequest = ObjectSerializer.serialize(donationRequest, "DonationRequest", "");
182204
const response = await getJsonResponse<DonationRequest, ModificationResult>(
183205
resource,
184206
request,
185207
{ ...requestOptions, method: "POST" }
186208
);
187-
return ObjectSerializer.deserialize(response, "ModificationResult");
209+
return ObjectSerializer.deserialize(response, "ModificationResult", "");
188210
}
189211

190212
/**
213+
* @deprecated Use services/payment/PaymentAPI
214+
*
191215
* @summary Get the 3DS authentication result
192216
* @param authenticationResultRequest {@link AuthenticationResultRequest }
193217
* @param requestOptions {@link IRequest.Options }
@@ -196,16 +220,18 @@ export class PaymentAPI extends Service {
196220
public async getAuthenticationResult(authenticationResultRequest: AuthenticationResultRequest, requestOptions?: IRequest.Options): Promise<AuthenticationResultResponse> {
197221
const endpoint = `${this.baseUrl}/getAuthenticationResult`;
198222
const resource = new Resource(this, endpoint);
199-
const request: AuthenticationResultRequest = ObjectSerializer.serialize(authenticationResultRequest, "AuthenticationResultRequest");
223+
const request: AuthenticationResultRequest = ObjectSerializer.serialize(authenticationResultRequest, "AuthenticationResultRequest", "");
200224
const response = await getJsonResponse<AuthenticationResultRequest, AuthenticationResultResponse>(
201225
resource,
202226
request,
203227
{ ...requestOptions, method: "POST" }
204228
);
205-
return ObjectSerializer.deserialize(response, "AuthenticationResultResponse");
229+
return ObjectSerializer.deserialize(response, "AuthenticationResultResponse", "");
206230
}
207231

208232
/**
233+
* @deprecated Use services/payment/PaymentAPI
234+
*
209235
* @summary Refund a captured payment
210236
* @param refundRequest {@link RefundRequest }
211237
* @param requestOptions {@link IRequest.Options }
@@ -214,16 +240,18 @@ export class PaymentAPI extends Service {
214240
public async refund(refundRequest: RefundRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
215241
const endpoint = `${this.baseUrl}/refund`;
216242
const resource = new Resource(this, endpoint);
217-
const request: RefundRequest = ObjectSerializer.serialize(refundRequest, "RefundRequest");
243+
const request: RefundRequest = ObjectSerializer.serialize(refundRequest, "RefundRequest", "");
218244
const response = await getJsonResponse<RefundRequest, ModificationResult>(
219245
resource,
220246
request,
221247
{ ...requestOptions, method: "POST" }
222248
);
223-
return ObjectSerializer.deserialize(response, "ModificationResult");
249+
return ObjectSerializer.deserialize(response, "ModificationResult", "");
224250
}
225251

226252
/**
253+
* @deprecated Use services/payment/PaymentAPI
254+
*
227255
* @summary Get the 3DS2 authentication result
228256
* @param threeDS2ResultRequest {@link ThreeDS2ResultRequest }
229257
* @param requestOptions {@link IRequest.Options }
@@ -232,16 +260,18 @@ export class PaymentAPI extends Service {
232260
public async retrieve3ds2Result(threeDS2ResultRequest: ThreeDS2ResultRequest, requestOptions?: IRequest.Options): Promise<ThreeDS2ResultResponse> {
233261
const endpoint = `${this.baseUrl}/retrieve3ds2Result`;
234262
const resource = new Resource(this, endpoint);
235-
const request: ThreeDS2ResultRequest = ObjectSerializer.serialize(threeDS2ResultRequest, "ThreeDS2ResultRequest");
263+
const request: ThreeDS2ResultRequest = ObjectSerializer.serialize(threeDS2ResultRequest, "ThreeDS2ResultRequest", "");
236264
const response = await getJsonResponse<ThreeDS2ResultRequest, ThreeDS2ResultResponse>(
237265
resource,
238266
request,
239267
{ ...requestOptions, method: "POST" }
240268
);
241-
return ObjectSerializer.deserialize(response, "ThreeDS2ResultResponse");
269+
return ObjectSerializer.deserialize(response, "ThreeDS2ResultResponse", "");
242270
}
243271

244272
/**
273+
* @deprecated Use services/payment/PaymentAPI
274+
*
245275
* @summary Cancel an authorisation using your reference
246276
* @param technicalCancelRequest {@link TechnicalCancelRequest }
247277
* @param requestOptions {@link IRequest.Options }
@@ -250,16 +280,18 @@ export class PaymentAPI extends Service {
250280
public async technicalCancel(technicalCancelRequest: TechnicalCancelRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
251281
const endpoint = `${this.baseUrl}/technicalCancel`;
252282
const resource = new Resource(this, endpoint);
253-
const request: TechnicalCancelRequest = ObjectSerializer.serialize(technicalCancelRequest, "TechnicalCancelRequest");
283+
const request: TechnicalCancelRequest = ObjectSerializer.serialize(technicalCancelRequest, "TechnicalCancelRequest", "");
254284
const response = await getJsonResponse<TechnicalCancelRequest, ModificationResult>(
255285
resource,
256286
request,
257287
{ ...requestOptions, method: "POST" }
258288
);
259-
return ObjectSerializer.deserialize(response, "ModificationResult");
289+
return ObjectSerializer.deserialize(response, "ModificationResult", "");
260290
}
261291

262292
/**
293+
* @deprecated Use services/payment/PaymentAPI
294+
*
263295
* @summary Cancel an in-person refund
264296
* @param voidPendingRefundRequest {@link VoidPendingRefundRequest }
265297
* @param requestOptions {@link IRequest.Options }
@@ -268,13 +300,13 @@ export class PaymentAPI extends Service {
268300
public async voidPendingRefund(voidPendingRefundRequest: VoidPendingRefundRequest, requestOptions?: IRequest.Options): Promise<ModificationResult> {
269301
const endpoint = `${this.baseUrl}/voidPendingRefund`;
270302
const resource = new Resource(this, endpoint);
271-
const request: VoidPendingRefundRequest = ObjectSerializer.serialize(voidPendingRefundRequest, "VoidPendingRefundRequest");
303+
const request: VoidPendingRefundRequest = ObjectSerializer.serialize(voidPendingRefundRequest, "VoidPendingRefundRequest", "");
272304
const response = await getJsonResponse<VoidPendingRefundRequest, ModificationResult>(
273305
resource,
274306
request,
275307
{ ...requestOptions, method: "POST" }
276308
);
277-
return ObjectSerializer.deserialize(response, "ModificationResult");
309+
return ObjectSerializer.deserialize(response, "ModificationResult", "");
278310
}
279311
}
280312

0 commit comments

Comments
 (0)