Foreign Currency (#347)

* RichMerchantData and CurrencyConversion added

* lint

---------

Co-authored-by: Ilya Merman <[email protected]>

Author: axshani

types/authorization.ts

@@ -1,4 +1,4 @@
-import { CardNetwork, Merchant, Relationship, Tags, UnimplementedRelationships } from "./common"
+import { CardNetwork, CurrencyConversion, Merchant, Relationship, RichMerchantData, Tags, UnimplementedRelationships } from "./common"
 
 export type AuthorizationStatus = "Authorized" | "Completed" | "Canceled" | "Declined"
 
@@ -86,6 +86,16 @@ export interface Authorization {
          * Optional. Summary of the authorization.
          */
         summary?: string
+
+        /**
+         * Optional. Full merchant information.
+         */
+        richMerchantData?: RichMerchantData
+
+        /**
+         * Optional. When original currency for transaction is not USD
+         */
+        currencyConversion?: CurrencyConversion
     }
 
     /**

types/common.ts

@@ -160,10 +160,10 @@ export interface Officer extends BaseContactAttributes {
 
 
 export type BusinessContact = {
-     /**
-     * Optional. See (this)[https://docs.unit.co/customer-api-tokens/#customers-create-customer-bearer-token-jwt] section for more information.
-     */
-     jwtSubject?: string
+    /**
+    * Optional. See (this)[https://docs.unit.co/customer-api-tokens/#customers-create-customer-bearer-token-jwt] section for more information.
+    */
+    jwtSubject?: string
 } & Pick<BaseContactAttributes, "fullName" | "email" | "phone">
 
 export type AuthorizedUser = Pick<BaseContactAttributes, "fullName" | "email" | "phone"> & {
@@ -400,12 +400,33 @@ export interface TrustContact extends Pick<BaseContactAttributes, "fullName" | "
 }
 
 export type Industry = "Retail" | "Wholesale" | "Restaurants" | "Hospitals" | "Construction" | "Insurance" | "Unions" | "RealEstate" |
- "FreelanceProfessional" | "OtherProfessionalServices" | "OnlineRetailer" | "OtherEducationServices"
- 
+    "FreelanceProfessional" | "OtherProfessionalServices" | "OnlineRetailer" | "OtherEducationServices"
+
 export type Direction = "Credit" | "Debit"
 
 export type CardNetwork = "Visa" | "Interlink" | "Accel" | "Allpoint" | "Other"
 
+export interface RichMerchantData {
+    logo?: string // URL of the merchant's logo.
+    phone?: string // Phone number of the merchant.
+    categories?: Array<{ name: string; icon: string; }> // Array of categories the merchant belongs to (from the least specific to the most specific).
+    address?: { city: string; state: string; country: string; street?: string; } // Address of the merchant.
+    coordinates?: Coordinates // Coordinates (latitude, longitude) of the merchant.
+    facilitators?: Array<RichMerchantDataFacilitator> // The transaction facilitators.
+}
+
+export interface RichMerchantDataFacilitator {
+    name: string // Name of the facilitator.
+    type?: "BuyNowPayLater" | "DeliveryService" | "Marketplace" | "PaymentProcessor" | "Platform" | "PointOfSale" // Optional. Type of the facilitator.
+    logo?: string // Optional. URL of the facilitator.
+}
+
+export interface CurrencyConversion {
+    originalCurrency: string // ISO 4217 currency code of original currency.
+    amountInOriginalCurrency: number // The amount in original currency in 'cents' (i.e. 50 euros will be written 5000)
+    fxRate?: string // Optional. The conversion rate for the currency conversion to USD.
+}
+
 export interface UnitResponse<T> {
     data: T
 }
