@oatfi/oatfi-sdk-ts 0.11.43 → 0.11.45

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 (67) hide show
  1. package/FUNCTIONS.md +66 -66
  2. package/README.md +333 -321
  3. package/dist/commonjs/funcs/embedRefreshToken.d.ts +17 -0
  4. package/dist/commonjs/funcs/embedRefreshToken.d.ts.map +1 -0
  5. package/dist/commonjs/funcs/embedRefreshToken.js +114 -0
  6. package/dist/commonjs/funcs/embedRefreshToken.js.map +1 -0
  7. package/dist/commonjs/lib/config.d.ts +3 -3
  8. package/dist/commonjs/lib/config.js +3 -3
  9. package/dist/commonjs/lib/sdks.js +2 -2
  10. package/dist/commonjs/lib/sdks.js.map +1 -1
  11. package/dist/commonjs/models/createpersondto.d.ts +1 -1
  12. package/dist/commonjs/models/financialaccountresponsedto.d.ts +19 -0
  13. package/dist/commonjs/models/financialaccountresponsedto.d.ts.map +1 -1
  14. package/dist/commonjs/models/financialaccountresponsedto.js +14 -1
  15. package/dist/commonjs/models/financialaccountresponsedto.js.map +1 -1
  16. package/dist/commonjs/models/personbusinessrelationship.d.ts +2 -2
  17. package/dist/commonjs/models/personbusinessrelationship.js +1 -1
  18. package/dist/commonjs/models/personinformationdto.d.ts +1 -1
  19. package/dist/commonjs/models/updatepersoninformationdto.d.ts +1 -1
  20. package/dist/commonjs/sdk/embed.d.ts +7 -0
  21. package/dist/commonjs/sdk/embed.d.ts.map +1 -1
  22. package/dist/commonjs/sdk/embed.js +10 -0
  23. package/dist/commonjs/sdk/embed.js.map +1 -1
  24. package/dist/commonjs/sdk/sdk.d.ts +4 -4
  25. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  26. package/dist/commonjs/sdk/sdk.js +4 -4
  27. package/dist/commonjs/sdk/sdk.js.map +1 -1
  28. package/dist/esm/funcs/embedRefreshToken.d.ts +17 -0
  29. package/dist/esm/funcs/embedRefreshToken.d.ts.map +1 -0
  30. package/dist/esm/funcs/embedRefreshToken.js +78 -0
  31. package/dist/esm/funcs/embedRefreshToken.js.map +1 -0
  32. package/dist/esm/lib/config.d.ts +3 -3
  33. package/dist/esm/lib/config.js +3 -3
  34. package/dist/esm/lib/sdks.js +2 -2
  35. package/dist/esm/lib/sdks.js.map +1 -1
  36. package/dist/esm/models/createpersondto.d.ts +1 -1
  37. package/dist/esm/models/financialaccountresponsedto.d.ts +19 -0
  38. package/dist/esm/models/financialaccountresponsedto.d.ts.map +1 -1
  39. package/dist/esm/models/financialaccountresponsedto.js +13 -0
  40. package/dist/esm/models/financialaccountresponsedto.js.map +1 -1
  41. package/dist/esm/models/personbusinessrelationship.d.ts +2 -2
  42. package/dist/esm/models/personbusinessrelationship.js +1 -1
  43. package/dist/esm/models/personinformationdto.d.ts +1 -1
  44. package/dist/esm/models/updatepersoninformationdto.d.ts +1 -1
  45. package/dist/esm/sdk/embed.d.ts +7 -0
  46. package/dist/esm/sdk/embed.d.ts.map +1 -1
  47. package/dist/esm/sdk/embed.js +10 -0
  48. package/dist/esm/sdk/embed.js.map +1 -1
  49. package/dist/esm/sdk/sdk.d.ts +4 -4
  50. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  51. package/dist/esm/sdk/sdk.js +4 -4
  52. package/dist/esm/sdk/sdk.js.map +1 -1
  53. package/examples/businessesCreate.example.ts +100 -0
  54. package/examples/package-lock.json +1 -1
  55. package/jsr.json +1 -1
  56. package/package.json +2 -1
  57. package/src/funcs/embedRefreshToken.ts +152 -0
  58. package/src/lib/config.ts +3 -3
  59. package/src/lib/sdks.ts +2 -2
  60. package/src/models/createpersondto.ts +1 -1
  61. package/src/models/financialaccountresponsedto.ts +25 -0
  62. package/src/models/personbusinessrelationship.ts +2 -2
  63. package/src/models/personinformationdto.ts +1 -1
  64. package/src/models/updatepersoninformationdto.ts +1 -1
  65. package/src/sdk/embed.ts +16 -0
  66. package/src/sdk/sdk.ts +6 -6
  67. package/examples/applicationsCreate.example.ts +0 -98
