@oatfi/oatfi-sdk-ts 0.11.63 → 0.11.64

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 (98) hide show
  1. package/README.md +2 -0
  2. package/dist/commonjs/funcs/businessesSubmitSupplementalData.d.ts +18 -0
  3. package/dist/commonjs/funcs/businessesSubmitSupplementalData.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/businessesSubmitSupplementalData.js +135 -0
  5. package/dist/commonjs/funcs/businessesSubmitSupplementalData.js.map +1 -0
  6. package/dist/commonjs/lib/config.d.ts +2 -2
  7. package/dist/commonjs/lib/config.js +2 -2
  8. package/dist/commonjs/models/accountstatementlistresponse.d.ts +2 -5
  9. package/dist/commonjs/models/accountstatementlistresponse.d.ts.map +1 -1
  10. package/dist/commonjs/models/accountstatementlistresponse.js +3 -8
  11. package/dist/commonjs/models/accountstatementlistresponse.js.map +1 -1
  12. package/dist/commonjs/models/businesslistresponsedto.d.ts +2 -5
  13. package/dist/commonjs/models/businesslistresponsedto.d.ts.map +1 -1
  14. package/dist/commonjs/models/businesslistresponsedto.js +3 -8
  15. package/dist/commonjs/models/businesslistresponsedto.js.map +1 -1
  16. package/dist/commonjs/models/createsupplementaldatadto.d.ts +64 -0
  17. package/dist/commonjs/models/createsupplementaldatadto.d.ts.map +1 -0
  18. package/dist/commonjs/models/createsupplementaldatadto.js +86 -0
  19. package/dist/commonjs/models/createsupplementaldatadto.js.map +1 -0
  20. package/dist/commonjs/models/increaseaccountstatement.d.ts +49 -0
  21. package/dist/commonjs/models/increaseaccountstatement.d.ts.map +1 -0
  22. package/dist/commonjs/models/increaseaccountstatement.js +71 -0
  23. package/dist/commonjs/models/increaseaccountstatement.js.map +1 -0
  24. package/dist/commonjs/models/index.d.ts +3 -0
  25. package/dist/commonjs/models/index.d.ts.map +1 -1
  26. package/dist/commonjs/models/index.js +3 -0
  27. package/dist/commonjs/models/index.js.map +1 -1
  28. package/dist/commonjs/models/operations/businessescontrollercreatesupplementaldata.d.ts +23 -0
  29. package/dist/commonjs/models/operations/businessescontrollercreatesupplementaldata.d.ts.map +1 -0
  30. package/dist/commonjs/models/operations/businessescontrollercreatesupplementaldata.js +58 -0
  31. package/dist/commonjs/models/operations/businessescontrollercreatesupplementaldata.js.map +1 -0
  32. package/dist/commonjs/models/operations/index.d.ts +1 -0
  33. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  34. package/dist/commonjs/models/operations/index.js +1 -0
  35. package/dist/commonjs/models/operations/index.js.map +1 -1
  36. package/dist/commonjs/models/supplementaldataresponsedto.d.ts +87 -0
  37. package/dist/commonjs/models/supplementaldataresponsedto.d.ts.map +1 -0
  38. package/dist/commonjs/models/supplementaldataresponsedto.js +104 -0
  39. package/dist/commonjs/models/supplementaldataresponsedto.js.map +1 -0
  40. package/dist/commonjs/sdk/businesses.d.ts +7 -0
  41. package/dist/commonjs/sdk/businesses.d.ts.map +1 -1
  42. package/dist/commonjs/sdk/businesses.js +10 -0
  43. package/dist/commonjs/sdk/businesses.js.map +1 -1
  44. package/dist/esm/funcs/businessesSubmitSupplementalData.d.ts +18 -0
  45. package/dist/esm/funcs/businessesSubmitSupplementalData.d.ts.map +1 -0
  46. package/dist/esm/funcs/businessesSubmitSupplementalData.js +99 -0
  47. package/dist/esm/funcs/businessesSubmitSupplementalData.js.map +1 -0
  48. package/dist/esm/lib/config.d.ts +2 -2
  49. package/dist/esm/lib/config.js +2 -2
  50. package/dist/esm/models/accountstatementlistresponse.d.ts +2 -5
  51. package/dist/esm/models/accountstatementlistresponse.d.ts.map +1 -1
  52. package/dist/esm/models/accountstatementlistresponse.js +2 -6
  53. package/dist/esm/models/accountstatementlistresponse.js.map +1 -1
  54. package/dist/esm/models/businesslistresponsedto.d.ts +2 -5
  55. package/dist/esm/models/businesslistresponsedto.d.ts.map +1 -1
  56. package/dist/esm/models/businesslistresponsedto.js +2 -6
  57. package/dist/esm/models/businesslistresponsedto.js.map +1 -1
  58. package/dist/esm/models/createsupplementaldatadto.d.ts +64 -0
  59. package/dist/esm/models/createsupplementaldatadto.d.ts.map +1 -0
  60. package/dist/esm/models/createsupplementaldatadto.js +48 -0
  61. package/dist/esm/models/createsupplementaldatadto.js.map +1 -0
  62. package/dist/esm/models/increaseaccountstatement.d.ts +49 -0
  63. package/dist/esm/models/increaseaccountstatement.d.ts.map +1 -0
  64. package/dist/esm/models/increaseaccountstatement.js +34 -0
  65. package/dist/esm/models/increaseaccountstatement.js.map +1 -0
  66. package/dist/esm/models/index.d.ts +3 -0
  67. package/dist/esm/models/index.d.ts.map +1 -1
  68. package/dist/esm/models/index.js +3 -0
  69. package/dist/esm/models/index.js.map +1 -1
  70. package/dist/esm/models/operations/businessescontrollercreatesupplementaldata.d.ts +23 -0
  71. package/dist/esm/models/operations/businessescontrollercreatesupplementaldata.d.ts.map +1 -0
  72. package/dist/esm/models/operations/businessescontrollercreatesupplementaldata.js +21 -0
  73. package/dist/esm/models/operations/businessescontrollercreatesupplementaldata.js.map +1 -0
  74. package/dist/esm/models/operations/index.d.ts +1 -0
  75. package/dist/esm/models/operations/index.d.ts.map +1 -1
  76. package/dist/esm/models/operations/index.js +1 -0
  77. package/dist/esm/models/operations/index.js.map +1 -1
  78. package/dist/esm/models/supplementaldataresponsedto.d.ts +87 -0
  79. package/dist/esm/models/supplementaldataresponsedto.d.ts.map +1 -0
  80. package/dist/esm/models/supplementaldataresponsedto.js +67 -0
  81. package/dist/esm/models/supplementaldataresponsedto.js.map +1 -0
  82. package/dist/esm/sdk/businesses.d.ts +7 -0
  83. package/dist/esm/sdk/businesses.d.ts.map +1 -1
  84. package/dist/esm/sdk/businesses.js +10 -0
  85. package/dist/esm/sdk/businesses.js.map +1 -1
  86. package/jsr.json +1 -1
  87. package/package.json +1 -1
  88. package/src/funcs/businessesSubmitSupplementalData.ts +188 -0
  89. package/src/lib/config.ts +2 -2
  90. package/src/models/accountstatementlistresponse.ts +6 -21
  91. package/src/models/businesslistresponsedto.ts +6 -21
  92. package/src/models/createsupplementaldatadto.ts +107 -0
  93. package/src/models/increaseaccountstatement.ts +91 -0
  94. package/src/models/index.ts +3 -0
  95. package/src/models/operations/businessescontrollercreatesupplementaldata.ts +54 -0
  96. package/src/models/operations/index.ts +1 -0
  97. package/src/models/supplementaldataresponsedto.ts +134 -0
  98. package/src/sdk/businesses.ts +18 -0
