Skip to content

Management API models #1500

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.

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 1 commit into from
May 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions src/typings/management/afterpayTouchInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@


export class AfterpayTouchInfo {
/**
* Support Email
*/
'supportEmail'?: string;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Consider adding a more detailed description for supportEmail to clarify its purpose and format. For example, "The email address to contact for support related to Afterpay Touch payments."

/**
* Support Url
*/
Expand All @@ -17,6 +21,11 @@ export class AfterpayTouchInfo {
static discriminator: string | undefined = undefined;

static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "supportEmail",
"baseName": "supportEmail",
"type": "string"
},
{
"name": "supportUrl",
"baseName": "supportUrl",
Expand Down
2 changes: 1 addition & 1 deletion src/typings/management/createCompanyWebhookRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export class CreateCompanyWebhookRequest {
*/
'populateSoapActionHeader'?: boolean;
/**
* The type of webhook that is being created. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** - **terminal-settings** - **terminal-boarding** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).
* The type of webhook that is being created. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **direct-debit-notice-of-change** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** - **terminal-settings** - **terminal-boarding** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

It seems like direct-debit-notice-of-change is a new webhook type. Consider adding a brief explanation of what this webhook type is for, similar to the descriptions for the other types.

*/
'type': string;
/**
Expand Down
2 changes: 1 addition & 1 deletion src/typings/management/createMerchantWebhookRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export class CreateMerchantWebhookRequest {
*/
'populateSoapActionHeader'?: boolean;
/**
* The type of webhook that is being created. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** - **terminal-settings** - **terminal-boarding** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).
* The type of webhook that is being created. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **direct-debit-notice-of-change** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** - **terminal-settings** - **terminal-boarding** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similar to the createCompanyWebhookRequest.ts file, consider adding a brief explanation of the direct-debit-notice-of-change webhook type.

*/
'type': string;
/**
Expand Down
30 changes: 0 additions & 30 deletions src/typings/management/giroPayInfo.ts

This file was deleted.

7 changes: 4 additions & 3 deletions src/typings/management/jCBInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ import { TransactionDescriptionInfo } from './transactionDescriptionInfo';

export class JCBInfo {
/**
* MID (Merchant ID) number. Required for merchants operating in Japan.Format: 14 numeric characters.
* MID (Merchant ID) number. Required for merchants operating in Japan or merchants operating in Canada, Australia and New Zealand when requesting `gatewayContract` or `paymentDesignatorContract` service levels.Format: 14 numeric characters for Japan, 10 numeric characters for Canada, Australia and New Zealand.
*/
'midNumber'?: string;
/**
* Indicates whether the JCB Merchant ID is reused from a previously setup JCB payment method. The default value is **false**.For merchants operating in Japan, this field is required and must be set to **true**.
*/
'reuseMidNumber'?: boolean;
/**
* Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values: * **noContract**: Adyen holds the contract with JCB. * **gatewayContract**: JCB receives the settlement and handles disputes, then pays out to you or your sub-merchant directly.
* Specifies the service level (settlement type) of this payment method. Required for merchants operating in Japan. Possible values: * **noContract**: Adyen holds the contract with JCB for merchants operating in Japan or American Express for merchants operating in Canada, Australia and New Zealand. * **gatewayContract**: JCB or American Express receives the settlement and handles disputes, then pays out to you or your sub-merchant directly. * **paymentDesignatorContract**: Available only for merchants operating in Canada, Australia and New Zealand. Adyen receives the settlement, and handles disputes and payouts.
*/
'serviceLevel'?: JCBInfo.ServiceLevelEnum;
'transactionDescription'?: TransactionDescriptionInfo | null;
Expand Down Expand Up @@ -56,6 +56,7 @@ export class JCBInfo {
export namespace JCBInfo {
export enum ServiceLevelEnum {
NoContract = 'noContract',
GatewayContract = 'gatewayContract'
GatewayContract = 'gatewayContract',
PaymentDesignatorContract = 'paymentDesignatorContract'
}
}
6 changes: 3 additions & 3 deletions src/typings/management/models.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ export * from './generateApiKeyResponse';
export * from './generateClientKeyResponse';
export * from './generateHmacKeyResponse';
export * from './genericPmWithTdiInfo';
export * from './giroPayInfo';
export * from './googlePayInfo';

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This change removes GiroPayInfo. Ensure that any code depending on this model is updated accordingly to avoid runtime errors.

export * from './gratuity';
export * from './hardware';
Expand Down Expand Up @@ -107,6 +106,7 @@ export * from './orderItem';
export * from './paginationLinks';
export * from './passcodes';
export * from './payAtTable';
export * from './payByBankPlaidInfo';

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This change adds PayByBankPlaidInfo. Ensure that this new model is correctly used and integrated into the existing codebase.

export * from './payMeInfo';
export * from './payPalInfo';
export * from './payToInfo';
Expand Down Expand Up @@ -261,7 +261,6 @@ import { GenerateApiKeyResponse } from './generateApiKeyResponse';
import { GenerateClientKeyResponse } from './generateClientKeyResponse';
import { GenerateHmacKeyResponse } from './generateHmacKeyResponse';
import { GenericPmWithTdiInfo } from './genericPmWithTdiInfo';
import { GiroPayInfo } from './giroPayInfo';
import { GooglePayInfo } from './googlePayInfo';
import { Gratuity } from './gratuity';
import { Hardware } from './hardware';
Expand Down Expand Up @@ -304,6 +303,7 @@ import { OrderItem } from './orderItem';
import { PaginationLinks } from './paginationLinks';
import { Passcodes } from './passcodes';
import { PayAtTable } from './payAtTable';
import { PayByBankPlaidInfo } from './payByBankPlaidInfo';
import { PayMeInfo } from './payMeInfo';
import { PayPalInfo } from './payPalInfo';
import { PayToInfo } from './payToInfo';
Expand Down Expand Up @@ -550,7 +550,6 @@ let typeMap: {[index: string]: any} = {
"GenerateClientKeyResponse": GenerateClientKeyResponse,
"GenerateHmacKeyResponse": GenerateHmacKeyResponse,
"GenericPmWithTdiInfo": GenericPmWithTdiInfo,
"GiroPayInfo": GiroPayInfo,
"GooglePayInfo": GooglePayInfo,
"Gratuity": Gratuity,
"Hardware": Hardware,
Expand Down Expand Up @@ -593,6 +592,7 @@ let typeMap: {[index: string]: any} = {
"PaginationLinks": PaginationLinks,
"Passcodes": Passcodes,
"PayAtTable": PayAtTable,
"PayByBankPlaidInfo": PayByBankPlaidInfo,
"PayMeInfo": PayMeInfo,
"PayPalInfo": PayPalInfo,
"PayToInfo": PayToInfo,
Expand Down
100 changes: 100 additions & 0 deletions src/typings/management/payByBankPlaidInfo.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
/*
* The version of the OpenAPI document: v3
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit this class manually.
*/

import { TransactionDescriptionInfo } from './transactionDescriptionInfo';

export class PayByBankPlaidInfo {
/**
* Country Code.
*/
'countryCode'?: string;
/**
* Merchant logo (max. size 150kB). Format: Base64-encoded string.
*/
'logo'?: string;
/**
* The city the merchant is doing business in.
*/
'merchantCity'?: string;
/**
* Legal Business Name of the Merchant.
*/
'merchantLegalName'?: string;
/**
* Merchant shop url.
*/
'merchantShopUrl'?: string;
/**
* The state/province of the merchant.
*/
'merchantStateProvince'?: string;
/**
* The street address of the merchant.
*/
'merchantStreetAddress'?: string;
'transactionDescription'?: TransactionDescriptionInfo | null;
/**
* The zip code of the account.
*/
'zipCode'?: string;

static discriminator: string | undefined = undefined;

static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "countryCode",
"baseName": "countryCode",
"type": "string"
},
{
"name": "logo",
"baseName": "logo",
"type": "string"
},
{
"name": "merchantCity",
"baseName": "merchantCity",
"type": "string"
},
{
"name": "merchantLegalName",
"baseName": "merchantLegalName",
"type": "string"
},
{
"name": "merchantShopUrl",
"baseName": "merchantShopUrl",
"type": "string"
},
{
"name": "merchantStateProvince",
"baseName": "merchantStateProvince",
"type": "string"
},
{
"name": "merchantStreetAddress",
"baseName": "merchantStreetAddress",
"type": "string"
},
{
"name": "transactionDescription",
"baseName": "transactionDescription",
"type": "TransactionDescriptionInfo | null"
},
{
"name": "zipCode",
"baseName": "zipCode",
"type": "string"
} ];

static getAttributeTypeMap() {
return PayByBankPlaidInfo.attributeTypeMap;
}
}

14 changes: 7 additions & 7 deletions src/typings/management/paymentMethod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ import { CartesBancairesInfo } from './cartesBancairesInfo';
import { ClearpayInfo } from './clearpayInfo';
import { DinersInfo } from './dinersInfo';
import { GenericPmWithTdiInfo } from './genericPmWithTdiInfo';
import { GiroPayInfo } from './giroPayInfo';
import { GooglePayInfo } from './googlePayInfo';
import { JCBInfo } from './jCBInfo';
import { KlarnaInfo } from './klarnaInfo';
import { MealVoucherFRInfo } from './mealVoucherFRInfo';
import { NyceInfo } from './nyceInfo';
import { PayByBankPlaidInfo } from './payByBankPlaidInfo';
import { PayMeInfo } from './payMeInfo';
import { PayPalInfo } from './payPalInfo';
import { PayToInfo } from './payToInfo';
Expand Down Expand Up @@ -75,7 +75,6 @@ export class PaymentMethod {
* Indicates whether the payment method is enabled (**true**) or disabled (**false**).
*/
'enabled'?: boolean;
'giroPay'?: GiroPayInfo | null;
'girocard'?: GenericPmWithTdiInfo | null;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The removal of giroPay requires verification that no part of the application relies on this payment method. If there are, those sections will need to be updated.

'googlePay'?: GooglePayInfo | null;
/**
Expand All @@ -90,6 +89,7 @@ export class PaymentMethod {
'mc'?: GenericPmWithTdiInfo | null;
'mealVoucher_FR'?: MealVoucherFRInfo | null;
'nyce'?: NyceInfo | null;
'paybybank_plaid'?: PayByBankPlaidInfo | null;
'payme'?: PayMeInfo | null;
'paypal'?: PayPalInfo | null;
'payto'?: PayToInfo | null;
Expand Down Expand Up @@ -223,11 +223,6 @@ export class PaymentMethod {
"baseName": "enabled",
"type": "boolean"
},
{
"name": "giroPay",
"baseName": "giroPay",
"type": "GiroPayInfo | null"
},
{
"name": "girocard",
"baseName": "girocard",
Expand Down Expand Up @@ -283,6 +278,11 @@ export class PaymentMethod {
"baseName": "nyce",
"type": "NyceInfo | null"
},
{
"name": "paybybank_plaid",
"baseName": "paybybank_plaid",
"type": "PayByBankPlaidInfo | null"
},
{
"name": "payme",
"baseName": "payme",
Expand Down
2 changes: 1 addition & 1 deletion src/typings/management/paymentMethodResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,12 @@ export namespace PaymentMethodResponse {
Nyce = 'nyce',
OnlineBankingPl = 'onlineBanking_PL',
Paybybank = 'paybybank',
PaybybankPlaid = 'paybybank_plaid',
Payme = 'payme',
PaymePos = 'payme_pos',
Paynow = 'paynow',
PaynowPos = 'paynow_pos',
Paypal = 'paypal',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The removal of Payshop from the enum requires verification that no part of the application relies on this payment method. If there are, those sections will need to be updated.

Payshop = 'payshop',
Payto = 'payto',
Pulse = 'pulse',
Sodexo = 'sodexo',
Expand Down
16 changes: 8 additions & 8 deletions src/typings/management/paymentMethodSetupInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ import { CartesBancairesInfo } from './cartesBancairesInfo';
import { ClearpayInfo } from './clearpayInfo';
import { DinersInfo } from './dinersInfo';
import { GenericPmWithTdiInfo } from './genericPmWithTdiInfo';
import { GiroPayInfo } from './giroPayInfo';
import { GooglePayInfo } from './googlePayInfo';
import { JCBInfo } from './jCBInfo';
import { KlarnaInfo } from './klarnaInfo';
import { MealVoucherFRInfo } from './mealVoucherFRInfo';
import { NyceInfo } from './nyceInfo';
import { PayByBankPlaidInfo } from './payByBankPlaidInfo';
import { PayMeInfo } from './payMeInfo';
import { PayPalInfo } from './payPalInfo';
import { PayToInfo } from './payToInfo';
Expand Down Expand Up @@ -67,7 +67,6 @@ export class PaymentMethodSetupInfo {
'discover'?: GenericPmWithTdiInfo | null;
'eft_directdebit_CA'?: GenericPmWithTdiInfo | null;
'eftpos_australia'?: GenericPmWithTdiInfo | null;
'giroPay'?: GiroPayInfo | null;
'girocard'?: GenericPmWithTdiInfo | null;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The removal of giroPay requires verification that no part of the application relies on this payment method. If there are, those sections will need to be updated.

'googlePay'?: GooglePayInfo | null;
'ideal'?: GenericPmWithTdiInfo | null;
Expand All @@ -78,6 +77,7 @@ export class PaymentMethodSetupInfo {
'mc'?: GenericPmWithTdiInfo | null;
'mealVoucher_FR'?: MealVoucherFRInfo | null;
'nyce'?: NyceInfo | null;
'paybybank_plaid'?: PayByBankPlaidInfo | null;
'payme'?: PayMeInfo | null;
'paypal'?: PayPalInfo | null;
'payto'?: PayToInfo | null;
Expand Down Expand Up @@ -197,11 +197,6 @@ export class PaymentMethodSetupInfo {
"baseName": "eftpos_australia",
"type": "GenericPmWithTdiInfo | null"
},
{
"name": "giroPay",
"baseName": "giroPay",
"type": "GiroPayInfo | null"
},
{
"name": "girocard",
"baseName": "girocard",
Expand Down Expand Up @@ -252,6 +247,11 @@ export class PaymentMethodSetupInfo {
"baseName": "nyce",
"type": "NyceInfo | null"
},
{
"name": "paybybank_plaid",
"baseName": "paybybank_plaid",
"type": "PayByBankPlaidInfo | null"
},
{
"name": "payme",
"baseName": "payme",
Expand Down Expand Up @@ -408,12 +408,12 @@ export namespace PaymentMethodSetupInfo {
Nyce = 'nyce',
OnlineBankingPl = 'onlineBanking_PL',
Paybybank = 'paybybank',
PaybybankPlaid = 'paybybank_plaid',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The addition of PaybybankPlaid to the enum requires verification that all parts of the application that use this enum are updated to handle this new value.

Payme = 'payme',
PaymePos = 'payme_pos',
Paynow = 'paynow',
PaynowPos = 'paynow_pos',
Paypal = 'paypal',
Payshop = 'payshop',
Payto = 'payto',
Pulse = 'pulse',
Sodexo = 'sodexo',
Expand Down
Loading