increase 0.3.0 → 0.4.0

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

@@ -27,10 +27,7 @@ describe('resource accountNumbers', () => {
   });
 
   test('update', async () => {
-    const response = await increase.accountNumbers.update('account_number_v18nkfqm6afpsrvy82b2', {
-      name: 'x',
-      status: 'active',
-    });
+    const response = await increase.accountNumbers.update('account_number_v18nkfqm6afpsrvy82b2', {});
   });
 
   test('list', async () => {
@@ -50,10 +47,12 @@ describe('resource accountNumbers', () => {
       increase.accountNumbers.list(
         {
           account_id: 'string',
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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',

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

@@ -37,10 +37,12 @@ describe('resource accountStatements', () => {
           account_id: 'string',
           cursor: 'string',
           limit: 0,
-          'statement_period_start.after': '2019-12-27T18:11:19.117Z',
-          'statement_period_start.before': '2019-12-27T18:11:19.117Z',
-          'statement_period_start.on_or_after': '2019-12-27T18:11:19.117Z',
-          'statement_period_start.on_or_before': '2019-12-27T18:11:19.117Z',
+          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',
+          },
         },
         { path: '/_stainless_unknown_path' },
       ),

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

@@ -11,7 +11,6 @@ describe('resource accountTransfers', () => {
       amount: 1,
       description: 'x',
       destination_account_id: 'string',
-      require_approval: true,
     });
   });
 
@@ -55,10 +54,12 @@ describe('resource accountTransfers', () => {
       increase.accountTransfers.list(
         {
           account_id: 'string',
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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,
         },

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

@@ -6,19 +6,14 @@ const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.
 
 describe('resource accounts', () => {
   test('create: only required params', async () => {
-    const response = await increase.accounts.create({
-      entity_id: 'string',
-      informational_entity_id: 'string',
-      name: 'x',
-      program_id: 'string',
-    });
+    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: 'x',
       program_id: 'string',
     });
   });
@@ -35,7 +30,7 @@ describe('resource accounts', () => {
   });
 
   test('update', async () => {
-    const response = await increase.accounts.update('account_in71c4amph0vgo2qllky', { name: 'x' });
+    const response = await increase.accounts.update('account_in71c4amph0vgo2qllky', {});
   });
 
   test('list', async () => {
@@ -54,12 +49,15 @@ describe('resource accounts', () => {
     await expect(
       increase.accounts.list(
         {
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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',
         },

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

@@ -8,23 +8,14 @@ describe('resource achPrenotifications', () => {
   test('create: only required params', async () => {
     const response = await increase.achPrenotifications.create({
       account_number: 'x',
-      addendum: 'x',
-      company_descriptive_date: 'x',
-      company_discretionary_data: 'x',
-      company_entry_description: 'x',
-      company_name: 'x',
-      credit_debit_indicator: 'credit',
-      effective_date: '2019-12-27',
-      individual_id: 'x',
-      individual_name: 'x',
       routing_number: 'xxxxxxxxx',
-      standard_entry_class_code: 'corporate_credit_or_debit',
     });
   });
 
   test('create: required and optional params', async () => {
     const response = await increase.achPrenotifications.create({
       account_number: 'x',
+      routing_number: 'xxxxxxxxx',
       addendum: 'x',
       company_descriptive_date: 'x',
       company_discretionary_data: 'x',
@@ -34,7 +25,6 @@ describe('resource achPrenotifications', () => {
       effective_date: '2019-12-27',
       individual_id: 'x',
       individual_name: 'x',
-      routing_number: 'xxxxxxxxx',
       standard_entry_class_code: 'corporate_credit_or_debit',
     });
   });
@@ -68,10 +58,12 @@ describe('resource achPrenotifications', () => {
     await expect(
       increase.achPrenotifications.list(
         {
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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,
         },

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

@@ -8,21 +8,7 @@ describe('resource achTransfers', () => {
   test('create: only required params', async () => {
     const response = await increase.achTransfers.create({
       account_id: 'string',
-      account_number: 'x',
-      addendum: 'x',
       amount: 0,
-      company_descriptive_date: 'x',
-      company_discretionary_data: 'x',
-      company_entry_description: 'x',
-      company_name: 'x',
-      effective_date: '2019-12-27',
-      external_account_id: 'string',
-      funding: 'checking',
-      individual_id: 'x',
-      individual_name: 'x',
-      require_approval: true,
-      routing_number: 'xxxxxxxxx',
-      standard_entry_class_code: 'corporate_credit_or_debit',
       statement_descriptor: 'x',
     });
   });
@@ -30,9 +16,10 @@ describe('resource achTransfers', () => {
   test('create: required and optional params', async () => {
     const response = await increase.achTransfers.create({
       account_id: 'string',
+      amount: 0,
+      statement_descriptor: 'x',
       account_number: 'x',
       addendum: 'x',
-      amount: 0,
       company_descriptive_date: 'x',
       company_discretionary_data: 'x',
       company_entry_description: 'x',
@@ -45,7 +32,6 @@ describe('resource achTransfers', () => {
       require_approval: true,
       routing_number: 'xxxxxxxxx',
       standard_entry_class_code: 'corporate_credit_or_debit',
-      statement_descriptor: 'x',
     });
   });
 
@@ -79,10 +65,12 @@ describe('resource achTransfers', () => {
       increase.achTransfers.list(
         {
           account_id: 'string',
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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',
           external_account_id: 'string',
           limit: 0,

package/tests/api-resources/balance-lookups.test.ts

@@ -6,10 +6,7 @@ const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.
 
 describe('resource balanceLookups', () => {
   test('lookup: only required params', async () => {
-    const response = await increase.balanceLookups.lookup({
-      account_id: 'string',
-      at_time: '2019-12-27T18:11:19.117Z',
-    });
+    const response = await increase.balanceLookups.lookup({ account_id: 'string' });
   });
 
   test('lookup: required and optional params', async () => {

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

@@ -6,20 +6,15 @@ const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.
 
 describe('resource bookkeepingAccounts', () => {
   test('create: only required params', async () => {
-    const response = await increase.bookkeepingAccounts.create({
-      account_id: 'string',
-      compliance_category: 'commingled_cash',
-      entity_id: 'string',
-      name: 'x',
-    });
+    const response = await increase.bookkeepingAccounts.create({ name: 'x' });
   });
 
   test('create: required and optional params', async () => {
     const response = await increase.bookkeepingAccounts.create({
+      name: 'x',
       account_id: 'string',
       compliance_category: 'commingled_cash',
       entity_id: 'string',
-      name: 'x',
     });
   });
 

package/tests/api-resources/bookkeeping-entry-sets.test.ts

@@ -7,24 +7,22 @@ const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.
 describe('resource bookkeepingEntrySets', () => {
   test('create: only required params', async () => {
     const response = await increase.bookkeepingEntrySets.create({
-      date: '2019-12-27T18:11:19.117Z',
       entries: [
         { account_id: 'string', amount: 0 },
         { account_id: 'string', amount: 0 },
         { account_id: 'string', amount: 0 },
       ],
-      transaction_id: 'string',
     });
   });
 
   test('create: required and optional params', async () => {
     const response = await increase.bookkeepingEntrySets.create({
-      date: '2019-12-27T18:11:19.117Z',
       entries: [
         { account_id: 'string', amount: 0 },
         { account_id: 'string', amount: 0 },
         { account_id: 'string', amount: 0 },
       ],
+      date: '2019-12-27T18:11:19.117Z',
       transaction_id: 'string',
     });
   });

package/tests/api-resources/card-disputes.test.ts

@@ -48,13 +48,15 @@ describe('resource cardDisputes', () => {
     await expect(
       increase.cardDisputes.list(
         {
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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.in': ['pending_reviewing', 'pending_reviewing', 'pending_reviewing'],
+          status: { in: ['pending_reviewing', 'pending_reviewing', 'pending_reviewing'] },
         },
         { path: '/_stainless_unknown_path' },
       ),

package/tests/api-resources/card-profiles.test.ts

@@ -61,7 +61,7 @@ describe('resource cardProfiles', () => {
     // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
     await expect(
       increase.cardProfiles.list(
-        { cursor: 'string', limit: 0, 'status.in': ['pending', 'pending', 'pending'] },
+        { cursor: 'string', limit: 0, status: { in: ['pending', 'pending', 'pending'] } },
         { path: '/_stainless_unknown_path' },
       ),
     ).rejects.toThrow(Increase.NotFoundError);

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

@@ -6,12 +6,7 @@ const increase = new Increase({ apiKey: 'something1234', baseURL: 'http://127.0.
 
 describe('resource cards', () => {
   test('create: only required params', async () => {
-    const response = await increase.cards.create({
-      account_id: 'string',
-      billing_address: { line1: 'x', city: 'x', state: 'x', postal_code: 'x' },
-      description: 'x',
-      digital_wallet: {},
-    });
+    const response = await increase.cards.create({ account_id: 'string' });
   });
 
   test('create: required and optional params', async () => {
@@ -35,12 +30,7 @@ describe('resource cards', () => {
   });
 
   test('update', async () => {
-    const response = await increase.cards.update('card_oubs0hwk5rn6knuecxg2', {
-      billing_address: { line1: 'x', city: 'x', state: 'x', postal_code: 'x' },
-      description: 'x',
-      digital_wallet: {},
-      status: 'active',
-    });
+    const response = await increase.cards.update('card_oubs0hwk5rn6knuecxg2', {});
   });
 
   test('list', async () => {
@@ -60,10 +50,12 @@ describe('resource cards', () => {
       increase.cards.list(
         {
           account_id: 'string',
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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,
         },

package/tests/api-resources/check-deposits.test.ts

@@ -55,10 +55,12 @@ describe('resource checkDeposits', () => {
       increase.checkDeposits.list(
         {
           account_id: 'string',
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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,
         },

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

@@ -10,15 +10,11 @@ describe('resource checkTransfers', () => {
       account_id: 'string',
       address_city: 'x',
       address_line1: 'x',
-      address_line2: 'x',
       address_state: 'x',
       address_zip: 'x',
       amount: 1,
       message: 'x',
-      note: 'x',
       recipient_name: 'x',
-      require_approval: true,
-      return_address: { name: 'x', line1: 'x', city: 'x', state: 'x', zip: 'x' },
     });
   });
 
@@ -27,13 +23,13 @@ describe('resource checkTransfers', () => {
       account_id: 'string',
       address_city: 'x',
       address_line1: 'x',
-      address_line2: 'x',
       address_state: 'x',
       address_zip: 'x',
       amount: 1,
       message: 'x',
-      note: 'x',
       recipient_name: 'x',
+      address_line2: 'x',
+      note: 'x',
       require_approval: true,
       return_address: { name: 'x', line1: 'x', line2: 'x', city: 'x', state: 'x', zip: 'x' },
     });
@@ -69,10 +65,12 @@ describe('resource checkTransfers', () => {
       increase.checkTransfers.list(
         {
           account_id: 'string',
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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,
         },

package/tests/api-resources/declined-transactions.test.ts

@@ -37,10 +37,12 @@ describe('resource declinedTransactions', () => {
       increase.declinedTransactions.list(
         {
           account_id: 'string',
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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,
           route_id: 'string',

package/tests/api-resources/digital-wallet-tokens.test.ts

@@ -35,10 +35,12 @@ describe('resource digitalWalletTokens', () => {
       increase.digitalWalletTokens.list(
         {
           card_id: 'string',
-          'created_at.after': '2019-12-27T18:11:19.117Z',
-          'created_at.before': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_after': '2019-12-27T18:11:19.117Z',
-          'created_at.on_or_before': '2019-12-27T18:11:19.117Z',
+          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,
         },