Generate Transfer webhooks

gcatanese · gcatanese · commit ffdd558c3885 · 2025-05-13T13:57:38.000+02:00
diff --git a/src/typings/transferWebhooks/address.ts b/src/typings/transferWebhooks/address.ts
@@ -10,27 +10,27 @@
 
 export class Address {
     /**
-    * The name of the city.  Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \\ | and Space.
+    * The name of the city.  Supported characters: **[a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \\ |** and Space.  > Required when the `category` is **card**. 
     */
     'city'?: string;
     /**
     * The two-character ISO 3166-1 alpha-2 country code. For example, **US**, **NL**, or **GB**.
     */
     'country': string;
     /**
-    * First line of the street address.  Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \\ | and Space.
+    * The first line of the street address.  Supported characters: **[a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \\ |** and Space.  > Required when the `category` is **card**. 
     */
     'line1'?: string;
     /**
-    * Second line of the street address.  Supported characters: [a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \\ | and Space.
+    * The second line of the street address.  Supported characters: **[a-z] [A-Z] [0-9] . - — / # , ’ ° ( ) : ; [ ] & \\ |** and Space.  > Required when the `category` is **card**. 
     */
     'line2'?: string;
     /**
-    * The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries.  Supported characters: [a-z] [A-Z] [0-9] and Space. 
+    * The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries.  Supported characters: **[a-z] [A-Z] [0-9]** and Space.  > Required for addresses in the US. 
     */
     'postalCode'?: string;
     /**
-    *    The two-letter ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.    > Required for the US and Canada. 
+    *    The two-letter ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.     > Required for the US and Canada. 
     */
     'stateOrProvince'?: string;
 
diff --git a/src/typings/transferWebhooks/issuingTransactionData.ts b/src/typings/transferWebhooks/issuingTransactionData.ts
@@ -0,0 +1,44 @@
+/*
+ * The version of the OpenAPI document: v4
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+
+export class IssuingTransactionData {
+    /**
+    * captureCycleId associated with transfer event.
+    */
+    'captureCycleId'?: string;
+    /**
+    * The type of events data.   Possible values:    - **issuingTransactionData**: issuing transaction data
+    */
+    'type': IssuingTransactionData.TypeEnum;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "captureCycleId",
+            "baseName": "captureCycleId",
+            "type": "string"
+        },
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "IssuingTransactionData.TypeEnum"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return IssuingTransactionData.attributeTypeMap;
+    }
+}
+
+export namespace IssuingTransactionData {
+    export enum TypeEnum {
+        IssuingTransactionData = 'issuingTransactionData'
+    }
+}
diff --git a/src/typings/transferWebhooks/lodging.ts b/src/typings/transferWebhooks/lodging.ts
@@ -0,0 +1,39 @@
+/*
+ * The version of the OpenAPI document: v4
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+
+export class Lodging {
+    /**
+    * The check-in date.
+    */
+    'checkInDate'?: string;
+    /**
+    * The total number of nights the room is booked for.
+    */
+    'numberOfNights'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "checkInDate",
+            "baseName": "checkInDate",
+            "type": "string"
+        },
+        {
+            "name": "numberOfNights",
+            "baseName": "numberOfNights",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Lodging.attributeTypeMap;
+    }
+}
+
diff --git a/src/typings/transferWebhooks/merchantData.ts b/src/typings/transferWebhooks/merchantData.ts
@@ -19,12 +19,12 @@ export class MerchantData {
     */
     'mcc'?: string;
     /**
-    * The merchant identifier.
+    * The unique identifier of the merchant.
     */
     'merchantId'?: string;
     'nameLocation'?: NameLocation | null;
     /**
-    * The merchant postal code.
+    * The postal code of the merchant.
     */
     'postalCode'?: string;
 
diff --git a/src/typings/transferWebhooks/merchantPurchaseData.ts b/src/typings/transferWebhooks/merchantPurchaseData.ts
@@ -8,10 +8,15 @@
  */
 
 import { Airline } from './airline';
+import { Lodging } from './lodging';
 
 export class MerchantPurchaseData {
     'airline'?: Airline | null;
     /**
+    * Lodging information.
+    */
+    'lodging'?: Array<Lodging>;
+    /**
     * The type of events data.   Possible values:    - **merchantPurchaseData**: merchant purchase data
     */
     'type': MerchantPurchaseData.TypeEnum;
@@ -24,6 +29,11 @@ export class MerchantPurchaseData {
             "baseName": "airline",
             "type": "Airline | null"
         },
+        {
+            "name": "lodging",
+            "baseName": "lodging",
+            "type": "Array<Lodging>"
+        },
         {
             "name": "type",
             "baseName": "type",
diff --git a/src/typings/transferWebhooks/models.ts b/src/typings/transferWebhooks/models.ts
@@ -35,7 +35,9 @@ export * from './ibanAccountIdentification';
 export * from './internalCategoryData';
 export * from './internalReviewTrackingData';
 export * from './issuedCard';
+export * from './issuingTransactionData';
 export * from './leg';
+export * from './lodging';
 export * from './merchantData';
 export * from './merchantPurchaseData';
 export * from './modification';
@@ -94,7 +96,9 @@ import { IbanAccountIdentification } from './ibanAccountIdentification';
 import { InternalCategoryData } from './internalCategoryData';
 import { InternalReviewTrackingData } from './internalReviewTrackingData';
 import { IssuedCard } from './issuedCard';
+import { IssuingTransactionData } from './issuingTransactionData';
 import { Leg } from './leg';
+import { Lodging } from './lodging';
 import { MerchantData } from './merchantData';
 import { MerchantPurchaseData } from './merchantPurchaseData';
 import { Modification } from './modification';
@@ -161,6 +165,7 @@ let enumsMap: {[index: string]: any} = {
         "IssuedCard.PanEntryModeEnum": IssuedCard.PanEntryModeEnum,
         "IssuedCard.ProcessingTypeEnum": IssuedCard.ProcessingTypeEnum,
         "IssuedCard.TypeEnum": IssuedCard.TypeEnum,
+        "IssuingTransactionData.TypeEnum": IssuingTransactionData.TypeEnum,
         "MerchantPurchaseData.TypeEnum": MerchantPurchaseData.TypeEnum,
         "Modification.StatusEnum": Modification.StatusEnum,
         "NOLocalAccountIdentification.TypeEnum": NOLocalAccountIdentification.TypeEnum,
@@ -181,6 +186,7 @@ let enumsMap: {[index: string]: any} = {
         "TransferEvent.StatusEnum": TransferEvent.StatusEnum,
         "TransferEvent.TypeEnum": TransferEvent.TypeEnum,
         "TransferNotificationRequest.TypeEnum": TransferNotificationRequest.TypeEnum,
+        "TransferReview.ScaOnApprovalEnum": TransferReview.ScaOnApprovalEnum,
         "UKLocalAccountIdentification.TypeEnum": UKLocalAccountIdentification.TypeEnum,
         "USLocalAccountIdentification.AccountTypeEnum": USLocalAccountIdentification.AccountTypeEnum,
         "USLocalAccountIdentification.TypeEnum": USLocalAccountIdentification.TypeEnum,
@@ -214,7 +220,9 @@ let typeMap: {[index: string]: any} = {
     "InternalCategoryData": InternalCategoryData,
     "InternalReviewTrackingData": InternalReviewTrackingData,
     "IssuedCard": IssuedCard,
+    "IssuingTransactionData": IssuingTransactionData,
     "Leg": Leg,
+    "Lodging": Lodging,
     "MerchantData": MerchantData,
     "MerchantPurchaseData": MerchantPurchaseData,
     "Modification": Modification,
diff --git a/src/typings/transferWebhooks/platformPayment.ts b/src/typings/transferWebhooks/platformPayment.ts
@@ -22,7 +22,7 @@ export class PlatformPayment {
     */
     'paymentMerchantReference'?: string;
     /**
-    * Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).  Possible values:  * **AcquiringFees**: for the acquiring fee incurred on a transaction.  * **AdyenCommission**: for the transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing).  * **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen\'s commission and Adyen\'s markup.  * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).  * **BalanceAccount**: or the sale amount of a transaction.  * **Commission**: for your platform\'s commission on a transaction.  * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.  * **PaymentFee**: for all of the transaction fees.  * **Remainder**: for the left over amount after currency conversion.  * **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.  * **Surcharge**: for the surcharge paid by the customer on a transaction.  * **Tip**: for the tip paid by the customer.  * **TopUp**: for an incoming transfer to top up your user\'s balance account.  * **VAT**: for the Value Added Tax.
+    * Specifies the nature of the transfer. This parameter helps categorize transfers so you can reconcile transactions at a later time, using the Balance Platform Accounting Report for [marketplaces](https://docs.adyen.com/marketplaces/reports-and-fees/balance-platform-accounting-report/) or [platforms](https://docs.adyen.com/platforms/reports-and-fees/balance-platform-accounting-report/).  Possible values:  * **AcquiringFees**: for the acquiring fee incurred on a transaction.  * **AdyenCommission**: for the transaction fee due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/guides/payments-training-guide/get-the-best-from-your-card-processing).  * **AdyenFees**: for all the transaction fees due to Adyen. This is the sum of Adyen\'s commission and Adyen\'s markup.  * **AdyenMarkup**: for the transaction fee due to Adyen under [Interchange++ pricing](https://www.adyen.com/pricing).  * **BalanceAccount**: or the sale amount of a transaction.  * **Commission**: for your platform\'s commission on a transaction.  * **DCCPlatformCommission**: for the DCC Commission for the platform on a transaction.  * **Interchange**: for the interchange fee (fee paid to the issuer) incurred on a transaction.  * **PaymentFee**: for all of the transaction fees.  * **Remainder**: for the left over amount after currency conversion.  * **SchemeFee**: for the scheme fee incurred on a transaction. This is the sum of the interchange fees and the acquiring fees.  * **Surcharge**: for the surcharge paid by the customer on a transaction.  * **Tip**: for the tip paid by the customer.  * **TopUp**: for an incoming transfer to top up your user\'s balance account.  * **VAT**: for the Value Added Tax.
     */
     'platformPaymentType'?: PlatformPayment.PlatformPaymentTypeEnum;
     /**
@@ -80,7 +80,9 @@ export namespace PlatformPayment {
         AdyenFees = 'AdyenFees',
         AdyenMarkup = 'AdyenMarkup',
         BalanceAccount = 'BalanceAccount',
+        ChargebackRemainder = 'ChargebackRemainder',
         Commission = 'Commission',
+        DccPlatformCommission = 'DCCPlatformCommission',
         Default = 'Default',
         Interchange = 'Interchange',
         PaymentFee = 'PaymentFee',
diff --git a/src/typings/transferWebhooks/transferData.ts b/src/typings/transferWebhooks/transferData.ts
@@ -13,6 +13,7 @@ import { BankCategoryData } from './bankCategoryData';
 import { ConfirmationTrackingData } from './confirmationTrackingData';
 import { DirectDebitInformation } from './directDebitInformation';
 import { EstimationTrackingData } from './estimationTrackingData';
+import { ExternalReason } from './externalReason';
 import { InternalCategoryData } from './internalCategoryData';
 import { InternalReviewTrackingData } from './internalReviewTrackingData';
 import { IssuedCard } from './issuedCard';
@@ -59,13 +60,14 @@ export class TransferData {
     */
     'direction'?: TransferData.DirectionEnum;
     /**
-    * The event id listed under events, that triggered the notification.
+    * The unique identifier of the latest transfer event. Included only when the `category` is **issuedCard**.
     */
     'eventId'?: string;
     /**
     * The list of events leading up to the current status of the transfer.
     */
     'events'?: Array<TransferEvent>;
+    'externalReason'?: ExternalReason | null;
     /**
     * The ID of the resource.
     */
@@ -175,6 +177,11 @@ export class TransferData {
             "baseName": "events",
             "type": "Array<TransferEvent>"
         },
+        {
+            "name": "externalReason",
+            "baseName": "externalReason",
+            "type": "ExternalReason | null"
+        },
         {
             "name": "id",
             "baseName": "id",
@@ -265,6 +272,7 @@ export namespace TransferData {
         DirectDebitNotSupported = 'directDebitNotSupported',
         Error = 'error',
         NotEnoughBalance = 'notEnoughBalance',
+        Pending = 'pending',
         PendingApproval = 'pendingApproval',
         PendingExecution = 'pendingExecution',
         RefusedByCounterpartyBank = 'refusedByCounterpartyBank',
diff --git a/src/typings/transferWebhooks/transferEvent.ts b/src/typings/transferWebhooks/transferEvent.ts
@@ -14,13 +14,14 @@ import { ConfirmationTrackingData } from './confirmationTrackingData';
 import { EstimationTrackingData } from './estimationTrackingData';
 import { ExternalReason } from './externalReason';
 import { InternalReviewTrackingData } from './internalReviewTrackingData';
+import { IssuingTransactionData } from './issuingTransactionData';
 import { MerchantPurchaseData } from './merchantPurchaseData';
 import { Modification } from './modification';
 
 export class TransferEvent {
     'amount'?: Amount | null;
     /**
-    * The amount adjustments in this transfer.
+    * The amount adjustments in this transfer. Only applicable for [issuing](https://docs.adyen.com/issuing/) integrations.
     */
     'amountAdjustments'?: Array<AmountAdjustment>;
     /**
@@ -38,7 +39,7 @@ export class TransferEvent {
     /**
     * A list of event data.
     */
-    'eventsData'?: Array<MerchantPurchaseData>;
+    'eventsData'?: Array<IssuingTransactionData | MerchantPurchaseData>;
     'externalReason'?: ExternalReason | null;
     /**
     * The unique identifier of the transfer event.
@@ -110,7 +111,7 @@ export class TransferEvent {
         {
             "name": "eventsData",
             "baseName": "eventsData",
-            "type": "Array<MerchantPurchaseData>"
+            "type": "Array<IssuingTransactionData | MerchantPurchaseData>"
         },
         {
             "name": "externalReason",
@@ -195,6 +196,7 @@ export namespace TransferEvent {
         DirectDebitNotSupported = 'directDebitNotSupported',
         Error = 'error',
         NotEnoughBalance = 'notEnoughBalance',
+        Pending = 'pending',
         PendingApproval = 'pendingApproval',
         PendingExecution = 'pendingExecution',
         RefusedByCounterpartyBank = 'refusedByCounterpartyBank',
diff --git a/src/typings/transferWebhooks/transferNotificationMerchantData.ts b/src/typings/transferWebhooks/transferNotificationMerchantData.ts
@@ -26,15 +26,15 @@ export class TransferNotificationMerchantData {
     */
     'mcc'?: string;
     /**
-    * The merchant identifier.
+    * The unique identifier of the merchant.
     */
     'merchantId'?: string;
     /**
     * The name of the merchant\'s shop or service.
     */
     'name'?: string;
     /**
-    * The merchant postal code.
+    * The postal code of the merchant.
     */
     'postalCode'?: string;
 
diff --git a/src/typings/transferWebhooks/transferReview.ts b/src/typings/transferWebhooks/transferReview.ts
@@ -13,6 +13,10 @@ export class TransferReview {
     * Shows the number of [approvals](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers/approve) required to process the transfer.
     */
     'numberOfApprovalsRequired'?: number;
+    /**
+    * Shows the status of the Strong Customer Authentication (SCA) process.  Possible values: **required**, **notApplicable**.
+    */
+    'scaOnApproval'?: TransferReview.ScaOnApprovalEnum;
 
     static discriminator: string | undefined = undefined;
 
@@ -21,10 +25,22 @@ export class TransferReview {
             "name": "numberOfApprovalsRequired",
             "baseName": "numberOfApprovalsRequired",
             "type": "number"
+        },
+        {
+            "name": "scaOnApproval",
+            "baseName": "scaOnApproval",
+            "type": "TransferReview.ScaOnApprovalEnum"
         }    ];
 
     static getAttributeTypeMap() {
         return TransferReview.attributeTypeMap;
     }
 }
 
+export namespace TransferReview {
+    export enum ScaOnApprovalEnum {
+        Completed = 'completed',
+        NotApplicable = 'notApplicable',
+        Required = 'required'
+    }
+}