package/FUNCTIONS.md CHANGED
@@ -20,7 +20,7 @@ specific category of applications.
20
20
 
21
21
  ```typescript
22
22
  import { OatFiSDKCore } from "@oatfi/oatfi-sdk-ts/core.js";
23
- import { applicationsCreate } from "@oatfi/oatfi-sdk-ts/funcs/applicationsCreate.js";
23
+ import { businessesCreate } from "@oatfi/oatfi-sdk-ts/funcs/businessesCreate.js";
24
24
 
25
25
  // Use `OatFiSDKCore` for best tree-shaking performance.
26
26
  // You can create one instance of it to use across an application.
@@ -29,76 +29,76 @@ const oatFiSDK = new OatFiSDKCore({
29
29
  });
30
30
 
31
31
  async function run() {
32
- const res = await applicationsCreate(oatFiSDK, {
32
+ const res = await businessesCreate(oatFiSDK, {
33
33
  idempotencyKey: "<value>",
34
- createApplicationDto: {
35
- platform: "<value>",
36
- businessInformation: {
37
- name: "Acme Corp",
38
- externalId: "biz_123abc",
39
- dbaName: "Acme Innovations",
40
- taxId: "123456789",
41
- businessEntityType: "corporation",
42
- stateOfIncorporation: "CA",
43
- dateEstablished: "2020-01-15",
44
- physicalAddress: {
45
- line1: "123 Main St",
46
- line2: "Apt 4B",
47
- city: "San Francisco",
48
- state: "CA",
49
- postalCode: "94107",
50
- },
51
- contactPhone: "555-123-4567",
52
- contactEmail: "contact@acme.com",
53
- industryType: "541511",
54
- businessDescription: "Software development services",
55
- websiteUrl: "https://acme.com",
56
- mailingAddress: {
57
- line1: "123 Main St",
58
- line2: "Apt 4B",
59
- city: "San Francisco",
60
- state: "CA",
61
- postalCode: "94107",
62
- },
34
+ createBusinessDto: {
35
+ externalId: "ext_123456",
36
+ name: "Acme Corporation",
37
+ dbaName: "Acme",
38
+ taxId: "123456789",
39
+ address: {
40
+ line1: "123 Main St",
41
+ line2: "Suite 100",
42
+ city: "San Francisco",
43
+ state: "CA",
44
+ postalCode: "94105",
63
45
  },
64
- personsInformation: [
46
+ contactFirstName: "John",
47
+ contactLastName: "Doe",
48
+ contactEmail: "john.doe@acme.com",
49
+ contactPhone: "+14155552671",
50
+ businessStartDateYear: "2020",
51
+ application: "507f1f77bcf86cd799439011",
52
+ users: [
53
+ "507f1f77bcf86cd799439011",
54
+ "507f1f77bcf86cd799439012",
55
+ ],
56
+ primaryUser: "507f1f77bcf86cd799439011",
57
+ achToken: "ACH20c64a3d71cb-4400-8225-6d19918aa183",
58
+ webhookUrl: "https://my.webhook.com/post",
59
+ plaidToken: "20c64a3d-71cb-4400-8225-6d19918aa183",
60
+ plaidTokens: [
61
+ {
62
+ alias: "Default Token",
63
+ token: "access-sandbox-43bb37eb-954c-45e8-b0be-391b1d2c06fc",
64
+ },
65
+ ],
66
+ heronId: "heron_123456",
67
+ paymentSettings: [
65
68
  {
66
- externalId: "person_ext_123",
67
- firstName: "John",
68
- lastName: "Doe",
69
- title: "CEO",
70
- email: "john.doe@example.com",
71
- phone: "555-0101",
72
- dateOfBirth: "1985-07-22",
73
- address: {
74
- line1: "123 Main St",
75
- line2: "Apt 4B",
76
- city: "San Francisco",
77
- state: "CA",
78
- postalCode: "94107",
69
+ partner: "62eaf2133147bd1b70da07d2",
70
+ business: "62eaf2133147bd1b70da07d2",
71
+ data: {
72
+ accountId: "acct_1J876rQjaww8b42s",
73
+ customerId: "cus_sdfsdfsd1J876rQjawghghw8b42s",
74
+ paymentMethodId: "pm_ssej45jawghghw8b42s",
75
+ accountNumber: "21565234545",
76
+ routingNumber: "1572515454",
77
+ directDebitAuthorization: "{\"authorized\": true, \"type\": \"PLAID\", \"account_id\": \"000123456789\", \"owner\": \"Business Owner\", \"created_at\": \"2023-01-01T00:00:00.000Z\"}",
78
+ fundingSourceId: "H6U1rvcYcDybNwKykiyM28of0mPdOnh9yCJPIa5MJEdSRD5846",
79
+ moovPaymentMethodId: "0ff91950-3333-4444-5555-b071f5550795",
80
+ unitAccountId: "21565234545",
81
+ swiftCode: "1572515454",
82
+ remittanceInformation: "Payment for {year}-{month}-{day}",
83
+ businessId: "biz_456",
84
+ lockboxAddress: "123 Main St",
85
+ accountNumberId: "account_number_i6kffj1pvwhmhi7okasb",
86
+ oatfiAccountNumber: "21565234545",
87
+ oatfiRoutingNumber: "21565234545",
79
88
  },
80
- relationshipToBusiness: "Owner",
81
- isControlPerson: false,
82
- ownershipPercentage: 25,
83
- kycStatus: "NOT_STARTED",
84
- ssn: "123-45-6789",
89
+ scheduledRepayment: false,
90
+ isDefault: true,
91
+ type: "UNIT",
85
92
  },
86
93
  ],
87
- expectedUsage: {
88
- expectedMonthlyPaymentsVolumeRange: "100,001-500,000",
89
- operationalCountries: [
90
- "US",
91
- "CA",
92
- ],
93
- customerTypes: [
94
- "B2C",
95
- "B2B",
96
- ],
97
- fundsTransferCountries: [
98
- "US",
99
- "MX",
100
- ],
101
- restrictedActivities: {},
94
+ codatCompanyId: "20c64a3d-71cb-4400-8225-6d19918aa183",
95
+ consumerInvoices: false,
96
+ requestedCreditLimit: 10000,
97
+ metadata: {
98
+ mcNumber: "20c64a3d-71cb-4400-8225-6d19918aa183",
99
+ avgMonthlySpend: "10000",
100
+ orderProductSelection: "20c64a3d-71cb-4400-8225-6d19918aa183",
101
+ requestedCreditLimit: 10000,
102
102
  },
103
103
  },
104
104
  });
@@ -106,7 +106,7 @@ async function run() {
106
106
  const { value: result } = res;
107
107
  console.log(result);
108
108
  } else {
109
- console.log("applicationsCreate failed:", res.error);
109
+ console.log("businessesCreate failed:", res.error);
110
110
  }
111
111
  }
112
112