Skip to content

Optional query params and code format #1513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jun 17, 2025
Merged

Optional query params and code format #1513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0bef5d3
Check if query param is optional
gcatanese Jun 16, 2025
ecac45b
Generate BinLookup
gcatanese Jun 16, 2025
7d508b1
Generate Recurring
gcatanese Jun 16, 2025
d1a1cdc
Generate Payout
gcatanese Jun 16, 2025
aec4bef
Generate PosMobile
gcatanese Jun 16, 2025
9ef4ccd
Generate PaymentsApp
gcatanese Jun 16, 2025
020d916
Generate BalanceControl
gcatanese Jun 16, 2025
a02848c
Generate LEM
gcatanese Jun 16, 2025
7a17026
Generate DataProtection
gcatanese Jun 16, 2025
f69ec94
Generate SessionAuthentication
gcatanese Jun 16, 2025
0a0b924
Generate Classic Payment
gcatanese Jun 16, 2025
bcf0079
Generate Disputes
gcatanese Jun 16, 2025
8079ca7
Update README.md
gcatanese Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ This library supports the following:
| [Notification Configuration API](https://docs.adyen.com/api-explorer/NotificationConfiguration/6/overview) | v6 | Provides endpoints for setting up and testing notifications that inform you of events on your platform, for example when a verification check or a payout has been completed. | [NotificationConfiguration](/src/services/resource/platforms/notificationConfiguration.ts) |
| [POS Terminal Management API](https://docs.adyen.com/api-explorer/postfmapi/1/overview) | ~~v1~~ | ~~Endpoints for managing your point-of-sale payment terminals.~~ ‼️ Deprecated: use instead the [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview) for the management of your terminal fleet. | [~~TerminalManagement~~](/src/services/terminalManagementApi.ts) |
| [Recurring API](https://docs.adyen.com/api-explorer/Recurring/68/overview) | v68 | Endpoints for managing saved payment details. | [Recurring](/src/services/recurringApi.ts) |
| [Session Authentication API](https://docs.adyen.com/api-explorer/sessionauthentication/1/overview) | **v1** | Create and manage the JSON Web Tokens (JWT) required for integrating [Onboarding](https://docs.adyen.com/platforms/onboard-users/components) and [Platform Experience](https://docs.adyen.com/platforms/build-user-dashboards) components. | [SessionAuthentication](/src/services/sessionAuthentication) |
| [Stored Value API](https://docs.adyen.com/payment-methods/gift-cards/stored-value-api) | v46 | Manage both online and point-of-sale gift cards and other stored-value cards. | [StoredValue](/src/services/storedValueApi.ts) |
| [Transfers API](https://docs.adyen.com/api-explorer/transfers/4/overview) | v4 | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | [Transfers](/src/services/transfers/index.ts) |
| [Disputes API](https://docs.adyen.com/api-explorer/Disputes/30/overview) | v30 | You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. | [Disputes](/src/services/disputesApi.ts) |
Expand Down
4 changes: 2 additions & 2 deletions src/services/balanceControl/balanceControlApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ export class BalanceControlApi extends Service {
const endpoint = `${this.baseUrl}/balanceTransfer`;
const resource = new Resource(this, endpoint);

const request: BalanceTransferRequest = ObjectSerializer.serialize(balanceTransferRequest, "BalanceTransferRequest", "");
const request: BalanceTransferRequest = ObjectSerializer.serialize(balanceTransferRequest, "BalanceTransferRequest");
const response = await getJsonResponse<BalanceTransferRequest, BalanceTransferResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "BalanceTransferResponse", "");
return ObjectSerializer.deserialize(response, "BalanceTransferResponse");
}

}
8 changes: 4 additions & 4 deletions src/services/binLookup/binLookupApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ export class BinLookupApi extends Service {
const endpoint = `${this.baseUrl}/get3dsAvailability`;
const resource = new Resource(this, endpoint);

const request: ThreeDSAvailabilityRequest = ObjectSerializer.serialize(threeDSAvailabilityRequest, "ThreeDSAvailabilityRequest", "");
const request: ThreeDSAvailabilityRequest = ObjectSerializer.serialize(threeDSAvailabilityRequest, "ThreeDSAvailabilityRequest");
const response = await getJsonResponse<ThreeDSAvailabilityRequest, ThreeDSAvailabilityResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "ThreeDSAvailabilityResponse", "");
return ObjectSerializer.deserialize(response, "ThreeDSAvailabilityResponse");
}

/**
Expand All @@ -63,14 +63,14 @@ export class BinLookupApi extends Service {
const endpoint = `${this.baseUrl}/getCostEstimate`;
const resource = new Resource(this, endpoint);

const request: CostEstimateRequest = ObjectSerializer.serialize(costEstimateRequest, "CostEstimateRequest", "");
const request: CostEstimateRequest = ObjectSerializer.serialize(costEstimateRequest, "CostEstimateRequest");
const response = await getJsonResponse<CostEstimateRequest, CostEstimateResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "CostEstimateResponse", "");
return ObjectSerializer.deserialize(response, "CostEstimateResponse");
}

}
4 changes: 2 additions & 2 deletions src/services/dataProtection/dataProtectionApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ export class DataProtectionApi extends Service {
const endpoint = `${this.baseUrl}/requestSubjectErasure`;
const resource = new Resource(this, endpoint);

const request: SubjectErasureByPspReferenceRequest = ObjectSerializer.serialize(subjectErasureByPspReferenceRequest, "SubjectErasureByPspReferenceRequest", "");
const request: SubjectErasureByPspReferenceRequest = ObjectSerializer.serialize(subjectErasureByPspReferenceRequest, "SubjectErasureByPspReferenceRequest");
const response = await getJsonResponse<SubjectErasureByPspReferenceRequest, SubjectErasureResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "SubjectErasureResponse", "");
return ObjectSerializer.deserialize(response, "SubjectErasureResponse");
}

}
20 changes: 10 additions & 10 deletions src/services/disputes/disputesApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ export class DisputesApi extends Service {
const endpoint = `${this.baseUrl}/acceptDispute`;
const resource = new Resource(this, endpoint);

const request: AcceptDisputeRequest = ObjectSerializer.serialize(acceptDisputeRequest, "AcceptDisputeRequest", "");
const request: AcceptDisputeRequest = ObjectSerializer.serialize(acceptDisputeRequest, "AcceptDisputeRequest");
const response = await getJsonResponse<AcceptDisputeRequest, AcceptDisputeResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "AcceptDisputeResponse", "");
return ObjectSerializer.deserialize(response, "AcceptDisputeResponse");
}

/**
Expand All @@ -69,14 +69,14 @@ export class DisputesApi extends Service {
const endpoint = `${this.baseUrl}/defendDispute`;
const resource = new Resource(this, endpoint);

const request: DefendDisputeRequest = ObjectSerializer.serialize(defendDisputeRequest, "DefendDisputeRequest", "");
const request: DefendDisputeRequest = ObjectSerializer.serialize(defendDisputeRequest, "DefendDisputeRequest");
const response = await getJsonResponse<DefendDisputeRequest, DefendDisputeResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "DefendDisputeResponse", "");
return ObjectSerializer.deserialize(response, "DefendDisputeResponse");
}

/**
Expand All @@ -89,14 +89,14 @@ export class DisputesApi extends Service {
const endpoint = `${this.baseUrl}/deleteDisputeDefenseDocument`;
const resource = new Resource(this, endpoint);

const request: DeleteDefenseDocumentRequest = ObjectSerializer.serialize(deleteDefenseDocumentRequest, "DeleteDefenseDocumentRequest", "");
const request: DeleteDefenseDocumentRequest = ObjectSerializer.serialize(deleteDefenseDocumentRequest, "DeleteDefenseDocumentRequest");
const response = await getJsonResponse<DeleteDefenseDocumentRequest, DeleteDefenseDocumentResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "DeleteDefenseDocumentResponse", "");
return ObjectSerializer.deserialize(response, "DeleteDefenseDocumentResponse");
}

/**
Expand All @@ -109,14 +109,14 @@ export class DisputesApi extends Service {
const endpoint = `${this.baseUrl}/retrieveApplicableDefenseReasons`;
const resource = new Resource(this, endpoint);

const request: DefenseReasonsRequest = ObjectSerializer.serialize(defenseReasonsRequest, "DefenseReasonsRequest", "");
const request: DefenseReasonsRequest = ObjectSerializer.serialize(defenseReasonsRequest, "DefenseReasonsRequest");
const response = await getJsonResponse<DefenseReasonsRequest, DefenseReasonsResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "DefenseReasonsResponse", "");
return ObjectSerializer.deserialize(response, "DefenseReasonsResponse");
}

/**
Expand All @@ -129,14 +129,14 @@ export class DisputesApi extends Service {
const endpoint = `${this.baseUrl}/supplyDefenseDocument`;
const resource = new Resource(this, endpoint);

const request: SupplyDefenseDocumentRequest = ObjectSerializer.serialize(supplyDefenseDocumentRequest, "SupplyDefenseDocumentRequest", "");
const request: SupplyDefenseDocumentRequest = ObjectSerializer.serialize(supplyDefenseDocumentRequest, "SupplyDefenseDocumentRequest");
const response = await getJsonResponse<SupplyDefenseDocumentRequest, SupplyDefenseDocumentResponse>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "SupplyDefenseDocumentResponse", "");
return ObjectSerializer.deserialize(response, "SupplyDefenseDocumentResponse");
}

}
10 changes: 5 additions & 5 deletions src/services/legalEntityManagement/businessLinesApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ export class BusinessLinesApi extends Service {
const endpoint = `${this.baseUrl}/businessLines`;
const resource = new Resource(this, endpoint);

const request: BusinessLineInfo = ObjectSerializer.serialize(businessLineInfo, "BusinessLineInfo", "");
const request: BusinessLineInfo = ObjectSerializer.serialize(businessLineInfo, "BusinessLineInfo");
const response = await getJsonResponse<BusinessLineInfo, BusinessLine>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "BusinessLine", "");
return ObjectSerializer.deserialize(response, "BusinessLine");
}

/**
Expand Down Expand Up @@ -87,7 +87,7 @@ export class BusinessLinesApi extends Service {
{ ...requestOptions, method: "GET" }
);

return ObjectSerializer.deserialize(response, "BusinessLine", "");
return ObjectSerializer.deserialize(response, "BusinessLine");
}

/**
Expand All @@ -102,14 +102,14 @@ export class BusinessLinesApi extends Service {
.replace("{" + "id" + "}", encodeURIComponent(String(id)));
const resource = new Resource(this, endpoint);

const request: BusinessLineInfoUpdate = ObjectSerializer.serialize(businessLineInfoUpdate, "BusinessLineInfoUpdate", "");
const request: BusinessLineInfoUpdate = ObjectSerializer.serialize(businessLineInfoUpdate, "BusinessLineInfoUpdate");
const response = await getJsonResponse<BusinessLineInfoUpdate, BusinessLine>(
resource,
request,
{ ...requestOptions, method: "PATCH" }
);

return ObjectSerializer.deserialize(response, "BusinessLine", "");
return ObjectSerializer.deserialize(response, "BusinessLine");
}

}
10 changes: 5 additions & 5 deletions src/services/legalEntityManagement/documentsApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export class DocumentsApi extends Service {
{ ...requestOptions, method: "GET" }
);

return ObjectSerializer.deserialize(response, "Document", "");
return ObjectSerializer.deserialize(response, "Document");
}

/**
Expand All @@ -87,14 +87,14 @@ export class DocumentsApi extends Service {
.replace("{" + "id" + "}", encodeURIComponent(String(id)));
const resource = new Resource(this, endpoint);

const request: Document = ObjectSerializer.serialize(document, "Document", "");
const request: Document = ObjectSerializer.serialize(document, "Document");
const response = await getJsonResponse<Document, Document>(
resource,
request,
{ ...requestOptions, method: "PATCH" }
);

return ObjectSerializer.deserialize(response, "Document", "");
return ObjectSerializer.deserialize(response, "Document");
}

/**
Expand All @@ -107,14 +107,14 @@ export class DocumentsApi extends Service {
const endpoint = `${this.baseUrl}/documents`;
const resource = new Resource(this, endpoint);

const request: Document = ObjectSerializer.serialize(document, "Document", "");
const request: Document = ObjectSerializer.serialize(document, "Document");
const response = await getJsonResponse<Document, Document>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "Document", "");
return ObjectSerializer.deserialize(response, "Document");
}

}
8 changes: 4 additions & 4 deletions src/services/legalEntityManagement/hostedOnboardingApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ export class HostedOnboardingApi extends Service {
.replace("{" + "id" + "}", encodeURIComponent(String(id)));
const resource = new Resource(this, endpoint);

const request: OnboardingLinkInfo = ObjectSerializer.serialize(onboardingLinkInfo, "OnboardingLinkInfo", "");
const request: OnboardingLinkInfo = ObjectSerializer.serialize(onboardingLinkInfo, "OnboardingLinkInfo");
const response = await getJsonResponse<OnboardingLinkInfo, OnboardingLink>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "OnboardingLink", "");
return ObjectSerializer.deserialize(response, "OnboardingLink");
}

/**
Expand All @@ -72,7 +72,7 @@ export class HostedOnboardingApi extends Service {
{ ...requestOptions, method: "GET" }
);

return ObjectSerializer.deserialize(response, "OnboardingTheme", "");
return ObjectSerializer.deserialize(response, "OnboardingTheme");
}

/**
Expand All @@ -90,7 +90,7 @@ export class HostedOnboardingApi extends Service {
{ ...requestOptions, method: "GET" }
);

return ObjectSerializer.deserialize(response, "OnboardingThemes", "");
return ObjectSerializer.deserialize(response, "OnboardingThemes");
}

}
16 changes: 8 additions & 8 deletions src/services/legalEntityManagement/legalEntitiesApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export class LegalEntitiesApi extends Service {
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "VerificationErrors", "");
return ObjectSerializer.deserialize(response, "VerificationErrors");
}

/**
Expand All @@ -72,7 +72,7 @@ export class LegalEntitiesApi extends Service {
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "DataReviewConfirmationResponse", "");
return ObjectSerializer.deserialize(response, "DataReviewConfirmationResponse");
}

/**
Expand All @@ -85,14 +85,14 @@ export class LegalEntitiesApi extends Service {
const endpoint = `${this.baseUrl}/legalEntities`;
const resource = new Resource(this, endpoint);

const request: LegalEntityInfoRequiredType = ObjectSerializer.serialize(legalEntityInfoRequiredType, "LegalEntityInfoRequiredType", "");
const request: LegalEntityInfoRequiredType = ObjectSerializer.serialize(legalEntityInfoRequiredType, "LegalEntityInfoRequiredType");
const response = await getJsonResponse<LegalEntityInfoRequiredType, LegalEntity>(
resource,
request,
{ ...requestOptions, method: "POST" }
);

return ObjectSerializer.deserialize(response, "LegalEntity", "");
return ObjectSerializer.deserialize(response, "LegalEntity");
}

/**
Expand All @@ -112,7 +112,7 @@ export class LegalEntitiesApi extends Service {
{ ...requestOptions, method: "GET" }
);

return ObjectSerializer.deserialize(response, "BusinessLines", "");
return ObjectSerializer.deserialize(response, "BusinessLines");
}

/**
Expand All @@ -132,7 +132,7 @@ export class LegalEntitiesApi extends Service {
{ ...requestOptions, method: "GET" }
);

return ObjectSerializer.deserialize(response, "LegalEntity", "");
return ObjectSerializer.deserialize(response, "LegalEntity");
}

/**
Expand All @@ -147,14 +147,14 @@ export class LegalEntitiesApi extends Service {
.replace("{" + "id" + "}", encodeURIComponent(String(id)));
const resource = new Resource(this, endpoint);

const request: LegalEntityInfo = ObjectSerializer.serialize(legalEntityInfo, "LegalEntityInfo", "");
const request: LegalEntityInfo = ObjectSerializer.serialize(legalEntityInfo, "LegalEntityInfo");
const response = await getJsonResponse<LegalEntityInfo, LegalEntity>(
resource,
request,
{ ...requestOptions, method: "PATCH" }
);

return ObjectSerializer.deserialize(response, "LegalEntity", "");
return ObjectSerializer.deserialize(response, "LegalEntity");
}

}
Loading