@tryfinch/finch-api 5.14.3 → 5.15.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 (153) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/LICENSE +1 -1
  3. package/_shims/index.d.ts +1 -1
  4. package/_shims/registry.d.ts +1 -1
  5. package/_shims/registry.d.ts.map +1 -1
  6. package/core.d.ts +12 -12
  7. package/core.d.ts.map +1 -1
  8. package/core.js +39 -13
  9. package/core.js.map +1 -1
  10. package/core.mjs +39 -13
  11. package/core.mjs.map +1 -1
  12. package/index.d.mts +15 -0
  13. package/index.d.ts +15 -0
  14. package/index.d.ts.map +1 -1
  15. package/index.js +15 -2
  16. package/index.js.map +1 -1
  17. package/index.mjs +15 -2
  18. package/index.mjs.map +1 -1
  19. package/package.json +1 -1
  20. package/resources/access-tokens.d.ts +23 -0
  21. package/resources/access-tokens.d.ts.map +1 -0
  22. package/resources/access-tokens.js +17 -0
  23. package/resources/access-tokens.js.map +1 -0
  24. package/resources/access-tokens.mjs +13 -0
  25. package/resources/access-tokens.mjs.map +1 -0
  26. package/resources/account.d.ts +14 -0
  27. package/resources/account.d.ts.map +1 -1
  28. package/resources/account.js.map +1 -1
  29. package/resources/account.mjs.map +1 -1
  30. package/resources/auth.d.ts +20 -0
  31. package/resources/auth.d.ts.map +1 -0
  32. package/resources/auth.js +17 -0
  33. package/resources/auth.js.map +1 -0
  34. package/resources/auth.mjs +13 -0
  35. package/resources/auth.mjs.map +1 -0
  36. package/resources/index.d.ts +3 -0
  37. package/resources/index.d.ts.map +1 -1
  38. package/resources/index.js +7 -1
  39. package/resources/index.js.map +1 -1
  40. package/resources/index.mjs +3 -0
  41. package/resources/index.mjs.map +1 -1
  42. package/resources/sandbox/company.d.ts +195 -0
  43. package/resources/sandbox/company.d.ts.map +1 -0
  44. package/resources/sandbox/company.js +17 -0
  45. package/resources/sandbox/company.js.map +1 -0
  46. package/resources/sandbox/company.mjs +13 -0
  47. package/resources/sandbox/company.mjs.map +1 -0
  48. package/resources/sandbox/connections/accounts.d.ts +51 -0
  49. package/resources/sandbox/connections/accounts.d.ts.map +1 -0
  50. package/resources/sandbox/connections/accounts.js +24 -0
  51. package/resources/sandbox/connections/accounts.js.map +1 -0
  52. package/resources/sandbox/connections/accounts.mjs +20 -0
  53. package/resources/sandbox/connections/accounts.mjs.map +1 -0
  54. package/resources/sandbox/connections/connections.d.ts +39 -0
  55. package/resources/sandbox/connections/connections.d.ts.map +1 -0
  56. package/resources/sandbox/connections/connections.js +46 -0
  57. package/resources/sandbox/connections/connections.js.map +1 -0
  58. package/resources/sandbox/connections/connections.mjs +19 -0
  59. package/resources/sandbox/connections/connections.mjs.map +1 -0
  60. package/resources/sandbox/connections/index.d.ts +3 -0
  61. package/resources/sandbox/connections/index.d.ts.map +1 -0
  62. package/resources/sandbox/connections/index.js +9 -0
  63. package/resources/sandbox/connections/index.js.map +1 -0
  64. package/resources/sandbox/connections/index.mjs +4 -0
  65. package/resources/sandbox/connections/index.mjs.map +1 -0
  66. package/resources/sandbox/directory.d.ts +156 -0
  67. package/resources/sandbox/directory.d.ts.map +1 -0
  68. package/resources/sandbox/directory.js +17 -0
  69. package/resources/sandbox/directory.js.map +1 -0
  70. package/resources/sandbox/directory.mjs +13 -0
  71. package/resources/sandbox/directory.mjs.map +1 -0
  72. package/resources/sandbox/employment.d.ts +216 -0
  73. package/resources/sandbox/employment.d.ts.map +1 -0
  74. package/resources/sandbox/employment.js +18 -0
  75. package/resources/sandbox/employment.js.map +1 -0
  76. package/resources/sandbox/employment.mjs +14 -0
  77. package/resources/sandbox/employment.mjs.map +1 -0
  78. package/resources/sandbox/index.d.ts +9 -0
  79. package/resources/sandbox/index.d.ts.map +1 -0
  80. package/resources/sandbox/index.js +21 -0
  81. package/resources/sandbox/index.js.map +1 -0
  82. package/resources/sandbox/index.mjs +10 -0
  83. package/resources/sandbox/index.mjs.map +1 -0
  84. package/resources/sandbox/individual.d.ts +124 -0
  85. package/resources/sandbox/individual.d.ts.map +1 -0
  86. package/resources/sandbox/individual.js +18 -0
  87. package/resources/sandbox/individual.js.map +1 -0
  88. package/resources/sandbox/individual.mjs +14 -0
  89. package/resources/sandbox/individual.mjs.map +1 -0
  90. package/resources/sandbox/jobs/configuration.d.ts +28 -0
  91. package/resources/sandbox/jobs/configuration.d.ts.map +1 -0
  92. package/resources/sandbox/jobs/configuration.js +23 -0
  93. package/resources/sandbox/jobs/configuration.js.map +1 -0
  94. package/resources/sandbox/jobs/configuration.mjs +19 -0
  95. package/resources/sandbox/jobs/configuration.mjs.map +1 -0
  96. package/resources/sandbox/jobs/index.d.ts +3 -0
  97. package/resources/sandbox/jobs/index.d.ts.map +1 -0
  98. package/resources/sandbox/jobs/index.js +9 -0
  99. package/resources/sandbox/jobs/index.js.map +1 -0
  100. package/resources/sandbox/jobs/index.mjs +4 -0
  101. package/resources/sandbox/jobs/index.mjs.map +1 -0
  102. package/resources/sandbox/jobs/jobs.d.ts +12 -0
  103. package/resources/sandbox/jobs/jobs.d.ts.map +1 -0
  104. package/resources/sandbox/jobs/jobs.js +40 -0
  105. package/resources/sandbox/jobs/jobs.js.map +1 -0
  106. package/resources/sandbox/jobs/jobs.mjs +13 -0
  107. package/resources/sandbox/jobs/jobs.mjs.map +1 -0
  108. package/resources/sandbox/payment.d.ts +154 -0
  109. package/resources/sandbox/payment.d.ts.map +1 -0
  110. package/resources/sandbox/payment.js +18 -0
  111. package/resources/sandbox/payment.js.map +1 -0
  112. package/resources/sandbox/payment.mjs +14 -0
  113. package/resources/sandbox/payment.mjs.map +1 -0
  114. package/resources/sandbox/sandbox.d.ts +39 -0
  115. package/resources/sandbox/sandbox.d.ts.map +1 -0
  116. package/resources/sandbox/sandbox.js +58 -0
  117. package/resources/sandbox/sandbox.js.map +1 -0
  118. package/resources/sandbox/sandbox.mjs +31 -0
  119. package/resources/sandbox/sandbox.mjs.map +1 -0
  120. package/resources/shared.d.ts +1 -0
  121. package/resources/shared.d.ts.map +1 -1
  122. package/src/_shims/index.d.ts +1 -1
  123. package/src/_shims/node-runtime.ts +1 -1
  124. package/src/_shims/registry.ts +1 -1
  125. package/src/_shims/web-runtime.ts +1 -1
  126. package/src/core.ts +65 -30
  127. package/src/index.ts +23 -2
  128. package/src/lib/.keep +4 -0
  129. package/src/resources/access-tokens.ts +36 -0
  130. package/src/resources/account.ts +19 -0
  131. package/src/resources/auth.ts +32 -0
  132. package/src/resources/index.ts +3 -0
  133. package/src/resources/sandbox/company.ts +252 -0
  134. package/src/resources/sandbox/connections/accounts.ts +83 -0
  135. package/src/resources/sandbox/connections/connections.ts +58 -0
  136. package/src/resources/sandbox/connections/index.ts +10 -0
  137. package/src/resources/sandbox/directory.ts +210 -0
  138. package/src/resources/sandbox/employment.ts +279 -0
  139. package/src/resources/sandbox/index.ts +10 -0
  140. package/src/resources/sandbox/individual.ts +193 -0
  141. package/src/resources/sandbox/jobs/configuration.ts +44 -0
  142. package/src/resources/sandbox/jobs/index.ts +9 -0
  143. package/src/resources/sandbox/jobs/jobs.ts +15 -0
  144. package/src/resources/sandbox/payment.ts +215 -0
  145. package/src/resources/sandbox/sandbox.ts +42 -0
  146. package/src/resources/shared.ts +8 -0
  147. package/src/uploads.ts +2 -2
  148. package/src/version.ts +1 -1
  149. package/uploads.d.ts +2 -2
  150. package/uploads.d.ts.map +1 -1
  151. package/version.d.ts +1 -1
  152. package/version.js +1 -1
  153. package/version.mjs +1 -1
