🤖 Merge PR DefinitelyTyped#74595 [invity-api] add subdivision to lists and statusUrl to trades by @hehe100596

Author: hehe100596

types/invity-api/index.d.ts

@@ -100,6 +100,10 @@ export interface BuySellProviderMetadata extends ProviderMetadata {
     disabledSubdivisions?: Subdivisions;
 }
 
+export interface TradeCommon {
+    statusUrl?: string | null; // URL with ID assigned to the trade by the provider to check status; if null, do not show any status url
+}
+
 // buy types
 
 export type BuyTradeFinalStatus =
@@ -160,6 +164,7 @@ export interface BuyProviderInfo extends BuySellProviderMetadata {
 
 export interface BuyListResponse {
     country: string;
+    subdivision?: string;
     suggestedFiatCurrency?: string | undefined; // optional field, fiat currency based on user's IP
     providers: BuyProviderInfo[];
     defaultAmountsOfFiatCurrencies: FiatCurrenciesProps;
@@ -180,7 +185,7 @@ export interface BuyTradeQuoteRequest {
 
 export type BuyTradeQuoteResponse = BuyTrade[];
 
-export interface BuyTrade {
+export interface BuyTrade extends TradeCommon {
     fiatAmount?: number | undefined; // 1000 - DEPRECATED, used only for TREZOR
     fiatStringAmount?: string | undefined; // 1000 - will pay fiat amount
     fiatCurrency?: string | undefined; // EUR
@@ -294,7 +299,7 @@ export type DexApprovalType =
     | "ZERO" // resets approval
     | "PRESET"; // PRESET takes value from approvalStringAmount
 
-export interface ExchangeTrade {
+export interface ExchangeTrade extends TradeCommon {
     send?: CryptoId | undefined; // bitcoin
 
     sendStringAmount?: string | undefined; // "0.01"
@@ -314,7 +319,6 @@ export interface ExchangeTrade {
     signature?: string | undefined; // Evercoin only, passed from createTrade response to confirmTrade request
     orderId?: string | undefined; // internal ID assigned to the trade by the exchange
     quoteId?: string | undefined;
-    statusUrl?: string | undefined; // internal URL + ID assigned to the trade by the exchange to check status
     status?: ExchangeTradeStatus | undefined; // state of trade after confirmTrade
     error?: string | undefined; // something went wrong after confirmTrade
     receiveTxHash?: string | undefined; // hash of tx from exchange to user or DEX swap
@@ -494,6 +498,7 @@ export interface SellProviderInfo extends BuySellProviderMetadata {
 
 export interface SellListResponse {
     country: string;
+    subdivision?: string;
     providers: SellProviderInfo[];
 }
 
@@ -515,7 +520,7 @@ export interface SellFiatTradeQuoteRequest {
 
 export type SellFiatTradeQuoteResponse = SellFiatTrade[];
 
-export interface SellFiatTrade {
+export interface SellFiatTrade extends TradeCommon {
     amountInCrypto?: boolean | undefined; // true for cryptoAmount, false for fiatAmount
     fiatStringAmount?: string | undefined; // 1000
     fiatCurrency?: string | undefined; // EUR

types/invity-api/invity-api-tests.ts

@@ -1,4 +1,5 @@
 import {
+    BuyListResponse,
     BuyProviderInfo,
     BuyTrade,
     ConfirmExchangeTradeRequest,
@@ -12,6 +13,7 @@ import {
     InfoResponse,
     SellFiatTrade,
     SellFiatTradeSigned,
+    SellListResponse,
     SellProviderInfo,
     WatchSellTradeResponse,
 } from "invity-api";
@@ -178,3 +180,56 @@ const exchangeTradeQuoteRequest: ExchangeTradeQuoteRequest = {
     fromAddress: "fromAddress",
     receiveAddress: "receiveAddress",
 };
+
+const buyListResponse: BuyListResponse = {
+    country: "US",
+    subdivision: "WA",
+    suggestedFiatCurrency: "USD",
+    providers: [providerInfo],
+    defaultAmountsOfFiatCurrencies: {
+        usd: 1,
+        eur: 1,
+        gbp: 1,
+        aed: 1,
+        ars: 1,
+        aud: 1,
+        bdt: 1,
+        brl: 1,
+        cad: 1,
+        chf: 1,
+        clp: 1,
+        cny: 1,
+        czk: 1,
+        dkk: 1,
+        hkd: 1,
+        huf: 1,
+        idr: 1,
+        ils: 1,
+        inr: 1,
+        jpy: 1,
+        krw: 1,
+        kwd: 1,
+        lkr: 1,
+        mxn: 1,
+        myr: 1,
+        nok: 1,
+        nzd: 1,
+        php: 1,
+        pln: 1,
+        rub: 1,
+        sar: 1,
+        sek: 1,
+        sgd: 1,
+        thb: 1,
+        try: 1,
+        twd: 1,
+        vnd: 1,
+        zar: 1,
+    },
+};
+
+const sellListResponse: SellListResponse = {
+    country: "US",
+    subdivision: "WA",
+    providers: [sellProviderInfo],
+};