@@ -0,0 +1,91 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../lib/primitives.js";
7
+ import { safeParse } from "../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../types/fp.js";
9
+ import * as types from "../types/primitives.js";
10
+ import { SDKValidationError } from "./errors/sdkvalidationerror.js";
11
+
12
+ export type IncreaseAccountStatement = {
13
+ /**
14
+ * The ID of the account statement
15
+ */
16
+ id: string;
17
+ /**
18
+ * Type of the resource
19
+ */
20
+ object: string;
21
+ /**
22
+ * The ID of the account
23
+ */
24
+ accountId: string;
25
+ /**
26
+ * The date the account statement was created
27
+ */
28
+ createdAt: string;
29
+ /**
30
+ * The ID of the file
31
+ */
32
+ fileId: string;
33
+ /**
34
+ * The start date of the statement period
35
+ */
36
+ statementPeriodStart: string;
37
+ /**
38
+ * The end date of the statement period
39
+ */
40
+ statementPeriodEnd: string;
41
+ /**
42
+ * The starting balance of the account statement
43
+ */
44
+ startingBalance: number;
45
+ /**
46
+ * The ending balance of the account statement
47
+ */
48
+ endingBalance: number;
49
+ /**
50
+ * The type of the account statement
51
+ */
52
+ type: string;
53
+ };
54
+
55
+ /** @internal */
56
+ export const IncreaseAccountStatement$inboundSchema: z.ZodType<
57
+ IncreaseAccountStatement,
58
+ z.ZodTypeDef,
59
+ unknown
60
+ > = z.object({
61
+ id: types.string(),
62
+ object: types.string(),
63
+ account_id: types.string(),
64
+ created_at: types.string(),
65
+ file_id: types.string(),
66
+ statement_period_start: types.string(),
67
+ statement_period_end: types.string(),
68
+ starting_balance: types.number(),
69
+ ending_balance: types.number(),
70
+ type: types.string(),
71
+ }).transform((v) => {
72
+ return remap$(v, {
73
+ "account_id": "accountId",
74
+ "created_at": "createdAt",
75
+ "file_id": "fileId",
76
+ "statement_period_start": "statementPeriodStart",
77
+ "statement_period_end": "statementPeriodEnd",
78
+ "starting_balance": "startingBalance",
79
+ "ending_balance": "endingBalance",
80
+ });
81
+ });
82
+
83
+ export function increaseAccountStatementFromJSON(
84
+ jsonString: string,
85
+ ): SafeParseResult<IncreaseAccountStatement, SDKValidationError> {
86
+ return safeParse(
87
+ jsonString,
88
+ (x) => IncreaseAccountStatement$inboundSchema.parse(JSON.parse(x)),
89
+ `Failed to parse 'IncreaseAccountStatement' from JSON`,
90
+ );
91
+ }
@@ -49,6 +49,7 @@ export * from "./createplatformsettingsdto.js";
49
49
  export * from "./createportfoliodto.js";
