increase 0.222.0 → 0.224.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 (51) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/README.md +21 -33
  3. package/core.js +1 -1
  4. package/core.js.map +1 -1
  5. package/core.mjs +1 -1
  6. package/core.mjs.map +1 -1
  7. package/index.d.mts +2 -2
  8. package/index.d.ts +2 -2
  9. package/index.d.ts.map +1 -1
  10. package/index.js.map +1 -1
  11. package/index.mjs +1 -1
  12. package/index.mjs.map +1 -1
  13. package/package.json +1 -1
  14. package/resources/documents.d.ts +54 -1
  15. package/resources/documents.d.ts.map +1 -1
  16. package/resources/documents.js +13 -0
  17. package/resources/documents.js.map +1 -1
  18. package/resources/documents.mjs +13 -0
  19. package/resources/documents.mjs.map +1 -1
  20. package/resources/external-accounts.d.ts +0 -8
  21. package/resources/external-accounts.d.ts.map +1 -1
  22. package/resources/external-accounts.js.map +1 -1
  23. package/resources/external-accounts.mjs.map +1 -1
  24. package/resources/inbound-wire-drawdown-requests.d.ts +2 -2
  25. package/resources/index.d.ts +1 -1
  26. package/resources/index.d.ts.map +1 -1
  27. package/resources/index.js.map +1 -1
  28. package/resources/index.mjs +1 -1
  29. package/resources/index.mjs.map +1 -1
  30. package/resources/real-time-payments-transfers.d.ts +24 -0
  31. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  32. package/resources/real-time-payments-transfers.js +28 -0
  33. package/resources/real-time-payments-transfers.js.map +1 -1
  34. package/resources/real-time-payments-transfers.mjs +28 -0
  35. package/resources/real-time-payments-transfers.mjs.map +1 -1
  36. package/resources/wire-drawdown-requests.d.ts +5 -2
  37. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  38. package/resources/wire-drawdown-requests.js.map +1 -1
  39. package/resources/wire-drawdown-requests.mjs.map +1 -1
  40. package/src/core.ts +1 -1
  41. package/src/index.ts +8 -1
  42. package/src/resources/documents.ts +63 -0
  43. package/src/resources/external-accounts.ts +0 -9
  44. package/src/resources/inbound-wire-drawdown-requests.ts +2 -2
  45. package/src/resources/index.ts +7 -1
  46. package/src/resources/real-time-payments-transfers.ts +36 -0
  47. package/src/resources/wire-drawdown-requests.ts +5 -2
  48. package/src/version.ts +1 -1
  49. package/version.d.ts +1 -1
  50. package/version.js +1 -1
  51. package/version.mjs +1 -1
@@ -6,6 +6,20 @@ import * as Core from '../core';
6
6
  import { Page, type PageParams } from '../pagination';
7
7
 
