@rippling/rippling-sdk 0.2.0-alpha.95 → 0.2.0-alpha.97
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.
- package/client.d.mts +78 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +78 -6
- package/client.d.ts.map +1 -1
- package/client.js +73 -1
- package/client.js.map +1 -1
- package/client.mjs +73 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/agents/sessions/index.d.mts +1 -0
- package/resources/agents/sessions/index.d.mts.map +1 -1
- package/resources/agents/sessions/index.d.ts +1 -0
- package/resources/agents/sessions/index.d.ts.map +1 -1
- package/resources/agents/sessions/index.js +3 -1
- package/resources/agents/sessions/index.js.map +1 -1
- package/resources/agents/sessions/index.mjs +1 -0
- package/resources/agents/sessions/index.mjs.map +1 -1
- package/resources/agents/sessions/messages.d.mts +24 -0
- package/resources/agents/sessions/messages.d.mts.map +1 -1
- package/resources/agents/sessions/messages.d.ts +24 -0
- package/resources/agents/sessions/messages.d.ts.map +1 -1
- package/resources/agents/sessions/resume-state.d.mts +25 -0
- package/resources/agents/sessions/resume-state.d.mts.map +1 -0
- package/resources/agents/sessions/resume-state.d.ts +25 -0
- package/resources/agents/sessions/resume-state.d.ts.map +1 -0
- package/resources/agents/sessions/resume-state.js +19 -0
- package/resources/agents/sessions/resume-state.js.map +1 -0
- package/resources/agents/sessions/resume-state.mjs +15 -0
- package/resources/agents/sessions/resume-state.mjs.map +1 -0
- package/resources/agents/sessions/sessions.d.mts +91 -0
- package/resources/agents/sessions/sessions.d.mts.map +1 -1
- package/resources/agents/sessions/sessions.d.ts +91 -0
- package/resources/agents/sessions/sessions.d.ts.map +1 -1
- package/resources/agents/sessions/sessions.js +4 -0
- package/resources/agents/sessions/sessions.js.map +1 -1
- package/resources/agents/sessions/sessions.mjs +4 -0
- package/resources/agents/sessions/sessions.mjs.map +1 -1
- package/resources/background-check-candidates.d.mts +337 -0
- package/resources/background-check-candidates.d.mts.map +1 -0
- package/resources/background-check-candidates.d.ts +337 -0
- package/resources/background-check-candidates.d.ts.map +1 -0
- package/resources/background-check-candidates.js +52 -0
- package/resources/background-check-candidates.js.map +1 -0
- package/resources/background-check-candidates.mjs +48 -0
- package/resources/background-check-candidates.mjs.map +1 -0
- package/resources/business-structure-paths.d.mts +54 -1
- package/resources/business-structure-paths.d.mts.map +1 -1
- package/resources/business-structure-paths.d.ts +54 -1
- package/resources/business-structure-paths.d.ts.map +1 -1
- package/resources/business-structure-paths.js +16 -0
- package/resources/business-structure-paths.js.map +1 -1
- package/resources/business-structure-paths.mjs +16 -0
- package/resources/business-structure-paths.mjs.map +1 -1
- package/resources/developer-program-application.d.mts +176 -0
- package/resources/developer-program-application.d.mts.map +1 -0
- package/resources/developer-program-application.d.ts +176 -0
- package/resources/developer-program-application.d.ts.map +1 -0
- package/resources/developer-program-application.js +27 -0
- package/resources/developer-program-application.js.map +1 -0
- package/resources/developer-program-application.mjs +23 -0
- package/resources/developer-program-application.mjs.map +1 -0
- package/resources/developer-users.d.mts +53 -0
- package/resources/developer-users.d.mts.map +1 -0
- package/resources/developer-users.d.ts +53 -0
- package/resources/developer-users.d.ts.map +1 -0
- package/resources/developer-users.js +25 -0
- package/resources/developer-users.js.map +1 -0
- package/resources/developer-users.mjs +21 -0
- package/resources/developer-users.mjs.map +1 -0
- package/resources/draft-transitions.d.mts +474 -0
- package/resources/draft-transitions.d.mts.map +1 -0
- package/resources/draft-transitions.d.ts +474 -0
- package/resources/draft-transitions.d.ts.map +1 -0
- package/resources/draft-transitions.js +25 -0
- package/resources/draft-transitions.js.map +1 -0
- package/resources/draft-transitions.mjs +21 -0
- package/resources/draft-transitions.mjs.map +1 -0
- package/resources/earnings-inputs.d.mts +30 -0
- package/resources/earnings-inputs.d.mts.map +1 -1
- package/resources/earnings-inputs.d.ts +30 -0
- package/resources/earnings-inputs.d.ts.map +1 -1
- package/resources/hire-requirements.d.mts +112 -0
- package/resources/hire-requirements.d.mts.map +1 -0
- package/resources/hire-requirements.d.ts +112 -0
- package/resources/hire-requirements.d.ts.map +1 -0
- package/resources/hire-requirements.js +19 -0
- package/resources/hire-requirements.js.map +1 -0
- package/resources/hire-requirements.mjs +15 -0
- package/resources/hire-requirements.mjs.map +1 -0
- package/resources/hires.d.mts +657 -0
- package/resources/hires.d.mts.map +1 -0
- package/resources/hires.d.ts +657 -0
- package/resources/hires.d.ts.map +1 -0
- package/resources/hires.js +25 -0
- package/resources/hires.js.map +1 -0
- package/resources/hires.mjs +21 -0
- package/resources/hires.mjs.map +1 -0
- package/resources/index.d.mts +15 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +15 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +27 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +13 -1
- package/resources/index.mjs.map +1 -1
- package/resources/listing-submissions.d.mts +86 -0
- package/resources/listing-submissions.d.mts.map +1 -0
- package/resources/listing-submissions.d.ts +86 -0
- package/resources/listing-submissions.d.ts.map +1 -0
- package/resources/listing-submissions.js +31 -0
- package/resources/listing-submissions.js.map +1 -0
- package/resources/listing-submissions.mjs +27 -0
- package/resources/listing-submissions.mjs.map +1 -0
- package/resources/listing-transitions.d.mts +59 -0
- package/resources/listing-transitions.d.mts.map +1 -0
- package/resources/listing-transitions.d.ts +59 -0
- package/resources/listing-transitions.d.ts.map +1 -0
- package/resources/listing-transitions.js +24 -0
- package/resources/listing-transitions.js.map +1 -0
- package/resources/listing-transitions.mjs +20 -0
- package/resources/listing-transitions.mjs.map +1 -0
- package/resources/listing.d.mts +1818 -0
- package/resources/listing.d.mts.map +1 -0
- package/resources/listing.d.ts +1818 -0
- package/resources/listing.d.ts.map +1 -0
- package/resources/listing.js +70 -0
- package/resources/listing.js.map +1 -0
- package/resources/listing.mjs +66 -0
- package/resources/listing.mjs.map +1 -0
- package/resources/package-managed-installs.d.mts +119 -0
- package/resources/package-managed-installs.d.mts.map +1 -0
- package/resources/package-managed-installs.d.ts +119 -0
- package/resources/package-managed-installs.d.ts.map +1 -0
- package/resources/package-managed-installs.js +26 -0
- package/resources/package-managed-installs.js.map +1 -0
- package/resources/package-managed-installs.mjs +22 -0
- package/resources/package-managed-installs.mjs.map +1 -0
- package/resources/package-sandbox-links.d.mts +150 -0
- package/resources/package-sandbox-links.d.mts.map +1 -0
- package/resources/package-sandbox-links.d.ts +150 -0
- package/resources/package-sandbox-links.d.ts.map +1 -0
- package/resources/package-sandbox-links.js +25 -0
- package/resources/package-sandbox-links.js.map +1 -0
- package/resources/package-sandbox-links.mjs +21 -0
- package/resources/package-sandbox-links.mjs.map +1 -0
- package/resources/package-versions/index.d.mts +3 -0
- package/resources/package-versions/index.d.mts.map +1 -0
- package/resources/package-versions/index.d.ts +3 -0
- package/resources/package-versions/index.d.ts.map +1 -0
- package/resources/package-versions/index.js +9 -0
- package/resources/package-versions/index.js.map +1 -0
- package/resources/package-versions/index.mjs +4 -0
- package/resources/package-versions/index.mjs.map +1 -0
- package/resources/package-versions/package-versions.d.mts +114 -0
- package/resources/package-versions/package-versions.d.mts.map +1 -0
- package/resources/package-versions/package-versions.d.ts +114 -0
- package/resources/package-versions/package-versions.d.ts.map +1 -0
- package/resources/package-versions/package-versions.js +33 -0
- package/resources/package-versions/package-versions.js.map +1 -0
- package/resources/package-versions/package-versions.mjs +28 -0
- package/resources/package-versions/package-versions.mjs.map +1 -0
- package/resources/package-versions/publish.d.mts +58 -0
- package/resources/package-versions/publish.d.mts.map +1 -0
- package/resources/package-versions/publish.d.ts +58 -0
- package/resources/package-versions/publish.d.ts.map +1 -0
- package/resources/package-versions/publish.js +19 -0
- package/resources/package-versions/publish.js.map +1 -0
- package/resources/package-versions/publish.mjs +15 -0
- package/resources/package-versions/publish.mjs.map +1 -0
- package/resources/package-versions.d.mts +1 -63
- package/resources/package-versions.d.mts.map +1 -1
- package/resources/package-versions.d.ts +1 -63
- package/resources/package-versions.d.ts.map +1 -1
- package/resources/package-versions.js +2 -15
- package/resources/package-versions.js.map +1 -1
- package/resources/package-versions.mjs +1 -13
- package/resources/package-versions.mjs.map +1 -1
- package/resources/packages/index.d.mts +1 -1
- package/resources/packages/index.d.mts.map +1 -1
- package/resources/packages/index.d.ts +1 -1
- package/resources/packages/index.d.ts.map +1 -1
- package/resources/packages/index.js.map +1 -1
- package/resources/packages/index.mjs +1 -1
- package/resources/packages/index.mjs.map +1 -1
- package/resources/packages/packages.d.mts +10 -10
- package/resources/packages/packages.d.mts.map +1 -1
- package/resources/packages/packages.d.ts +10 -10
- package/resources/packages/packages.d.ts.map +1 -1
- package/resources/packages/packages.js +11 -11
- package/resources/packages/packages.js.map +1 -1
- package/resources/packages/packages.mjs +12 -12
- package/resources/packages/packages.mjs.map +1 -1
- package/resources/packages/versions.d.mts +57 -2
- package/resources/packages/versions.d.mts.map +1 -1
- package/resources/packages/versions.d.ts +57 -2
- package/resources/packages/versions.d.ts.map +1 -1
- package/resources/packages/versions.js +8 -1
- package/resources/packages/versions.js.map +1 -1
- package/resources/packages/versions.mjs +8 -1
- package/resources/packages/versions.mjs.map +1 -1
- package/resources/sandboxes.d.mts +35 -22
- package/resources/sandboxes.d.mts.map +1 -1
- package/resources/sandboxes.d.ts +35 -22
- package/resources/sandboxes.d.ts.map +1 -1
- package/resources/sandboxes.js +6 -0
- package/resources/sandboxes.js.map +1 -1
- package/resources/sandboxes.mjs +6 -0
- package/resources/sandboxes.mjs.map +1 -1
- package/resources/sites.d.mts +2 -1
- package/resources/sites.d.mts.map +1 -1
- package/resources/sites.d.ts +2 -1
- package/resources/sites.d.ts.map +1 -1
- package/resources/workers.d.mts +41 -0
- package/resources/workers.d.mts.map +1 -1
- package/resources/workers.d.ts +41 -0
- package/resources/workers.d.ts.map +1 -1
- package/resources/workflows.d.mts +768 -0
- package/resources/workflows.d.mts.map +1 -0
- package/resources/workflows.d.ts +768 -0
- package/resources/workflows.d.ts.map +1 -0
- package/resources/workflows.js +48 -0
- package/resources/workflows.js.map +1 -0
- package/resources/workflows.mjs +44 -0
- package/resources/workflows.mjs.map +1 -0
- package/src/client.ts +277 -5
- package/src/resources/agents/sessions/index.ts +1 -0
- package/src/resources/agents/sessions/messages.ts +28 -0
- package/src/resources/agents/sessions/resume-state.ts +32 -0
- package/src/resources/agents/sessions/sessions.ts +107 -0
- package/src/resources/background-check-candidates.ts +434 -0
- package/src/resources/business-structure-paths.ts +78 -0
- package/src/resources/developer-program-application.ts +233 -0
- package/src/resources/developer-users.ts +77 -0
- package/src/resources/draft-transitions.ts +583 -0
- package/src/resources/earnings-inputs.ts +36 -0
- package/src/resources/hire-requirements.ts +140 -0
- package/src/resources/hires.ts +786 -0
- package/src/resources/index.ts +99 -1
- package/src/resources/listing-submissions.ts +120 -0
- package/src/resources/listing-transitions.ts +84 -0
- package/src/resources/listing.ts +2297 -0
- package/src/resources/package-managed-installs.ts +156 -0
- package/src/resources/package-sandbox-links.ts +195 -0
- package/src/resources/package-versions/index.ts +9 -0
- package/src/resources/package-versions/package-versions.ts +156 -0
- package/src/resources/package-versions/publish.ts +74 -0
- package/src/resources/package-versions.ts +1 -86
- package/src/resources/packages/index.ts +8 -1
- package/src/resources/packages/packages.ts +26 -12
- package/src/resources/packages/versions.ts +83 -1
- package/src/resources/sandboxes.ts +45 -24
- package/src/resources/sites.ts +2 -1
- package/src/resources/workers.ts +46 -0
- package/src/resources/workflows.ts +1434 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -3,6 +3,8 @@ import * as EventsAPI from "./events.js";
|
|
|
3
3
|
import { EventRetrieveParams, EventRetrieveResponse, Events } from "./events.js";
|
|
4
4
|
import * as MessagesAPI from "./messages.js";
|
|
5
5
|
import { MessageCreateParams, MessageCreateResponse, Messages } from "./messages.js";
|
|
6
|
+
import * as ResumeStateAPI from "./resume-state.js";
|
|
7
|
+
import { ResumeState, ResumeStateCreateResponse } from "./resume-state.js";
|
|
6
8
|
import { APIPromise } from "../../../core/api-promise.js";
|
|
7
9
|
import { PageCursorURL, PagePromise } from "../../../core/pagination.js";
|
|
8
10
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
@@ -11,6 +13,7 @@ import { RequestOptions } from "../../../internal/request-options.js";
|
|
|
11
13
|
*/
|
|
12
14
|
export declare class Sessions extends APIResource {
|
|
13
15
|
messages: MessagesAPI.Messages;
|
|
16
|
+
resumeState: ResumeStateAPI.ResumeState;
|
|
14
17
|
events: EventsAPI.Events;
|
|
15
18
|
/**
|
|
16
19
|
* Start an agent session with a prompt.
|
|
@@ -52,14 +55,38 @@ export interface SessionCreateResponse {
|
|
|
52
55
|
* The session error message
|
|
53
56
|
*/
|
|
54
57
|
error_message?: string;
|
|
58
|
+
/**
|
|
59
|
+
* The stable LangSmith thread identifier for this session
|
|
60
|
+
*/
|
|
61
|
+
langsmith_thread_id?: string;
|
|
55
62
|
/**
|
|
56
63
|
* The output of the session
|
|
57
64
|
*/
|
|
58
65
|
output?: unknown;
|
|
66
|
+
/**
|
|
67
|
+
* Receipt that ACP restored the requested session resume state
|
|
68
|
+
*/
|
|
69
|
+
session_resume_receipt?: SessionCreateResponse.SessionResumeReceipt;
|
|
59
70
|
/**
|
|
60
71
|
* The status of the session
|
|
61
72
|
*/
|
|
62
73
|
status?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Receipt for correlating agent.submission.settled events after create or
|
|
76
|
+
* append-message writes
|
|
77
|
+
*/
|
|
78
|
+
submission_id?: string;
|
|
79
|
+
}
|
|
80
|
+
export declare namespace SessionCreateResponse {
|
|
81
|
+
/**
|
|
82
|
+
* Receipt that ACP restored the requested session resume state
|
|
83
|
+
*/
|
|
84
|
+
interface SessionResumeReceipt {
|
|
85
|
+
/**
|
|
86
|
+
* The session resume state restore status
|
|
87
|
+
*/
|
|
88
|
+
status?: string;
|
|
89
|
+
}
|
|
63
90
|
}
|
|
64
91
|
export interface SessionListResponse {
|
|
65
92
|
/**
|
|
@@ -86,14 +113,38 @@ export interface SessionListResponse {
|
|
|
86
113
|
* The session error message
|
|
87
114
|
*/
|
|
88
115
|
error_message?: string;
|
|
116
|
+
/**
|
|
117
|
+
* The stable LangSmith thread identifier for this session
|
|
118
|
+
*/
|
|
119
|
+
langsmith_thread_id?: string;
|
|
89
120
|
/**
|
|
90
121
|
* The output of the session
|
|
91
122
|
*/
|
|
92
123
|
output?: unknown;
|
|
124
|
+
/**
|
|
125
|
+
* Receipt that ACP restored the requested session resume state
|
|
126
|
+
*/
|
|
127
|
+
session_resume_receipt?: SessionListResponse.SessionResumeReceipt;
|
|
93
128
|
/**
|
|
94
129
|
* The status of the session
|
|
95
130
|
*/
|
|
96
131
|
status?: string;
|
|
132
|
+
/**
|
|
133
|
+
* Receipt for correlating agent.submission.settled events after create or
|
|
134
|
+
* append-message writes
|
|
135
|
+
*/
|
|
136
|
+
submission_id?: string;
|
|
137
|
+
}
|
|
138
|
+
export declare namespace SessionListResponse {
|
|
139
|
+
/**
|
|
140
|
+
* Receipt that ACP restored the requested session resume state
|
|
141
|
+
*/
|
|
142
|
+
interface SessionResumeReceipt {
|
|
143
|
+
/**
|
|
144
|
+
* The session resume state restore status
|
|
145
|
+
*/
|
|
146
|
+
status?: string;
|
|
147
|
+
}
|
|
97
148
|
}
|
|
98
149
|
export interface SessionRetrieveResponse {
|
|
99
150
|
/**
|
|
@@ -120,14 +171,38 @@ export interface SessionRetrieveResponse {
|
|
|
120
171
|
* The session error message
|
|
121
172
|
*/
|
|
122
173
|
error_message?: string;
|
|
174
|
+
/**
|
|
175
|
+
* The stable LangSmith thread identifier for this session
|
|
176
|
+
*/
|
|
177
|
+
langsmith_thread_id?: string;
|
|
123
178
|
/**
|
|
124
179
|
* The output of the session
|
|
125
180
|
*/
|
|
126
181
|
output?: unknown;
|
|
182
|
+
/**
|
|
183
|
+
* Receipt that ACP restored the requested session resume state
|
|
184
|
+
*/
|
|
185
|
+
session_resume_receipt?: SessionRetrieveResponse.SessionResumeReceipt;
|
|
127
186
|
/**
|
|
128
187
|
* The status of the session
|
|
129
188
|
*/
|
|
130
189
|
status?: string;
|
|
190
|
+
/**
|
|
191
|
+
* Receipt for correlating agent.submission.settled events after create or
|
|
192
|
+
* append-message writes
|
|
193
|
+
*/
|
|
194
|
+
submission_id?: string;
|
|
195
|
+
}
|
|
196
|
+
export declare namespace SessionRetrieveResponse {
|
|
197
|
+
/**
|
|
198
|
+
* Receipt that ACP restored the requested session resume state
|
|
199
|
+
*/
|
|
200
|
+
interface SessionResumeReceipt {
|
|
201
|
+
/**
|
|
202
|
+
* The session resume state restore status
|
|
203
|
+
*/
|
|
204
|
+
status?: string;
|
|
205
|
+
}
|
|
131
206
|
}
|
|
132
207
|
export interface SessionCreateParams {
|
|
133
208
|
/**
|
|
@@ -138,6 +213,21 @@ export interface SessionCreateParams {
|
|
|
138
213
|
* The prompt to send to the agent
|
|
139
214
|
*/
|
|
140
215
|
prompt: string;
|
|
216
|
+
/**
|
|
217
|
+
* Optional opaque state used to restore the new session
|
|
218
|
+
*/
|
|
219
|
+
session_resume_state?: SessionCreateParams.SessionResumeState;
|
|
220
|
+
}
|
|
221
|
+
export declare namespace SessionCreateParams {
|
|
222
|
+
/**
|
|
223
|
+
* Optional opaque state used to restore the new session
|
|
224
|
+
*/
|
|
225
|
+
interface SessionResumeState {
|
|
226
|
+
/**
|
|
227
|
+
* An opaque base64-encoded agent session resume state
|
|
228
|
+
*/
|
|
229
|
+
artifact: string;
|
|
230
|
+
}
|
|
141
231
|
}
|
|
142
232
|
export interface SessionListParams {
|
|
143
233
|
/**
|
|
@@ -152,6 +242,7 @@ export interface SessionListParams {
|
|
|
152
242
|
export declare namespace Sessions {
|
|
153
243
|
export { type SessionCreateResponse as SessionCreateResponse, type SessionListResponse as SessionListResponse, type SessionRetrieveResponse as SessionRetrieveResponse, type SessionListResponsesPageCursorURL as SessionListResponsesPageCursorURL, type SessionCreateParams as SessionCreateParams, type SessionListParams as SessionListParams, };
|
|
154
244
|
export { Messages as Messages, type MessageCreateResponse as MessageCreateResponse, type MessageCreateParams as MessageCreateParams, };
|
|
245
|
+
export { ResumeState as ResumeState, type ResumeStateCreateResponse as ResumeStateCreateResponse };
|
|
155
246
|
export { Events as Events, type EventRetrieveResponse as EventRetrieveResponse, type EventRetrieveParams as EventRetrieveParams, };
|
|
156
247
|
}
|
|
157
248
|
//# sourceMappingURL=sessions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../../src/resources/agents/sessions/sessions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,EAAE,oBAAiB;AAC9E,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,QAAQ,EAAE,sBAAmB;AAClF,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,oCAAiC;AACtE,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;OAEG;IACH,IAAI,CACF,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,mBAAmB,CAAC;IAOtE;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAG3F;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAEnF,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../../src/resources/agents/sessions/sessions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,EAAE,oBAAiB;AAC9E,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,QAAQ,EAAE,sBAAmB;AAClF,OAAO,KAAK,cAAc,0BAAuB;AACjD,OAAO,EAAE,WAAW,EAAE,yBAAyB,EAAE,0BAAuB;AACxE,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,oCAAiC;AACtE,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;OAEG;IACH,IAAI,CACF,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,mBAAmB,CAAC;IAOtE;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;CAG3F;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAEnF,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,sBAAsB,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,CAAC;IAEpE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,sBAAsB,CAAC,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;IAElE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,sBAAsB,CAAC,EAAE,uBAAuB,CAAC,oBAAoB,CAAC;IAEtE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,kBAAkB,CAAC;CAC/D;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAMD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EAAE,WAAW,IAAI,WAAW,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;IAEnG,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -8,6 +8,8 @@ const EventsAPI = tslib_1.__importStar(require("./events.js"));
|
|
|
8
8
|
const events_1 = require("./events.js");
|
|
9
9
|
const MessagesAPI = tslib_1.__importStar(require("./messages.js"));
|
|
10
10
|
const messages_1 = require("./messages.js");
|
|
11
|
+
const ResumeStateAPI = tslib_1.__importStar(require("./resume-state.js"));
|
|
12
|
+
const resume_state_1 = require("./resume-state.js");
|
|
11
13
|
const pagination_1 = require("../../../core/pagination.js");
|
|
12
14
|
const path_1 = require("../../../internal/utils/path.js");
|
|
13
15
|
/**
|
|
@@ -17,6 +19,7 @@ class Sessions extends resource_1.APIResource {
|
|
|
17
19
|
constructor() {
|
|
18
20
|
super(...arguments);
|
|
19
21
|
this.messages = new MessagesAPI.Messages(this._client);
|
|
22
|
+
this.resumeState = new ResumeStateAPI.ResumeState(this._client);
|
|
20
23
|
this.events = new EventsAPI.Events(this._client);
|
|
21
24
|
}
|
|
22
25
|
/**
|
|
@@ -44,5 +47,6 @@ class Sessions extends resource_1.APIResource {
|
|
|
44
47
|
}
|
|
45
48
|
exports.Sessions = Sessions;
|
|
46
49
|
Sessions.Messages = messages_1.Messages;
|
|
50
|
+
Sessions.ResumeState = resume_state_1.ResumeState;
|
|
47
51
|
Sessions.Events = events_1.Events;
|
|
48
52
|
//# sourceMappingURL=sessions.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sessions.js","sourceRoot":"","sources":["../../../src/resources/agents/sessions/sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,+DAAsC;AACtC,wCAA8E;AAC9E,mEAA0C;AAC1C,4CAAkF;
|
|
1
|
+
{"version":3,"file":"sessions.js","sourceRoot":"","sources":["../../../src/resources/agents/sessions/sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,+DAAsC;AACtC,wCAA8E;AAC9E,mEAA0C;AAC1C,4CAAkF;AAClF,0EAAiD;AACjD,oDAAwE;AAExE,4DAAsE;AAEtE,0DAAoD;AAEpD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8BhE,CAAC;IA5BC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,OAAe,EACf,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,YAAY,EAAE,CAAA,0BAAkC,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,SAAS,GAAG,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF;AAjCD,4BAiCC;AA+PD,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC7B,QAAQ,CAAC,WAAW,GAAG,0BAAW,CAAC;AACnC,QAAQ,CAAC,MAAM,GAAG,eAAM,CAAC"}
|
|
@@ -4,6 +4,8 @@ import * as EventsAPI from "./events.mjs";
|
|
|
4
4
|
import { Events } from "./events.mjs";
|
|
5
5
|
import * as MessagesAPI from "./messages.mjs";
|
|
6
6
|
import { Messages } from "./messages.mjs";
|
|
7
|
+
import * as ResumeStateAPI from "./resume-state.mjs";
|
|
8
|
+
import { ResumeState } from "./resume-state.mjs";
|
|
7
9
|
import { PageCursorURL } from "../../../core/pagination.mjs";
|
|
8
10
|
import { path } from "../../../internal/utils/path.mjs";
|
|
9
11
|
/**
|
|
@@ -13,6 +15,7 @@ export class Sessions extends APIResource {
|
|
|
13
15
|
constructor() {
|
|
14
16
|
super(...arguments);
|
|
15
17
|
this.messages = new MessagesAPI.Messages(this._client);
|
|
18
|
+
this.resumeState = new ResumeStateAPI.ResumeState(this._client);
|
|
16
19
|
this.events = new EventsAPI.Events(this._client);
|
|
17
20
|
}
|
|
18
21
|
/**
|
|
@@ -39,5 +42,6 @@ export class Sessions extends APIResource {
|
|
|
39
42
|
}
|
|
40
43
|
}
|
|
41
44
|
Sessions.Messages = Messages;
|
|
45
|
+
Sessions.ResumeState = ResumeState;
|
|
42
46
|
Sessions.Events = Events;
|
|
43
47
|
//# sourceMappingURL=sessions.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sessions.mjs","sourceRoot":"","sources":["../../../src/resources/agents/sessions/sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAA8C,MAAM,EAAE,qBAAiB;AAC9E,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAA8C,QAAQ,EAAE,uBAAmB;
|
|
1
|
+
{"version":3,"file":"sessions.mjs","sourceRoot":"","sources":["../../../src/resources/agents/sessions/sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAA8C,MAAM,EAAE,qBAAiB;AAC9E,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAA8C,QAAQ,EAAE,uBAAmB;AAClF,OAAO,KAAK,cAAc,2BAAuB;AACjD,OAAO,EAAE,WAAW,EAA6B,2BAAuB;AAExE,OAAO,EAAE,aAAa,EAAe,qCAAiC;AAEtE,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8BhE,CAAC;IA5BC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,IAAI,CACF,OAAe,EACf,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,WAAW,OAAO,YAAY,EAAE,CAAA,aAAkC,CAAA,EAAE;YACrG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,SAAS,GAAG,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF;AA+PD,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC7B,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;AACnC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC"}
|
|
@@ -0,0 +1,337 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as BusinessPartnersAPI from "./business-partners.mjs";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
+
import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
|
+
/**
|
|
7
|
+
* Candidates who have been submitted for background check screening
|
|
8
|
+
*/
|
|
9
|
+
export declare class BackgroundCheckCandidates extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* A list of background check candidates.
|
|
12
|
+
*
|
|
13
|
+
* - Requires: `API Tier 2`
|
|
14
|
+
* - Filterable fields: `external_id`, `email`, `created_at`, `updated_at`
|
|
15
|
+
* - Sortable fields: `created_at`, `updated_at`
|
|
16
|
+
*/
|
|
17
|
+
list(query?: BackgroundCheckCandidateListParams | null | undefined, options?: RequestOptions): PagePromise<BackgroundCheckCandidateListResponsesPageCursorURL, BackgroundCheckCandidateListResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Create a new background check candidate
|
|
20
|
+
*/
|
|
21
|
+
create(body: BackgroundCheckCandidateCreateParams, options?: RequestOptions): APIPromise<BackgroundCheckCandidateCreateResponse>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve a specific background check candidate
|
|
24
|
+
*/
|
|
25
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<BackgroundCheckCandidateRetrieveResponse>;
|
|
26
|
+
/**
|
|
27
|
+
* Update a specific background check candidate.
|
|
28
|
+
*/
|
|
29
|
+
update(id: string, body: BackgroundCheckCandidateUpdateParams, options?: RequestOptions): APIPromise<BackgroundCheckCandidateUpdateResponse>;
|
|
30
|
+
/**
|
|
31
|
+
* Delete a background check candidate
|
|
32
|
+
*/
|
|
33
|
+
delete(id: string, options?: RequestOptions): APIPromise<void>;
|
|
34
|
+
}
|
|
35
|
+
export type BackgroundCheckCandidateListResponsesPageCursorURL = PageCursorURL<BackgroundCheckCandidateListResponse>;
|
|
36
|
+
/**
|
|
37
|
+
* Background Check Candidate DTO.
|
|
38
|
+
*
|
|
39
|
+
* Represents a candidate who has been submitted for background check screening.
|
|
40
|
+
*
|
|
41
|
+
* Required on Create (but nullable on read for legacy rows):
|
|
42
|
+
* - email: Required for new candidates, but may be null on read for legacy rows
|
|
43
|
+
* - external_id: Required for new candidates, but may be null on read for legacy rows
|
|
44
|
+
*
|
|
45
|
+
* Optional Fields:
|
|
46
|
+
* - owner_id: May be null if no provider is associated
|
|
47
|
+
* - first_name: May be null if name is not available
|
|
48
|
+
* - last_name: May be null if name is not available
|
|
49
|
+
* - middle_name: May be null if not provided
|
|
50
|
+
*
|
|
51
|
+
* Sensitive Fields:
|
|
52
|
+
* - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
|
|
53
|
+
* - These do not require separate OAuth scopes beyond the resource-level scopes
|
|
54
|
+
* (background-check-candidates.read / .read-write) because they are not updating
|
|
55
|
+
* role or worker data, only storing candidate names for background check processing
|
|
56
|
+
*
|
|
57
|
+
* Note: first_name, last_name, and middle_name are NOT filterable.
|
|
58
|
+
* Only external_id, email, created_at, and updated_at support filtering.
|
|
59
|
+
*/
|
|
60
|
+
export interface BackgroundCheckCandidateListResponse {
|
|
61
|
+
/**
|
|
62
|
+
* The email address of the candidate. Required on create, but may be null on read
|
|
63
|
+
* for legacy rows.
|
|
64
|
+
*/
|
|
65
|
+
email: string;
|
|
66
|
+
/**
|
|
67
|
+
* The provider's unique identifier for the candidate. Required on create, but may
|
|
68
|
+
* be null on read for legacy rows. Can only be set once (during creation or when
|
|
69
|
+
* null). Cannot be changed after being set.
|
|
70
|
+
*/
|
|
71
|
+
external_id: string;
|
|
72
|
+
/**
|
|
73
|
+
* The unique identifier of the background check candidate.
|
|
74
|
+
*/
|
|
75
|
+
id?: string;
|
|
76
|
+
/**
|
|
77
|
+
* The timestamp when the candidate was created.
|
|
78
|
+
*/
|
|
79
|
+
created_at?: string;
|
|
80
|
+
/**
|
|
81
|
+
* The first name of the candidate.
|
|
82
|
+
*/
|
|
83
|
+
first_name?: string;
|
|
84
|
+
/**
|
|
85
|
+
* The last name of the candidate.
|
|
86
|
+
*/
|
|
87
|
+
last_name?: string;
|
|
88
|
+
/**
|
|
89
|
+
* The middle name of the candidate.
|
|
90
|
+
*/
|
|
91
|
+
middle_name?: string;
|
|
92
|
+
/**
|
|
93
|
+
* The ID of the background check provider (OAuth spoke owner).
|
|
94
|
+
*/
|
|
95
|
+
owner_id?: string;
|
|
96
|
+
/**
|
|
97
|
+
* The timestamp when the candidate was last updated.
|
|
98
|
+
*/
|
|
99
|
+
updated_at?: string;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Background Check Candidate DTO.
|
|
103
|
+
*
|
|
104
|
+
* Represents a candidate who has been submitted for background check screening.
|
|
105
|
+
*
|
|
106
|
+
* Required on Create (but nullable on read for legacy rows):
|
|
107
|
+
* - email: Required for new candidates, but may be null on read for legacy rows
|
|
108
|
+
* - external_id: Required for new candidates, but may be null on read for legacy rows
|
|
109
|
+
*
|
|
110
|
+
* Optional Fields:
|
|
111
|
+
* - owner_id: May be null if no provider is associated
|
|
112
|
+
* - first_name: May be null if name is not available
|
|
113
|
+
* - last_name: May be null if name is not available
|
|
114
|
+
* - middle_name: May be null if not provided
|
|
115
|
+
*
|
|
116
|
+
* Sensitive Fields:
|
|
117
|
+
* - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
|
|
118
|
+
* - These do not require separate OAuth scopes beyond the resource-level scopes
|
|
119
|
+
* (background-check-candidates.read / .read-write) because they are not updating
|
|
120
|
+
* role or worker data, only storing candidate names for background check processing
|
|
121
|
+
*
|
|
122
|
+
* Note: first_name, last_name, and middle_name are NOT filterable.
|
|
123
|
+
* Only external_id, email, created_at, and updated_at support filtering.
|
|
124
|
+
*/
|
|
125
|
+
export interface BackgroundCheckCandidateCreateResponse {
|
|
126
|
+
/**
|
|
127
|
+
* The email address of the candidate. Required on create, but may be null on read
|
|
128
|
+
* for legacy rows.
|
|
129
|
+
*/
|
|
130
|
+
email: string;
|
|
131
|
+
/**
|
|
132
|
+
* The provider's unique identifier for the candidate. Required on create, but may
|
|
133
|
+
* be null on read for legacy rows. Can only be set once (during creation or when
|
|
134
|
+
* null). Cannot be changed after being set.
|
|
135
|
+
*/
|
|
136
|
+
external_id: string;
|
|
137
|
+
/**
|
|
138
|
+
* The unique identifier of the background check candidate.
|
|
139
|
+
*/
|
|
140
|
+
id?: string;
|
|
141
|
+
/**
|
|
142
|
+
* The timestamp when the candidate was created.
|
|
143
|
+
*/
|
|
144
|
+
created_at?: string;
|
|
145
|
+
/**
|
|
146
|
+
* The first name of the candidate.
|
|
147
|
+
*/
|
|
148
|
+
first_name?: string;
|
|
149
|
+
/**
|
|
150
|
+
* The last name of the candidate.
|
|
151
|
+
*/
|
|
152
|
+
last_name?: string;
|
|
153
|
+
/**
|
|
154
|
+
* The middle name of the candidate.
|
|
155
|
+
*/
|
|
156
|
+
middle_name?: string;
|
|
157
|
+
/**
|
|
158
|
+
* The ID of the background check provider (OAuth spoke owner).
|
|
159
|
+
*/
|
|
160
|
+
owner_id?: string;
|
|
161
|
+
/**
|
|
162
|
+
* The timestamp when the candidate was last updated.
|
|
163
|
+
*/
|
|
164
|
+
updated_at?: string;
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Meta information for the response.
|
|
168
|
+
*/
|
|
169
|
+
export interface BackgroundCheckCandidateRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
170
|
+
/**
|
|
171
|
+
* The email address of the candidate. Required on create, but may be null on read
|
|
172
|
+
* for legacy rows.
|
|
173
|
+
*/
|
|
174
|
+
email: string;
|
|
175
|
+
/**
|
|
176
|
+
* The provider's unique identifier for the candidate. Required on create, but may
|
|
177
|
+
* be null on read for legacy rows. Can only be set once (during creation or when
|
|
178
|
+
* null). Cannot be changed after being set.
|
|
179
|
+
*/
|
|
180
|
+
external_id: string;
|
|
181
|
+
/**
|
|
182
|
+
* The unique identifier of the background check candidate.
|
|
183
|
+
*/
|
|
184
|
+
id?: string;
|
|
185
|
+
/**
|
|
186
|
+
* The timestamp when the candidate was created.
|
|
187
|
+
*/
|
|
188
|
+
created_at?: string;
|
|
189
|
+
/**
|
|
190
|
+
* The first name of the candidate.
|
|
191
|
+
*/
|
|
192
|
+
first_name?: string;
|
|
193
|
+
/**
|
|
194
|
+
* The last name of the candidate.
|
|
195
|
+
*/
|
|
196
|
+
last_name?: string;
|
|
197
|
+
/**
|
|
198
|
+
* The middle name of the candidate.
|
|
199
|
+
*/
|
|
200
|
+
middle_name?: string;
|
|
201
|
+
/**
|
|
202
|
+
* The ID of the background check provider (OAuth spoke owner).
|
|
203
|
+
*/
|
|
204
|
+
owner_id?: string;
|
|
205
|
+
/**
|
|
206
|
+
* The timestamp when the candidate was last updated.
|
|
207
|
+
*/
|
|
208
|
+
updated_at?: string;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Background Check Candidate DTO.
|
|
212
|
+
*
|
|
213
|
+
* Represents a candidate who has been submitted for background check screening.
|
|
214
|
+
*
|
|
215
|
+
* Required on Create (but nullable on read for legacy rows):
|
|
216
|
+
* - email: Required for new candidates, but may be null on read for legacy rows
|
|
217
|
+
* - external_id: Required for new candidates, but may be null on read for legacy rows
|
|
218
|
+
*
|
|
219
|
+
* Optional Fields:
|
|
220
|
+
* - owner_id: May be null if no provider is associated
|
|
221
|
+
* - first_name: May be null if name is not available
|
|
222
|
+
* - last_name: May be null if name is not available
|
|
223
|
+
* - middle_name: May be null if not provided
|
|
224
|
+
*
|
|
225
|
+
* Sensitive Fields:
|
|
226
|
+
* - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
|
|
227
|
+
* - These do not require separate OAuth scopes beyond the resource-level scopes
|
|
228
|
+
* (background-check-candidates.read / .read-write) because they are not updating
|
|
229
|
+
* role or worker data, only storing candidate names for background check processing
|
|
230
|
+
*
|
|
231
|
+
* Note: first_name, last_name, and middle_name are NOT filterable.
|
|
232
|
+
* Only external_id, email, created_at, and updated_at support filtering.
|
|
233
|
+
*/
|
|
234
|
+
export interface BackgroundCheckCandidateUpdateResponse {
|
|
235
|
+
/**
|
|
236
|
+
* The email address of the candidate. Required on create, but may be null on read
|
|
237
|
+
* for legacy rows.
|
|
238
|
+
*/
|
|
239
|
+
email: string;
|
|
240
|
+
/**
|
|
241
|
+
* The provider's unique identifier for the candidate. Required on create, but may
|
|
242
|
+
* be null on read for legacy rows. Can only be set once (during creation or when
|
|
243
|
+
* null). Cannot be changed after being set.
|
|
244
|
+
*/
|
|
245
|
+
external_id: string;
|
|
246
|
+
/**
|
|
247
|
+
* The unique identifier of the background check candidate.
|
|
248
|
+
*/
|
|
249
|
+
id?: string;
|
|
250
|
+
/**
|
|
251
|
+
* The timestamp when the candidate was created.
|
|
252
|
+
*/
|
|
253
|
+
created_at?: string;
|
|
254
|
+
/**
|
|
255
|
+
* The first name of the candidate.
|
|
256
|
+
*/
|
|
257
|
+
first_name?: string;
|
|
258
|
+
/**
|
|
259
|
+
* The last name of the candidate.
|
|
260
|
+
*/
|
|
261
|
+
last_name?: string;
|
|
262
|
+
/**
|
|
263
|
+
* The middle name of the candidate.
|
|
264
|
+
*/
|
|
265
|
+
middle_name?: string;
|
|
266
|
+
/**
|
|
267
|
+
* The ID of the background check provider (OAuth spoke owner).
|
|
268
|
+
*/
|
|
269
|
+
owner_id?: string;
|
|
270
|
+
/**
|
|
271
|
+
* The timestamp when the candidate was last updated.
|
|
272
|
+
*/
|
|
273
|
+
updated_at?: string;
|
|
274
|
+
}
|
|
275
|
+
export interface BackgroundCheckCandidateListParams {
|
|
276
|
+
cursor?: string;
|
|
277
|
+
filter?: string;
|
|
278
|
+
/**
|
|
279
|
+
* The maximum number of results to return. Defaults to 50. Maximum is 100.
|
|
280
|
+
*/
|
|
281
|
+
limit?: number;
|
|
282
|
+
order_by?: string;
|
|
283
|
+
}
|
|
284
|
+
export interface BackgroundCheckCandidateCreateParams {
|
|
285
|
+
/**
|
|
286
|
+
* The email address of the candidate. Required on create, but may be null on read
|
|
287
|
+
* for legacy rows.
|
|
288
|
+
*/
|
|
289
|
+
email: string;
|
|
290
|
+
/**
|
|
291
|
+
* The provider's unique identifier for the candidate. Required on create, but may
|
|
292
|
+
* be null on read for legacy rows. Can only be set once (during creation or when
|
|
293
|
+
* null). Cannot be changed after being set.
|
|
294
|
+
*/
|
|
295
|
+
external_id: string;
|
|
296
|
+
/**
|
|
297
|
+
* The first name of the candidate.
|
|
298
|
+
*/
|
|
299
|
+
first_name?: string;
|
|
300
|
+
/**
|
|
301
|
+
* The last name of the candidate.
|
|
302
|
+
*/
|
|
303
|
+
last_name?: string;
|
|
304
|
+
/**
|
|
305
|
+
* The middle name of the candidate.
|
|
306
|
+
*/
|
|
307
|
+
middle_name?: string;
|
|
308
|
+
}
|
|
309
|
+
export interface BackgroundCheckCandidateUpdateParams {
|
|
310
|
+
/**
|
|
311
|
+
* The email address of the candidate. Required on create, but may be null on read
|
|
312
|
+
* for legacy rows.
|
|
313
|
+
*/
|
|
314
|
+
email: string;
|
|
315
|
+
/**
|
|
316
|
+
* The provider's unique identifier for the candidate. Required on create, but may
|
|
317
|
+
* be null on read for legacy rows. Can only be set once (during creation or when
|
|
318
|
+
* null). Cannot be changed after being set.
|
|
319
|
+
*/
|
|
320
|
+
external_id: string;
|
|
321
|
+
/**
|
|
322
|
+
* The first name of the candidate.
|
|
323
|
+
*/
|
|
324
|
+
first_name?: string;
|
|
325
|
+
/**
|
|
326
|
+
* The last name of the candidate.
|
|
327
|
+
*/
|
|
328
|
+
last_name?: string;
|
|
329
|
+
/**
|
|
330
|
+
* The middle name of the candidate.
|
|
331
|
+
*/
|
|
332
|
+
middle_name?: string;
|
|
333
|
+
}
|
|
334
|
+
export declare namespace BackgroundCheckCandidates {
|
|
335
|
+
export { type BackgroundCheckCandidateListResponse as BackgroundCheckCandidateListResponse, type BackgroundCheckCandidateCreateResponse as BackgroundCheckCandidateCreateResponse, type BackgroundCheckCandidateRetrieveResponse as BackgroundCheckCandidateRetrieveResponse, type BackgroundCheckCandidateUpdateResponse as BackgroundCheckCandidateUpdateResponse, type BackgroundCheckCandidateListResponsesPageCursorURL as BackgroundCheckCandidateListResponsesPageCursorURL, type BackgroundCheckCandidateListParams as BackgroundCheckCandidateListParams, type BackgroundCheckCandidateCreateParams as BackgroundCheckCandidateCreateParams, type BackgroundCheckCandidateUpdateParams as BackgroundCheckCandidateUpdateParams, };
|
|
336
|
+
}
|
|
337
|
+
//# sourceMappingURL=background-check-candidates.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"background-check-candidates.d.mts","sourceRoot":"","sources":["../src/resources/background-check-candidates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAEhE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,WAAW;IACxD;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kDAAkD,EAAE,oCAAoC,CAAC;IAQxG;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;IAIrD;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wCAAwC,CAAC;IAIpG;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;IAIrD;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,kDAAkD,GAC5D,aAAa,CAAC,oCAAoC,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAyC,SAAQ,mBAAmB,CAAC,IAAI;IACxF;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,yBAAyB,CAAC;IACjD,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,kDAAkD,IAAI,kDAAkD,EAC7G,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oCAAoC,IAAI,oCAAoC,GAClF,CAAC;CACH"}
|