@@ -0,0 +1,156 @@
1
+ import * as Core from '@tryfinch/finch-api/core';
2
+ import { APIResource } from '@tryfinch/finch-api/resource';
3
+ import * as DirectoryAPI from '@tryfinch/finch-api/resources/sandbox/directory';
4
+ import * as HRISAPI from '@tryfinch/finch-api/resources/hris/hris';
5
+ export declare class Directory extends APIResource {
6
+ /**
7
+ * Add new individuals to a sandbox company
8
+ */
9
+ create(body: DirectoryCreateParams, options?: Core.RequestOptions): Core.APIPromise<DirectoryCreateResponse>;
10
+ }
11
+ /**
12
+ * The individuals which were created
13
+ */
14
+ export type DirectoryCreateResponse = Array<unknown>;
15
+ export type DirectoryCreateParams = Array<DirectoryCreateParams.Body>;
16
+ export declare namespace DirectoryCreateParams {
17
+ interface Body {
18
+ /**
19
+ * Worker's compensation classification code for this employee
20
+ */
21
+ class_code?: string | null;
22
+ /**
23
+ * Custom fields for the individual. These are fields which are defined by the
24
+ * employer in the system. Custom fields are not currently supported for assisted
25
+ * connections.
26
+ */
27
+ custom_fields?: Array<Body.CustomField>;
28
+ /**
29
+ * The department object.
30
+ */
31
+ department?: Body.Department | null;
32
+ dob?: string | null;
33
+ emails?: Array<Body.Email> | null;
34
+ /**
35
+ * The employment object.
36
+ */
37
+ employment?: Body.Employment | null;
38
+ /**
39
+ * Social Security Number of the individual in **encrypted** format. This field is
40
+ * only available with the `ssn` scope enabled and the
41
+ * `options: { include: ['ssn'] }` param set in the body.
42
+ */
43
+ encrypted_ssn?: string | null;
44
+ end_date?: string | null;
45
+ /**
46
+ * The EEOC-defined ethnicity of the individual.
47
+ */
48
+ ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null;
49
+ /**
50
+ * The legal first name of the individual.
51
+ */
52
+ first_name?: string | null;
53
+ /**
54
+ * The gender of the individual.
55
+ */
56
+ gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
57
+ /**
58
+ * The employee's income as reported by the provider. This may not always be
59
+ * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
60
+ * depending on what information the provider returns.
61
+ */
62
+ income?: HRISAPI.Income | null;
63
+ /**
64
+ * The array of income history.
65
+ */
66
+ income_history?: Array<HRISAPI.Income | null> | null;
67
+ /**
68
+ * `true` if the individual an an active employee or contractor at the company.
69
+ */
70
+ is_active?: boolean | null;
71
+ /**
72
+ * The legal last name of the individual.
73
+ */
74
+ last_name?: string | null;
75
+ location?: HRISAPI.Location | null;
76
+ /**
77
+ * The manager object representing the manager of the individual within the org.
78
+ */
79
+ manager?: Body.Manager | null;
80
+ /**
81
+ * The legal middle name of the individual.
82
+ */
83
+ middle_name?: string | null;
84
+ phone_numbers?: Array<Body.PhoneNumber | null> | null;
85
+ /**
86
+ * The preferred name of the individual.
87
+ */
88
+ preferred_name?: string | null;
89
+ residence?: HRISAPI.Location | null;
90
+ /**
91
+ * The source system's unique employment identifier for this individual
92
+ */
93
+ source_id?: string;
94
+ /**
95
+ * Social Security Number of the individual. This field is only available with the
96
+ * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
97
+ * body.
98
+ */
99
+ ssn?: string | null;
100
+ start_date?: string | null;
101
+ /**
102
+ * The current title of the individual.
103
+ */
104
+ title?: string | null;
105
+ }
106
+ namespace Body {
107
+ interface CustomField {
108
+ name?: string | null;
109
+ value?: unknown;
110
+ }
111
+ /**
112
+ * The department object.
113
+ */
114
+ interface Department {
115
+ /**
116
+ * The name of the department associated with the individual.
117
+ */
118
+ name?: string | null;
119
+ }
120
+ interface Email {
121
+ data?: string;
122
+ type?: 'work' | 'personal';
123
+ }
124
+ /**
125
+ * The employment object.
126
+ */
127
+ interface Employment {
128
+ /**
129
+ * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
130
+ */
131
+ subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
132
+ /**
133
+ * The main employment type of the individual.
134
+ */
135
+ type?: 'employee' | 'contractor' | null;
136
+ }
137
+ /**
138
+ * The manager object representing the manager of the individual within the org.
139
+ */
140
+ interface Manager {
141
+ /**
142
+ * A stable Finch `id` (UUID v4) for an individual in the company.
143
+ */
144
+ id?: string;
145
+ }
146
+ interface PhoneNumber {
147
+ data?: string;
148
+ type?: 'work' | 'personal';
149
+ }
150
+ }
151
+ }
152
+ export declare namespace Directory {
153
+ export import DirectoryCreateResponse = DirectoryAPI.DirectoryCreateResponse;
154
+ export import DirectoryCreateParams = DirectoryAPI.DirectoryCreateParams;
155
+ }
156
+ //# sourceMappingURL=directory.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"directory.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/directory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,YAAY,MAAM,iDAAiD,CAAC;AAChF,OAAO,KAAK,OAAO,MAAM,yCAAyC,CAAC;AAEnE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAG5C;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;AAErD,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;AAEtE,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;;WAIG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAExC;;WAEG;QACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpC;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,CAAC,EACN,OAAO,GACP,OAAO,GACP,2BAA2B,GAC3B,qCAAqC,GACrC,kCAAkC,GAClC,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,IAAI,CAAC;QAET;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;QAEnE;;;;WAIG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAErD;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,SAAS,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,WAAW;YAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,KAAK,CAAC,EAAE,OAAO,CAAC;SACjB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;YAEtG;;eAEG;YACH,IAAI,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;SACzC;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;QAED,UAAiB,WAAW;YAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;SAC5B;KACF;CACF;AAED,yBAAiB,SAAS,CAAC;IACzB,MAAM,QAAQ,uBAAuB,GAAG,YAAY,CAAC,uBAAuB,CAAC;IAC7E,MAAM,QAAQ,qBAAqB,GAAG,YAAY,CAAC,qBAAqB,CAAC;CAC1E"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Directory = void 0;
5
+ const resource_1 = require("@tryfinch/finch-api/resource");
6
+ class Directory extends resource_1.APIResource {
7
+ /**
8
+ * Add new individuals to a sandbox company
9
+ */
10
+ create(body, options) {
11
+ return this._client.post('/sandbox/directory', { body, ...options });
12
+ }
13
+ }
14
+ exports.Directory = Directory;
15
+ (function (Directory) {
16
+ })(Directory = exports.Directory || (exports.Directory = {}));
17
+ //# sourceMappingURL=directory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"directory.js","sourceRoot":"","sources":["../../src/resources/sandbox/directory.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2DAA2D;AAI3D,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,MAAM,CACJ,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAVD,8BAUC;AA6LD,WAAiB,SAAS;AAG1B,CAAC,EAHgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGzB"}
@@ -0,0 +1,13 @@
1
+ // File generated from our OpenAPI spec by Stainless.
2
+ import { APIResource } from '@tryfinch/finch-api/resource';
3
+ export class Directory extends APIResource {
4
+ /**
5
+ * Add new individuals to a sandbox company
6
+ */
7
+ create(body, options) {
8
+ return this._client.post('/sandbox/directory', { body, ...options });
9
+ }
10
+ }
11
+ (function (Directory) {
12
+ })(Directory || (Directory = {}));
13
+ //# sourceMappingURL=directory.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"directory.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/directory.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;AAI1D,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AA6LD,WAAiB,SAAS;AAG1B,CAAC,EAHgB,SAAS,KAAT,SAAS,QAGzB"}
@@ -0,0 +1,216 @@
1
+ import * as Core from '@tryfinch/finch-api/core';
2
+ import { APIResource } from '@tryfinch/finch-api/resource';
3
+ import * as EmploymentAPI from '@tryfinch/finch-api/resources/sandbox/employment';
4
+ import * as HRISAPI from '@tryfinch/finch-api/resources/hris/hris';
5
+ export declare class Employment extends APIResource {
6
+ /**
7
+ * Update sandbox employment
8
+ */
9
+ update(individualId: string, body?: EmploymentUpdateParams, options?: Core.RequestOptions): Core.APIPromise<EmploymentUpdateResponse>;
10
+ update(individualId: string, options?: Core.RequestOptions): Core.APIPromise<EmploymentUpdateResponse>;
11
+ }
12
+ export interface EmploymentUpdateResponse {
13
+ /**
14
+ * A stable Finch `id` (UUID v4) for an individual in the company.
15
+ */
16
+ id?: string;
17
+ /**
18
+ * Worker's compensation classification code for this employee
19
+ */
20
+ class_code?: string | null;
21
+ /**
22
+ * Custom fields for the individual. These are fields which are defined by the
23
+ * employer in the system. Custom fields are not currently supported for assisted
24
+ * connections.
25
+ */
26
+ custom_fields?: Array<EmploymentUpdateResponse.CustomField>;
27
+ /**
28
+ * The department object.
29
+ */
30
+ department?: EmploymentUpdateResponse.Department | null;
31
+ /**
32
+ * The employment object.
33
+ */
34
+ employment?: EmploymentUpdateResponse.Employment | null;
35
+ end_date?: string | null;
36
+ /**
37
+ * The legal first name of the individual.
38
+ */
39
+ first_name?: string | null;
40
+ /**
41
+ * The employee's income as reported by the provider. This may not always be
42
+ * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
43
+ * depending on what information the provider returns.
44
+ */
45
+ income?: HRISAPI.Income | null;
46
+ /**
47
+ * The array of income history.
48
+ */
49
+ income_history?: Array<HRISAPI.Income | null> | null;
50
+ /**
51
+ * `true` if the individual an an active employee or contractor at the company.
52
+ */
53
+ is_active?: boolean | null;
54
+ /**
55
+ * The legal last name of the individual.
56
+ */
57
+ last_name?: string | null;
58
+ location?: HRISAPI.Location | null;
59
+ /**
60
+ * The manager object representing the manager of the individual within the org.
61
+ */
62
+ manager?: EmploymentUpdateResponse.Manager | null;
63
+ /**
64
+ * The legal middle name of the individual.
65
+ */
66
+ middle_name?: string | null;
67
+ /**
68
+ * The source system's unique employment identifier for this individual
69
+ */
70
+ source_id?: string;
71
+ start_date?: string | null;
72
+ /**
73
+ * The current title of the individual.
74
+ */
75
+ title?: string | null;
76
+ }
77
+ export declare namespace EmploymentUpdateResponse {
78
+ interface CustomField {
79
+ name?: string | null;
80
+ value?: unknown;
81
+ }
82
+ /**
83
+ * The department object.
84
+ */
85
+ interface Department {
86
+ /**
87
+ * The name of the department associated with the individual.
88
+ */
89
+ name?: string | null;
90
+ }
91
+ /**
92
+ * The employment object.
93
+ */
94
+ interface Employment {
95
+ /**
96
+ * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
97
+ */
98
+ subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
99
+ /**
100
+ * The main employment type of the individual.
101
+ */
102
+ type?: 'employee' | 'contractor' | null;
103
+ }
104
+ /**
105
+ * The manager object representing the manager of the individual within the org.
106
+ */
107
+ interface Manager {
108
+ /**
109
+ * A stable Finch `id` (UUID v4) for an individual in the company.
110
+ */
111
+ id?: string;
112
+ }
113
+ }
114
+ export interface EmploymentUpdateParams {
115
+ /**
116
+ * Worker's compensation classification code for this employee
117
+ */
118
+ class_code?: string | null;
119
+ /**
120
+ * Custom fields for the individual. These are fields which are defined by the
121
+ * employer in the system. Custom fields are not currently supported for assisted
122
+ * connections.
123
+ */
124
+ custom_fields?: Array<EmploymentUpdateParams.CustomField>;
125
+ /**
126
+ * The department object.
127
+ */
128
+ department?: EmploymentUpdateParams.Department | null;
129
+ /**
130
+ * The employment object.
131
+ */
132
+ employment?: EmploymentUpdateParams.Employment | null;
133
+ end_date?: string | null;
134
+ /**
135
+ * The legal first name of the individual.
136
+ */
137
+ first_name?: string | null;
138
+ /**
139
+ * The employee's income as reported by the provider. This may not always be
140
+ * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
141
+ * depending on what information the provider returns.
142
+ */
143
+ income?: HRISAPI.Income | null;
144
+ /**
145
+ * The array of income history.
146
+ */
147
+ income_history?: Array<HRISAPI.Income | null> | null;
148
+ /**
149
+ * `true` if the individual an an active employee or contractor at the company.
150
+ */
151
+ is_active?: boolean | null;
152
+ /**
153
+ * The legal last name of the individual.
154
+ */
155
+ last_name?: string | null;
156
+ location?: HRISAPI.Location | null;
157
+ /**
158
+ * The manager object representing the manager of the individual within the org.
159
+ */
160
+ manager?: EmploymentUpdateParams.Manager | null;
161
+ /**
162
+ * The legal middle name of the individual.
163
+ */
164
+ middle_name?: string | null;
165
+ /**
166
+ * The source system's unique employment identifier for this individual
167
+ */
168
+ source_id?: string;
169
+ start_date?: string | null;
170
+ /**
171
+ * The current title of the individual.
172
+ */
173
+ title?: string | null;
174
+ }
175
+ export declare namespace EmploymentUpdateParams {
176
+ interface CustomField {
177
+ name?: string | null;
178
+ value?: unknown;
179
+ }
180
+ /**
181
+ * The department object.
182
+ */
183
+ interface Department {
184
+ /**
185
+ * The name of the department associated with the individual.
186
+ */
187
+ name?: string | null;
188
+ }
189
+ /**
190
+ * The employment object.
191
+ */
192
+ interface Employment {
193
+ /**
194
+ * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
195
+ */
196
+ subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
197
+ /**
198
+ * The main employment type of the individual.
199
+ */
200
+ type?: 'employee' | 'contractor' | null;
201
+ }
202
+ /**
203
+ * The manager object representing the manager of the individual within the org.
204
+ */
205
+ interface Manager {
206
+ /**
207
+ * A stable Finch `id` (UUID v4) for an individual in the company.
208
+ */
209
+ id?: string;
210
+ }
211
+ }
212
+ export declare namespace Employment {
213
+ export import EmploymentUpdateResponse = EmploymentAPI.EmploymentUpdateResponse;
214
+ export import EmploymentUpdateParams = EmploymentAPI.EmploymentUpdateParams;
215
+ }
216
+ //# sourceMappingURL=employment.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"employment.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/employment.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,KAAK,aAAa,MAAM,kDAAkD,CAAC;AAClF,OAAO,KAAK,OAAO,MAAM,yCAAyC,CAAC;AAEnE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAC5C,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;CAWvG;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAE5D;;OAEG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC,UAAU,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC,UAAU,GAAG,IAAI,CAAC;IAExD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;QAEtG;;WAEG;QACH,IAAI,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;KACzC;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;IAE1D;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,GAAG,IAAI,CAAC;IAEtD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;QAEtG;;WAEG;QACH,IAAI,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;KACzC;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,yBAAiB,UAAU,CAAC;IAC1B,MAAM,QAAQ,wBAAwB,GAAG,aAAa,CAAC,wBAAwB,CAAC;IAChF,MAAM,QAAQ,sBAAsB,GAAG,aAAa,CAAC,sBAAsB,CAAC;CAC7E"}
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Employment = void 0;
5
+ const resource_1 = require("@tryfinch/finch-api/resource");
6
+ const core_1 = require("@tryfinch/finch-api/core");
7
+ class Employment extends resource_1.APIResource {
8
+ update(individualId, body = {}, options) {
9
+ if ((0, core_1.isRequestOptions)(body)) {
10
+ return this.update(individualId, {}, body);
11
+ }
12
+ return this._client.put(`/sandbox/employment/${individualId}`, { body, ...options });
13
+ }
14
+ }
15
+ exports.Employment = Employment;
16
+ (function (Employment) {
17
+ })(Employment = exports.Employment || (exports.Employment = {}));
18
+ //# sourceMappingURL=employment.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"employment.js","sourceRoot":"","sources":["../../src/resources/sandbox/employment.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2DAA2D;AAC3D,mDAA4D;AAI5D,MAAa,UAAW,SAAQ,sBAAW;IAUzC,MAAM,CACJ,YAAoB,EACpB,OAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AApBD,gCAoBC;AAuPD,WAAiB,UAAU;AAG3B,CAAC,EAHgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAG1B"}
@@ -0,0 +1,14 @@
1
+ // File generated from our OpenAPI spec by Stainless.
2
+ import { APIResource } from '@tryfinch/finch-api/resource';
3
+ import { isRequestOptions } from '@tryfinch/finch-api/core';
4
+ export class Employment extends APIResource {
5
+ update(individualId, body = {}, options) {
6
+ if (isRequestOptions(body)) {
7
+ return this.update(individualId, {}, body);
8
+ }
9
+ return this._client.put(`/sandbox/employment/${individualId}`, { body, ...options });
10
+ }
11
+ }
12
+ (function (Employment) {
13
+ })(Employment || (Employment = {}));
14
+ //# sourceMappingURL=employment.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"employment.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/employment.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;OACnD,EAAE,gBAAgB,EAAE,MAAM,0BAA0B;AAI3D,MAAM,OAAO,UAAW,SAAQ,WAAW;IAUzC,MAAM,CACJ,YAAoB,EACpB,OAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AAuPD,WAAiB,UAAU;AAG3B,CAAC,EAHgB,UAAU,KAAV,UAAU,QAG1B"}
@@ -0,0 +1,9 @@
1
+ export { CompanyUpdateResponse, CompanyUpdateParams, Company } from "./company.js";
2
+ export { ConnectionCreateResponse, ConnectionCreateParams, Connections } from "./connections/index.js";
3
+ export { DirectoryCreateResponse, DirectoryCreateParams, Directory } from "./directory.js";
4
+ export { EmploymentUpdateResponse, EmploymentUpdateParams, Employment } from "./employment.js";
5
+ export { IndividualUpdateResponse, IndividualUpdateParams, Individual } from "./individual.js";
6
+ export { Jobs } from "./jobs/index.js";
7
+ export { PaymentCreateResponse, PaymentCreateParams, Payment } from "./payment.js";
8
+ export { Sandbox } from "./sandbox.js";
9
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxF,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Sandbox = exports.Payment = exports.Jobs = exports.Individual = exports.Employment = exports.Directory = exports.Connections = exports.Company = void 0;
5
+ var company_1 = require("./company.js");
6
+ Object.defineProperty(exports, "Company", { enumerable: true, get: function () { return company_1.Company; } });
7
+ var index_1 = require("./connections/index.js");
8
+ Object.defineProperty(exports, "Connections", { enumerable: true, get: function () { return index_1.Connections; } });
9
+ var directory_1 = require("./directory.js");
10
+ Object.defineProperty(exports, "Directory", { enumerable: true, get: function () { return directory_1.Directory; } });
11
+ var employment_1 = require("./employment.js");
12
+ Object.defineProperty(exports, "Employment", { enumerable: true, get: function () { return employment_1.Employment; } });
13
+ var individual_1 = require("./individual.js");
14
+ Object.defineProperty(exports, "Individual", { enumerable: true, get: function () { return individual_1.Individual; } });
15
+ var index_2 = require("./jobs/index.js");
16
+ Object.defineProperty(exports, "Jobs", { enumerable: true, get: function () { return index_2.Jobs; } });
17
+ var payment_1 = require("./payment.js");
18
+ Object.defineProperty(exports, "Payment", { enumerable: true, get: function () { return payment_1.Payment; } });
19
+ var sandbox_1 = require("./sandbox.js");
20
+ Object.defineProperty(exports, "Sandbox", { enumerable: true, get: function () { return sandbox_1.Sandbox; } });
21
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/sandbox/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,wCAAgF;AAA3B,kGAAA,OAAO,OAAA;AAC5D,gDAAoG;AAAzC,oGAAA,WAAW,OAAA;AACtE,4CAAwF;AAA/B,sGAAA,SAAS,OAAA;AAClE,8CAA4F;AAAjC,wGAAA,UAAU,OAAA;AACrE,8CAA4F;AAAjC,wGAAA,UAAU,OAAA;AACrE,yCAAoC;AAA3B,6FAAA,IAAI,OAAA;AACb,wCAAgF;AAA3B,kGAAA,OAAO,OAAA;AAC5D,wCAAoC;AAA3B,kGAAA,OAAO,OAAA"}
@@ -0,0 +1,10 @@
1
+ // File generated from our OpenAPI spec by Stainless.
2
+ export { Company } from "./company.mjs";
3
+ export { Connections } from "./connections/index.mjs";
4
+ export { Directory } from "./directory.mjs";
5
+ export { Employment } from "./employment.mjs";
6
+ export { Individual } from "./individual.mjs";
7
+ export { Jobs } from "./jobs/index.mjs";
8
+ export { Payment } from "./payment.mjs";
9
+ export { Sandbox } from "./sandbox.mjs";
10
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAA8C,OAAO,EAAE;OACvD,EAAoD,WAAW,EAAE;OACjE,EAAkD,SAAS,EAAE;OAC7D,EAAoD,UAAU,EAAE;OAChE,EAAoD,UAAU,EAAE;OAChE,EAAE,IAAI,EAAE;OACR,EAA8C,OAAO,EAAE;OACvD,EAAE,OAAO,EAAE"}
@@ -0,0 +1,124 @@
1
+ import * as Core from '@tryfinch/finch-api/core';
2
+ import { APIResource } from '@tryfinch/finch-api/resource';
3
+ import * as IndividualAPI from '@tryfinch/finch-api/resources/sandbox/individual';
4
+ import * as HRISAPI from '@tryfinch/finch-api/resources/hris/hris';
5
+ export declare class Individual extends APIResource {
6
+ /**
7
+ * Update sandbox individual
8
+ */
9
+ update(individualId: string, body?: IndividualUpdateParams, options?: Core.RequestOptions): Core.APIPromise<IndividualUpdateResponse>;
10
+ update(individualId: string, options?: Core.RequestOptions): Core.APIPromise<IndividualUpdateResponse>;
11
+ }
12
+ export interface IndividualUpdateResponse {
13
+ /**
14
+ * A stable Finch `id` (UUID v4) for an individual in the company.
15
+ */
16
+ id?: string;
17
+ dob?: string | null;
18
+ emails?: Array<IndividualUpdateResponse.Email> | null;
19
+ /**
20
+ * Social Security Number of the individual in **encrypted** format. This field is
21
+ * only available with the `ssn` scope enabled and the
22
+ * `options: { include: ['ssn'] }` param set in the body.
23
+ */
24
+ encrypted_ssn?: string | null;
25
+ /**
26
+ * The EEOC-defined ethnicity of the individual.
27
+ */
28
+ ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null;
29
+ /**
30
+ * The legal first name of the individual.
31
+ */
32
+ first_name?: string | null;
33
+ /**
34
+ * The gender of the individual.
35
+ */
36
+ gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
37
+ /**
38
+ * The legal last name of the individual.
39
+ */
40
+ last_name?: string | null;
41
+ /**
42
+ * The legal middle name of the individual.
43
+ */
44
+ middle_name?: string | null;
45
+ phone_numbers?: Array<IndividualUpdateResponse.PhoneNumber | null> | null;
46
+ /**
47
+ * The preferred name of the individual.
48
+ */
49
+ preferred_name?: string | null;
50
+ residence?: HRISAPI.Location | null;
51
+ /**
52
+ * Social Security Number of the individual. This field is only available with the
53
+ * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
54
+ * body.
55
+ */
56
+ ssn?: string | null;
57
+ }
58
+ export declare namespace IndividualUpdateResponse {
59
+ interface Email {
60
+ data?: string;
61
+ type?: 'work' | 'personal';
62
+ }
63
+ interface PhoneNumber {
64
+ data?: string;
65
+ type?: 'work' | 'personal';
66
+ }
67
+ }
68
+ export interface IndividualUpdateParams {
69
+ dob?: string | null;
70
+ emails?: Array<IndividualUpdateParams.Email> | null;
71
+ /**
72
+ * Social Security Number of the individual in **encrypted** format. This field is
73
+ * only available with the `ssn` scope enabled and the
74
+ * `options: { include: ['ssn'] }` param set in the body.
75
+ */
76
+ encrypted_ssn?: string | null;
77
+ /**
78
+ * The EEOC-defined ethnicity of the individual.
79
+ */
80
+ ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null;
81
+ /**
82
+ * The legal first name of the individual.
83
+ */
84
+ first_name?: string | null;
85
+ /**
86
+ * The gender of the individual.
87
+ */
88
+ gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
89
+ /**
90
+ * The legal last name of the individual.
91
+ */
92
+ last_name?: string | null;
93
+ /**
94
+ * The legal middle name of the individual.
95
+ */
96
+ middle_name?: string | null;
97
+ phone_numbers?: Array<IndividualUpdateParams.PhoneNumber | null> | null;
98
+ /**
99
+ * The preferred name of the individual.
100
+ */
101
+ preferred_name?: string | null;
102
+ residence?: HRISAPI.Location | null;
103
+ /**
104
+ * Social Security Number of the individual. This field is only available with the
105
+ * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
106
+ * body.
107
+ */
108
+ ssn?: string | null;
109
+ }
110
+ export declare namespace IndividualUpdateParams {
111
+ interface Email {
112
+ data?: string;
113
+ type?: 'work' | 'personal';
114
+ }
115
+ interface PhoneNumber {
116
+ data?: string;
117
+ type?: 'work' | 'personal';
118
+ }
119
+ }
120
+ export declare namespace Individual {
121
+ export import IndividualUpdateResponse = IndividualAPI.IndividualUpdateResponse;
122
+ export import IndividualUpdateParams = IndividualAPI.IndividualUpdateParams;
123
+ }
124
+ //# sourceMappingURL=individual.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"individual.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/individual.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,KAAK,aAAa,MAAM,kDAAkD,CAAC;AAClF,OAAO,KAAK,OAAO,MAAM,yCAAyC,CAAC;AAEnE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAC5C,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;CAWvG;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,MAAM,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAEtD;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EACN,OAAO,GACP,OAAO,GACP,2BAA2B,GAC3B,qCAAqC,GACrC,kCAAkC,GAClC,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,IAAI,CAAC;IAET;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1E;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,SAAS,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,KAAK;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;KAC5B;IAED,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,MAAM,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAEpD;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EACN,OAAO,GACP,OAAO,GACP,2BAA2B,GAC3B,qCAAqC,GACrC,kCAAkC,GAClC,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,IAAI,CAAC;IAET;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAExE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,SAAS,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,KAAK;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;KAC5B;IAED,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;KAC5B;CACF;AAED,yBAAiB,UAAU,CAAC;IAC1B,MAAM,QAAQ,wBAAwB,GAAG,aAAa,CAAC,wBAAwB,CAAC;IAChF,MAAM,QAAQ,sBAAsB,GAAG,aAAa,CAAC,sBAAsB,CAAC;CAC7E"}