@@ -430,15 +451,15 @@ export interface Meta extends UnimplementedFields {
 }
 
 export interface BaseCreateRequestAttributes {
-        /**
-         * See [Tags](https://developers.unit.co/#tags).
-         */
-        tags?: Tags
+    /**
+     * See [Tags](https://developers.unit.co/#tags).
+     */
+    tags?: Tags
 
-        /**
-         * See [Idempotency.](https://developers.unit.co/#intro-idempotency)
-         */
-        idempotencyKey?: string
+    /**
+     * See [Idempotency.](https://developers.unit.co/#intro-idempotency)
+     */
+    idempotencyKey?: string
 }
 
 export interface UnitConfig {

types/transactions.ts

@@ -1,8 +1,8 @@
-import { Address, CardNetwork, Coordinates, Counterparty, Direction, Merchant, Relationship, RelationshipsArray, Tags, UnimplementedFields } from "./common"
+import { Address, CardNetwork, Coordinates, Counterparty, CurrencyConversion, Direction, Merchant, Relationship, RelationshipsArray, RichMerchantData, Tags, UnimplementedFields } from "./common"
 
-export type Transaction = OriginatedAchTransaction | ReceivedAchTransaction | ReturnedAchTransaction | ReturnedReceivedAchTransaction | DishonoredAchTransaction | BookTransaction | PurchaseTransaction | AtmTransaction | FeeTransaction | 
-CardReversalTransaction | CardTransaction | WireTransaction | ReleaseTransaction | AdjustmentTransaction | InterestTransaction | DisputeTransaction | CheckDepositTransaction | ReturnedCheckDepositTransaction | PaymentAdvanceTransaction | 
-RepaidPaymentAdvanceTransaction | PaymentCanceledTransaction | RewardTransaction | NegativeBalanceCoverageTransaction | PushToCardTransaction | AccountLowBalanceClosureTransaction
+export type Transaction = OriginatedAchTransaction | ReceivedAchTransaction | ReturnedAchTransaction | ReturnedReceivedAchTransaction | DishonoredAchTransaction | BookTransaction | PurchaseTransaction | AtmTransaction | FeeTransaction |
+    CardReversalTransaction | CardTransaction | WireTransaction | ReleaseTransaction | AdjustmentTransaction | InterestTransaction | DisputeTransaction | CheckDepositTransaction | ReturnedCheckDepositTransaction | PaymentAdvanceTransaction |
+    RepaidPaymentAdvanceTransaction | PaymentCanceledTransaction | RewardTransaction | NegativeBalanceCoverageTransaction | PushToCardTransaction | AccountLowBalanceClosureTransaction
 
 export interface BaseTransaction {
     /**
@@ -396,8 +396,28 @@ export type PurchaseTransaction = BaseTransaction & {
          * Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
          */
         interchange?: number
+
+        /**
+         * Optional. The gross interchange share for this transaction.
+         */
+        grossInterchange?: string
+
+        /**
+         * Optional. Cash withdrawal amount
+         */
+        cashWithdrawalAmount?: number
+
+        /**
+         * Optional. Full merchant information.
+         */
+        richMerchantData?: RichMerchantData
+
+        /**
+         * Optional. When original currency for transaction is not USD.
+         */
+        currencyConversion?: CurrencyConversion
     } & CardRelatedTransactionsBaseAttributes &
-        BaseTransactionAttributes
+    BaseTransactionAttributes
 
     /**
      * Describes relationships between the transaction resource and other resources (account and customer).
@@ -455,6 +475,16 @@ export type AtmTransaction = BaseTransaction & {
          * Calculated at the end of each day, see the [transaction.updated](https://developers.unit.co/events/#transactionupdated) event.
          */
         intercharge?: number
+
+        /**
+         * Optional. The gross interchange share for this transaction.
+         */
+        grossInterchange?: string
+
+        /**
+         * Optional. When original currency for transaction is not USD.
+         */
+        currencyConversion?: CurrencyConversion
     }
 
     /**
@@ -531,6 +561,21 @@ export type CardTransaction = BaseTransaction & {
          * Optional. The interchange share for this transaction. Calculated at the end of each day, see the [transaction.updated](https://developers.unit.co/events/#transactionupdated) event.
          */
         interchange?: number
+
+        /**
+         * Optional. The gross interchange share for this transaction.
+         */
+        grossInterchange?: string
+
+        /**
+         * Optional. Full merchant information.
+         */
+        richMerchantData?: RichMerchantData
+
+        /**
+         * Optional. When original currency for transaction is not USD.
+         */
+        currencyConversion?: CurrencyConversion
     } & CardRelatedTransactionsBaseAttributes
 
     /**