feat(api): updates (#235)

Modern-Treasury · Sep 19, 2023 · ce16952 · ce16952
1 parent c2d9f18
commit ce16952
Show file tree

Hide file tree

Showing 30 changed files with 1,014 additions and 76 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1 +1 @@
-configured_endpoints: 127
+configured_endpoints: 134
diff --git a/api.md b/api.md
@@ -102,6 +102,7 @@ Methods:
 - <code title="get /api/invoices/{id}">client.invoices.<a href="./src/resources/invoices/invoices.ts">retrieve</a>(id) -> Invoice</code>
 - <code title="patch /api/invoices/{id}">client.invoices.<a href="./src/resources/invoices/invoices.ts">update</a>(id, { ...params }) -> Invoice</code>
 - <code title="get /api/invoices">client.invoices.<a href="./src/resources/invoices/invoices.ts">list</a>({ ...params }) -> InvoicesPage</code>
+- <code title="put /api/invoices/{id}/payment_orders/{payment_order_id}">client.invoices.<a href="./src/resources/invoices/invoices.ts">addPaymentOrder</a>(id, paymentOrderId) -> void</code>
 
 ## LineItems
 
@@ -249,6 +250,20 @@ Methods:
 - <code title="get /api/ledger_accounts">client.ledgerAccounts.<a href="./src/resources/ledger-accounts.ts">list</a>({ ...params }) -> LedgerAccountsPage</code>
 - <code title="delete /api/ledger_accounts/{id}">client.ledgerAccounts.<a href="./src/resources/ledger-accounts.ts">del</a>(id) -> LedgerAccount</code>
 
+# LedgerAccountBalanceMonitors
+
+Types:
+
+- <code><a href="./src/resources/ledger-account-balance-monitors.ts">LedgerAccountBalanceMonitor</a></code>
+
+Methods:
+
+- <code title="post /api/ledger_account_balance_monitors">client.ledgerAccountBalanceMonitors.<a href="./src/resources/ledger-account-balance-monitors.ts">create</a>({ ...params }) -> LedgerAccountBalanceMonitor</code>
+- <code title="get /api/ledger_account_balance_monitors/{id}">client.ledgerAccountBalanceMonitors.<a href="./src/resources/ledger-account-balance-monitors.ts">retrieve</a>(id) -> LedgerAccountBalanceMonitor</code>
+- <code title="patch /api/ledger_account_balance_monitors/{id}">client.ledgerAccountBalanceMonitors.<a href="./src/resources/ledger-account-balance-monitors.ts">update</a>(id, { ...params }) -> LedgerAccountBalanceMonitor</code>
+- <code title="get /api/ledger_account_balance_monitors">client.ledgerAccountBalanceMonitors.<a href="./src/resources/ledger-account-balance-monitors.ts">list</a>({ ...params }) -> LedgerAccountBalanceMonitorsPage</code>
+- <code title="delete /api/ledger_account_balance_monitors/{id}">client.ledgerAccountBalanceMonitors.<a href="./src/resources/ledger-account-balance-monitors.ts">del</a>(id) -> LedgerAccountBalanceMonitor</code>
+
 # LedgerAccountPayouts
 
 Types:
@@ -258,9 +273,9 @@ Types:
 Methods:
 
 - <code title="post /api/ledger_account_payouts">client.ledgerAccountPayouts.<a href="./src/resources/ledger-account-payouts.ts">create</a>({ ...params }) -> LedgerAccountPayout</code>
+- <code title="get /api/ledger_account_payouts/{id}">client.ledgerAccountPayouts.<a href="./src/resources/ledger-account-payouts.ts">retrieve</a>(id) -> LedgerAccountPayout</code>
 - <code title="patch /api/ledger_account_payouts/{id}">client.ledgerAccountPayouts.<a href="./src/resources/ledger-account-payouts.ts">update</a>(id, { ...params }) -> LedgerAccountPayout</code>
 - <code title="get /api/ledger_account_payouts">client.ledgerAccountPayouts.<a href="./src/resources/ledger-account-payouts.ts">list</a>({ ...params }) -> LedgerAccountPayoutsPage</code>
-- <code title="get /api/ledger_account_payouts/{id}">client.ledgerAccountPayouts.<a href="./src/resources/ledger-account-payouts.ts">retireve</a>(id) -> LedgerAccountPayout</code>
 
 # LedgerAccountStatements
 
@@ -386,8 +401,8 @@ Types:
 
 Methods:
 
+- <code title="get /api/payment_references/{id}">client.paymentReferences.<a href="./src/resources/payment-references.ts">retrieve</a>(id) -> PaymentReference</code>
 - <code title="get /api/payment_references">client.paymentReferences.<a href="./src/resources/payment-references.ts">list</a>({ ...params }) -> PaymentReferencesPage</code>
-- <code title="get /api/payment_references/{id}">client.paymentReferences.<a href="./src/resources/payment-references.ts">retireve</a>(id) -> PaymentReference</code>
 
 # Returns
 
@@ -421,7 +436,8 @@ Types:
 
 Methods:
 
-- <code title="get /api/transactions/{transaction_id}/line_items">client.transactions.lineItems.<a href="./src/resources/transactions/line-items.ts">list</a>(transactionId, { ...params }) -> TransactionLineItemsPage</code>
+- <code title="get /api/transaction_line_items/{id}">client.transactions.lineItems.<a href="./src/resources/transactions/line-items.ts">retrieve</a>(id) -> TransactionLineItem</code>
+- <code title="get /api/transaction_line_items">client.transactions.lineItems.<a href="./src/resources/transactions/line-items.ts">list</a>({ ...params }) -> TransactionLineItemsPage</code>
 
 # Validations
 

diff --git a/src/index.ts b/src/index.ts
@@ -151,6 +151,7 @@ export class ModernTreasury extends Core.APIClient {
   ledgerableEvents: API.LedgerableEvents = new API.LedgerableEvents(this);
   ledgerAccountCategories: API.LedgerAccountCategories = new API.LedgerAccountCategories(this);
   ledgerAccounts: API.LedgerAccounts = new API.LedgerAccounts(this);
+  ledgerAccountBalanceMonitors: API.LedgerAccountBalanceMonitors = new API.LedgerAccountBalanceMonitors(this);
   ledgerAccountPayouts: API.LedgerAccountPayouts = new API.LedgerAccountPayouts(this);
   ledgerAccountStatements: API.LedgerAccountStatements = new API.LedgerAccountStatements(this);
   ledgerEntries: API.LedgerEntries = new API.LedgerEntries(this);
@@ -353,6 +354,13 @@ export namespace ModernTreasury {
   export import LedgerAccountUpdateParams = API.LedgerAccountUpdateParams;
   export import LedgerAccountListParams = API.LedgerAccountListParams;
 
+  export import LedgerAccountBalanceMonitors = API.LedgerAccountBalanceMonitors;
+  export import LedgerAccountBalanceMonitor = API.LedgerAccountBalanceMonitor;
+  export import LedgerAccountBalanceMonitorsPage = API.LedgerAccountBalanceMonitorsPage;
+  export import LedgerAccountBalanceMonitorCreateParams = API.LedgerAccountBalanceMonitorCreateParams;
+  export import LedgerAccountBalanceMonitorUpdateParams = API.LedgerAccountBalanceMonitorUpdateParams;
+  export import LedgerAccountBalanceMonitorListParams = API.LedgerAccountBalanceMonitorListParams;
+
   export import LedgerAccountPayouts = API.LedgerAccountPayouts;
   export import LedgerAccountPayout = API.LedgerAccountPayout;
   export import LedgerAccountPayoutsPage = API.LedgerAccountPayoutsPage;

diff --git a/src/resources/account-collection-flows.ts b/src/resources/account-collection-flows.ts
@@ -115,6 +115,26 @@ export interface AccountCollectionFlow {
 
   object?: string;
 
+  receiving_countries?: Array<
+    | 'USA'
+    | 'AUS'
+    | 'BEL'
+    | 'CAN'
+    | 'CHL'
+    | 'CHN'
+    | 'COL'
+    | 'FRA'
+    | 'DEU'
+    | 'HKG'
+    | 'IND'
+    | 'IRL'
+    | 'ITA'
+    | 'MEX'
+    | 'NLD'
+    | 'PER'
+    | 'ESP'
+  >;
+
   /**
    * The current status of the account collection flow. One of `pending`,
    * `completed`, `expired`, or `cancelled`.
@@ -131,6 +151,26 @@ export interface AccountCollectionFlowCreateParams {
   counterparty_id: string;
 
   payment_types: Array<string>;
+
+  receiving_countries?: Array<
+    | 'USA'
+    | 'AUS'
+    | 'BEL'
+    | 'CAN'
+    | 'CHL'
+    | 'CHN'
+    | 'COL'
+    | 'FRA'
+    | 'DEU'
+    | 'HKG'
+    | 'IND'
+    | 'IRL'
+    | 'ITA'
+    | 'MEX'
+    | 'NLD'
+    | 'PER'
+    | 'ESP'
+  >;
 }
 
 export interface AccountCollectionFlowUpdateParams {

diff --git a/src/resources/counterparties.ts b/src/resources/counterparties.ts
@@ -533,18 +533,21 @@ export namespace CounterpartyCreateParams {
       routing_number_type:
         | 'aba'
         | 'au_bsb'
+        | 'se_bankgiro_clearing_code'
         | 'br_codigo'
         | 'ca_cpa'
         | 'chips'
         | 'cnaps'
         | 'gb_sort_code'
         | 'in_ifsc'
         | 'my_branch_code'
-        | 'swift';
+        | 'swift'
+        | 'jp_zengin_code';
 
       payment_type?:
         | 'ach'
         | 'au_becs'
+        | 'se_bankgirot'
         | 'bacs'
         | 'book'
         | 'card'
@@ -554,12 +557,15 @@ export namespace CounterpartyCreateParams {
         | 'interac'
         | 'masav'
         | 'neft'
+        | 'nics'
         | 'provxchange'
         | 'rtp'
         | 'sen'
+        | 'sic'
         | 'sepa'
         | 'signet'
-        | 'wire';
+        | 'wire'
+        | 'zengin';
     }
   }
 }
@@ -668,6 +674,7 @@ export interface CounterpartyCollectAccountParams {
     | 'brCodigo'
     | 'routingNumberType'
     | 'address'
+    | 'jp_zengin_code'
   >;
 
   /**

diff --git a/src/resources/expected-payments.ts b/src/resources/expected-payments.ts
@@ -193,7 +193,7 @@ export interface ExpectedPayment {
   /**
    * One of unreconciled, reconciled, or archived.
    */
-  status: 'archived' | 'reconciled' | 'unreconciled';
+  status: 'archived' | 'partially_reconciled' | 'reconciled' | 'unreconciled';
 
   /**
    * The ID of the Transaction this expected payment object has been matched to.
@@ -230,12 +230,16 @@ export type ExpectedPaymentType =
   | 'interac'
   | 'masav'
   | 'neft'
+  | 'nics'
   | 'provxchange'
   | 'rtp'
+  | 'se_bankgirot'
   | 'sen'
   | 'sepa'
+  | 'sic'
   | 'signet'
   | 'wire'
+  | 'zengin'
   | null;
 
 export interface ExpectedPaymentCreateParams {
@@ -477,7 +481,7 @@ export interface ExpectedPaymentListParams extends PageParams {
   /**
    * One of unreconciled, reconciled, or archived.
    */
-  status?: 'archived' | 'reconciled' | 'unreconciled';
+  status?: 'archived' | 'partially_reconciled' | 'reconciled' | 'unreconciled';
 
   /**
    * One of: ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp,sen,
@@ -495,12 +499,16 @@ export interface ExpectedPaymentListParams extends PageParams {
     | 'interac'
     | 'masav'
     | 'neft'
+    | 'nics'
     | 'provxchange'
     | 'rtp'
+    | 'se_bankgirot'
     | 'sen'
     | 'sepa'
+    | 'sic'
     | 'signet'
-    | 'wire';
+    | 'wire'
+    | 'zengin';
 }
 
 export namespace ExpectedPayments {

diff --git a/src/resources/external-accounts.ts b/src/resources/external-accounts.ts
@@ -454,18 +454,21 @@ export namespace ExternalAccountCreateParams {
     routing_number_type:
       | 'aba'
       | 'au_bsb'
+      | 'se_bankgiro_clearing_code'
       | 'br_codigo'
       | 'ca_cpa'
       | 'chips'
       | 'cnaps'
       | 'gb_sort_code'
       | 'in_ifsc'
       | 'my_branch_code'
-      | 'swift';
+      | 'swift'
+      | 'jp_zengin_code';
 
     payment_type?:
       | 'ach'
       | 'au_becs'
+      | 'se_bankgirot'
       | 'bacs'
       | 'book'
       | 'card'
@@ -475,12 +478,15 @@ export namespace ExternalAccountCreateParams {
       | 'interac'
       | 'masav'
       | 'neft'
+      | 'nics'
       | 'provxchange'
       | 'rtp'
       | 'sen'
+      | 'sic'
       | 'sepa'
       | 'signet'
-      | 'wire';
+      | 'wire'
+      | 'zengin';
   }
 }
 
@@ -587,12 +593,16 @@ export interface ExternalAccountVerifyParams {
     | 'interac'
     | 'masav'
     | 'neft'
+    | 'nics'
     | 'provxchange'
     | 'rtp'
+    | 'se_bankgirot'
     | 'sen'
     | 'sepa'
+    | 'sic'
     | 'signet'
-    | 'wire';
+    | 'wire'
+    | 'zengin';
 
   /**
    * Defaults to the currency of the originating account.

diff --git a/src/resources/incoming-payment-details.ts b/src/resources/incoming-payment-details.ts
@@ -176,7 +176,9 @@ export interface IncomingPaymentDetail {
     | 'cnaps'
     | 'gb_sort_code'
     | 'in_ifsc'
+    | 'jp_zengin_code'
     | 'my_branch_code'
+    | 'se_bankgiro_clearing_code'
     | 'swift'
     | null;
 

diff --git a/src/resources/index.ts b/src/resources/index.ts
@@ -90,6 +90,14 @@ export {
   LedgerAccountsPage,
   LedgerAccounts,
 } from './ledger-accounts';
+export {
+  LedgerAccountBalanceMonitor,
+  LedgerAccountBalanceMonitorCreateParams,
+  LedgerAccountBalanceMonitorUpdateParams,
+  LedgerAccountBalanceMonitorListParams,
+  LedgerAccountBalanceMonitorsPage,
+  LedgerAccountBalanceMonitors,
+} from './ledger-account-balance-monitors';
 export {
   LedgerAccountCategory,
   LedgerAccountCategoryCreateParams,

diff --git a/src/resources/internal-accounts/internal-accounts.ts b/src/resources/internal-accounts/internal-accounts.ts
@@ -349,12 +349,16 @@ export interface InternalAccountListParams extends PageParams {
     | 'interac'
     | 'masav'
     | 'neft'
+    | 'nics'
     | 'provxchange'
     | 'rtp'
+    | 'se_bankgirot'
     | 'sen'
     | 'sepa'
+    | 'sic'
     | 'signet'
-    | 'wire';
+    | 'wire'
+    | 'zengin';
 }
 
 export namespace InternalAccounts {