increase 0.2.0 → 0.4.0

package/resources/wire-drawdown-requests.ts

@@ -41,7 +41,6 @@ export class WireDrawdownRequests extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/wire_drawdown_requests', WireDrawdownRequestsPage, { query, ...options });
   }
 }
@@ -136,6 +135,10 @@ export interface WireDrawdownRequest {
 }
 
 export namespace WireDrawdownRequest {
+  /**
+   * After the drawdown request is submitted to Fedwire, this will contain
+   * supplemental details.
+   */
   export interface Submission {
     /**
      * The input message accountability data (IMAD) uniquely identifying the submission

package/resources/wire-transfers.ts

@@ -35,7 +35,6 @@ export class WireTransfers extends APIResource {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }
-
     return this.getAPIList('/wire_transfers', WireTransfersPage, { query, ...options });
   }
 
@@ -187,11 +186,6 @@ export interface WireTransfer {
    */
   submission: WireTransfer.Submission | null;
 
-  /**
-   * If the transfer was created from a template, this will be the template's ID.
-   */
-  template_id: string | null;
-
   /**
    * The ID for the transaction funding the transfer.
    */
@@ -205,28 +199,57 @@ export interface WireTransfer {
 }
 
 export namespace WireTransfer {
+  /**
+   * If your account requires approvals for transfers and the transfer was approved,
+   * this will contain details of the approval.
+   */
   export interface Approval {
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
      * the transfer was approved.
      */
     approved_at: string;
+
+    /**
+     * If the Transfer was approved by a user in the dashboard, the email address of
+     * that user.
+     */
+    approved_by: string | null;
   }
 
+  /**
+   * If your account requires approvals for transfers and the transfer was not
+   * approved, this will contain details of the cancellation.
+   */
   export interface Cancellation {
     /**
      * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
      * the Transfer was canceled.
      */
     canceled_at: string;
+
+    /**
+     * If the Transfer was canceled by a user in the dashboard, the email address of
+     * that user.
+     */
+    canceled_by: string | null;
   }
 
+  /**
+   * If your transfer is reversed, this will contain details of the reversal.
+   */
   export interface Reversal {
     /**
      * The amount that was reversed.
      */
     amount: number;
 
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+     * the reversal was created.
+     */
+    created_at: string;
+
     /**
      * The description on the reversal message from Fedwire.
      */
@@ -282,8 +305,22 @@ export namespace WireTransfer {
      * institution.
      */
     receiver_financial_institution_information: string | null;
+
+    /**
+     * The ID for the Transaction associated with the transfer reversal.
+     */
+    transaction_id: string | null;
+
+    /**
+     * The ID for the Wire Transfer that is being reversed.
+     */
+    wire_transfer_id: string;
   }
 
+  /**
+   * After the transfer is submitted to Fedwire, this will contain supplemental
+   * details.
+   */
   export interface Submission {
     /**
      * The accountability data for the submission.

package/streaming.ts

@@ -0,0 +1,199 @@
+import type { Response } from 'node-fetch';
+import { APIResponse, Headers, createResponseHeaders } from '~/core';
+
+type ServerSentEvent = {
+  event: string | null;
+  data: string;
+  raw: string[];
+};
+
+class SSEDecoder {
+  private data: string[];
+  private event: string | null;
+  private chunks: string[];
+
+  constructor() {
+    this.event = null;
+    this.data = [];
+    this.chunks = [];
+  }
+
+  decode(line: string) {
+    if (line.endsWith('\r')) {
+      line = line.substring(0, line.length - 1);
+    }
+
+    if (!line) {
+      // empty line and we didn't previously encounter any messages
+      if (!this.event && !this.data.length) return null;
+
+      const sse: ServerSentEvent = {
+        event: this.event,
+        data: this.data.join('\n'),
+        raw: this.chunks,
+      };
+
+      this.event = null;
+      this.data = [];
+      this.chunks = [];
+
+      return sse;
+    }
+
+    this.chunks.push(line);
+
+    if (line.startsWith(':')) {
+      return null;
+    }
+
+    let [fieldname, _, value] = partition(line, ':');
+
+    if (value.startsWith(' ')) {
+      value = value.substring(1);
+    }
+
+    if (fieldname === 'event') {
+      this.event = value;
+    } else if (fieldname === 'data') {
+      this.data.push(value);
+    }
+
+    return null;
+  }
+}
+
+export class Stream<Item> implements AsyncIterable<Item>, APIResponse<Stream<Item>> {
+  response: Response;
+  responseHeaders: Headers;
+  controller: AbortController;
+
+  private decoder: SSEDecoder;
+
+  constructor(response: Response, controller: AbortController) {
+    this.response = response;
+    this.controller = controller;
+    this.decoder = new SSEDecoder();
+    this.responseHeaders = createResponseHeaders(response.headers);
+  }
+
+  private async *iterMessages(): AsyncGenerator<ServerSentEvent, void, unknown> {
+    if (!this.response.body) {
+      this.controller.abort();
+      throw new Error(`Attempted to iterate over a response with no body`);
+    }
+
+    const lineDecoder = new LineDecoder();
+
+    for await (const chunk of this.response.body) {
+      let text;
+      if (chunk instanceof Buffer) {
+        text = chunk.toString();
+      } else {
+        text = chunk;
+      }
+
+      for (const line of lineDecoder.decode(text)) {
+        const sse = this.decoder.decode(line);
+        if (sse) yield sse;
+      }
+    }
+
+    for (const line of lineDecoder.flush()) {
+      const sse = this.decoder.decode(line);
+      if (sse) yield sse;
+    }
+  }
+
+  async *[Symbol.asyncIterator](): AsyncIterator<Item, any, undefined> {
+    try {
+      for await (const sse of this.iterMessages()) {
+        try {
+          yield JSON.parse(sse.data);
+        } catch (e) {
+          console.error(`Could not parse message into JSON:`, sse.data);
+          console.error(`From chunk:`, sse.raw);
+          throw e;
+        }
+      }
+    } catch (e) {
+      // If the user calls `stream.controller.abort()`, we should exit without throwing.
+      if (e instanceof Error && e.name === 'AbortError') return;
+      throw e;
+    } finally {
+      // If the user `break`s, abort the ongoing request.
+      this.controller.abort();
+    }
+  }
+}
+
+const NEWLINE_CHARS = '\n\r\x0b\x0c\x1c\x1d\x1e\x85\u2028\u2029';
+
+/**
+ * A re-implementation of httpx's `LineDecoder` in Python that handles incrementally
+ * reading lines from text.
+ *
+ * https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258
+ */
+class LineDecoder {
+  buffer: string[];
+  trailingCR: boolean;
+
+  constructor() {
+    this.buffer = [];
+    this.trailingCR = false;
+  }
+
+  decode(text: string): string[] {
+    if (this.trailingCR) {
+      text = '\r' + text;
+      this.trailingCR = false;
+    }
+    if (text.endsWith('\r')) {
+      this.trailingCR = true;
+      text = text.slice(0, -1);
+    }
+
+    if (!text) {
+      return [];
+    }
+
+    const trailing_newline = NEWLINE_CHARS.includes(text.slice(-1));
+    let lines = text.split(/\r\n|[\n\r\x0b\x0c\x1c\x1d\x1e\x85\u2028\u2029]/g);
+
+    if (lines.length === 1 && !trailing_newline) {
+      this.buffer.push(lines[0]!);
+      return [];
+    }
+
+    if (this.buffer.length > 0) {
+      lines = [this.buffer.join('') + lines[0], ...lines.slice(1)];
+      this.buffer = [];
+    }
+
+    if (!trailing_newline) {
+      this.buffer = [lines.pop() || ''];
+    }
+
+    return lines;
+  }
+
+  flush(): string[] {
+    if (!this.buffer.length && !this.trailingCR) {
+      return [];
+    }
+
+    const lines = [this.buffer.join('')];
+    this.buffer = [];
+    this.trailingCR = false;
+    return lines;
+  }
+}
+
+function partition(str: string, delimiter: string): [string, string, string] {
+  const index = str.indexOf(delimiter);
+  if (index !== -1) {
+    return [str.substring(0, index), delimiter, str.substring(index + delimiter.length)];
+  }
+
+  return [str, '', ''];
+}

package/tests/api-resources/account-numbers.test.ts

@@ -1,14 +1,16 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import Increase from '~/index';
+
 const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.0.1:4010' });
 
-describe('resource account_numbers', () => {
-  test('create', async () => {
-    const response = await increase.accountNumbers.create({
-      account_id: 'account_in71c4amph0vgo2qllky',
-      name: 'Rent payments',
-    });
+describe('resource accountNumbers', () => {
+  test('create: only required params', async () => {
+    const response = await increase.accountNumbers.create({ account_id: 'string', name: 'x' });
+  });
+
+  test('create: required and optional params', async () => {
+    const response = await increase.accountNumbers.create({ account_id: 'string', name: 'x' });
   });
 
   test('retrieve', async () => {
@@ -24,30 +26,14 @@ describe('resource account_numbers', () => {
     ).rejects.toThrow(Increase.NotFoundError);
   });
 
-  test('update: only required params', async () => {
+  test('update', async () => {
     const response = await increase.accountNumbers.update('account_number_v18nkfqm6afpsrvy82b2', {});
   });
 
-  test('update: required and optional params', async () => {
-    const response = await increase.accountNumbers.update('account_number_v18nkfqm6afpsrvy82b2', {
-      name: 'x',
-      status: 'disabled',
-    });
-  });
-
-  test('list: only required params', async () => {
+  test('list', async () => {
     const response = await increase.accountNumbers.list();
   });
 
-  test('list: required and optional params', async () => {
-    const response = await increase.accountNumbers.list({
-      cursor: 'string',
-      limit: 0,
-      status: 'active',
-      account_id: 'string',
-    });
-  });
-
   test('list: request options instead of params are passed correctly', async () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(increase.accountNumbers.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
@@ -59,7 +45,18 @@ describe('resource account_numbers', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       increase.accountNumbers.list(
-        { cursor: 'string', limit: 0, status: 'active', account_id: 'string' },
+        {
+          account_id: 'string',
+          created_at: {
+            after: '2019-12-27T18:11:19.117Z',
+            before: '2019-12-27T18:11:19.117Z',
+            on_or_after: '2019-12-27T18:11:19.117Z',
+            on_or_before: '2019-12-27T18:11:19.117Z',
+          },
+          cursor: 'string',
+          limit: 0,
+          status: 'active',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Increase.NotFoundError);

package/tests/api-resources/account-statements.test.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import Increase from '~/index';
+
 const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.0.1:4010' });
 
-describe('resource account_statements', () => {
+describe('resource accountStatements', () => {
   test('retrieve', async () => {
     const response = await increase.accountStatements.retrieve('account_statement_lkc03a4skm2k7f38vj15');
   });
@@ -17,24 +18,10 @@ describe('resource account_statements', () => {
     ).rejects.toThrow(Increase.NotFoundError);
   });
 
-  test('list: only required params', async () => {
+  test('list', async () => {
     const response = await increase.accountStatements.list();
   });
 
-  test('list: required and optional params', async () => {
-    const response = await increase.accountStatements.list({
-      cursor: 'string',
-      limit: 0,
-      account_id: 'string',
-      statement_period_start: {
-        after: '2019-12-27T18:11:19.117Z',
-        before: '2019-12-27T18:11:19.117Z',
-        on_or_after: '2019-12-27T18:11:19.117Z',
-        on_or_before: '2019-12-27T18:11:19.117Z',
-      },
-    });
-  });
-
   test('list: request options instead of params are passed correctly', async () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(increase.accountStatements.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
@@ -47,9 +34,9 @@ describe('resource account_statements', () => {
     await expect(
       increase.accountStatements.list(
         {
+          account_id: 'string',
           cursor: 'string',
           limit: 0,
-          account_id: 'string',
           statement_period_start: {
             after: '2019-12-27T18:11:19.117Z',
             before: '2019-12-27T18:11:19.117Z',

package/tests/api-resources/account-transfers.test.ts

@@ -1,24 +1,25 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import Increase from '~/index';
+
 const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.0.1:4010' });
 
-describe('resource account_transfers', () => {
+describe('resource accountTransfers', () => {
   test('create: only required params', async () => {
     const response = await increase.accountTransfers.create({
-      account_id: 'account_in71c4amph0vgo2qllky',
-      amount: 100,
-      description: 'Creating liquidity',
-      destination_account_id: 'account_uf16sut2ct5bevmq3eh',
+      account_id: 'string',
+      amount: 1,
+      description: 'x',
+      destination_account_id: 'string',
     });
   });
 
   test('create: required and optional params', async () => {
     const response = await increase.accountTransfers.create({
-      account_id: 'account_in71c4amph0vgo2qllky',
-      amount: 100,
-      description: 'Creating liquidity',
-      destination_account_id: 'account_uf16sut2ct5bevmq3eh',
+      account_id: 'string',
+      amount: 1,
+      description: 'x',
+      destination_account_id: 'string',
       require_approval: true,
     });
   });
@@ -36,24 +37,10 @@ describe('resource account_transfers', () => {
     ).rejects.toThrow(Increase.NotFoundError);
   });
 
-  test('list: only required params', async () => {
+  test('list', async () => {
     const response = await increase.accountTransfers.list();
   });
 
-  test('list: required and optional params', async () => {
-    const response = await increase.accountTransfers.list({
-      cursor: 'string',
-      limit: 0,
-      account_id: 'string',
-      created_at: {
-        after: '2019-12-27T18:11:19.117Z',
-        before: '2019-12-27T18:11:19.117Z',
-        on_or_after: '2019-12-27T18:11:19.117Z',
-        on_or_before: '2019-12-27T18:11:19.117Z',
-      },
-    });
-  });
-
   test('list: request options instead of params are passed correctly', async () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(increase.accountTransfers.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
@@ -66,8 +53,6 @@ describe('resource account_transfers', () => {
     await expect(
       increase.accountTransfers.list(
         {
-          cursor: 'string',
-          limit: 0,
           account_id: 'string',
           created_at: {
             after: '2019-12-27T18:11:19.117Z',
@@ -75,6 +60,8 @@ describe('resource account_transfers', () => {
             on_or_after: '2019-12-27T18:11:19.117Z',
             on_or_before: '2019-12-27T18:11:19.117Z',
           },
+          cursor: 'string',
+          limit: 0,
         },
         { path: '/_stainless_unknown_path' },
       ),

package/tests/api-resources/accounts.test.ts

@@ -1,18 +1,20 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import Increase from '~/index';
+
 const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.0.1:4010' });
 
 describe('resource accounts', () => {
   test('create: only required params', async () => {
-    const response = await increase.accounts.create({ name: 'New Account!' });
+    const response = await increase.accounts.create({ name: 'x' });
   });
 
   test('create: required and optional params', async () => {
     const response = await increase.accounts.create({
+      name: 'x',
       entity_id: 'string',
       informational_entity_id: 'string',
-      name: 'New Account!',
+      program_id: 'string',
     });
   });
 
@@ -27,29 +29,14 @@ describe('resource accounts', () => {
     ).rejects.toThrow(Increase.NotFoundError);
   });
 
-  test('update: only required params', async () => {
+  test('update', async () => {
     const response = await increase.accounts.update('account_in71c4amph0vgo2qllky', {});
   });
 
-  test('update: required and optional params', async () => {
-    const response = await increase.accounts.update('account_in71c4amph0vgo2qllky', {
-      name: 'My renamed account',
-    });
-  });
-
-  test('list: only required params', async () => {
+  test('list', async () => {
     const response = await increase.accounts.list();
   });
 
-  test('list: required and optional params', async () => {
-    const response = await increase.accounts.list({
-      cursor: 'string',
-      limit: 0,
-      entity_id: 'string',
-      status: 'open',
-    });
-  });
-
   test('list: request options instead of params are passed correctly', async () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(increase.accounts.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
@@ -61,7 +48,19 @@ describe('resource accounts', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       increase.accounts.list(
-        { cursor: 'string', limit: 0, entity_id: 'string', status: 'open' },
+        {
+          created_at: {
+            after: '2019-12-27T18:11:19.117Z',
+            before: '2019-12-27T18:11:19.117Z',
+            on_or_after: '2019-12-27T18:11:19.117Z',
+            on_or_before: '2019-12-27T18:11:19.117Z',
+          },
+          cursor: 'string',
+          entity_id: 'string',
+          informational_entity_id: 'string',
+          limit: 0,
+          status: 'open',
+        },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Increase.NotFoundError);

package/tests/api-resources/ach-prenotifications.test.ts

@@ -1,19 +1,21 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import Increase from '~/index';
+
 const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.0.1:4010' });
 
-describe('resource ach_prenotifications', () => {
+describe('resource achPrenotifications', () => {
   test('create: only required params', async () => {
     const response = await increase.achPrenotifications.create({
-      account_number: '987654321',
-      routing_number: '101050001',
+      account_number: 'x',
+      routing_number: 'xxxxxxxxx',
     });
   });
 
   test('create: required and optional params', async () => {
     const response = await increase.achPrenotifications.create({
-      account_number: '987654321',
+      account_number: 'x',
+      routing_number: 'xxxxxxxxx',
       addendum: 'x',
       company_descriptive_date: 'x',
       company_discretionary_data: 'x',
@@ -23,7 +25,6 @@ describe('resource ach_prenotifications', () => {
       effective_date: '2019-12-27',
       individual_id: 'x',
       individual_name: 'x',
-      routing_number: '101050001',
       standard_entry_class_code: 'corporate_credit_or_debit',
     });
   });
@@ -41,23 +42,10 @@ describe('resource ach_prenotifications', () => {
     ).rejects.toThrow(Increase.NotFoundError);
   });
 
-  test('list: only required params', async () => {
+  test('list', async () => {
     const response = await increase.achPrenotifications.list();
   });
 
-  test('list: required and optional params', async () => {
-    const response = await increase.achPrenotifications.list({
-      cursor: 'string',
-      limit: 0,
-      created_at: {
-        after: '2019-12-27T18:11:19.117Z',
-        before: '2019-12-27T18:11:19.117Z',
-        on_or_after: '2019-12-27T18:11:19.117Z',
-        on_or_before: '2019-12-27T18:11:19.117Z',
-      },
-    });
-  });
-
   test('list: request options instead of params are passed correctly', async () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(increase.achPrenotifications.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
@@ -70,14 +58,14 @@ describe('resource ach_prenotifications', () => {
     await expect(
       increase.achPrenotifications.list(
         {
-          cursor: 'string',
-          limit: 0,
           created_at: {
             after: '2019-12-27T18:11:19.117Z',
             before: '2019-12-27T18:11:19.117Z',
             on_or_after: '2019-12-27T18:11:19.117Z',
             on_or_before: '2019-12-27T18:11:19.117Z',
           },
+          cursor: 'string',
+          limit: 0,
         },
         { path: '/_stainless_unknown_path' },
       ),