increase 0.538.0 → 0.539.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/client.d.mts +0 -9
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +0 -9
  5. package/client.d.ts.map +1 -1
  6. package/client.js +0 -9
  7. package/client.js.map +1 -1
  8. package/client.mjs +0 -9
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/index.d.mts +0 -3
  12. package/resources/index.d.mts.map +1 -1
  13. package/resources/index.d.ts +0 -3
  14. package/resources/index.d.ts.map +1 -1
  15. package/resources/index.js +2 -8
  16. package/resources/index.js.map +1 -1
  17. package/resources/index.mjs +0 -3
  18. package/resources/index.mjs.map +1 -1
  19. package/src/client.ts +0 -55
  20. package/src/resources/index.ts +0 -23
  21. package/src/version.ts +1 -1
  22. package/version.d.mts +1 -1
  23. package/version.d.ts +1 -1
  24. package/version.js +1 -1
  25. package/version.mjs +1 -1
  26. package/resources/bookkeeping-accounts.d.mts +0 -164
  27. package/resources/bookkeeping-accounts.d.mts.map +0 -1
  28. package/resources/bookkeeping-accounts.d.ts +0 -164
  29. package/resources/bookkeeping-accounts.d.ts.map +0 -1
  30. package/resources/bookkeeping-accounts.js +0 -71
  31. package/resources/bookkeeping-accounts.js.map +0 -1
  32. package/resources/bookkeeping-accounts.mjs +0 -67
  33. package/resources/bookkeeping-accounts.mjs.map +0 -1
  34. package/resources/bookkeeping-entries.d.mts +0 -74
  35. package/resources/bookkeeping-entries.d.mts.map +0 -1
  36. package/resources/bookkeeping-entries.d.ts +0 -74
  37. package/resources/bookkeeping-entries.d.ts.map +0 -1
  38. package/resources/bookkeeping-entries.js +0 -39
  39. package/resources/bookkeeping-entries.js.map +0 -1
  40. package/resources/bookkeeping-entries.mjs +0 -35
  41. package/resources/bookkeeping-entries.mjs.map +0 -1
  42. package/resources/bookkeeping-entry-sets.d.mts +0 -156
  43. package/resources/bookkeeping-entry-sets.d.mts.map +0 -1
  44. package/resources/bookkeeping-entry-sets.d.ts +0 -156
  45. package/resources/bookkeeping-entry-sets.d.ts.map +0 -1
  46. package/resources/bookkeeping-entry-sets.js +0 -67
  47. package/resources/bookkeeping-entry-sets.js.map +0 -1
  48. package/resources/bookkeeping-entry-sets.mjs +0 -63
  49. package/resources/bookkeeping-entry-sets.mjs.map +0 -1
  50. package/src/resources/bookkeeping-accounts.ts +0 -220
  51. package/src/resources/bookkeeping-entries.ts +0 -98
  52. package/src/resources/bookkeeping-entry-sets.ts +0 -198