50
50
  export * from "./createprogramdto.js";
51
51
  export * from "./createprogramsettingdto.js";
52
+ export * from "./createsupplementaldatadto.js";
52
53
  export * from "./customertype.js";
53
54
  export * from "./delaybatchtimeframedto.js";
54
55
  export * from "./delayfundingconfigdto.js";
@@ -75,6 +76,7 @@ export * from "./getvirtualaccountinformationresponsedto.js";
75
76
  export * from "./holdreleasebalanceupdaterequest.js";
76
77
  export * from "./holdresponsedto.js";
77
78
  export * from "./holdsettingsdto.js";
79
+ export * from "./increaseaccountstatement.js";
78
80
  export * from "./increasedatadto.js";
79
81
  export * from "./increasefilelink.js";
80
82
  export * from "./increasetransactiondto.js";
@@ -150,6 +152,7 @@ export * from "./spendcapacityenum.js";
150
152
  export * from "./startunderwritingdto.js";
151
153
  export * from "./statusruledto.js";
152
154
  export * from "./statusruleresponsedto.js";
155
+ export * from "./supplementaldataresponsedto.js";
153
156
  export * from "./termssettingsdto.js";
154
157
  export * from "./termssettingsrecipientdto.js";
155
158
  export * from "./transactionsettingsdto.js";
