From 13cec6f7502b43e22c218db1aceb077ca8ef59fc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 23:00:44 +0000 Subject: [PATCH 1/2] feat(api): api update --- .stats.yml | 8 +- MIGRATION.md | 1 - api.md | 18 -- src/client.ts | 17 -- src/resources/documents.ts | 274 ------------------ src/resources/index.ts | 7 - src/resources/simulations/documents.ts | 33 --- src/resources/simulations/index.ts | 1 - src/resources/simulations/simulations.ts | 6 - tests/api-resources/documents.test.ts | 76 ----- .../simulations/documents.test.ts | 29 -- 11 files changed, 4 insertions(+), 466 deletions(-) delete mode 100644 src/resources/documents.ts delete mode 100644 src/resources/simulations/documents.ts delete mode 100644 tests/api-resources/documents.test.ts delete mode 100644 tests/api-resources/simulations/documents.test.ts diff --git a/.stats.yml b/.stats.yml index bc6173cc..4bf821de 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 231 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-2304a782c25d2a6b9586de2f6e2b536b5abbf62735f9c18ed0551607f134b714.yml -openapi_spec_hash: 67d6de7181215abe88dcc3da557a1e0d -config_hash: 5a0bf28bf735edf93f36c6c808711847 +configured_endpoints: 227 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-60f9bca532c8805735c227730bbb14858faa64bfd5f83a1a78640f0119a3f99c.yml +openapi_spec_hash: 17ddd87efe6c029f2fa660c8781ccfaf +config_hash: ca52ca9a2968f330339fd50c1a386e05 diff --git a/MIGRATION.md b/MIGRATION.md index 2bf1aa34..e84c30a7 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -105,7 +105,6 @@ client.example.list(undefined, { headers: { ... } }); - `client.programs.list()` - `client.accountStatements.list()` - `client.files.list()` -- `client.documents.list()` - `client.exports.list()` - `client.events.list()` - `client.eventSubscriptions.list()` diff --git a/api.md b/api.md index 4722ad6b..c1eb1ab8 100644 --- a/api.md +++ b/api.md @@ -484,18 +484,6 @@ Methods: - client.fileLinks.create({ ...params }) -> FileLink -# Documents - -Types: - -- Document - -Methods: - -- client.documents.create({ ...params }) -> Document -- client.documents.retrieve(documentID) -> Document -- client.documents.list({ ...params }) -> DocumentsPage - # Exports Types: @@ -890,12 +878,6 @@ Methods: - client.simulations.accountStatements.create({ ...params }) -> AccountStatement -## Documents - -Methods: - -- client.simulations.documents.create({ ...params }) -> Document - ## Exports Methods: diff --git a/src/client.ts b/src/client.ts index 4dece3f6..4c8ee7e9 100644 --- a/src/client.ts +++ b/src/client.ts @@ -175,13 +175,6 @@ import { DigitalWalletTokens, DigitalWalletTokensPage, } from './resources/digital-wallet-tokens'; -import { - Document, - DocumentCreateParams, - DocumentListParams, - Documents, - DocumentsPage, -} from './resources/documents'; import { Entities, EntitiesPage, @@ -1159,7 +1152,6 @@ export class Increase { accountStatements: API.AccountStatements = new API.AccountStatements(this); files: API.Files = new API.Files(this); fileLinks: API.FileLinks = new API.FileLinks(this); - documents: API.Documents = new API.Documents(this); exports: API.Exports = new API.Exports(this); events: API.Events = new API.Events(this); eventSubscriptions: API.EventSubscriptions = new API.EventSubscriptions(this); @@ -1218,7 +1210,6 @@ Increase.Programs = Programs; Increase.AccountStatements = AccountStatements; Increase.Files = Files; Increase.FileLinks = FileLinks; -Increase.Documents = Documents; Increase.Exports = Exports; Increase.Events = Events; Increase.EventSubscriptions = EventSubscriptions; @@ -1560,14 +1551,6 @@ export declare namespace Increase { type FileLinkCreateParams as FileLinkCreateParams, }; - export { - Documents as Documents, - type Document as Document, - type DocumentsPage as DocumentsPage, - type DocumentCreateParams as DocumentCreateParams, - type DocumentListParams as DocumentListParams, - }; - export { Exports as Exports, type Export as Export, diff --git a/src/resources/documents.ts b/src/resources/documents.ts deleted file mode 100644 index 44895c50..00000000 --- a/src/resources/documents.ts +++ /dev/null @@ -1,274 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { APIResource } from '../core/resource'; -import { APIPromise } from '../core/api-promise'; -import { Page, type PageParams, PagePromise } from '../core/pagination'; -import { RequestOptions } from '../internal/request-options'; -import { path } from '../internal/utils/path'; - -export class Documents extends APIResource { - /** - * Create a Document - * - * @example - * ```ts - * const document = await client.documents.create({ - * category: 'account_verification_letter', - * }); - * ``` - */ - create(body: DocumentCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/documents', { body, ...options }); - } - - /** - * Retrieve a Document - * - * @example - * ```ts - * const document = await client.documents.retrieve( - * 'document_qjtqc6s4c14ve2q89izm', - * ); - * ``` - */ - retrieve(documentID: string, options?: RequestOptions): APIPromise { - return this._client.get(path`/documents/${documentID}`, options); - } - - /** - * List Documents - * - * @example - * ```ts - * // Automatically fetches more pages as needed. - * for await (const document of client.documents.list()) { - * // ... - * } - * ``` - */ - list( - query: DocumentListParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - return this._client.getAPIList('/documents', Page, { query, ...options }); - } -} - -export type DocumentsPage = Page; - -/** - * Increase generates certain documents / forms automatically for your application; - * they can be listed here. - */ -export interface Document { - /** - * The Document identifier. - */ - id: string; - - /** - * Properties of an account verification letter document. - */ - account_verification_letter: Document.AccountVerificationLetter | null; - - /** - * The type of document. - * - * - `form_1099_int` - Internal Revenue Service Form 1099-INT. - * - `form_1099_misc` - Internal Revenue Service Form 1099-MISC. - * - `proof_of_authorization` - A document submitted in response to a proof of - * authorization request for an ACH transfer. - * - `company_information` - Company information, such a policies or procedures, - * typically submitted during our due diligence process. - * - `account_verification_letter` - An account verification letter. - * - `funding_instructions` - Funding instructions. - */ - category: - | 'form_1099_int' - | 'form_1099_misc' - | 'proof_of_authorization' - | 'company_information' - | 'account_verification_letter' - | 'funding_instructions'; - - /** - * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the - * Document was created. - */ - created_at: string; - - /** - * The identifier of the Entity the document was generated for. - */ - entity_id: string | null; - - /** - * The identifier of the File containing the Document's contents. - */ - file_id: string; - - /** - * Properties of a funding instructions document. - */ - funding_instructions: Document.FundingInstructions | null; - - /** - * The idempotency key you chose for this object. This value is unique across - * Increase and is used to ensure that a request is only processed once. Learn more - * about [idempotency](https://increase.com/documentation/idempotency-keys). - */ - idempotency_key: string | null; - - /** - * A constant representing the object's type. For this resource it will always be - * `document`. - */ - type: 'document'; -} - -export namespace Document { - /** - * Properties of an account verification letter document. - */ - export interface AccountVerificationLetter { - /** - * The identifier of the Account Number the document was generated for. - */ - account_number_id: string; - } - - /** - * Properties of a funding instructions document. - */ - export interface FundingInstructions { - /** - * The identifier of the Account Number the document was generated for. - */ - account_number_id: string; - } -} - -export interface DocumentCreateParams { - /** - * The type of document to create. - * - * - `account_verification_letter` - An account verification letter. - * - `funding_instructions` - Funding instructions. - */ - category: 'account_verification_letter' | 'funding_instructions'; - - /** - * An account verification letter. Required if and only if `category` is - * `account_verification_letter`. - */ - account_verification_letter?: DocumentCreateParams.AccountVerificationLetter; - - /** - * Funding instructions. Required if and only if `category` is - * `funding_instructions`. - */ - funding_instructions?: DocumentCreateParams.FundingInstructions; - - [k: string]: unknown; -} - -export namespace DocumentCreateParams { - /** - * An account verification letter. Required if and only if `category` is - * `account_verification_letter`. - */ - export interface AccountVerificationLetter { - /** - * The Account Number the bank letter should be generated for. - */ - account_number_id: string; - - /** - * If provided, the letter will include the Account's balance as of the date. - */ - balance_date?: string; - } - - /** - * Funding instructions. Required if and only if `category` is - * `funding_instructions`. - */ - export interface FundingInstructions { - /** - * The Account Number the funding instructions should be generated for. - */ - account_number_id: string; - } -} - -export interface DocumentListParams extends PageParams { - category?: DocumentListParams.Category; - - created_at?: DocumentListParams.CreatedAt; - - /** - * Filter Documents to ones belonging to the specified Entity. - */ - entity_id?: string; - - /** - * Filter records to the one with the specified `idempotency_key` you chose for - * that object. This value is unique across Increase and is used to ensure that a - * request is only processed once. Learn more about - * [idempotency](https://increase.com/documentation/idempotency-keys). - */ - idempotency_key?: string; -} - -export namespace DocumentListParams { - export interface Category { - /** - * Filter Documents for those with the specified category or categories. For GET - * requests, this should be encoded as a comma-delimited string, such as - * `?in=one,two,three`. - */ - in?: Array< - | 'form_1099_int' - | 'form_1099_misc' - | 'proof_of_authorization' - | 'company_information' - | 'account_verification_letter' - | 'funding_instructions' - >; - } - - export interface CreatedAt { - /** - * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - * timestamp. - */ - after?: string; - - /** - * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - * timestamp. - */ - before?: string; - - /** - * Return results on or after this - * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - */ - on_or_after?: string; - - /** - * Return results on or before this - * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. - */ - on_or_before?: string; - } -} - -export declare namespace Documents { - export { - type Document as Document, - type DocumentsPage as DocumentsPage, - type DocumentCreateParams as DocumentCreateParams, - type DocumentListParams as DocumentListParams, - }; -} diff --git a/src/resources/index.ts b/src/resources/index.ts index 84889576..96566089 100644 --- a/src/resources/index.ts +++ b/src/resources/index.ts @@ -156,13 +156,6 @@ export { type DigitalWalletTokenListParams, type DigitalWalletTokensPage, } from './digital-wallet-tokens'; -export { - Documents, - type Document, - type DocumentCreateParams, - type DocumentListParams, - type DocumentsPage, -} from './documents'; export { Entities, type Entity, diff --git a/src/resources/simulations/documents.ts b/src/resources/simulations/documents.ts deleted file mode 100644 index ea8b23dd..00000000 --- a/src/resources/simulations/documents.ts +++ /dev/null @@ -1,33 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { APIResource } from '../../core/resource'; -import * as DocumentsAPI from '../documents'; -import { APIPromise } from '../../core/api-promise'; -import { RequestOptions } from '../../internal/request-options'; - -export class Documents extends APIResource { - /** - * Simulates an tax document being created for an account. - * - * @example - * ```ts - * const document = await client.simulations.documents.create({ - * account_id: 'account_in71c4amph0vgo2qllky', - * }); - * ``` - */ - create(body: DocumentCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/simulations/documents', { body, ...options }); - } -} - -export interface DocumentCreateParams { - /** - * The identifier of the Account the tax document is for. - */ - account_id: string; -} - -export declare namespace Documents { - export { type DocumentCreateParams as DocumentCreateParams }; -} diff --git a/src/resources/simulations/index.ts b/src/resources/simulations/index.ts index 720b8403..ac5643f2 100644 --- a/src/resources/simulations/index.ts +++ b/src/resources/simulations/index.ts @@ -32,7 +32,6 @@ export { type DigitalWalletTokenRequestCreateResponse, type DigitalWalletTokenRequestCreateParams, } from './digital-wallet-token-requests'; -export { Documents, type DocumentCreateParams } from './documents'; export { Exports, type ExportCreateParams } from './exports'; export { InboundACHTransfers, type InboundACHTransferCreateParams } from './inbound-ach-transfers'; export { InboundCheckDeposits, type InboundCheckDepositCreateParams } from './inbound-check-deposits'; diff --git a/src/resources/simulations/simulations.ts b/src/resources/simulations/simulations.ts index 9182de1d..2b3251be 100644 --- a/src/resources/simulations/simulations.ts +++ b/src/resources/simulations/simulations.ts @@ -49,8 +49,6 @@ import { DigitalWalletTokenRequestCreateResponse, DigitalWalletTokenRequests, } from './digital-wallet-token-requests'; -import * as DocumentsAPI from './documents'; -import { DocumentCreateParams, Documents } from './documents'; import * as ExportsAPI from './exports'; import { ExportCreateParams, Exports } from './exports'; import * as InboundACHTransfersAPI from './inbound-ach-transfers'; @@ -144,7 +142,6 @@ export class Simulations extends APIResource { accountStatements: AccountStatementsAPI.AccountStatements = new AccountStatementsAPI.AccountStatements( this._client, ); - documents: DocumentsAPI.Documents = new DocumentsAPI.Documents(this._client); exports: ExportsAPI.Exports = new ExportsAPI.Exports(this._client); cardTokens: CardTokensAPI.CardTokens = new CardTokensAPI.CardTokens(this._client); } @@ -178,7 +175,6 @@ Simulations.CheckDeposits = CheckDeposits; Simulations.InboundMailItems = InboundMailItems; Simulations.Programs = Programs; Simulations.AccountStatements = AccountStatements; -Simulations.Documents = Documents; Simulations.Exports = Exports; Simulations.CardTokens = CardTokens; @@ -300,8 +296,6 @@ export declare namespace Simulations { type AccountStatementCreateParams as AccountStatementCreateParams, }; - export { Documents as Documents, type DocumentCreateParams as DocumentCreateParams }; - export { Exports as Exports, type ExportCreateParams as ExportCreateParams }; export { CardTokens as CardTokens, type CardTokenCreateParams as CardTokenCreateParams }; diff --git a/tests/api-resources/documents.test.ts b/tests/api-resources/documents.test.ts deleted file mode 100644 index 00eee00f..00000000 --- a/tests/api-resources/documents.test.ts +++ /dev/null @@ -1,76 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import Increase from 'increase'; - -const client = new Increase({ - apiKey: 'My API Key', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', -}); - -describe('resource documents', () => { - test('create: only required params', async () => { - const responsePromise = client.documents.create({ category: 'account_verification_letter' }); - const rawResponse = await responsePromise.asResponse(); - expect(rawResponse).toBeInstanceOf(Response); - const response = await responsePromise; - expect(response).not.toBeInstanceOf(Response); - const dataAndResponse = await responsePromise.withResponse(); - expect(dataAndResponse.data).toBe(response); - expect(dataAndResponse.response).toBe(rawResponse); - }); - - test('create: required and optional params', async () => { - const response = await client.documents.create({ - category: 'account_verification_letter', - account_verification_letter: { - account_number_id: 'account_number_v18nkfqm6afpsrvy82b2', - balance_date: '2024-12-31', - }, - funding_instructions: { account_number_id: 'account_number_id' }, - }); - }); - - test('retrieve', async () => { - const responsePromise = client.documents.retrieve('document_qjtqc6s4c14ve2q89izm'); - const rawResponse = await responsePromise.asResponse(); - expect(rawResponse).toBeInstanceOf(Response); - const response = await responsePromise; - expect(response).not.toBeInstanceOf(Response); - const dataAndResponse = await responsePromise.withResponse(); - expect(dataAndResponse.data).toBe(response); - expect(dataAndResponse.response).toBe(rawResponse); - }); - - test('list', async () => { - const responsePromise = client.documents.list(); - const rawResponse = await responsePromise.asResponse(); - expect(rawResponse).toBeInstanceOf(Response); - const response = await responsePromise; - expect(response).not.toBeInstanceOf(Response); - const dataAndResponse = await responsePromise.withResponse(); - expect(dataAndResponse.data).toBe(response); - expect(dataAndResponse.response).toBe(rawResponse); - }); - - test('list: request options and 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( - client.documents.list( - { - category: { in: ['form_1099_int'] }, - 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: 'cursor', - entity_id: 'entity_id', - idempotency_key: 'x', - limit: 1, - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Increase.NotFoundError); - }); -}); diff --git a/tests/api-resources/simulations/documents.test.ts b/tests/api-resources/simulations/documents.test.ts deleted file mode 100644 index 496c2143..00000000 --- a/tests/api-resources/simulations/documents.test.ts +++ /dev/null @@ -1,29 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import Increase from 'increase'; - -const client = new Increase({ - apiKey: 'My API Key', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', -}); - -describe('resource documents', () => { - test('create: only required params', async () => { - const responsePromise = client.simulations.documents.create({ - account_id: 'account_in71c4amph0vgo2qllky', - }); - const rawResponse = await responsePromise.asResponse(); - expect(rawResponse).toBeInstanceOf(Response); - const response = await responsePromise; - expect(response).not.toBeInstanceOf(Response); - const dataAndResponse = await responsePromise.withResponse(); - expect(dataAndResponse.data).toBe(response); - expect(dataAndResponse.response).toBe(rawResponse); - }); - - test('create: required and optional params', async () => { - const response = await client.simulations.documents.create({ - account_id: 'account_in71c4amph0vgo2qllky', - }); - }); -}); From 229c775e2d44e3f8e4225db77bf82218371fbc51 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 23:01:04 +0000 Subject: [PATCH 2/2] release: 0.389.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 8 ++++++++ package.json | 2 +- src/version.ts | 2 +- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 60a1e001..d352db7f 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.388.0" + ".": "0.389.0" } diff --git a/CHANGELOG.md b/CHANGELOG.md index c8a9f0a4..b20d00aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.389.0 (2025-12-18) + +Full Changelog: [v0.388.0...v0.389.0](https://github.com/Increase/increase-typescript/compare/v0.388.0...v0.389.0) + +### Features + +* **api:** api update ([13cec6f](https://github.com/Increase/increase-typescript/commit/13cec6f7502b43e22c218db1aceb077ca8ef59fc)) + ## 0.388.0 (2025-12-18) Full Changelog: [v0.387.0...v0.388.0](https://github.com/Increase/increase-typescript/compare/v0.387.0...v0.388.0) diff --git a/package.json b/package.json index 98e79318..b5175037 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "increase", - "version": "0.388.0", + "version": "0.389.0", "description": "The official TypeScript library for the Increase API", "author": "Increase ", "types": "dist/index.d.ts", diff --git a/src/version.ts b/src/version.ts index 4d17d703..40eecdb8 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '0.388.0'; // x-release-please-version +export const VERSION = '0.389.0'; // x-release-please-version