release: 2.18.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.17.0"
+  ".": "2.18.0"
 }

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 2.18.0 (2024-03-07)
+
+Full Changelog: [v2.17.0...v2.18.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.17.0...v2.18.0)
+
+### Features
+
+* **api:** add legal_structure enum member ([#350](https://github.com/Modern-Treasury/modern-treasury-node/issues/350)) ([9b0d264](https://github.com/Modern-Treasury/modern-treasury-node/commit/9b0d2644f3fb302fb21438db80b05ef091f5e81e))
+
+
+### Chores
+
+* **docs:** mention install from git repo ([#348](https://github.com/Modern-Treasury/modern-treasury-node/issues/348)) ([2059850](https://github.com/Modern-Treasury/modern-treasury-node/commit/2059850d97544230b5b693c76ec4b2f9dce31e36))
+* fix error handler in readme ([#351](https://github.com/Modern-Treasury/modern-treasury-node/issues/351)) ([9945dc2](https://github.com/Modern-Treasury/modern-treasury-node/commit/9945dc2044abb688d9facbd5f536f3ad4bdc0b1f))
+
+
+### Documentation
+
+* **readme:** fix https proxy example ([#352](https://github.com/Modern-Treasury/modern-treasury-node/issues/352)) ([142890f](https://github.com/Modern-Treasury/modern-treasury-node/commit/142890f21d48ce288c038439cfc4dc9d83eaf8f8))
+* remove extraneous --save and yarn install instructions ([#353](https://github.com/Modern-Treasury/modern-treasury-node/issues/353)) ([085dae2](https://github.com/Modern-Treasury/modern-treasury-node/commit/085dae29b1478576f31c791e29e26fa675417209))
+* use [@deprecated](https://github.com/deprecated) decorator for deprecated params ([#354](https://github.com/Modern-Treasury/modern-treasury-node/issues/354)) ([e8e2144](https://github.com/Modern-Treasury/modern-treasury-node/commit/e8e21442db2464df3f047da24f5cd92d8c61621a))
+
 ## 2.17.0 (2024-02-29)
 
 Full Changelog: [v2.16.0...v2.17.0](https://github.com/Modern-Treasury/modern-treasury-node/compare/v2.16.0...v2.17.0)

CONTRIBUTING.md

@@ -42,7 +42,7 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```bash
-npm install --save git+ssh://git@github.com:Modern-Treasury/modern-treasury-node.git
+npm install git+ssh://git@github.com:Modern-Treasury/modern-treasury-node.git
 ```
 
 Alternatively, to link a local copy of the repo:

README.md

@@ -9,9 +9,7 @@ The REST API documentation can be found [on docs.moderntreasury.com](https://doc
 ## Installation
 
 ```sh
-npm install --save modern-treasury
-# or
-yarn add modern-treasury
+npm install modern-treasury
 ```
 
 ## Usage
@@ -128,7 +126,7 @@ a subclass of `APIError` will be thrown:
 async function main() {
   const externalAccount = await modernTreasury.externalAccounts
     .create({ counterparty_id: 'missing' })
-    .catch((err) => {
+    .catch(async (err) => {
       if (err instanceof ModernTreasury.APIError) {
         console.log(err.status); // 400
         console.log(err.name); // BadRequestError
@@ -300,7 +298,7 @@ If you would like to disable or customize this behavior, for example to use the
 <!-- prettier-ignore -->
 ```ts
 import http from 'http';
-import HttpsProxyAgent from 'https-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 
 // Configure the default for all requests:
 const modernTreasury = new ModernTreasury({
@@ -309,9 +307,8 @@ const modernTreasury = new ModernTreasury({
 
 // Override per-request:
 await modernTreasury.externalAccounts.list({
-  baseURL: 'http://localhost:8080/test-api',
   httpAgent: new http.Agent({ keepAlive: false }),
-})
+});
 ```
 
 ## Semantic Versioning

package.json

@@ -1,6 +1,6 @@
 {
   "name": "modern-treasury",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "The official TypeScript library for the Modern Treasury API",
   "author": "Modern Treasury <sdk-feedback@moderntreasury.com>",
   "types": "dist/index.d.ts",

src/resources/bulk-requests.ts

@@ -173,14 +173,14 @@ export namespace BulkRequestCreateParams {
     accounting?: PaymentOrderAsyncCreateRequest.Accounting;
 
     /**
-     * The ID of one of your accounting categories. Note that these will only be
-     * accessible if your accounting system has been connected.
+     * @deprecated: The ID of one of your accounting categories. Note that these will
+     * only be accessible if your accounting system has been connected.
      */
     accounting_category_id?: string | null;
 
     /**
-     * The ID of one of your accounting ledger classes. Note that these will only be
-     * accessible if your accounting system has been connected.
+     * @deprecated: The ID of one of your accounting ledger classes. Note that these
+     * will only be accessible if your accounting system has been connected.
      */
     accounting_ledger_class_id?: string | null;
 
@@ -1177,14 +1177,14 @@ export namespace BulkRequestCreateParams {
     accounting?: PaymentOrderUpdateRequestWithID.Accounting;
 
     /**
-     * The ID of one of your accounting categories. Note that these will only be
-     * accessible if your accounting system has been connected.
+     * @deprecated: The ID of one of your accounting categories. Note that these will
+     * only be accessible if your accounting system has been connected.
      */
     accounting_category_id?: string | null;
 
     /**
-     * The ID of one of your accounting ledger classes. Note that these will only be
-     * accessible if your accounting system has been connected.
+     * @deprecated: The ID of one of your accounting ledger classes. Note that these
+     * will only be accessible if your accounting system has been connected.
      */
     accounting_ledger_class_id?: string | null;
 

src/resources/connection-legal-entities.ts

@@ -176,6 +176,18 @@ export namespace ConnectionLegalEntityCreateParams {
      */
     legal_entity_type?: 'business' | 'individual';
 
+    /**
+     * The business's legal structure.
+     */
+    legal_structure?:
+      | 'corporation'
+      | 'llc'
+      | 'non_profit'
+      | 'partnership'
+      | 'sole_proprietorship'
+      | 'trust'
+      | null;
+
     /**
      * Additional data represented as key-value pairs. Both the key and value must be
      * strings.
@@ -217,7 +229,7 @@ export namespace ConnectionLegalEntityCreateParams {
       /**
        * The types of this address.
        */
-      address_types?: Array<string>;
+      address_types?: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
 
       line2?: string | null;
     }

src/resources/counterparties.ts

@@ -645,6 +645,18 @@ export namespace CounterpartyCreateParams {
      */
     last_name?: string | null;
 
+    /**
+     * The business's legal structure.
+     */
+    legal_structure?:
+      | 'corporation'
+      | 'llc'
+      | 'non_profit'
+      | 'partnership'
+      | 'sole_proprietorship'
+      | 'trust'
+      | null;
+
     /**
      * Additional data represented as key-value pairs. Both the key and value must be
      * strings.
@@ -686,7 +698,7 @@ export namespace CounterpartyCreateParams {
       /**
        * The types of this address.
        */
-      address_types?: Array<string>;
+      address_types?: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
 
       line2?: string | null;
     }

src/resources/legal-entities.ts

@@ -122,6 +122,18 @@ export interface LegalEntity {
    */
   legal_entity_type?: 'business' | 'individual' | 'joint';
 
+  /**
+   * The business's legal structure.
+   */
+  legal_structure?:
+    | 'corporation'
+    | 'llc'
+    | 'non_profit'
+    | 'partnership'
+    | 'sole_proprietorship'
+    | 'trust'
+    | null;
+
   /**
    * This field will be true if this object exists in the live environment or false
    * if it exists in the test environment.
@@ -153,7 +165,7 @@ export namespace LegalEntity {
     /**
      * The types of this address.
      */
-    address_types: Array<string>;
+    address_types: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
 
     /**
      * Country code conforms to [ISO 3166-1 alpha-2]
@@ -287,6 +299,18 @@ export interface LegalEntityCreateParams {
    */
   last_name?: string | null;
 
+  /**
+   * The business's legal structure.
+   */
+  legal_structure?:
+    | 'corporation'
+    | 'llc'
+    | 'non_profit'
+    | 'partnership'
+    | 'sole_proprietorship'
+    | 'trust'
+    | null;
+
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.
@@ -328,7 +352,7 @@ export namespace LegalEntityCreateParams {
     /**
      * The types of this address.
      */
-    address_types?: Array<string>;
+    address_types?: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
 
     line2?: string | null;
   }
@@ -400,6 +424,18 @@ export interface LegalEntityUpdateParams {
    */
   last_name?: string | null;
 
+  /**
+   * The business's legal structure.
+   */
+  legal_structure?:
+    | 'corporation'
+    | 'llc'
+    | 'non_profit'
+    | 'partnership'
+    | 'sole_proprietorship'
+    | 'trust'
+    | null;
+
   /**
    * Additional data represented as key-value pairs. Both the key and value must be
    * strings.

src/resources/legal-entity-associations.ts

@@ -121,6 +121,18 @@ export namespace LegalEntityAssociation {
      */
     legal_entity_type?: 'business' | 'individual' | 'joint';
 
+    /**
+     * The business's legal structure.
+     */
+    legal_structure?:
+      | 'corporation'
+      | 'llc'
+      | 'non_profit'
+      | 'partnership'
+      | 'sole_proprietorship'
+      | 'trust'
+      | null;
+
     /**
      * This field will be true if this object exists in the live environment or false
      * if it exists in the test environment.
@@ -152,7 +164,7 @@ export namespace LegalEntityAssociation {
       /**
        * The types of this address.
        */
-      address_types: Array<string>;
+      address_types: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
 
       /**
        * Country code conforms to [ISO 3166-1 alpha-2]
@@ -321,6 +333,18 @@ export namespace LegalEntityAssociationCreateParams {
      */
     legal_entity_type?: 'business' | 'individual';
 
+    /**
+     * The business's legal structure.
+     */
+    legal_structure?:
+      | 'corporation'
+      | 'llc'
+      | 'non_profit'
+      | 'partnership'
+      | 'sole_proprietorship'
+      | 'trust'
+      | null;
+
     /**
      * Additional data represented as key-value pairs. Both the key and value must be
      * strings.
@@ -362,7 +386,7 @@ export namespace LegalEntityAssociationCreateParams {
       /**
        * The types of this address.
        */
-      address_types?: Array<string>;
+      address_types?: Array<'business' | 'mailing' | 'other' | 'po_box' | 'residential'>;
 
       line2?: string | null;
     }

src/resources/payment-orders/payment-orders.ts

@@ -112,14 +112,14 @@ export interface PaymentOrder {
   accounting: PaymentOrder.Accounting;
 
   /**
-   * The ID of one of your accounting categories. Note that these will only be
-   * accessible if your accounting system has been connected.
+   * @deprecated: The ID of one of your accounting categories. Note that these will
+   * only be accessible if your accounting system has been connected.
    */
   accounting_category_id: string | null;
 
   /**
-   * The ID of one of your accounting ledger classes. Note that these will only be
-   * accessible if your accounting system has been connected.
+   * @deprecated: The ID of one of your accounting ledger classes. Note that these
+   * will only be accessible if your accounting system has been connected.
    */
   accounting_ledger_class_id: string | null;
 
@@ -484,6 +484,7 @@ export namespace PaymentOrder {
       | 'column_reversal_pair_transfer_id'
       | 'column_transfer_id'
       | 'cross_river_payment_id'
+      | 'cross_river_service_message'
       | 'cross_river_transaction_id'
       | 'currencycloud_conversion_id'
       | 'currencycloud_payment_id'

src/resources/payment-references.ts

@@ -75,6 +75,7 @@ export interface PaymentReference {
     | 'column_reversal_pair_transfer_id'
     | 'column_transfer_id'
     | 'cross_river_payment_id'
+    | 'cross_river_service_message'
     | 'cross_river_transaction_id'
     | 'currencycloud_conversion_id'
     | 'currencycloud_payment_id'

src/resources/returns.ts

@@ -270,6 +270,7 @@ export namespace ReturnObject {
       | 'column_reversal_pair_transfer_id'
       | 'column_transfer_id'
       | 'cross_river_payment_id'
+      | 'cross_river_service_message'
       | 'cross_river_transaction_id'
       | 'currencycloud_conversion_id'
       | 'currencycloud_payment_id'

src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.17.0'; // x-release-please-version
+export const VERSION = '2.18.0'; // x-release-please-version

tests/api-resources/connection-legal-entities.test.ts

@@ -31,13 +31,14 @@ describe('resource connectionLegalEntities', () => {
         date_of_birth: '2019-12-27',
         business_name: 'string',
         doing_business_as_names: ['string', 'string', 'string'],
+        legal_structure: 'corporation',
         phone_numbers: [{ phone_number: 'string' }, { phone_number: 'string' }, { phone_number: 'string' }],
         email: 'string',
         website: 'string',
         metadata: { key: 'value', foo: 'bar', modern: 'treasury' },
         addresses: [
           {
-            address_types: ['string', 'string', 'string'],
+            address_types: ['business', 'mailing', 'other'],
             line1: 'string',
             line2: 'string',
             locality: 'string',
@@ -46,7 +47,7 @@ describe('resource connectionLegalEntities', () => {
             country: 'string',
           },
           {
-            address_types: ['string', 'string', 'string'],
+            address_types: ['business', 'mailing', 'other'],
             line1: 'string',
             line2: 'string',
             locality: 'string',
@@ -55,7 +56,7 @@ describe('resource connectionLegalEntities', () => {
             country: 'string',
           },
           {
-            address_types: ['string', 'string', 'string'],
+            address_types: ['business', 'mailing', 'other'],
             line1: 'string',
             line2: 'string',
             locality: 'string',