@@ -1,156 +0,0 @@
1
- import { APIResource } from "../core/resource.js";
2
- import { APIPromise } from "../core/api-promise.js";
3
- import { Page, type PageParams, PagePromise } from "../core/pagination.js";
4
- import { RequestOptions } from "../internal/request-options.js";
5
- export declare class BookkeepingEntrySets extends APIResource {
6
- /**
7
- * Create a Bookkeeping Entry Set
8
- *
9
- * @example
10
- * ```ts
11
- * const bookkeepingEntrySet =
12
- * await client.bookkeepingEntrySets.create({
13
- * entries: [
14
- * {
15
- * account_id:
16
- * 'bookkeeping_account_9husfpw68pzmve9dvvc7',
17
- * amount: 100,
18
- * },
19
- * {
20
- * account_id:
21
- * 'bookkeeping_account_t2obldz1rcu15zr54umg',
22
- * amount: -100,
23
- * },
24
- * ],
25
- * });
26
- * ```
27
- */
28
- create(body: BookkeepingEntrySetCreateParams, options?: RequestOptions): APIPromise<BookkeepingEntrySet>;
29
- /**
30
- * Retrieve a Bookkeeping Entry Set
31
- *
32
- * @example
33
- * ```ts
34
- * const bookkeepingEntrySet =
35
- * await client.bookkeepingEntrySets.retrieve(
36
- * 'bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf',
37
- * );
38
- * ```
39
- */
40
- retrieve(bookkeepingEntrySetID: string, options?: RequestOptions): APIPromise<BookkeepingEntrySet>;
41
- /**
42
- * List Bookkeeping Entry Sets
43
- *
44
- * @example
45
- * ```ts
46
- * // Automatically fetches more pages as needed.
47
- * for await (const bookkeepingEntrySet of client.bookkeepingEntrySets.list()) {
48
- * // ...
49
- * }
50
- * ```
51
- */
52
- list(query?: BookkeepingEntrySetListParams | null | undefined, options?: RequestOptions): PagePromise<BookkeepingEntrySetsPage, BookkeepingEntrySet>;
53
- }
54
- export type BookkeepingEntrySetsPage = Page<BookkeepingEntrySet>;
55
- /**
56
- * Entry Sets are accounting entries that are transactionally applied. Your
57
- * compliance setup might require annotating money movements using this API. Learn
58
- * more in our
59
- * [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
60
- */
61
- export interface BookkeepingEntrySet {
62
- /**
63
- * The entry set identifier.
64
- */
65
- id: string;
66
- /**
67
- * When the entry set was created.
68
- */
69
- created_at: string;
70
- /**
71
- * The timestamp of the entry set.
72
- */
73
- date: string;
74
- /**
75
- * The entries.
76
- */
77
- entries: Array<BookkeepingEntrySet.Entry>;
78
- /**
79
- * The idempotency key you chose for this object. This value is unique across
80
- * Increase and is used to ensure that a request is only processed once. Learn more
81
- * about [idempotency](https://increase.com/documentation/idempotency-keys).
82
- */
83
- idempotency_key: string | null;
84
- /**
85
- * The transaction identifier, if any.
86
- */
87
- transaction_id: string | null;
88
- /**
89
- * A constant representing the object's type. For this resource it will always be
90
- * `bookkeeping_entry_set`.
91
- */
92
- type: 'bookkeeping_entry_set';
93
- }
94
- export declare namespace BookkeepingEntrySet {
95
- interface Entry {
96
- /**
97
- * The entry identifier.
98
- */
99
- id: string;
100
- /**
101
- * The bookkeeping account impacted by the entry.
102
- */
103
- account_id: string;
104
- /**
105
- * The amount of the entry in minor units.
106
- */
107
- amount: number;
108
- }
109
- }
110
- export interface BookkeepingEntrySetCreateParams {
111
- /**
112
- * The bookkeeping entries.
113
- */
114
- entries: Array<BookkeepingEntrySetCreateParams.Entry>;
115
- /**
116
- * The date of the transaction. Optional if `transaction_id` is provided, in which
117
- * case we use the `date` of that transaction. Required otherwise.
118
- */
119
- date?: string;
120
- /**
121
- * The identifier of the Transaction related to this entry set, if any.
122
- */
123
- transaction_id?: string;
124
- [k: string]: unknown;
125
- }
126
- export declare namespace BookkeepingEntrySetCreateParams {
127
- interface Entry {
128
- /**
129
- * The identifier for the Bookkeeping Account impacted by this entry.
130
- */
131
- account_id: string;
132
- /**
133
- * The entry amount in the minor unit of the account currency. For dollars, for
134
- * example, this is cents. Debit entries have positive amounts; credit entries have
135
- * negative amounts.
136
- */
137
- amount: number;
138
- }
139
- }
140
- export interface BookkeepingEntrySetListParams extends PageParams {
141
- /**
142
- * Filter records to the one with the specified `idempotency_key` you chose for
143
- * that object. This value is unique across Increase and is used to ensure that a
144
- * request is only processed once. Learn more about
145
- * [idempotency](https://increase.com/documentation/idempotency-keys).
146
- */
147
- idempotency_key?: string;
148
- /**
149
- * Filter to the Bookkeeping Entry Set that maps to this Transaction.
150
- */
151
- transaction_id?: string;
152
- }
153
- export declare namespace BookkeepingEntrySets {
154
- export { type BookkeepingEntrySet as BookkeepingEntrySet, type BookkeepingEntrySetsPage as BookkeepingEntrySetsPage, type BookkeepingEntrySetCreateParams as BookkeepingEntrySetCreateParams, type BookkeepingEntrySetListParams as BookkeepingEntrySetListParams, };
155
- }
156
- //# sourceMappingURL=bookkeeping-entry-sets.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"bookkeeping-entry-sets.d.ts","sourceRoot":"","sources":["../src/resources/bookkeeping-entry-sets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE;OACtC,EAAE,cAAc,EAAE;AAGzB,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIlG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wBAAwB,EAAE,mBAAmB,CAAC;CAM9D;AAED,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAE1C;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,+BAA+B,CAAC,KAAK,CAAC,CAAC;IAEtD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,KAAK;QACpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF;AAED,MAAM,WAAW,6BAA8B,SAAQ,UAAU;IAC/D;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
@@ -1,67 +0,0 @@
1
- "use strict";
2
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.BookkeepingEntrySets = void 0;
5
- const resource_1 = require("../core/resource.js");
6
- const pagination_1 = require("../core/pagination.js");
7
- const path_1 = require("../internal/utils/path.js");
8
- class BookkeepingEntrySets extends resource_1.APIResource {
9
- /**
10
- * Create a Bookkeeping Entry Set
11
- *
12
- * @example
13
- * ```ts
14
- * const bookkeepingEntrySet =
15
- * await client.bookkeepingEntrySets.create({
16
- * entries: [
17
- * {
18
- * account_id:
19
- * 'bookkeeping_account_9husfpw68pzmve9dvvc7',
20
- * amount: 100,
21
- * },
22
- * {
23
- * account_id:
24
- * 'bookkeeping_account_t2obldz1rcu15zr54umg',
25
- * amount: -100,
26
- * },
27
- * ],
28
- * });
29
- * ```
30
- */
31
- create(body, options) {
32
- return this._client.post('/bookkeeping_entry_sets', { body, ...options });
33
- }
34
- /**
35
- * Retrieve a Bookkeeping Entry Set
36
- *
37
- * @example
38
- * ```ts
39
- * const bookkeepingEntrySet =
40
- * await client.bookkeepingEntrySets.retrieve(
41
- * 'bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf',
42
- * );
43
- * ```
44
- */
45
- retrieve(bookkeepingEntrySetID, options) {
46
- return this._client.get((0, path_1.path) `/bookkeeping_entry_sets/${bookkeepingEntrySetID}`, options);
47
- }
48
- /**
49
- * List Bookkeeping Entry Sets
50
- *
51
- * @example
52
- * ```ts
53
- * // Automatically fetches more pages as needed.
54
- * for await (const bookkeepingEntrySet of client.bookkeepingEntrySets.list()) {
55
- * // ...
56
- * }
57
- * ```
58
- */
59
- list(query = {}, options) {
60
- return this._client.getAPIList('/bookkeeping_entry_sets', (pagination_1.Page), {
61
- query,
62
- ...options,
63
- });
64
- }
65
- }
66
- exports.BookkeepingEntrySets = BookkeepingEntrySets;
67
- //# sourceMappingURL=bookkeeping-entry-sets.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"bookkeeping-entry-sets.js","sourceRoot":"","sources":["../src/resources/bookkeeping-entry-sets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwE;AAExE,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAqC,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,qBAA6B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAA,iBAAyB,CAAA,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA9DD,oDA8DC"}
@@ -1,63 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
- import { APIResource } from "../core/resource.mjs";
3
- import { Page } from "../core/pagination.mjs";
4
- import { path } from "../internal/utils/path.mjs";
5
- export class BookkeepingEntrySets extends APIResource {
6
- /**
7
- * Create a Bookkeeping Entry Set
8
- *
9
- * @example
10
- * ```ts
11
- * const bookkeepingEntrySet =
12
- * await client.bookkeepingEntrySets.create({
13
- * entries: [
14
- * {
15
- * account_id:
16
- * 'bookkeeping_account_9husfpw68pzmve9dvvc7',
17
- * amount: 100,
18
- * },
19
- * {
20
- * account_id:
21
- * 'bookkeeping_account_t2obldz1rcu15zr54umg',
22
- * amount: -100,
23
- * },
24
- * ],
25
- * });
26
- * ```
27
- */
28
- create(body, options) {
29
- return this._client.post('/bookkeeping_entry_sets', { body, ...options });
30
- }
31
- /**
32
- * Retrieve a Bookkeeping Entry Set
33
- *
34
- * @example
35
- * ```ts
36
- * const bookkeepingEntrySet =
37
- * await client.bookkeepingEntrySets.retrieve(
38
- * 'bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf',
39
- * );
40
- * ```
41
- */
42
- retrieve(bookkeepingEntrySetID, options) {
43
- return this._client.get(path `/bookkeeping_entry_sets/${bookkeepingEntrySetID}`, options);
44
- }
45
- /**
46
- * List Bookkeeping Entry Sets
47
- *
48
- * @example
49
- * ```ts
50
- * // Automatically fetches more pages as needed.
51
- * for await (const bookkeepingEntrySet of client.bookkeepingEntrySets.list()) {
52
- * // ...
53
- * }
54
- * ```
55
- */
56
- list(query = {}, options) {
57
- return this._client.getAPIList('/bookkeeping_entry_sets', (Page), {
58
- query,
59
- ...options,
60
- });
61
- }
62
- }
63
- //# sourceMappingURL=bookkeeping-entry-sets.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"bookkeeping-entry-sets.mjs","sourceRoot":"","sources":["../src/resources/bookkeeping-entry-sets.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,IAAI,EAAgC;OAEtC,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAqC,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,qBAA6B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,2BAA2B,qBAAqB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAA,IAAyB,CAAA,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -1,220 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- import { APIResource } from '../core/resource';
4
- import { APIPromise } from '../core/api-promise';
5
- import { Page, type PageParams, PagePromise } from '../core/pagination';
6
- import { RequestOptions } from '../internal/request-options';
7
- import { path } from '../internal/utils/path';
8
-
9
- export class BookkeepingAccounts extends APIResource {
10
- /**
11
- * Create a Bookkeeping Account
12
- *
13
- * @example
14
- * ```ts
15
- * const bookkeepingAccount =
16
- * await client.bookkeepingAccounts.create({
17
- * name: 'New Account!',
18
- * });
19
- * ```
20
- */
21
- create(body: BookkeepingAccountCreateParams, options?: RequestOptions): APIPromise<BookkeepingAccount> {
22
- return this._client.post('/bookkeeping_accounts', { body, ...options });
23
- }
24
-
25
- /**
26
- * Update a Bookkeeping Account
27
- *
28
- * @example
29
- * ```ts
30
- * const bookkeepingAccount =
31
- * await client.bookkeepingAccounts.update(
32
- * 'bookkeeping_account_e37p1f1iuocw5intf35v',
33
- * { name: 'Deprecated Account' },
34
- * );
35
- * ```
36
- */
37
- update(
38
- bookkeepingAccountID: string,
39
- body: BookkeepingAccountUpdateParams,
40
- options?: RequestOptions,
41
- ): APIPromise<BookkeepingAccount> {
42
- return this._client.patch(path`/bookkeeping_accounts/${bookkeepingAccountID}`, { body, ...options });
43
- }
44
-
45
- /**
46
- * List Bookkeeping Accounts
47
- *
48
- * @example
49
- * ```ts
50
- * // Automatically fetches more pages as needed.
51
- * for await (const bookkeepingAccount of client.bookkeepingAccounts.list()) {
52
- * // ...
53
- * }
54
- * ```
55
- */
56
- list(
57
- query: BookkeepingAccountListParams | null | undefined = {},
58
- options?: RequestOptions,
59
- ): PagePromise<BookkeepingAccountsPage, BookkeepingAccount> {
60
- return this._client.getAPIList('/bookkeeping_accounts', Page<BookkeepingAccount>, { query, ...options });
61
- }
62
-
63
- /**
64
- * Retrieve a Bookkeeping Account Balance
65
- *
66
- * @example
67
- * ```ts
68
- * const bookkeepingBalanceLookup =
69
- * await client.bookkeepingAccounts.balance(
70
- * 'bookkeeping_account_e37p1f1iuocw5intf35v',
71
- * );
72
- * ```
73
- */
74
- balance(
75
- bookkeepingAccountID: string,
76
- query: BookkeepingAccountBalanceParams | null | undefined = {},
77
- options?: RequestOptions,
78
- ): APIPromise<BookkeepingBalanceLookup> {
79
- return this._client.get(path`/bookkeeping_accounts/${bookkeepingAccountID}/balance`, {
80
- query,
81
- ...options,
82
- });
83
- }
84
- }
85
-
86
- export type BookkeepingAccountsPage = Page<BookkeepingAccount>;
87
-
88
- /**
89
- * Accounts are T-accounts. They can store accounting entries. Your compliance
90
- * setup might require annotating money movements using this API. Learn more in our
91
- * [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
92
- */
93
- export interface BookkeepingAccount {
94
- /**
95
- * The account identifier.
96
- */
97
- id: string;
98
-
99
- /**
100
- * The API Account associated with this bookkeeping account.
101
- */
102
- account_id: string | null;
103
-
104
- /**
105
- * The compliance category of the account.
106
- *
107
- * - `commingled_cash` - A cash in an commingled Increase Account.
108
- * - `customer_balance` - A customer balance.
109
- */
110
- compliance_category: 'commingled_cash' | 'customer_balance' | null;
111
-
112
- /**
113
- * The Entity associated with this bookkeeping account.
114
- */
115
- entity_id: string | null;
116
-
117
- /**
118
- * The idempotency key you chose for this object. This value is unique across
119
- * Increase and is used to ensure that a request is only processed once. Learn more
120
- * about [idempotency](https://increase.com/documentation/idempotency-keys).
121
- */
122
- idempotency_key: string | null;
123
-
124
- /**
125
- * The name you choose for the account.
126
- */
127
- name: string;
128
-
129
- /**
130
- * A constant representing the object's type. For this resource it will always be
131
- * `bookkeeping_account`.
132
- */
133
- type: 'bookkeeping_account';
134
- }
135
-
136
- /**
137
- * Represents a request to lookup the balance of a Bookkeeping Account at a given
138
- * point in time.
139
- */
140
- export interface BookkeepingBalanceLookup {
141
- /**
142
- * The Bookkeeping Account's current balance, representing the sum of all
143
- * Bookkeeping Entries on the Bookkeeping Account.
144
- */
145
- balance: number;
146
-
147
- /**
148
- * The identifier for the account for which the balance was queried.
149
- */
150
- bookkeeping_account_id: string;
151
-
152
- /**
153
- * A constant representing the object's type. For this resource it will always be
154
- * `bookkeeping_balance_lookup`.
155
- */
156
- type: 'bookkeeping_balance_lookup';
157
- }
158
-
159
- export interface BookkeepingAccountCreateParams {
160
- /**
161
- * The name you choose for the account.
162
- */
163
- name: string;
164
-
165
- /**
166
- * The account, if `compliance_category` is `commingled_cash`.
167
- */
168
- account_id?: string;
169
-
170
- /**
171
- * The account compliance category.
172
- *
173
- * - `commingled_cash` - A cash in an commingled Increase Account.
174
- * - `customer_balance` - A customer balance.
175
- */
176
- compliance_category?: 'commingled_cash' | 'customer_balance';
177
-
178
- /**
179
- * The entity, if `compliance_category` is `customer_balance`.
180
- */
181
- entity_id?: string;
182
-
183
- [k: string]: unknown;
184
- }
185
-
186
- export interface BookkeepingAccountUpdateParams {
187
- /**
188
- * The name you choose for the account.
189
- */
190
- name: string;
191
- }
192
-
193
- export interface BookkeepingAccountListParams extends PageParams {
194
- /**
195
- * Filter records to the one with the specified `idempotency_key` you chose for
196
- * that object. This value is unique across Increase and is used to ensure that a
197
- * request is only processed once. Learn more about
198
- * [idempotency](https://increase.com/documentation/idempotency-keys).
199
- */
200
- idempotency_key?: string;
201
- }
202
-
203
- export interface BookkeepingAccountBalanceParams {
204
- /**
205
- * The moment to query the balance at. If not set, returns the current balances.
206
- */
207
- at_time?: string;
208
- }
209
-
210
- export declare namespace BookkeepingAccounts {
211
- export {
212
- type BookkeepingAccount as BookkeepingAccount,
213
- type BookkeepingBalanceLookup as BookkeepingBalanceLookup,
214
- type BookkeepingAccountsPage as BookkeepingAccountsPage,
215
- type BookkeepingAccountCreateParams as BookkeepingAccountCreateParams,
216
- type BookkeepingAccountUpdateParams as BookkeepingAccountUpdateParams,
217
- type BookkeepingAccountListParams as BookkeepingAccountListParams,
218
- type BookkeepingAccountBalanceParams as BookkeepingAccountBalanceParams,
219
- };
220
- }
@@ -1,98 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- import { APIResource } from '../core/resource';
4
- import { APIPromise } from '../core/api-promise';
5
- import { Page, type PageParams, PagePromise } from '../core/pagination';
6
- import { RequestOptions } from '../internal/request-options';
7
- import { path } from '../internal/utils/path';
8
-
9
- export class BookkeepingEntries extends APIResource {
10
- /**
11
- * Retrieve a Bookkeeping Entry
12
- *
13
- * @example
14
- * ```ts
15
- * const bookkeepingEntry =
16
- * await client.bookkeepingEntries.retrieve(
17
- * 'bookkeeping_entry_ctjpajsj3ks2blx10375',
18
- * );
19
- * ```
20
- */
21
- retrieve(bookkeepingEntryID: string, options?: RequestOptions): APIPromise<BookkeepingEntry> {
22
- return this._client.get(path`/bookkeeping_entries/${bookkeepingEntryID}`, options);
23
- }
24
-
25
- /**
26
- * List Bookkeeping Entries
27
- *
28
- * @example
29
- * ```ts
30
- * // Automatically fetches more pages as needed.
31
- * for await (const bookkeepingEntry of client.bookkeepingEntries.list()) {
32
- * // ...
33
- * }
34
- * ```
35
- */
36
- list(
37
- query: BookkeepingEntryListParams | null | undefined = {},
38
- options?: RequestOptions,
39
- ): PagePromise<BookkeepingEntriesPage, BookkeepingEntry> {
40
- return this._client.getAPIList('/bookkeeping_entries', Page<BookkeepingEntry>, { query, ...options });
41
- }
42
- }
43
-
44
- export type BookkeepingEntriesPage = Page<BookkeepingEntry>;
45
-
46
- /**
47
- * Entries are T-account entries recording debits and credits. Your compliance
48
- * setup might require annotating money movements using this API. Learn more in our
49
- * [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
50
- */
51
- export interface BookkeepingEntry {
52
- /**
53
- * The entry identifier.
54
- */
55
- id: string;
56
-
57
- /**
58
- * The identifier for the Account the Entry belongs to.
59
- */
60
- account_id: string;
61
-
62
- /**
63
- * The Entry amount in the minor unit of its currency. For dollars, for example,
64
- * this is cents.
65
- */
66
- amount: number;
67
-
68
- /**
69
- * When the entry set was created.
70
- */
71
- created_at: string;
72
-
73
- /**
74
- * The identifier for the Entry Set the Entry belongs to.
75
- */
76
- entry_set_id: string;
77
-
78
- /**
79
- * A constant representing the object's type. For this resource it will always be
80
- * `bookkeeping_entry`.
81
- */
82
- type: 'bookkeeping_entry';
83
- }
84
-
85
- export interface BookkeepingEntryListParams extends PageParams {
86
- /**
87
- * The identifier for the Bookkeeping Account to filter by.
88
- */
89
- account_id?: string;
90
- }
91
-
92
- export declare namespace BookkeepingEntries {
93
- export {
94
- type BookkeepingEntry as BookkeepingEntry,
95
- type BookkeepingEntriesPage as BookkeepingEntriesPage,
96
- type BookkeepingEntryListParams as BookkeepingEntryListParams,
97
- };
98
- }