@@ -0,0 +1,54 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import * as models from "../index.js";
8
+
9
+ export type BusinessesControllerCreateSupplementalDataRequest = {
10
+ /**
11
+ * The ID of the business
12
+ */
13
+ id: string;
14
+ /**
15
+ * Unique key for idempotency
16
+ */
17
+ idempotencyKey: string;
18
+ createSupplementalDataDto: models.CreateSupplementalDataDto;
19
+ };
20
+
21
+ /** @internal */
22
+ export type BusinessesControllerCreateSupplementalDataRequest$Outbound = {
23
+ id: string;
24
+ "Idempotency-Key": string;
25
+ CreateSupplementalDataDto: models.CreateSupplementalDataDto$Outbound;
26
+ };
27
+
28
+ /** @internal */
29
+ export const BusinessesControllerCreateSupplementalDataRequest$outboundSchema:
30
+ z.ZodType<
31
+ BusinessesControllerCreateSupplementalDataRequest$Outbound,
32
+ z.ZodTypeDef,
33
+ BusinessesControllerCreateSupplementalDataRequest
34
+ > = z.object({
35
+ id: z.string(),
36
+ idempotencyKey: z.string(),
37
+ createSupplementalDataDto: models.CreateSupplementalDataDto$outboundSchema,
38
+ }).transform((v) => {
39
+ return remap$(v, {
40
+ idempotencyKey: "Idempotency-Key",
41
+ createSupplementalDataDto: "CreateSupplementalDataDto",
42
+ });
43
+ });
44
+
45
+ export function businessesControllerCreateSupplementalDataRequestToJSON(
46
+ businessesControllerCreateSupplementalDataRequest:
47
+ BusinessesControllerCreateSupplementalDataRequest,
48
+ ): string {
49
+ return JSON.stringify(
50
+ BusinessesControllerCreateSupplementalDataRequest$outboundSchema.parse(
51
+ businessesControllerCreateSupplementalDataRequest,
52
+ ),
53
+ );
54
+ }
@@ -17,6 +17,7 @@ export * from "./applicationscontrollersubmitapplication.js";
17
17
  export * from "./applicationscontrollerupdate.js";
18
18
  export * from "./businessescontrollercreate.js";
19
19
  export * from "./businessescontrollercreatebulk.js";
20
+ export * from "./businessescontrollercreatesupplementaldata.js";
20
21
  export * from "./businessescontrollerfindall.js";
21
22
  export * from "./businessescontrollerfindone.js";
22
23
  export * from "./businessescontrollergetaccountholderinformation.js";