8
8
  export class Documents extends APIResource {
9
+ /**
10
+ * Create a Document
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const document = await client.documents.create({
15
+ * category: 'account_verification_letter',
16
+ * });
17
+ * ```
18
+ */
19
+ create(body: DocumentCreateParams, options?: Core.RequestOptions): Core.APIPromise<Document> {
20
+ return this._client.post('/documents', { body, ...options });
21
+ }
22
+
9
23
  /**
10
24
  * Retrieve a Document
11
25
  *
@@ -56,6 +70,11 @@ export interface Document {
56
70
  */
57
71
  id: string;
58
72
 
73
+ /**
74
+ * Properties of an account verification letter document.
75
+ */
76
+ account_verification_letter: Document.AccountVerificationLetter | null;
77
+
59
78
  /**
60
79
  * The type of document.
61
80
  *
@@ -104,6 +123,49 @@ export interface Document {
104
123
  type: 'document';
105
124
  }
106
125
 
126
+ export namespace Document {
127
+ /**
128
+ * Properties of an account verification letter document.
129
+ */
130
+ export interface AccountVerificationLetter {
131
+ /**
132
+ * The identifier of the Account Number the document was generated for.
133
+ */
134
+ account_number_id: string;
135
+ }
136
+ }
137
+
138
+ export interface DocumentCreateParams {
139
+ /**
140
+ * The type of document to create.
141
+ *
142
+ * - `account_verification_letter` - An account verification letter.
143
+ */
144
+ category: 'account_verification_letter';
145
+
146
+ /**
147
+ * An account verification letter.
148
+ */
149
+ account_verification_letter?: DocumentCreateParams.AccountVerificationLetter;
150
+ }
151
+
152
+ export namespace DocumentCreateParams {
153
+ /**
154
+ * An account verification letter.
155
+ */
156
+ export interface AccountVerificationLetter {
157
+ /**
158
+ * The Account Number the bank letter should be generated for.
159
+ */
160
+ account_number_id: string;
161
+
162
+ /**
163
+ * If provided, the letter will include the Account's balance as of the date.
164
+ */
165
+ balance_date?: string;
166
+ }
167
+ }
168
+
107
169
  export interface DocumentListParams extends PageParams {
108
170
  category?: DocumentListParams.Category;
109
171
 
@@ -172,6 +234,7 @@ export declare namespace Documents {
172
234
  export {
173
235
  type Document as Document,
174
236
  DocumentsPage as DocumentsPage,
237
+ type DocumentCreateParams as DocumentCreateParams,
175
238
  type DocumentListParams as DocumentListParams,
176
239
  };
177
240
  }
@@ -156,15 +156,6 @@ export interface ExternalAccount {
156
156
  * `external_account`.
157
157
  */
158
158
  type: 'external_account';
159
-
160
- /**
161
- * If you have verified ownership of the External Account.
162
- *
163
- * - `unverified` - The External Account has not been verified.
164
- * - `pending` - The External Account is in the process of being verified.
165
- * - `verified` - The External Account is verified.
166
- */
167
- verification_status: 'unverified' | 'pending' | 'verified';
168
159
  }
169
160
 
170
161
  export interface ExternalAccountCreateParams {
@@ -60,8 +60,8 @@ export class InboundWireDrawdownRequestsPage extends Page<InboundWireDrawdownReq
60
60
 
61
61
  /**
62
62
  * Inbound wire drawdown requests are requests from someone else to send them a
63
- * wire. This feature is in beta; reach out to
64
- * [support@increase.com](mailto:support@increase.com) to learn more.
63
+ * wire. For more information, see our
64
+ * [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).
65
65
  */
66
66
  export interface InboundWireDrawdownRequest {
67
67
  /**
@@ -131,7 +131,13 @@ export {
131
131
  type DigitalWalletToken,
132
132
  type DigitalWalletTokenListParams,
133
133
  } from './digital-wallet-tokens';
134
- export { DocumentsPage, Documents, type Document, type DocumentListParams } from './documents';
134
+ export {
135
+ DocumentsPage,
136
+ Documents,
137
+ type Document,
138
+ type DocumentCreateParams,
139
+ type DocumentListParams,
140
+ } from './documents';
135
141
  export {
136
142
  EntitiesPage,
137
143
  Entities,
@@ -76,6 +76,42 @@ export class RealTimePaymentsTransfers extends APIResource {
76
76
  ...options,
77
77
  });
78
78
  }
79
+
80
+ /**
81
+ * Approves an Real-Time Payments Transfer in a pending_approval state.
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * const realTimePaymentsTransfer =
86
+ * await client.realTimePaymentsTransfers.approve(
87
+ * 'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
88
+ * );
89
+ * ```
90
+ */
91
+ approve(
92
+ realTimePaymentsTransferId: string,
93
+ options?: Core.RequestOptions,
94
+ ): Core.APIPromise<RealTimePaymentsTransfer> {
95
+ return this._client.post(`/real_time_payments_transfers/${realTimePaymentsTransferId}/approve`, options);
96
+ }
97
+
98
+ /**
99
+ * Cancels an Real-Time Payments Transfer in a pending_approval state.
100
+ *
101
+ * @example
102
+ * ```ts
103
+ * const realTimePaymentsTransfer =
104
+ * await client.realTimePaymentsTransfers.cancel(
105
+ * 'real_time_payments_transfer_iyuhl5kdn7ssmup83mvq',
106
+ * );
107
+ * ```
108
+ */
109
+ cancel(
110
+ realTimePaymentsTransferId: string,
111
+ options?: Core.RequestOptions,
112
+ ): Core.APIPromise<RealTimePaymentsTransfer> {
113
+ return this._client.post(`/real_time_payments_transfers/${realTimePaymentsTransferId}/cancel`, options);
114
+ }
79
115
  }
80
116
 
81
117
  export class RealTimePaymentsTransfersPage extends Page<RealTimePaymentsTransfer> {}
@@ -82,8 +82,11 @@ export class WireDrawdownRequestsPage extends Page<WireDrawdownRequest> {}
82
82
 
83
83
  /**
84
84
  * Wire drawdown requests enable you to request that someone else send you a wire.
85
- * This feature is in beta; reach out to
86
- * [support@increase.com](mailto:support@increase.com) to learn more.
85
+ * Because there is nuance to making sure your counterparty's bank processes these
86
+ * correctly, we ask that you reach out to
87
+ * [support@increase.com](mailto:support@increase.com) to enable this feature so we
88
+ * can help you plan your integration. For more information, see our
89
+ * [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).
87
90
  */
88
91
  export interface WireDrawdownRequest {
89
92
  /**
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.222.0'; // x-release-please-version
1
+ export const VERSION = '0.224.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.222.0";
1
+ export declare const VERSION = "0.224.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.222.0'; // x-release-please-version
4
+ exports.VERSION = '0.224.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.222.0'; // x-release-please-version
1
+ export const VERSION = '0.224.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map