@@ -0,0 +1,134 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../lib/primitives.js";
7
+ import { safeParse } from "../lib/schemas.js";
8
+ import { ClosedEnum } from "../types/enums.js";
9
+ import { Result as SafeParseResult } from "../types/fp.js";
10
+ import * as types from "../types/primitives.js";
11
+ import { SDKValidationError } from "./errors/sdkvalidationerror.js";
12
+
13
+ /**
14
+ * Data source
15
+ */
16
+ export const SupplementalDataResponseDtoSource = {
17
+ Plaid: "PLAID",
18
+ Codat: "CODAT",
19
+ TaktileResponse: "TAKTILE_RESPONSE",
20
+ TaktileRequest: "TAKTILE_REQUEST",
21
+ Transcredit: "TRANSCREDIT",
22
+ TranscreditScores: "TRANSCREDIT_SCORES",
23
+ Heron: "HERON",
24
+ HeronPdf: "HERON_PDF",
25
+ OpenBanking: "OPEN_BANKING",
26
+ Alloy: "ALLOY",
27
+ CodatBalanceSheet: "CODAT_BALANCE_SHEET",
28
+ CodatAccountBalance: "CODAT_ACCOUNT_BALANCE",
29
+ CodatBankingTransactions: "CODAT_BANKING_TRANSACTIONS",
30
+ CodatPl: "CODAT_PL",
31
+ CodatAgedCreditor: "CODAT_AGED_CREDITOR",
32
+ CodatAgedDebtor: "CODAT_AGED_DEBTOR",
33
+ QuickbooksBalanceSheet: "QUICKBOOKS_BALANCE_SHEET",
34
+ QuickbooksPl: "QUICKBOOKS_PL",
35
+ FinancialStatementMetrics: "FINANCIAL_STATEMENT_METRICS",
36
+ PdfBalanceSheet: "PDF_BALANCE_SHEET",
37
+ PdfProfitLoss: "PDF_PROFIT_LOSS",
38
+ StripeFinancialConnectionsBalance: "STRIPE_FINANCIAL_CONNECTIONS_BALANCE",
39
+ StripeFinancialConnectionsTransactions:
40
+ "STRIPE_FINANCIAL_CONNECTIONS_TRANSACTIONS",
41
+ } as const;
42
+ /**
43
+ * Data source
44
+ */
45
+ export type SupplementalDataResponseDtoSource = ClosedEnum<
46
+ typeof SupplementalDataResponseDtoSource
47
+ >;
48
+
49
+ /**
50
+ * Processing status
51
+ */
52
+ export const SupplementalDataResponseDtoStatus = {
53
+ Pending: "PENDING",
54
+ Success: "SUCCESS",
55
+ Error: "ERROR",
56
+ TimeOut: "TIME_OUT",
57
+ } as const;
58
+ /**
59
+ * Processing status
60
+ */
61
+ export type SupplementalDataResponseDtoStatus = ClosedEnum<
62
+ typeof SupplementalDataResponseDtoStatus
63
+ >;
64
+
65
+ export type SupplementalDataResponseDto = {
66
+ /**
67
+ * Unique identifier
68
+ */
69
+ id: string;
70
+ /**
71
+ * Object type
72
+ */
73
+ object: string;
74
+ /**
75
+ * Business ID
76
+ */
77
+ business: string;
78
+ /**
79
+ * Data source
80
+ */
81
+ source: SupplementalDataResponseDtoSource;
82
+ /**
83
+ * Processing status
84
+ */
85
+ status: SupplementalDataResponseDtoStatus;
86
+ /**
87
+ * Creation timestamp
88
+ */
89
+ createdAt: Date;
90
+ /**
91
+ * Last update timestamp
92
+ */
93
+ updatedAt: Date;
94
+ };
95
+
96
+ /** @internal */
97
+ export const SupplementalDataResponseDtoSource$inboundSchema: z.ZodNativeEnum<
98
+ typeof SupplementalDataResponseDtoSource
99
+ > = z.nativeEnum(SupplementalDataResponseDtoSource);
100
+
101
+ /** @internal */
102
+ export const SupplementalDataResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
103
+ typeof SupplementalDataResponseDtoStatus
104
+ > = z.nativeEnum(SupplementalDataResponseDtoStatus);
105
+
106
+ /** @internal */
107
+ export const SupplementalDataResponseDto$inboundSchema: z.ZodType<
108
+ SupplementalDataResponseDto,
109
+ z.ZodTypeDef,
110
+ unknown
111
+ > = z.object({
112
+ id: types.string(),
113
+ object: types.string(),
114
+ business: types.string(),
115
+ source: SupplementalDataResponseDtoSource$inboundSchema,
116
+ status: SupplementalDataResponseDtoStatus$inboundSchema,
117
+ created_at: types.date(),
118
+ updated_at: types.date(),
119
+ }).transform((v) => {
120
+ return remap$(v, {
121
+ "created_at": "createdAt",
122
+ "updated_at": "updatedAt",
123
+ });
124
+ });
125
+
126
+ export function supplementalDataResponseDtoFromJSON(
127
+ jsonString: string,
128
+ ): SafeParseResult<SupplementalDataResponseDto, SDKValidationError> {
129
+ return safeParse(
130
+ jsonString,
131
+ (x) => SupplementalDataResponseDto$inboundSchema.parse(JSON.parse(x)),
132
+ `Failed to parse 'SupplementalDataResponseDto' from JSON`,
133
+ );
134
+ }
@@ -16,6 +16,7 @@ import { businessesGetVirtualAccountInformation } from "../funcs/businessesGetVi
16
16
  import { businessesList } from "../funcs/businessesList.js";
17
17
  import { businessesSearch } from "../funcs/businessesSearch.js";
18
18
  import { businessesStartUnderwriting } from "../funcs/businessesStartUnderwriting.js";
19
+ import { businessesSubmitSupplementalData } from "../funcs/businessesSubmitSupplementalData.js";
19
20
  import { businessesUpdate } from "../funcs/businessesUpdate.js";
20
21
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
21
22
  import * as models from "../models/index.js";
@@ -265,4 +266,21 @@ export class Businesses extends ClientSDK {
265
266
  options,
266
267
  ));
267
268
  }
269
+
270
+ /**
271
+ * Submit supplemental data for a business
272
+ *
273
+ * @remarks
274
+ * Provides supplemental data used for underwriting a business. Data is processed by source-specific handlers.
275
+ */
276
+ async submitSupplementalData(
277
+ request: operations.BusinessesControllerCreateSupplementalDataRequest,
278
+ options?: RequestOptions,
279
+ ): Promise<models.SupplementalDataResponseDto> {
280
+ return unwrapAsync(businessesSubmitSupplementalData(
281
+ this,
282
+ request,
283
+ options,
284
+ ));
285
+ }
268
286
  }