@rippling/rippling-sdk 0.2.0-alpha.72 → 0.2.0-alpha.73
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/examples/functions/durable.ts +41 -52
- package/package.json +1 -1
- package/resources/workflow-action-executions.d.mts +9 -1627
- package/resources/workflow-action-executions.d.mts.map +1 -1
- package/resources/workflow-action-executions.d.ts +9 -1627
- package/resources/workflow-action-executions.d.ts.map +1 -1
- package/resources/workflow-action-executions.js +1 -1
- package/resources/workflow-action-executions.mjs +1 -1
- package/src/functions.md +19 -30
- package/src/resources/workflow-action-executions.ts +10 -2320
- 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
|
@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
|
|
|
9
9
|
*/
|
|
10
10
|
export class WorkflowActionExecutions extends APIResource {
|
|
11
11
|
/**
|
|
12
|
-
* Execute a workflow action
|
|
12
|
+
* Execute a workflow action from Rippling Functions
|
|
13
13
|
*/
|
|
14
14
|
create(
|
|
15
15
|
body: WorkflowActionExecutionCreateParams,
|
|
@@ -26,2329 +26,19 @@ export interface WorkflowActionExecutionCreateResponse {
|
|
|
26
26
|
result: unknown;
|
|
27
27
|
}
|
|
28
28
|
|
|
29
|
-
export
|
|
30
|
-
|
|
31
|
-
| WorkflowActionExecutionCreateParams.SendSlackActionRequest
|
|
32
|
-
| WorkflowActionExecutionCreateParams.CreateAppNotificationActionRequest
|
|
33
|
-
| WorkflowActionExecutionCreateParams.SendSMSActionRequest
|
|
34
|
-
| WorkflowActionExecutionCreateParams.SendPushNotificationActionRequest
|
|
35
|
-
| WorkflowActionExecutionCreateParams.SendHTTPRequestActionRequest
|
|
36
|
-
| WorkflowActionExecutionCreateParams.DeleteCustomObjectRecordActionRequest
|
|
37
|
-
| WorkflowActionExecutionCreateParams.SendSurveyActionRequest
|
|
38
|
-
| WorkflowActionExecutionCreateParams.EvaluateRqlActionRequest
|
|
39
|
-
| WorkflowActionExecutionCreateParams.UpsertCustomObjectActionRequest
|
|
40
|
-
| WorkflowActionExecutionCreateParams.UpdateCustomObjectRecordActionRequest
|
|
41
|
-
| WorkflowActionExecutionCreateParams.CreateGcalEventActionRequest
|
|
42
|
-
| WorkflowActionExecutionCreateParams.SendTeamsActionRequest
|
|
43
|
-
| WorkflowActionExecutionCreateParams.AssignReviewActionRequest
|
|
44
|
-
| WorkflowActionExecutionCreateParams.SendReportSftpActionRequest
|
|
45
|
-
| WorkflowActionExecutionCreateParams.EnrollIntoCourseActionRequest
|
|
46
|
-
| WorkflowActionExecutionCreateParams.EnrollIntoLearningPathActionRequest
|
|
47
|
-
| WorkflowActionExecutionCreateParams.SendReportEmailActionRequest
|
|
48
|
-
| WorkflowActionExecutionCreateParams.SendDocumentActionRequest
|
|
49
|
-
| WorkflowActionExecutionCreateParams.AccrueLeaveActionRequest
|
|
50
|
-
| WorkflowActionExecutionCreateParams.MakePaymentActionRequest
|
|
51
|
-
| WorkflowActionExecutionCreateParams.RunQueryActionRequest;
|
|
29
|
+
export interface WorkflowActionExecutionCreateParams {
|
|
30
|
+
action_type: 'run_query';
|
|
52
31
|
|
|
53
|
-
|
|
54
|
-
export interface SendEmailActionRequest {
|
|
55
|
-
action_type: 'send_email';
|
|
32
|
+
payload: WorkflowActionExecutionCreateParams.Payload;
|
|
56
33
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
*/
|
|
60
|
-
payload: SendEmailActionRequest.Payload;
|
|
61
|
-
|
|
62
|
-
workflow_definition_id: string;
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
export namespace SendEmailActionRequest {
|
|
66
|
-
/**
|
|
67
|
-
* An action that sends an email.
|
|
68
|
-
*/
|
|
69
|
-
export interface Payload {
|
|
70
|
-
/**
|
|
71
|
-
* Email mode
|
|
72
|
-
*/
|
|
73
|
-
action_type: 'INDIVIDUAL_EMAILS' | 'GROUP_EMAIL';
|
|
74
|
-
|
|
75
|
-
body: string;
|
|
76
|
-
|
|
77
|
-
send_to: Payload.SendTo;
|
|
78
|
-
|
|
79
|
-
subject: string;
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* Maximum total attachment size: 20MB
|
|
83
|
-
*/
|
|
84
|
-
attachments?: Array<Payload.Attachment> | null;
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
export namespace Payload {
|
|
88
|
-
export interface SendTo {
|
|
89
|
-
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
90
|
-
|
|
91
|
-
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
92
|
-
|
|
93
|
-
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
export namespace SendTo {
|
|
97
|
-
export interface Recipient1 {
|
|
98
|
-
supergroup: string;
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
* Email type
|
|
102
|
-
*/
|
|
103
|
-
emailType?:
|
|
104
|
-
| 'work_or_personal_email'
|
|
105
|
-
| 'work_email_only'
|
|
106
|
-
| 'personal_email_only'
|
|
107
|
-
| 'work_and_personal_email'
|
|
108
|
-
| null;
|
|
109
|
-
|
|
110
|
-
externalEmails?: Array<string> | null;
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
export interface Recipient2 {
|
|
114
|
-
externalEmails: Array<string>;
|
|
115
|
-
|
|
116
|
-
/**
|
|
117
|
-
* Email type
|
|
118
|
-
*/
|
|
119
|
-
emailType?:
|
|
120
|
-
| 'work_or_personal_email'
|
|
121
|
-
| 'work_email_only'
|
|
122
|
-
| 'personal_email_only'
|
|
123
|
-
| 'work_and_personal_email'
|
|
124
|
-
| null;
|
|
125
|
-
|
|
126
|
-
supergroup?: string | null;
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
export interface Recipient1 {
|
|
130
|
-
supergroup: string;
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
* Email type
|
|
134
|
-
*/
|
|
135
|
-
emailType?:
|
|
136
|
-
| 'work_or_personal_email'
|
|
137
|
-
| 'work_email_only'
|
|
138
|
-
| 'personal_email_only'
|
|
139
|
-
| 'work_and_personal_email'
|
|
140
|
-
| null;
|
|
141
|
-
|
|
142
|
-
externalEmails?: Array<string> | null;
|
|
143
|
-
}
|
|
144
|
-
|
|
145
|
-
export interface Recipient2 {
|
|
146
|
-
externalEmails: Array<string>;
|
|
147
|
-
|
|
148
|
-
/**
|
|
149
|
-
* Email type
|
|
150
|
-
*/
|
|
151
|
-
emailType?:
|
|
152
|
-
| 'work_or_personal_email'
|
|
153
|
-
| 'work_email_only'
|
|
154
|
-
| 'personal_email_only'
|
|
155
|
-
| 'work_and_personal_email'
|
|
156
|
-
| null;
|
|
157
|
-
|
|
158
|
-
supergroup?: string | null;
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
export interface Recipient1 {
|
|
162
|
-
supergroup: string;
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* Email type
|
|
166
|
-
*/
|
|
167
|
-
emailType?:
|
|
168
|
-
| 'work_or_personal_email'
|
|
169
|
-
| 'work_email_only'
|
|
170
|
-
| 'personal_email_only'
|
|
171
|
-
| 'work_and_personal_email'
|
|
172
|
-
| null;
|
|
173
|
-
|
|
174
|
-
externalEmails?: Array<string> | null;
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
export interface Recipient2 {
|
|
178
|
-
externalEmails: Array<string>;
|
|
179
|
-
|
|
180
|
-
/**
|
|
181
|
-
* Email type
|
|
182
|
-
*/
|
|
183
|
-
emailType?:
|
|
184
|
-
| 'work_or_personal_email'
|
|
185
|
-
| 'work_email_only'
|
|
186
|
-
| 'personal_email_only'
|
|
187
|
-
| 'work_and_personal_email'
|
|
188
|
-
| null;
|
|
189
|
-
|
|
190
|
-
supergroup?: string | null;
|
|
191
|
-
}
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
export interface Attachment {
|
|
195
|
-
fileName: string;
|
|
196
|
-
}
|
|
197
|
-
}
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
export interface SendSlackActionRequest {
|
|
201
|
-
action_type: 'send_slack';
|
|
202
|
-
|
|
203
|
-
/**
|
|
204
|
-
* An action that sends a slack message
|
|
205
|
-
*/
|
|
206
|
-
payload:
|
|
207
|
-
| SendSlackActionRequest.SendSlackSingleDirectMessagePayload
|
|
208
|
-
| SendSlackActionRequest.SendSlackGroupDirectMessagePayload
|
|
209
|
-
| SendSlackActionRequest.SendSlackPublicChannelMessagePayload
|
|
210
|
-
| SendSlackActionRequest.SendSlackPrivateChannelMessagePayload;
|
|
211
|
-
|
|
212
|
-
workflow_definition_id: string;
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
export namespace SendSlackActionRequest {
|
|
216
|
-
/**
|
|
217
|
-
* An action that sends a slack message
|
|
218
|
-
*/
|
|
219
|
-
export interface SendSlackSingleDirectMessagePayload {
|
|
220
|
-
action_type: 'SINGLE_DIRECT_MESSAGE';
|
|
221
|
-
|
|
222
|
-
/**
|
|
223
|
-
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
224
|
-
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
225
|
-
* markup options</a>
|
|
226
|
-
*/
|
|
227
|
-
body: string;
|
|
228
|
-
|
|
229
|
-
recipients: string;
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
/**
|
|
233
|
-
* An action that sends a slack message
|
|
234
|
-
*/
|
|
235
|
-
export interface SendSlackGroupDirectMessagePayload {
|
|
236
|
-
action_type: 'GROUP_DIRECT_MESSAGE';
|
|
237
|
-
|
|
238
|
-
/**
|
|
239
|
-
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
240
|
-
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
241
|
-
* markup options</a>
|
|
242
|
-
*/
|
|
243
|
-
body: string;
|
|
244
|
-
|
|
245
|
-
recipients: string;
|
|
246
|
-
}
|
|
247
|
-
|
|
248
|
-
/**
|
|
249
|
-
* An action that sends a slack message
|
|
250
|
-
*/
|
|
251
|
-
export interface SendSlackPublicChannelMessagePayload {
|
|
252
|
-
action_type: 'PUBLIC_CHANNEL_MESSAGE';
|
|
253
|
-
|
|
254
|
-
/**
|
|
255
|
-
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
256
|
-
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
257
|
-
* markup options</a>
|
|
258
|
-
*/
|
|
259
|
-
body: string;
|
|
260
|
-
|
|
261
|
-
channel: string;
|
|
262
|
-
}
|
|
263
|
-
|
|
264
|
-
/**
|
|
265
|
-
* An action that sends a slack message
|
|
266
|
-
*/
|
|
267
|
-
export interface SendSlackPrivateChannelMessagePayload {
|
|
268
|
-
action_type: 'PRIVATE_CHANNEL_MESSAGE';
|
|
269
|
-
|
|
270
|
-
/**
|
|
271
|
-
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
272
|
-
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
273
|
-
* markup options</a>
|
|
274
|
-
*/
|
|
275
|
-
body: string;
|
|
276
|
-
|
|
277
|
-
channel: string;
|
|
278
|
-
}
|
|
279
|
-
}
|
|
280
|
-
|
|
281
|
-
export interface CreateAppNotificationActionRequest {
|
|
282
|
-
action_type: 'create_app_notification';
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* Assign tasks to configurable recipients
|
|
286
|
-
*/
|
|
287
|
-
payload: CreateAppNotificationActionRequest.Payload;
|
|
288
|
-
|
|
289
|
-
workflow_definition_id: string;
|
|
290
|
-
}
|
|
291
|
-
|
|
292
|
-
export namespace CreateAppNotificationActionRequest {
|
|
293
|
-
/**
|
|
294
|
-
* Assign tasks to configurable recipients
|
|
295
|
-
*/
|
|
296
|
-
export interface Payload {
|
|
297
|
-
description: string;
|
|
298
|
-
|
|
299
|
-
recipients: string;
|
|
300
|
-
|
|
301
|
-
subject: string;
|
|
302
|
-
|
|
303
|
-
dueDate?: Payload.DueDate | Payload.DueDate1 | null;
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
export namespace Payload {
|
|
307
|
-
export interface DueDate {
|
|
308
|
-
date: string;
|
|
309
|
-
}
|
|
310
|
-
|
|
311
|
-
export interface DueDate1 {
|
|
312
|
-
daysFromNow: number | string;
|
|
313
|
-
}
|
|
314
|
-
}
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
export interface SendSMSActionRequest {
|
|
318
|
-
action_type: 'send_sms';
|
|
319
|
-
|
|
320
|
-
/**
|
|
321
|
-
* An action that sends a text message.
|
|
322
|
-
*/
|
|
323
|
-
payload: SendSMSActionRequest.Payload;
|
|
324
|
-
|
|
325
|
-
workflow_definition_id: string;
|
|
326
|
-
}
|
|
327
|
-
|
|
328
|
-
export namespace SendSMSActionRequest {
|
|
329
|
-
/**
|
|
330
|
-
* An action that sends a text message.
|
|
331
|
-
*/
|
|
332
|
-
export interface Payload {
|
|
333
|
-
/**
|
|
334
|
-
* Maximum characters: 500
|
|
335
|
-
*/
|
|
336
|
-
message: string;
|
|
337
|
-
|
|
338
|
-
recipients: string;
|
|
339
|
-
}
|
|
340
|
-
}
|
|
341
|
-
|
|
342
|
-
export interface SendPushNotificationActionRequest {
|
|
343
|
-
action_type: 'send_push_notification';
|
|
344
|
-
|
|
345
|
-
/**
|
|
346
|
-
* Sends a push notification to mobile devices. Recipients require the Rippling
|
|
347
|
-
* mobile app to receive this notification.
|
|
348
|
-
*/
|
|
349
|
-
payload: SendPushNotificationActionRequest.Payload;
|
|
350
|
-
|
|
351
|
-
workflow_definition_id: string;
|
|
352
|
-
}
|
|
353
|
-
|
|
354
|
-
export namespace SendPushNotificationActionRequest {
|
|
355
|
-
/**
|
|
356
|
-
* Sends a push notification to mobile devices. Recipients require the Rippling
|
|
357
|
-
* mobile app to receive this notification.
|
|
358
|
-
*/
|
|
359
|
-
export interface Payload {
|
|
360
|
-
/**
|
|
361
|
-
* Maximum character count: 65
|
|
362
|
-
*/
|
|
363
|
-
header: string;
|
|
364
|
-
|
|
365
|
-
/**
|
|
366
|
-
* In many devices, your description will be truncated after 178 characters.
|
|
367
|
-
*/
|
|
368
|
-
message: string;
|
|
369
|
-
|
|
370
|
-
recipients: string;
|
|
371
|
-
}
|
|
372
|
-
}
|
|
373
|
-
|
|
374
|
-
export interface SendHTTPRequestActionRequest {
|
|
375
|
-
action_type: 'send_http_request';
|
|
376
|
-
|
|
377
|
-
/**
|
|
378
|
-
* An action that sends an HTTP request with a JSON payload. The following keys -
|
|
379
|
-
* Authorization, Api-Key, and Token - in URL query parameters and custom headers
|
|
380
|
-
* are masked due to their sensitive nature
|
|
381
|
-
*/
|
|
382
|
-
payload: SendHTTPRequestActionRequest.Payload;
|
|
383
|
-
|
|
384
|
-
workflow_definition_id: string;
|
|
385
|
-
}
|
|
386
|
-
|
|
387
|
-
export namespace SendHTTPRequestActionRequest {
|
|
388
|
-
/**
|
|
389
|
-
* An action that sends an HTTP request with a JSON payload. The following keys -
|
|
390
|
-
* Authorization, Api-Key, and Token - in URL query parameters and custom headers
|
|
391
|
-
* are masked due to their sensitive nature
|
|
392
|
-
*/
|
|
393
|
-
export interface Payload {
|
|
394
|
-
url: string;
|
|
395
|
-
|
|
396
|
-
customHTTPHeaders?: { [key: string]: string } | null;
|
|
397
|
-
|
|
398
|
-
expectedResponseSchema?: unknown | null;
|
|
399
|
-
|
|
400
|
-
/**
|
|
401
|
-
* HTTP method
|
|
402
|
-
*/
|
|
403
|
-
method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | null;
|
|
404
|
-
|
|
405
|
-
payload?: unknown | null;
|
|
406
|
-
|
|
407
|
-
queryParams?: { [key: string]: string } | null;
|
|
408
|
-
}
|
|
409
|
-
}
|
|
410
|
-
|
|
411
|
-
export interface DeleteCustomObjectRecordActionRequest {
|
|
412
|
-
action_type: 'delete_custom_object_record';
|
|
413
|
-
|
|
414
|
-
/**
|
|
415
|
-
* An action that deletes a custom object record.
|
|
416
|
-
*/
|
|
417
|
-
payload: DeleteCustomObjectRecordActionRequest.Payload;
|
|
418
|
-
|
|
419
|
-
workflow_definition_id: string;
|
|
420
|
-
}
|
|
421
|
-
|
|
422
|
-
export namespace DeleteCustomObjectRecordActionRequest {
|
|
423
|
-
/**
|
|
424
|
-
* An action that deletes a custom object record.
|
|
425
|
-
*/
|
|
426
|
-
export interface Payload {
|
|
427
|
-
customObjectAPIName: string;
|
|
428
|
-
|
|
429
|
-
recordID: string;
|
|
430
|
-
}
|
|
431
|
-
}
|
|
432
|
-
|
|
433
|
-
export interface SendSurveyActionRequest {
|
|
434
|
-
action_type: 'send_survey';
|
|
435
|
-
|
|
436
|
-
/**
|
|
437
|
-
* An action that sends a survey.
|
|
438
|
-
*/
|
|
439
|
-
payload: SendSurveyActionRequest.Payload;
|
|
440
|
-
|
|
441
|
-
workflow_definition_id: string;
|
|
442
|
-
}
|
|
443
|
-
|
|
444
|
-
export namespace SendSurveyActionRequest {
|
|
445
|
-
/**
|
|
446
|
-
* An action that sends a survey.
|
|
447
|
-
*/
|
|
448
|
-
export interface Payload {
|
|
449
|
-
body: string;
|
|
450
|
-
|
|
451
|
-
recipients: string;
|
|
452
|
-
|
|
453
|
-
subject: string;
|
|
454
|
-
|
|
455
|
-
surveyID: string;
|
|
456
|
-
|
|
457
|
-
expiryDays?: number | string | null;
|
|
458
|
-
}
|
|
459
|
-
}
|
|
460
|
-
|
|
461
|
-
export interface EvaluateRqlActionRequest {
|
|
462
|
-
action_type: 'evaluate_rql';
|
|
463
|
-
|
|
464
|
-
/**
|
|
465
|
-
* Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
|
|
466
|
-
* returns matching record IDs for a chosen Rippling model via a wizard-built
|
|
467
|
-
* filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
|
|
468
|
-
* of any RQL type (scalar or list). Always express filtering inside this action
|
|
469
|
-
* (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
|
|
470
|
-
* and filter in code downstream.
|
|
471
|
-
*/
|
|
472
|
-
payload:
|
|
473
|
-
| EvaluateRqlActionRequest.EvaluateRqlSelectionPayload
|
|
474
|
-
| EvaluateRqlActionRequest.EvaluateRqlQueryPayload;
|
|
475
|
-
|
|
476
|
-
workflow_definition_id: string;
|
|
477
|
-
}
|
|
478
|
-
|
|
479
|
-
export namespace EvaluateRqlActionRequest {
|
|
480
|
-
/**
|
|
481
|
-
* Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
|
|
482
|
-
* returns matching record IDs for a chosen Rippling model via a wizard-built
|
|
483
|
-
* filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
|
|
484
|
-
* of any RQL type (scalar or list). Always express filtering inside this action
|
|
485
|
-
* (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
|
|
486
|
-
* and filter in code downstream.
|
|
487
|
-
*/
|
|
488
|
-
export interface EvaluateRqlSelectionPayload {
|
|
489
|
-
queryType: 'SELECTION';
|
|
490
|
-
|
|
491
|
-
rqlModelName?: string | null;
|
|
492
|
-
}
|
|
493
|
-
|
|
494
|
-
/**
|
|
495
|
-
* Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
|
|
496
|
-
* returns matching record IDs for a chosen Rippling model via a wizard-built
|
|
497
|
-
* filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
|
|
498
|
-
* of any RQL type (scalar or list). Always express filtering inside this action
|
|
499
|
-
* (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
|
|
500
|
-
* and filter in code downstream.
|
|
501
|
-
*/
|
|
502
|
-
export interface EvaluateRqlQueryPayload {
|
|
503
|
-
queryType: 'QUERY';
|
|
504
|
-
|
|
505
|
-
/**
|
|
506
|
-
* Data type
|
|
507
|
-
*/
|
|
508
|
-
dataType?: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'OBJECT_ID' | 'DATE' | 'DATETIME' | null;
|
|
509
|
-
|
|
510
|
-
isAList?: boolean | null;
|
|
511
|
-
|
|
512
|
-
rqlFormula?: EvaluateRqlQueryPayload.RqlFormula | null;
|
|
513
|
-
}
|
|
514
|
-
|
|
515
|
-
export namespace EvaluateRqlQueryPayload {
|
|
516
|
-
export interface RqlFormula {
|
|
517
|
-
rqlFormula?: string | null;
|
|
518
|
-
}
|
|
519
|
-
}
|
|
520
|
-
}
|
|
521
|
-
|
|
522
|
-
export interface UpsertCustomObjectActionRequest {
|
|
523
|
-
action_type: 'upsert_custom_object';
|
|
524
|
-
|
|
525
|
-
/**
|
|
526
|
-
* An action that creates a custom object record.
|
|
527
|
-
*/
|
|
528
|
-
payload: UpsertCustomObjectActionRequest.Payload;
|
|
529
|
-
|
|
530
|
-
workflow_definition_id: string;
|
|
531
|
-
}
|
|
532
|
-
|
|
533
|
-
export namespace UpsertCustomObjectActionRequest {
|
|
534
|
-
/**
|
|
535
|
-
* An action that creates a custom object record.
|
|
536
|
-
*/
|
|
537
|
-
export interface Payload {
|
|
538
|
-
customObjectAPIName: string;
|
|
539
|
-
}
|
|
540
|
-
}
|
|
541
|
-
|
|
542
|
-
export interface UpdateCustomObjectRecordActionRequest {
|
|
543
|
-
action_type: 'update_custom_object_record';
|
|
544
|
-
|
|
545
|
-
/**
|
|
546
|
-
* An action that updates a custom object record.
|
|
547
|
-
*/
|
|
548
|
-
payload: UpdateCustomObjectRecordActionRequest.Payload;
|
|
549
|
-
|
|
550
|
-
workflow_definition_id: string;
|
|
551
|
-
}
|
|
552
|
-
|
|
553
|
-
export namespace UpdateCustomObjectRecordActionRequest {
|
|
554
|
-
/**
|
|
555
|
-
* An action that updates a custom object record.
|
|
556
|
-
*/
|
|
557
|
-
export interface Payload {
|
|
558
|
-
customObjectAPIName: string;
|
|
559
|
-
}
|
|
560
|
-
}
|
|
561
|
-
|
|
562
|
-
export interface CreateGcalEventActionRequest {
|
|
563
|
-
action_type: 'create_gcal_event';
|
|
564
|
-
|
|
565
|
-
/**
|
|
566
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
567
|
-
* attendees
|
|
568
|
-
*/
|
|
569
|
-
payload:
|
|
570
|
-
| CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerNullPayload
|
|
571
|
-
| CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerDailyPayload
|
|
572
|
-
| CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerWeeklyPayload
|
|
573
|
-
| CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerMonthlyPayload
|
|
574
|
-
| CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerYearlyPayload
|
|
575
|
-
| CreateGcalEventActionRequest.CreateGcalEventSupergroupNullPayload
|
|
576
|
-
| CreateGcalEventActionRequest.CreateGcalEventSupergroupDailyPayload
|
|
577
|
-
| CreateGcalEventActionRequest.CreateGcalEventSupergroupWeeklyPayload
|
|
578
|
-
| CreateGcalEventActionRequest.CreateGcalEventSupergroupMonthlyPayload
|
|
579
|
-
| CreateGcalEventActionRequest.CreateGcalEventSupergroupYearlyPayload;
|
|
580
|
-
|
|
581
|
-
workflow_definition_id: string;
|
|
582
|
-
}
|
|
583
|
-
|
|
584
|
-
export namespace CreateGcalEventActionRequest {
|
|
585
|
-
/**
|
|
586
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
587
|
-
* attendees
|
|
588
|
-
*/
|
|
589
|
-
export interface CreateGcalEventWorkflowOwnerNullPayload {
|
|
590
|
-
attendees: string;
|
|
591
|
-
|
|
592
|
-
description: string;
|
|
593
|
-
|
|
594
|
-
end: CreateGcalEventWorkflowOwnerNullPayload.End;
|
|
595
|
-
|
|
596
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
597
|
-
|
|
598
|
-
recurrence_frequency: 'null';
|
|
599
|
-
|
|
600
|
-
spoke_owner: string;
|
|
601
|
-
|
|
602
|
-
start: CreateGcalEventWorkflowOwnerNullPayload.Start;
|
|
603
|
-
|
|
604
|
-
timezone: string;
|
|
605
|
-
|
|
606
|
-
title: string;
|
|
607
|
-
|
|
608
|
-
all_day_event?: boolean | null;
|
|
609
|
-
|
|
610
|
-
guestsCanInviteOthers?: boolean | null;
|
|
611
|
-
|
|
612
|
-
guestsCanModify?: boolean | null;
|
|
613
|
-
|
|
614
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
615
|
-
|
|
616
|
-
/**
|
|
617
|
-
* Show me as
|
|
618
|
-
*/
|
|
619
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
620
|
-
|
|
621
|
-
/**
|
|
622
|
-
* Calendar Visibility
|
|
623
|
-
*/
|
|
624
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
625
|
-
}
|
|
626
|
-
|
|
627
|
-
export namespace CreateGcalEventWorkflowOwnerNullPayload {
|
|
628
|
-
export interface End {
|
|
629
|
-
date: string;
|
|
630
|
-
|
|
631
|
-
time: string;
|
|
632
|
-
}
|
|
633
|
-
|
|
634
|
-
export interface Start {
|
|
635
|
-
date: string;
|
|
636
|
-
|
|
637
|
-
time: string;
|
|
638
|
-
}
|
|
639
|
-
}
|
|
640
|
-
|
|
641
|
-
/**
|
|
642
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
643
|
-
* attendees
|
|
644
|
-
*/
|
|
645
|
-
export interface CreateGcalEventWorkflowOwnerDailyPayload {
|
|
646
|
-
attendees: string;
|
|
647
|
-
|
|
648
|
-
description: string;
|
|
649
|
-
|
|
650
|
-
end: CreateGcalEventWorkflowOwnerDailyPayload.End;
|
|
651
|
-
|
|
652
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
653
|
-
|
|
654
|
-
recurrence_frequency: 'DAILY';
|
|
655
|
-
|
|
656
|
-
spoke_owner: string;
|
|
657
|
-
|
|
658
|
-
start: CreateGcalEventWorkflowOwnerDailyPayload.Start;
|
|
659
|
-
|
|
660
|
-
timezone: string;
|
|
661
|
-
|
|
662
|
-
title: string;
|
|
663
|
-
|
|
664
|
-
all_day_event?: boolean | null;
|
|
665
|
-
|
|
666
|
-
guestsCanInviteOthers?: boolean | null;
|
|
667
|
-
|
|
668
|
-
guestsCanModify?: boolean | null;
|
|
669
|
-
|
|
670
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
671
|
-
|
|
672
|
-
recurrence_has_end?: boolean | null;
|
|
673
|
-
|
|
674
|
-
/**
|
|
675
|
-
* Show me as
|
|
676
|
-
*/
|
|
677
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
678
|
-
|
|
679
|
-
/**
|
|
680
|
-
* Calendar Visibility
|
|
681
|
-
*/
|
|
682
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
683
|
-
}
|
|
684
|
-
|
|
685
|
-
export namespace CreateGcalEventWorkflowOwnerDailyPayload {
|
|
686
|
-
export interface End {
|
|
687
|
-
date: string;
|
|
688
|
-
|
|
689
|
-
time: string;
|
|
690
|
-
}
|
|
691
|
-
|
|
692
|
-
export interface Start {
|
|
693
|
-
date: string;
|
|
694
|
-
|
|
695
|
-
time: string;
|
|
696
|
-
}
|
|
697
|
-
}
|
|
698
|
-
|
|
699
|
-
/**
|
|
700
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
701
|
-
* attendees
|
|
702
|
-
*/
|
|
703
|
-
export interface CreateGcalEventWorkflowOwnerWeeklyPayload {
|
|
704
|
-
attendees: string;
|
|
705
|
-
|
|
706
|
-
description: string;
|
|
707
|
-
|
|
708
|
-
end: CreateGcalEventWorkflowOwnerWeeklyPayload.End;
|
|
709
|
-
|
|
710
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
711
|
-
|
|
712
|
-
recurrence_frequency: 'WEEKLY';
|
|
713
|
-
|
|
714
|
-
spoke_owner: string;
|
|
715
|
-
|
|
716
|
-
start: CreateGcalEventWorkflowOwnerWeeklyPayload.Start;
|
|
717
|
-
|
|
718
|
-
timezone: string;
|
|
719
|
-
|
|
720
|
-
title: string;
|
|
721
|
-
|
|
722
|
-
all_day_event?: boolean | null;
|
|
723
|
-
|
|
724
|
-
guestsCanInviteOthers?: boolean | null;
|
|
725
|
-
|
|
726
|
-
guestsCanModify?: boolean | null;
|
|
727
|
-
|
|
728
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
729
|
-
|
|
730
|
-
recurrence_has_end?: boolean | null;
|
|
731
|
-
|
|
732
|
-
/**
|
|
733
|
-
* Show me as
|
|
734
|
-
*/
|
|
735
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
736
|
-
|
|
737
|
-
/**
|
|
738
|
-
* Calendar Visibility
|
|
739
|
-
*/
|
|
740
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
741
|
-
}
|
|
742
|
-
|
|
743
|
-
export namespace CreateGcalEventWorkflowOwnerWeeklyPayload {
|
|
744
|
-
export interface End {
|
|
745
|
-
date: string;
|
|
746
|
-
|
|
747
|
-
time: string;
|
|
748
|
-
}
|
|
749
|
-
|
|
750
|
-
export interface Start {
|
|
751
|
-
date: string;
|
|
752
|
-
|
|
753
|
-
time: string;
|
|
754
|
-
}
|
|
755
|
-
}
|
|
756
|
-
|
|
757
|
-
/**
|
|
758
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
759
|
-
* attendees
|
|
760
|
-
*/
|
|
761
|
-
export interface CreateGcalEventWorkflowOwnerMonthlyPayload {
|
|
762
|
-
attendees: string;
|
|
763
|
-
|
|
764
|
-
description: string;
|
|
765
|
-
|
|
766
|
-
end: CreateGcalEventWorkflowOwnerMonthlyPayload.End;
|
|
767
|
-
|
|
768
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
769
|
-
|
|
770
|
-
recurrence_frequency: 'MONTHLY';
|
|
771
|
-
|
|
772
|
-
spoke_owner: string;
|
|
773
|
-
|
|
774
|
-
start: CreateGcalEventWorkflowOwnerMonthlyPayload.Start;
|
|
775
|
-
|
|
776
|
-
timezone: string;
|
|
777
|
-
|
|
778
|
-
title: string;
|
|
779
|
-
|
|
780
|
-
all_day_event?: boolean | null;
|
|
781
|
-
|
|
782
|
-
guestsCanInviteOthers?: boolean | null;
|
|
783
|
-
|
|
784
|
-
guestsCanModify?: boolean | null;
|
|
785
|
-
|
|
786
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
787
|
-
|
|
788
|
-
recurrence_has_end?: boolean | null;
|
|
789
|
-
|
|
790
|
-
/**
|
|
791
|
-
* Show me as
|
|
792
|
-
*/
|
|
793
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
794
|
-
|
|
795
|
-
/**
|
|
796
|
-
* Calendar Visibility
|
|
797
|
-
*/
|
|
798
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
799
|
-
}
|
|
800
|
-
|
|
801
|
-
export namespace CreateGcalEventWorkflowOwnerMonthlyPayload {
|
|
802
|
-
export interface End {
|
|
803
|
-
date: string;
|
|
804
|
-
|
|
805
|
-
time: string;
|
|
806
|
-
}
|
|
807
|
-
|
|
808
|
-
export interface Start {
|
|
809
|
-
date: string;
|
|
810
|
-
|
|
811
|
-
time: string;
|
|
812
|
-
}
|
|
813
|
-
}
|
|
814
|
-
|
|
815
|
-
/**
|
|
816
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
817
|
-
* attendees
|
|
818
|
-
*/
|
|
819
|
-
export interface CreateGcalEventWorkflowOwnerYearlyPayload {
|
|
820
|
-
attendees: string;
|
|
821
|
-
|
|
822
|
-
description: string;
|
|
823
|
-
|
|
824
|
-
end: CreateGcalEventWorkflowOwnerYearlyPayload.End;
|
|
825
|
-
|
|
826
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
827
|
-
|
|
828
|
-
recurrence_frequency: 'YEARLY';
|
|
829
|
-
|
|
830
|
-
spoke_owner: string;
|
|
831
|
-
|
|
832
|
-
start: CreateGcalEventWorkflowOwnerYearlyPayload.Start;
|
|
833
|
-
|
|
834
|
-
timezone: string;
|
|
835
|
-
|
|
836
|
-
title: string;
|
|
837
|
-
|
|
838
|
-
all_day_event?: boolean | null;
|
|
839
|
-
|
|
840
|
-
guestsCanInviteOthers?: boolean | null;
|
|
841
|
-
|
|
842
|
-
guestsCanModify?: boolean | null;
|
|
843
|
-
|
|
844
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
845
|
-
|
|
846
|
-
recurrence_has_end?: boolean | null;
|
|
847
|
-
|
|
848
|
-
/**
|
|
849
|
-
* Show me as
|
|
850
|
-
*/
|
|
851
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
852
|
-
|
|
853
|
-
/**
|
|
854
|
-
* Calendar Visibility
|
|
855
|
-
*/
|
|
856
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
857
|
-
}
|
|
858
|
-
|
|
859
|
-
export namespace CreateGcalEventWorkflowOwnerYearlyPayload {
|
|
860
|
-
export interface End {
|
|
861
|
-
date: string;
|
|
862
|
-
|
|
863
|
-
time: string;
|
|
864
|
-
}
|
|
865
|
-
|
|
866
|
-
export interface Start {
|
|
867
|
-
date: string;
|
|
868
|
-
|
|
869
|
-
time: string;
|
|
870
|
-
}
|
|
871
|
-
}
|
|
872
|
-
|
|
873
|
-
/**
|
|
874
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
875
|
-
* attendees
|
|
876
|
-
*/
|
|
877
|
-
export interface CreateGcalEventSupergroupNullPayload {
|
|
878
|
-
attendees: string;
|
|
879
|
-
|
|
880
|
-
description: string;
|
|
881
|
-
|
|
882
|
-
end: CreateGcalEventSupergroupNullPayload.End;
|
|
883
|
-
|
|
884
|
-
organizer: string;
|
|
885
|
-
|
|
886
|
-
organizer_type: 'SUPERGROUP';
|
|
887
|
-
|
|
888
|
-
recurrence_frequency: 'null';
|
|
889
|
-
|
|
890
|
-
spoke_owner: string;
|
|
891
|
-
|
|
892
|
-
start: CreateGcalEventSupergroupNullPayload.Start;
|
|
893
|
-
|
|
894
|
-
timezone: string;
|
|
895
|
-
|
|
896
|
-
title: string;
|
|
897
|
-
|
|
898
|
-
all_day_event?: boolean | null;
|
|
899
|
-
|
|
900
|
-
guestsCanInviteOthers?: boolean | null;
|
|
901
|
-
|
|
902
|
-
guestsCanModify?: boolean | null;
|
|
903
|
-
|
|
904
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
905
|
-
|
|
906
|
-
/**
|
|
907
|
-
* Show me as
|
|
908
|
-
*/
|
|
909
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
910
|
-
|
|
911
|
-
/**
|
|
912
|
-
* Calendar Visibility
|
|
913
|
-
*/
|
|
914
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
915
|
-
}
|
|
916
|
-
|
|
917
|
-
export namespace CreateGcalEventSupergroupNullPayload {
|
|
918
|
-
export interface End {
|
|
919
|
-
date: string;
|
|
920
|
-
|
|
921
|
-
time: string;
|
|
922
|
-
}
|
|
923
|
-
|
|
924
|
-
export interface Start {
|
|
925
|
-
date: string;
|
|
926
|
-
|
|
927
|
-
time: string;
|
|
928
|
-
}
|
|
929
|
-
}
|
|
930
|
-
|
|
931
|
-
/**
|
|
932
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
933
|
-
* attendees
|
|
934
|
-
*/
|
|
935
|
-
export interface CreateGcalEventSupergroupDailyPayload {
|
|
936
|
-
attendees: string;
|
|
937
|
-
|
|
938
|
-
description: string;
|
|
939
|
-
|
|
940
|
-
end: CreateGcalEventSupergroupDailyPayload.End;
|
|
941
|
-
|
|
942
|
-
organizer: string;
|
|
943
|
-
|
|
944
|
-
organizer_type: 'SUPERGROUP';
|
|
945
|
-
|
|
946
|
-
recurrence_frequency: 'DAILY';
|
|
947
|
-
|
|
948
|
-
spoke_owner: string;
|
|
949
|
-
|
|
950
|
-
start: CreateGcalEventSupergroupDailyPayload.Start;
|
|
951
|
-
|
|
952
|
-
timezone: string;
|
|
953
|
-
|
|
954
|
-
title: string;
|
|
955
|
-
|
|
956
|
-
all_day_event?: boolean | null;
|
|
957
|
-
|
|
958
|
-
guestsCanInviteOthers?: boolean | null;
|
|
959
|
-
|
|
960
|
-
guestsCanModify?: boolean | null;
|
|
961
|
-
|
|
962
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
963
|
-
|
|
964
|
-
recurrence_has_end?: boolean | null;
|
|
965
|
-
|
|
966
|
-
/**
|
|
967
|
-
* Show me as
|
|
968
|
-
*/
|
|
969
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
970
|
-
|
|
971
|
-
/**
|
|
972
|
-
* Calendar Visibility
|
|
973
|
-
*/
|
|
974
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
975
|
-
}
|
|
976
|
-
|
|
977
|
-
export namespace CreateGcalEventSupergroupDailyPayload {
|
|
978
|
-
export interface End {
|
|
979
|
-
date: string;
|
|
980
|
-
|
|
981
|
-
time: string;
|
|
982
|
-
}
|
|
983
|
-
|
|
984
|
-
export interface Start {
|
|
985
|
-
date: string;
|
|
986
|
-
|
|
987
|
-
time: string;
|
|
988
|
-
}
|
|
989
|
-
}
|
|
990
|
-
|
|
991
|
-
/**
|
|
992
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
993
|
-
* attendees
|
|
994
|
-
*/
|
|
995
|
-
export interface CreateGcalEventSupergroupWeeklyPayload {
|
|
996
|
-
attendees: string;
|
|
997
|
-
|
|
998
|
-
description: string;
|
|
999
|
-
|
|
1000
|
-
end: CreateGcalEventSupergroupWeeklyPayload.End;
|
|
1001
|
-
|
|
1002
|
-
organizer: string;
|
|
1003
|
-
|
|
1004
|
-
organizer_type: 'SUPERGROUP';
|
|
1005
|
-
|
|
1006
|
-
recurrence_frequency: 'WEEKLY';
|
|
1007
|
-
|
|
1008
|
-
spoke_owner: string;
|
|
1009
|
-
|
|
1010
|
-
start: CreateGcalEventSupergroupWeeklyPayload.Start;
|
|
1011
|
-
|
|
1012
|
-
timezone: string;
|
|
1013
|
-
|
|
1014
|
-
title: string;
|
|
1015
|
-
|
|
1016
|
-
all_day_event?: boolean | null;
|
|
1017
|
-
|
|
1018
|
-
guestsCanInviteOthers?: boolean | null;
|
|
1019
|
-
|
|
1020
|
-
guestsCanModify?: boolean | null;
|
|
1021
|
-
|
|
1022
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
1023
|
-
|
|
1024
|
-
recurrence_has_end?: boolean | null;
|
|
1025
|
-
|
|
1026
|
-
/**
|
|
1027
|
-
* Show me as
|
|
1028
|
-
*/
|
|
1029
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
1030
|
-
|
|
1031
|
-
/**
|
|
1032
|
-
* Calendar Visibility
|
|
1033
|
-
*/
|
|
1034
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
1035
|
-
}
|
|
1036
|
-
|
|
1037
|
-
export namespace CreateGcalEventSupergroupWeeklyPayload {
|
|
1038
|
-
export interface End {
|
|
1039
|
-
date: string;
|
|
1040
|
-
|
|
1041
|
-
time: string;
|
|
1042
|
-
}
|
|
1043
|
-
|
|
1044
|
-
export interface Start {
|
|
1045
|
-
date: string;
|
|
1046
|
-
|
|
1047
|
-
time: string;
|
|
1048
|
-
}
|
|
1049
|
-
}
|
|
1050
|
-
|
|
1051
|
-
/**
|
|
1052
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
1053
|
-
* attendees
|
|
1054
|
-
*/
|
|
1055
|
-
export interface CreateGcalEventSupergroupMonthlyPayload {
|
|
1056
|
-
attendees: string;
|
|
1057
|
-
|
|
1058
|
-
description: string;
|
|
1059
|
-
|
|
1060
|
-
end: CreateGcalEventSupergroupMonthlyPayload.End;
|
|
1061
|
-
|
|
1062
|
-
organizer: string;
|
|
1063
|
-
|
|
1064
|
-
organizer_type: 'SUPERGROUP';
|
|
1065
|
-
|
|
1066
|
-
recurrence_frequency: 'MONTHLY';
|
|
1067
|
-
|
|
1068
|
-
spoke_owner: string;
|
|
1069
|
-
|
|
1070
|
-
start: CreateGcalEventSupergroupMonthlyPayload.Start;
|
|
1071
|
-
|
|
1072
|
-
timezone: string;
|
|
1073
|
-
|
|
1074
|
-
title: string;
|
|
1075
|
-
|
|
1076
|
-
all_day_event?: boolean | null;
|
|
1077
|
-
|
|
1078
|
-
guestsCanInviteOthers?: boolean | null;
|
|
1079
|
-
|
|
1080
|
-
guestsCanModify?: boolean | null;
|
|
1081
|
-
|
|
1082
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
1083
|
-
|
|
1084
|
-
recurrence_has_end?: boolean | null;
|
|
1085
|
-
|
|
1086
|
-
/**
|
|
1087
|
-
* Show me as
|
|
1088
|
-
*/
|
|
1089
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
1090
|
-
|
|
1091
|
-
/**
|
|
1092
|
-
* Calendar Visibility
|
|
1093
|
-
*/
|
|
1094
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
1095
|
-
}
|
|
1096
|
-
|
|
1097
|
-
export namespace CreateGcalEventSupergroupMonthlyPayload {
|
|
1098
|
-
export interface End {
|
|
1099
|
-
date: string;
|
|
1100
|
-
|
|
1101
|
-
time: string;
|
|
1102
|
-
}
|
|
1103
|
-
|
|
1104
|
-
export interface Start {
|
|
1105
|
-
date: string;
|
|
1106
|
-
|
|
1107
|
-
time: string;
|
|
1108
|
-
}
|
|
1109
|
-
}
|
|
1110
|
-
|
|
1111
|
-
/**
|
|
1112
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
1113
|
-
* attendees
|
|
1114
|
-
*/
|
|
1115
|
-
export interface CreateGcalEventSupergroupYearlyPayload {
|
|
1116
|
-
attendees: string;
|
|
1117
|
-
|
|
1118
|
-
description: string;
|
|
1119
|
-
|
|
1120
|
-
end: CreateGcalEventSupergroupYearlyPayload.End;
|
|
1121
|
-
|
|
1122
|
-
organizer: string;
|
|
1123
|
-
|
|
1124
|
-
organizer_type: 'SUPERGROUP';
|
|
1125
|
-
|
|
1126
|
-
recurrence_frequency: 'YEARLY';
|
|
1127
|
-
|
|
1128
|
-
spoke_owner: string;
|
|
1129
|
-
|
|
1130
|
-
start: CreateGcalEventSupergroupYearlyPayload.Start;
|
|
1131
|
-
|
|
1132
|
-
timezone: string;
|
|
1133
|
-
|
|
1134
|
-
title: string;
|
|
1135
|
-
|
|
1136
|
-
all_day_event?: boolean | null;
|
|
1137
|
-
|
|
1138
|
-
guestsCanInviteOthers?: boolean | null;
|
|
1139
|
-
|
|
1140
|
-
guestsCanModify?: boolean | null;
|
|
1141
|
-
|
|
1142
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
1143
|
-
|
|
1144
|
-
recurrence_has_end?: boolean | null;
|
|
1145
|
-
|
|
1146
|
-
/**
|
|
1147
|
-
* Show me as
|
|
1148
|
-
*/
|
|
1149
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
1150
|
-
|
|
1151
|
-
/**
|
|
1152
|
-
* Calendar Visibility
|
|
1153
|
-
*/
|
|
1154
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
1155
|
-
}
|
|
1156
|
-
|
|
1157
|
-
export namespace CreateGcalEventSupergroupYearlyPayload {
|
|
1158
|
-
export interface End {
|
|
1159
|
-
date: string;
|
|
1160
|
-
|
|
1161
|
-
time: string;
|
|
1162
|
-
}
|
|
1163
|
-
|
|
1164
|
-
export interface Start {
|
|
1165
|
-
date: string;
|
|
1166
|
-
|
|
1167
|
-
time: string;
|
|
1168
|
-
}
|
|
1169
|
-
}
|
|
1170
|
-
}
|
|
1171
|
-
|
|
1172
|
-
export interface SendTeamsActionRequest {
|
|
1173
|
-
action_type: 'send_teams';
|
|
1174
|
-
|
|
1175
|
-
/**
|
|
1176
|
-
* An action that sends a teams message
|
|
1177
|
-
*/
|
|
1178
|
-
payload:
|
|
1179
|
-
| SendTeamsActionRequest.SendTeamsPublicChannelMessagePayload
|
|
1180
|
-
| SendTeamsActionRequest.SendTeamsSingleDirectMessagePayload;
|
|
1181
|
-
|
|
1182
|
-
workflow_definition_id: string;
|
|
1183
|
-
}
|
|
1184
|
-
|
|
1185
|
-
export namespace SendTeamsActionRequest {
|
|
1186
|
-
/**
|
|
1187
|
-
* An action that sends a teams message
|
|
1188
|
-
*/
|
|
1189
|
-
export interface SendTeamsPublicChannelMessagePayload {
|
|
1190
|
-
action_type: 'PUBLIC_CHANNEL_MESSAGE';
|
|
1191
|
-
|
|
1192
|
-
message: string;
|
|
1193
|
-
|
|
1194
|
-
/**
|
|
1195
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1196
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1197
|
-
* back to synchronous execution.
|
|
1198
|
-
*/
|
|
1199
|
-
run_id?: string | null;
|
|
1200
|
-
|
|
1201
|
-
team_id?: string | null;
|
|
1202
|
-
}
|
|
1203
|
-
|
|
1204
|
-
/**
|
|
1205
|
-
* An action that sends a teams message
|
|
1206
|
-
*/
|
|
1207
|
-
export interface SendTeamsSingleDirectMessagePayload {
|
|
1208
|
-
action_type: 'SINGLE_DIRECT_MESSAGE';
|
|
1209
|
-
|
|
1210
|
-
message: string;
|
|
1211
|
-
|
|
1212
|
-
recipients?: string | null;
|
|
1213
|
-
|
|
1214
|
-
/**
|
|
1215
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1216
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1217
|
-
* back to synchronous execution.
|
|
1218
|
-
*/
|
|
1219
|
-
run_id?: string | null;
|
|
1220
|
-
}
|
|
1221
|
-
}
|
|
1222
|
-
|
|
1223
|
-
export interface AssignReviewActionRequest {
|
|
1224
|
-
action_type: 'assign_review';
|
|
1225
|
-
|
|
1226
|
-
/**
|
|
1227
|
-
* Select a cycle and reviewers for the employee that triggered the workflow
|
|
1228
|
-
*/
|
|
1229
|
-
payload:
|
|
1230
|
-
| AssignReviewActionRequest.AssignReviewReviewerRelativeToRevieweePayload
|
|
1231
|
-
| AssignReviewActionRequest.AssignReviewReviewerRelativeToTriggerPayload;
|
|
1232
|
-
|
|
1233
|
-
workflow_definition_id: string;
|
|
1234
|
-
}
|
|
1235
|
-
|
|
1236
|
-
export namespace AssignReviewActionRequest {
|
|
1237
|
-
/**
|
|
1238
|
-
* Select a cycle and reviewers for the employee that triggered the workflow
|
|
1239
|
-
*/
|
|
1240
|
-
export interface AssignReviewReviewerRelativeToRevieweePayload {
|
|
1241
|
-
cycle_id: string;
|
|
1242
|
-
|
|
1243
|
-
is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_REVIEWEE';
|
|
1244
|
-
|
|
1245
|
-
reviewees: string;
|
|
1246
|
-
|
|
1247
|
-
/**
|
|
1248
|
-
* Maximum reviewees: 500
|
|
1249
|
-
*/
|
|
1250
|
-
reviewers: string;
|
|
1251
|
-
|
|
1252
|
-
/**
|
|
1253
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1254
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1255
|
-
* back to synchronous execution.
|
|
1256
|
-
*/
|
|
1257
|
-
run_id?: string | null;
|
|
1258
|
-
}
|
|
1259
|
-
|
|
1260
|
-
/**
|
|
1261
|
-
* Select a cycle and reviewers for the employee that triggered the workflow
|
|
1262
|
-
*/
|
|
1263
|
-
export interface AssignReviewReviewerRelativeToTriggerPayload {
|
|
1264
|
-
cycle_id: string;
|
|
1265
|
-
|
|
1266
|
-
is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_TRIGGER';
|
|
1267
|
-
|
|
1268
|
-
reviewees: string;
|
|
1269
|
-
|
|
1270
|
-
/**
|
|
1271
|
-
* Maximum reviewees: 500
|
|
1272
|
-
*/
|
|
1273
|
-
reviewers: string;
|
|
1274
|
-
|
|
1275
|
-
/**
|
|
1276
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1277
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1278
|
-
* back to synchronous execution.
|
|
1279
|
-
*/
|
|
1280
|
-
run_id?: string | null;
|
|
1281
|
-
}
|
|
1282
|
-
}
|
|
1283
|
-
|
|
1284
|
-
export interface SendReportSftpActionRequest {
|
|
1285
|
-
action_type: 'send_report_sftp';
|
|
1286
|
-
|
|
1287
|
-
/**
|
|
1288
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
1289
|
-
* specified SFTP server
|
|
1290
|
-
*/
|
|
1291
|
-
payload:
|
|
1292
|
-
| SendReportSftpActionRequest.SendReportSftpPasswordExcelPayload
|
|
1293
|
-
| SendReportSftpActionRequest.SendReportSftpPasswordCsvPayload
|
|
1294
|
-
| SendReportSftpActionRequest.SendReportSftpSSHKeyExcelPayload
|
|
1295
|
-
| SendReportSftpActionRequest.SendReportSftpSSHKeyCsvPayload;
|
|
1296
|
-
|
|
1297
|
-
workflow_definition_id: string;
|
|
1298
|
-
}
|
|
1299
|
-
|
|
1300
|
-
export namespace SendReportSftpActionRequest {
|
|
1301
|
-
/**
|
|
1302
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
1303
|
-
* specified SFTP server
|
|
1304
|
-
*/
|
|
1305
|
-
export interface SendReportSftpPasswordExcelPayload {
|
|
1306
|
-
authentication_type: 'PASSWORD';
|
|
1307
|
-
|
|
1308
|
-
/**
|
|
1309
|
-
* Specify the full path where the file should be stored on the remote server,
|
|
1310
|
-
* starting from the root directory. Example: /rippling-workflows
|
|
1311
|
-
*/
|
|
1312
|
-
file_path: string;
|
|
1313
|
-
|
|
1314
|
-
file_type: 'EXCEL';
|
|
1315
|
-
|
|
1316
|
-
/**
|
|
1317
|
-
* sftp://username@[hostname]
|
|
1318
|
-
*/
|
|
1319
|
-
host_name: string;
|
|
1320
|
-
|
|
1321
|
-
/**
|
|
1322
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1323
|
-
*/
|
|
1324
|
-
report_id: string;
|
|
1325
|
-
|
|
1326
|
-
/**
|
|
1327
|
-
* sftp://[username]@hostname
|
|
1328
|
-
*/
|
|
1329
|
-
user_name: string;
|
|
1330
|
-
|
|
1331
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1332
|
-
|
|
1333
|
-
/**
|
|
1334
|
-
* CSV quoting
|
|
1335
|
-
*/
|
|
1336
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1337
|
-
|
|
1338
|
-
/**
|
|
1339
|
-
* Currency field formatting
|
|
1340
|
-
*/
|
|
1341
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1342
|
-
|
|
1343
|
-
/**
|
|
1344
|
-
* Date & time formatting
|
|
1345
|
-
*/
|
|
1346
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1347
|
-
|
|
1348
|
-
/**
|
|
1349
|
-
* Files will be automatically named if the file name is empty
|
|
1350
|
-
*/
|
|
1351
|
-
file_name?: string | null;
|
|
1352
|
-
|
|
1353
|
-
/**
|
|
1354
|
-
* File name suffix
|
|
1355
|
-
*/
|
|
1356
|
-
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
1357
|
-
|
|
1358
|
-
port?: number | null;
|
|
1359
|
-
|
|
1360
|
-
/**
|
|
1361
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1362
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1363
|
-
* back to synchronous execution.
|
|
1364
|
-
*/
|
|
1365
|
-
run_id?: string | null;
|
|
1366
|
-
|
|
1367
|
-
show_sub_totals?: boolean | null;
|
|
1368
|
-
|
|
1369
|
-
/**
|
|
1370
|
-
* Time zones
|
|
1371
|
-
*/
|
|
1372
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1373
|
-
}
|
|
1374
|
-
|
|
1375
|
-
/**
|
|
1376
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
1377
|
-
* specified SFTP server
|
|
1378
|
-
*/
|
|
1379
|
-
export interface SendReportSftpPasswordCsvPayload {
|
|
1380
|
-
authentication_type: 'PASSWORD';
|
|
1381
|
-
|
|
1382
|
-
/**
|
|
1383
|
-
* Specify the full path where the file should be stored on the remote server,
|
|
1384
|
-
* starting from the root directory. Example: /rippling-workflows
|
|
1385
|
-
*/
|
|
1386
|
-
file_path: string;
|
|
1387
|
-
|
|
1388
|
-
file_type: 'CSV';
|
|
1389
|
-
|
|
1390
|
-
/**
|
|
1391
|
-
* sftp://username@[hostname]
|
|
1392
|
-
*/
|
|
1393
|
-
host_name: string;
|
|
1394
|
-
|
|
1395
|
-
/**
|
|
1396
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1397
|
-
*/
|
|
1398
|
-
report_id: string;
|
|
1399
|
-
|
|
1400
|
-
/**
|
|
1401
|
-
* sftp://[username]@hostname
|
|
1402
|
-
*/
|
|
1403
|
-
user_name: string;
|
|
1404
|
-
|
|
1405
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1406
|
-
|
|
1407
|
-
/**
|
|
1408
|
-
* CSV quoting
|
|
1409
|
-
*/
|
|
1410
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1411
|
-
|
|
1412
|
-
/**
|
|
1413
|
-
* Custom separator
|
|
1414
|
-
*/
|
|
1415
|
-
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
1416
|
-
|
|
1417
|
-
/**
|
|
1418
|
-
* Currency field formatting
|
|
1419
|
-
*/
|
|
1420
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1421
|
-
|
|
1422
|
-
/**
|
|
1423
|
-
* Date & time formatting
|
|
1424
|
-
*/
|
|
1425
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1426
|
-
|
|
1427
|
-
/**
|
|
1428
|
-
* Files will be automatically named if the file name is empty
|
|
1429
|
-
*/
|
|
1430
|
-
file_name?: string | null;
|
|
1431
|
-
|
|
1432
|
-
/**
|
|
1433
|
-
* File name suffix
|
|
1434
|
-
*/
|
|
1435
|
-
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
1436
|
-
|
|
1437
|
-
port?: number | null;
|
|
1438
|
-
|
|
1439
|
-
/**
|
|
1440
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1441
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1442
|
-
* back to synchronous execution.
|
|
1443
|
-
*/
|
|
1444
|
-
run_id?: string | null;
|
|
1445
|
-
|
|
1446
|
-
show_sub_totals?: boolean | null;
|
|
1447
|
-
|
|
1448
|
-
/**
|
|
1449
|
-
* Time zones
|
|
1450
|
-
*/
|
|
1451
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1452
|
-
}
|
|
1453
|
-
|
|
1454
|
-
/**
|
|
1455
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
1456
|
-
* specified SFTP server
|
|
1457
|
-
*/
|
|
1458
|
-
export interface SendReportSftpSSHKeyExcelPayload {
|
|
1459
|
-
authentication_type: 'SSH_KEY';
|
|
1460
|
-
|
|
1461
|
-
/**
|
|
1462
|
-
* Specify the full path where the file should be stored on the remote server,
|
|
1463
|
-
* starting from the root directory. Example: /rippling-workflows
|
|
1464
|
-
*/
|
|
1465
|
-
file_path: string;
|
|
1466
|
-
|
|
1467
|
-
file_type: 'EXCEL';
|
|
1468
|
-
|
|
1469
|
-
/**
|
|
1470
|
-
* sftp://username@[hostname]
|
|
1471
|
-
*/
|
|
1472
|
-
host_name: string;
|
|
1473
|
-
|
|
1474
|
-
/**
|
|
1475
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1476
|
-
*/
|
|
1477
|
-
report_id: string;
|
|
1478
|
-
|
|
1479
|
-
/**
|
|
1480
|
-
* sftp://[username]@hostname
|
|
1481
|
-
*/
|
|
1482
|
-
user_name: string;
|
|
1483
|
-
|
|
1484
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1485
|
-
|
|
1486
|
-
/**
|
|
1487
|
-
* CSV quoting
|
|
1488
|
-
*/
|
|
1489
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1490
|
-
|
|
1491
|
-
/**
|
|
1492
|
-
* Currency field formatting
|
|
1493
|
-
*/
|
|
1494
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1495
|
-
|
|
1496
|
-
/**
|
|
1497
|
-
* Date & time formatting
|
|
1498
|
-
*/
|
|
1499
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1500
|
-
|
|
1501
|
-
/**
|
|
1502
|
-
* Files will be automatically named if the file name is empty
|
|
1503
|
-
*/
|
|
1504
|
-
file_name?: string | null;
|
|
1505
|
-
|
|
1506
|
-
/**
|
|
1507
|
-
* File name suffix
|
|
1508
|
-
*/
|
|
1509
|
-
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
1510
|
-
|
|
1511
|
-
port?: number | null;
|
|
1512
|
-
|
|
1513
|
-
/**
|
|
1514
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1515
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1516
|
-
* back to synchronous execution.
|
|
1517
|
-
*/
|
|
1518
|
-
run_id?: string | null;
|
|
1519
|
-
|
|
1520
|
-
show_sub_totals?: boolean | null;
|
|
1521
|
-
|
|
1522
|
-
/**
|
|
1523
|
-
* Time zones
|
|
1524
|
-
*/
|
|
1525
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1526
|
-
}
|
|
1527
|
-
|
|
1528
|
-
/**
|
|
1529
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
1530
|
-
* specified SFTP server
|
|
1531
|
-
*/
|
|
1532
|
-
export interface SendReportSftpSSHKeyCsvPayload {
|
|
1533
|
-
authentication_type: 'SSH_KEY';
|
|
1534
|
-
|
|
1535
|
-
/**
|
|
1536
|
-
* Specify the full path where the file should be stored on the remote server,
|
|
1537
|
-
* starting from the root directory. Example: /rippling-workflows
|
|
1538
|
-
*/
|
|
1539
|
-
file_path: string;
|
|
1540
|
-
|
|
1541
|
-
file_type: 'CSV';
|
|
1542
|
-
|
|
1543
|
-
/**
|
|
1544
|
-
* sftp://username@[hostname]
|
|
1545
|
-
*/
|
|
1546
|
-
host_name: string;
|
|
1547
|
-
|
|
1548
|
-
/**
|
|
1549
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1550
|
-
*/
|
|
1551
|
-
report_id: string;
|
|
1552
|
-
|
|
1553
|
-
/**
|
|
1554
|
-
* sftp://[username]@hostname
|
|
1555
|
-
*/
|
|
1556
|
-
user_name: string;
|
|
1557
|
-
|
|
1558
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1559
|
-
|
|
1560
|
-
/**
|
|
1561
|
-
* CSV quoting
|
|
1562
|
-
*/
|
|
1563
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1564
|
-
|
|
1565
|
-
/**
|
|
1566
|
-
* Custom separator
|
|
1567
|
-
*/
|
|
1568
|
-
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
1569
|
-
|
|
1570
|
-
/**
|
|
1571
|
-
* Currency field formatting
|
|
1572
|
-
*/
|
|
1573
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1574
|
-
|
|
1575
|
-
/**
|
|
1576
|
-
* Date & time formatting
|
|
1577
|
-
*/
|
|
1578
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1579
|
-
|
|
1580
|
-
/**
|
|
1581
|
-
* Files will be automatically named if the file name is empty
|
|
1582
|
-
*/
|
|
1583
|
-
file_name?: string | null;
|
|
1584
|
-
|
|
1585
|
-
/**
|
|
1586
|
-
* File name suffix
|
|
1587
|
-
*/
|
|
1588
|
-
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
1589
|
-
|
|
1590
|
-
port?: number | null;
|
|
1591
|
-
|
|
1592
|
-
/**
|
|
1593
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1594
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1595
|
-
* back to synchronous execution.
|
|
1596
|
-
*/
|
|
1597
|
-
run_id?: string | null;
|
|
1598
|
-
|
|
1599
|
-
show_sub_totals?: boolean | null;
|
|
1600
|
-
|
|
1601
|
-
/**
|
|
1602
|
-
* Time zones
|
|
1603
|
-
*/
|
|
1604
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1605
|
-
}
|
|
1606
|
-
}
|
|
1607
|
-
|
|
1608
|
-
export interface EnrollIntoCourseActionRequest {
|
|
1609
|
-
action_type: 'enroll_into_course';
|
|
1610
|
-
|
|
1611
|
-
/**
|
|
1612
|
-
* Automatically enroll people into a course
|
|
1613
|
-
*/
|
|
1614
|
-
payload:
|
|
1615
|
-
| EnrollIntoCourseActionRequest.EnrollIntoCourse1WeekPayload
|
|
1616
|
-
| EnrollIntoCourseActionRequest.EnrollIntoCourse2WeeksPayload
|
|
1617
|
-
| EnrollIntoCourseActionRequest.EnrollIntoCourse1MonthPayload
|
|
1618
|
-
| EnrollIntoCourseActionRequest.EnrollIntoCourse3MonthsPayload
|
|
1619
|
-
| EnrollIntoCourseActionRequest.EnrollIntoCourse6MonthsPayload
|
|
1620
|
-
| EnrollIntoCourseActionRequest.EnrollIntoCourse12MonthsPayload
|
|
1621
|
-
| EnrollIntoCourseActionRequest.EnrollIntoCourseCustomPayload;
|
|
1622
|
-
|
|
1623
|
-
workflow_definition_id: string;
|
|
1624
|
-
}
|
|
1625
|
-
|
|
1626
|
-
export namespace EnrollIntoCourseActionRequest {
|
|
1627
|
-
/**
|
|
1628
|
-
* Automatically enroll people into a course
|
|
1629
|
-
*/
|
|
1630
|
-
export interface EnrollIntoCourse1WeekPayload {
|
|
1631
|
-
/**
|
|
1632
|
-
* Select a course to enroll people in
|
|
1633
|
-
*/
|
|
1634
|
-
course_id: string;
|
|
1635
|
-
|
|
1636
|
-
due_date: '1_week';
|
|
1637
|
-
|
|
1638
|
-
/**
|
|
1639
|
-
* Select people to enroll in this course
|
|
1640
|
-
*/
|
|
1641
|
-
role_ids: string;
|
|
1642
|
-
|
|
1643
|
-
/**
|
|
1644
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1645
|
-
*/
|
|
1646
|
-
skip_if_certified?: boolean | null;
|
|
1647
|
-
}
|
|
1648
|
-
|
|
1649
|
-
/**
|
|
1650
|
-
* Automatically enroll people into a course
|
|
1651
|
-
*/
|
|
1652
|
-
export interface EnrollIntoCourse2WeeksPayload {
|
|
1653
|
-
/**
|
|
1654
|
-
* Select a course to enroll people in
|
|
1655
|
-
*/
|
|
1656
|
-
course_id: string;
|
|
1657
|
-
|
|
1658
|
-
due_date: '2_weeks';
|
|
1659
|
-
|
|
1660
|
-
/**
|
|
1661
|
-
* Select people to enroll in this course
|
|
1662
|
-
*/
|
|
1663
|
-
role_ids: string;
|
|
1664
|
-
|
|
1665
|
-
/**
|
|
1666
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1667
|
-
*/
|
|
1668
|
-
skip_if_certified?: boolean | null;
|
|
1669
|
-
}
|
|
1670
|
-
|
|
1671
|
-
/**
|
|
1672
|
-
* Automatically enroll people into a course
|
|
1673
|
-
*/
|
|
1674
|
-
export interface EnrollIntoCourse1MonthPayload {
|
|
1675
|
-
/**
|
|
1676
|
-
* Select a course to enroll people in
|
|
1677
|
-
*/
|
|
1678
|
-
course_id: string;
|
|
1679
|
-
|
|
1680
|
-
due_date: '1_month';
|
|
1681
|
-
|
|
1682
|
-
/**
|
|
1683
|
-
* Select people to enroll in this course
|
|
1684
|
-
*/
|
|
1685
|
-
role_ids: string;
|
|
1686
|
-
|
|
1687
|
-
/**
|
|
1688
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1689
|
-
*/
|
|
1690
|
-
skip_if_certified?: boolean | null;
|
|
1691
|
-
}
|
|
1692
|
-
|
|
1693
|
-
/**
|
|
1694
|
-
* Automatically enroll people into a course
|
|
1695
|
-
*/
|
|
1696
|
-
export interface EnrollIntoCourse3MonthsPayload {
|
|
1697
|
-
/**
|
|
1698
|
-
* Select a course to enroll people in
|
|
1699
|
-
*/
|
|
1700
|
-
course_id: string;
|
|
1701
|
-
|
|
1702
|
-
due_date: '3_months';
|
|
1703
|
-
|
|
1704
|
-
/**
|
|
1705
|
-
* Select people to enroll in this course
|
|
1706
|
-
*/
|
|
1707
|
-
role_ids: string;
|
|
1708
|
-
|
|
1709
|
-
/**
|
|
1710
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1711
|
-
*/
|
|
1712
|
-
skip_if_certified?: boolean | null;
|
|
1713
|
-
}
|
|
1714
|
-
|
|
1715
|
-
/**
|
|
1716
|
-
* Automatically enroll people into a course
|
|
1717
|
-
*/
|
|
1718
|
-
export interface EnrollIntoCourse6MonthsPayload {
|
|
1719
|
-
/**
|
|
1720
|
-
* Select a course to enroll people in
|
|
1721
|
-
*/
|
|
1722
|
-
course_id: string;
|
|
1723
|
-
|
|
1724
|
-
due_date: '6_months';
|
|
1725
|
-
|
|
1726
|
-
/**
|
|
1727
|
-
* Select people to enroll in this course
|
|
1728
|
-
*/
|
|
1729
|
-
role_ids: string;
|
|
1730
|
-
|
|
1731
|
-
/**
|
|
1732
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1733
|
-
*/
|
|
1734
|
-
skip_if_certified?: boolean | null;
|
|
1735
|
-
}
|
|
1736
|
-
|
|
1737
|
-
/**
|
|
1738
|
-
* Automatically enroll people into a course
|
|
1739
|
-
*/
|
|
1740
|
-
export interface EnrollIntoCourse12MonthsPayload {
|
|
1741
|
-
/**
|
|
1742
|
-
* Select a course to enroll people in
|
|
1743
|
-
*/
|
|
1744
|
-
course_id: string;
|
|
1745
|
-
|
|
1746
|
-
due_date: '12_months';
|
|
1747
|
-
|
|
1748
|
-
/**
|
|
1749
|
-
* Select people to enroll in this course
|
|
1750
|
-
*/
|
|
1751
|
-
role_ids: string;
|
|
1752
|
-
|
|
1753
|
-
/**
|
|
1754
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1755
|
-
*/
|
|
1756
|
-
skip_if_certified?: boolean | null;
|
|
1757
|
-
}
|
|
1758
|
-
|
|
1759
|
-
/**
|
|
1760
|
-
* Automatically enroll people into a course
|
|
1761
|
-
*/
|
|
1762
|
-
export interface EnrollIntoCourseCustomPayload {
|
|
1763
|
-
/**
|
|
1764
|
-
* Select a course to enroll people in
|
|
1765
|
-
*/
|
|
1766
|
-
course_id: string;
|
|
1767
|
-
|
|
1768
|
-
due_date: 'custom';
|
|
1769
|
-
|
|
1770
|
-
/**
|
|
1771
|
-
* Select people to enroll in this course
|
|
1772
|
-
*/
|
|
1773
|
-
role_ids: string;
|
|
1774
|
-
|
|
1775
|
-
/**
|
|
1776
|
-
* Time unit
|
|
1777
|
-
*/
|
|
1778
|
-
custom_due_duration?: 'day' | 'week' | 'month' | 'year' | null;
|
|
1779
|
-
|
|
1780
|
-
/**
|
|
1781
|
-
* Number of days/weeks/months/years
|
|
1782
|
-
*/
|
|
1783
|
-
custom_due_value?: number | null;
|
|
1784
|
-
|
|
1785
|
-
/**
|
|
1786
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1787
|
-
*/
|
|
1788
|
-
skip_if_certified?: boolean | null;
|
|
1789
|
-
}
|
|
1790
|
-
}
|
|
1791
|
-
|
|
1792
|
-
export interface EnrollIntoLearningPathActionRequest {
|
|
1793
|
-
action_type: 'enroll_into_learning_path';
|
|
1794
|
-
|
|
1795
|
-
/**
|
|
1796
|
-
* Automatically enroll people into a learning path
|
|
1797
|
-
*/
|
|
1798
|
-
payload: EnrollIntoLearningPathActionRequest.Payload;
|
|
1799
|
-
|
|
1800
|
-
workflow_definition_id: string;
|
|
1801
|
-
}
|
|
1802
|
-
|
|
1803
|
-
export namespace EnrollIntoLearningPathActionRequest {
|
|
1804
|
-
/**
|
|
1805
|
-
* Automatically enroll people into a learning path
|
|
1806
|
-
*/
|
|
1807
|
-
export interface Payload {
|
|
1808
|
-
/**
|
|
1809
|
-
* Select a learning path to enroll people in
|
|
1810
|
-
*/
|
|
1811
|
-
learning_path_id: string;
|
|
1812
|
-
|
|
1813
|
-
/**
|
|
1814
|
-
* Select people to enroll in this learning path
|
|
1815
|
-
*/
|
|
1816
|
-
role_ids: string;
|
|
1817
|
-
|
|
1818
|
-
/**
|
|
1819
|
-
* Time unit
|
|
1820
|
-
*/
|
|
1821
|
-
custom_due_unit?: 'day' | 'week' | 'month' | 'year' | null;
|
|
1822
|
-
|
|
1823
|
-
/**
|
|
1824
|
-
* Number of days/weeks/months/years
|
|
1825
|
-
*/
|
|
1826
|
-
custom_due_value?: number | null;
|
|
1827
|
-
|
|
1828
|
-
/**
|
|
1829
|
-
* Number of days after completing one course before the next is due
|
|
1830
|
-
*/
|
|
1831
|
-
days_between_courses?: number | null;
|
|
1832
|
-
|
|
1833
|
-
/**
|
|
1834
|
-
* Due date type
|
|
1835
|
-
*/
|
|
1836
|
-
due_date_type?: 'global' | 'relative' | null;
|
|
1837
|
-
|
|
1838
|
-
/**
|
|
1839
|
-
* Due in
|
|
1840
|
-
*/
|
|
1841
|
-
due_in?: '1_week' | '2_weeks' | '1_month' | '3_months' | '6_months' | '12_months' | 'custom' | null;
|
|
1842
|
-
|
|
1843
|
-
/**
|
|
1844
|
-
* Give credit for courses the employee has already completed
|
|
1845
|
-
*/
|
|
1846
|
-
induct_completed_enrollments?: boolean | null;
|
|
1847
|
-
|
|
1848
|
-
/**
|
|
1849
|
-
* Skip enrollment if the employee already completed this learning path
|
|
1850
|
-
*/
|
|
1851
|
-
skip_if_completed?: boolean | null;
|
|
1852
|
-
}
|
|
1853
|
-
}
|
|
1854
|
-
|
|
1855
|
-
export interface SendReportEmailActionRequest {
|
|
1856
|
-
action_type: 'report_email';
|
|
1857
|
-
|
|
1858
|
-
/**
|
|
1859
|
-
* Send Report via Email.
|
|
1860
|
-
*/
|
|
1861
|
-
payload:
|
|
1862
|
-
| SendReportEmailActionRequest.SendReportEmailExcelPayload
|
|
1863
|
-
| SendReportEmailActionRequest.SendReportEmailCsvPayload;
|
|
1864
|
-
|
|
1865
|
-
workflow_definition_id: string;
|
|
1866
|
-
}
|
|
1867
|
-
|
|
1868
|
-
export namespace SendReportEmailActionRequest {
|
|
1869
|
-
/**
|
|
1870
|
-
* Send Report via Email.
|
|
1871
|
-
*/
|
|
1872
|
-
export interface SendReportEmailExcelPayload {
|
|
1873
|
-
file_type: 'EXCEL';
|
|
1874
|
-
|
|
1875
|
-
/**
|
|
1876
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1877
|
-
*/
|
|
1878
|
-
report_id: string;
|
|
1879
|
-
|
|
1880
|
-
/**
|
|
1881
|
-
* Whose report view should be used to generate this report? (Only the workflow
|
|
1882
|
-
* owner's access level will be available if external emails are included.)
|
|
1883
|
-
*/
|
|
1884
|
-
run_report_perms: 'RECIPIENT' | 'WORKFLOW_OWNER';
|
|
1885
|
-
|
|
1886
|
-
send_to: SendReportEmailExcelPayload.SendTo;
|
|
1887
|
-
|
|
1888
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1889
|
-
|
|
1890
|
-
/**
|
|
1891
|
-
* CSV quoting
|
|
1892
|
-
*/
|
|
1893
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1894
|
-
|
|
1895
|
-
/**
|
|
1896
|
-
* Currency field formatting
|
|
1897
|
-
*/
|
|
1898
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1899
|
-
|
|
1900
|
-
/**
|
|
1901
|
-
* Date & time formatting
|
|
1902
|
-
*/
|
|
1903
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1904
|
-
|
|
1905
|
-
/**
|
|
1906
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1907
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1908
|
-
* back to synchronous execution.
|
|
1909
|
-
*/
|
|
1910
|
-
run_id?: string | null;
|
|
1911
|
-
|
|
1912
|
-
show_sub_totals?: boolean | null;
|
|
1913
|
-
|
|
1914
|
-
/**
|
|
1915
|
-
* Time zones
|
|
1916
|
-
*/
|
|
1917
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1918
|
-
}
|
|
1919
|
-
|
|
1920
|
-
export namespace SendReportEmailExcelPayload {
|
|
1921
|
-
export interface SendTo {
|
|
1922
|
-
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1923
|
-
|
|
1924
|
-
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1925
|
-
|
|
1926
|
-
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1927
|
-
}
|
|
1928
|
-
|
|
1929
|
-
export namespace SendTo {
|
|
1930
|
-
export interface Recipient1 {
|
|
1931
|
-
supergroup: string;
|
|
1932
|
-
|
|
1933
|
-
/**
|
|
1934
|
-
* Email type
|
|
1935
|
-
*/
|
|
1936
|
-
emailType?:
|
|
1937
|
-
| 'work_or_personal_email'
|
|
1938
|
-
| 'work_email_only'
|
|
1939
|
-
| 'personal_email_only'
|
|
1940
|
-
| 'work_and_personal_email'
|
|
1941
|
-
| null;
|
|
1942
|
-
|
|
1943
|
-
externalEmails?: Array<string> | null;
|
|
1944
|
-
}
|
|
1945
|
-
|
|
1946
|
-
export interface Recipient2 {
|
|
1947
|
-
externalEmails: Array<string>;
|
|
1948
|
-
|
|
1949
|
-
/**
|
|
1950
|
-
* Email type
|
|
1951
|
-
*/
|
|
1952
|
-
emailType?:
|
|
1953
|
-
| 'work_or_personal_email'
|
|
1954
|
-
| 'work_email_only'
|
|
1955
|
-
| 'personal_email_only'
|
|
1956
|
-
| 'work_and_personal_email'
|
|
1957
|
-
| null;
|
|
1958
|
-
|
|
1959
|
-
supergroup?: string | null;
|
|
1960
|
-
}
|
|
1961
|
-
|
|
1962
|
-
export interface Recipient1 {
|
|
1963
|
-
supergroup: string;
|
|
1964
|
-
|
|
1965
|
-
/**
|
|
1966
|
-
* Email type
|
|
1967
|
-
*/
|
|
1968
|
-
emailType?:
|
|
1969
|
-
| 'work_or_personal_email'
|
|
1970
|
-
| 'work_email_only'
|
|
1971
|
-
| 'personal_email_only'
|
|
1972
|
-
| 'work_and_personal_email'
|
|
1973
|
-
| null;
|
|
1974
|
-
|
|
1975
|
-
externalEmails?: Array<string> | null;
|
|
1976
|
-
}
|
|
1977
|
-
|
|
1978
|
-
export interface Recipient2 {
|
|
1979
|
-
externalEmails: Array<string>;
|
|
1980
|
-
|
|
1981
|
-
/**
|
|
1982
|
-
* Email type
|
|
1983
|
-
*/
|
|
1984
|
-
emailType?:
|
|
1985
|
-
| 'work_or_personal_email'
|
|
1986
|
-
| 'work_email_only'
|
|
1987
|
-
| 'personal_email_only'
|
|
1988
|
-
| 'work_and_personal_email'
|
|
1989
|
-
| null;
|
|
1990
|
-
|
|
1991
|
-
supergroup?: string | null;
|
|
1992
|
-
}
|
|
1993
|
-
|
|
1994
|
-
export interface Recipient1 {
|
|
1995
|
-
supergroup: string;
|
|
1996
|
-
|
|
1997
|
-
/**
|
|
1998
|
-
* Email type
|
|
1999
|
-
*/
|
|
2000
|
-
emailType?:
|
|
2001
|
-
| 'work_or_personal_email'
|
|
2002
|
-
| 'work_email_only'
|
|
2003
|
-
| 'personal_email_only'
|
|
2004
|
-
| 'work_and_personal_email'
|
|
2005
|
-
| null;
|
|
2006
|
-
|
|
2007
|
-
externalEmails?: Array<string> | null;
|
|
2008
|
-
}
|
|
2009
|
-
|
|
2010
|
-
export interface Recipient2 {
|
|
2011
|
-
externalEmails: Array<string>;
|
|
2012
|
-
|
|
2013
|
-
/**
|
|
2014
|
-
* Email type
|
|
2015
|
-
*/
|
|
2016
|
-
emailType?:
|
|
2017
|
-
| 'work_or_personal_email'
|
|
2018
|
-
| 'work_email_only'
|
|
2019
|
-
| 'personal_email_only'
|
|
2020
|
-
| 'work_and_personal_email'
|
|
2021
|
-
| null;
|
|
2022
|
-
|
|
2023
|
-
supergroup?: string | null;
|
|
2024
|
-
}
|
|
2025
|
-
}
|
|
2026
|
-
}
|
|
2027
|
-
|
|
2028
|
-
/**
|
|
2029
|
-
* Send Report via Email.
|
|
2030
|
-
*/
|
|
2031
|
-
export interface SendReportEmailCsvPayload {
|
|
2032
|
-
file_type: 'CSV';
|
|
2033
|
-
|
|
2034
|
-
/**
|
|
2035
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
2036
|
-
*/
|
|
2037
|
-
report_id: string;
|
|
2038
|
-
|
|
2039
|
-
/**
|
|
2040
|
-
* Whose report view should be used to generate this report? (Only the workflow
|
|
2041
|
-
* owner's access level will be available if external emails are included.)
|
|
2042
|
-
*/
|
|
2043
|
-
run_report_perms: 'RECIPIENT' | 'WORKFLOW_OWNER';
|
|
2044
|
-
|
|
2045
|
-
send_to: SendReportEmailCsvPayload.SendTo;
|
|
2046
|
-
|
|
2047
|
-
add_role_referenced_id_column?: boolean | null;
|
|
2048
|
-
|
|
2049
|
-
/**
|
|
2050
|
-
* CSV quoting
|
|
2051
|
-
*/
|
|
2052
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
2053
|
-
|
|
2054
|
-
/**
|
|
2055
|
-
* Custom separator
|
|
2056
|
-
*/
|
|
2057
|
-
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
2058
|
-
|
|
2059
|
-
/**
|
|
2060
|
-
* Currency field formatting
|
|
2061
|
-
*/
|
|
2062
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
2063
|
-
|
|
2064
|
-
/**
|
|
2065
|
-
* Date & time formatting
|
|
2066
|
-
*/
|
|
2067
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
2068
|
-
|
|
2069
|
-
/**
|
|
2070
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
2071
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
2072
|
-
* back to synchronous execution.
|
|
2073
|
-
*/
|
|
2074
|
-
run_id?: string | null;
|
|
2075
|
-
|
|
2076
|
-
show_sub_totals?: boolean | null;
|
|
2077
|
-
|
|
2078
|
-
/**
|
|
2079
|
-
* Time zones
|
|
2080
|
-
*/
|
|
2081
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
2082
|
-
}
|
|
2083
|
-
|
|
2084
|
-
export namespace SendReportEmailCsvPayload {
|
|
2085
|
-
export interface SendTo {
|
|
2086
|
-
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
2087
|
-
|
|
2088
|
-
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
2089
|
-
|
|
2090
|
-
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
2091
|
-
}
|
|
2092
|
-
|
|
2093
|
-
export namespace SendTo {
|
|
2094
|
-
export interface Recipient1 {
|
|
2095
|
-
supergroup: string;
|
|
2096
|
-
|
|
2097
|
-
/**
|
|
2098
|
-
* Email type
|
|
2099
|
-
*/
|
|
2100
|
-
emailType?:
|
|
2101
|
-
| 'work_or_personal_email'
|
|
2102
|
-
| 'work_email_only'
|
|
2103
|
-
| 'personal_email_only'
|
|
2104
|
-
| 'work_and_personal_email'
|
|
2105
|
-
| null;
|
|
2106
|
-
|
|
2107
|
-
externalEmails?: Array<string> | null;
|
|
2108
|
-
}
|
|
2109
|
-
|
|
2110
|
-
export interface Recipient2 {
|
|
2111
|
-
externalEmails: Array<string>;
|
|
2112
|
-
|
|
2113
|
-
/**
|
|
2114
|
-
* Email type
|
|
2115
|
-
*/
|
|
2116
|
-
emailType?:
|
|
2117
|
-
| 'work_or_personal_email'
|
|
2118
|
-
| 'work_email_only'
|
|
2119
|
-
| 'personal_email_only'
|
|
2120
|
-
| 'work_and_personal_email'
|
|
2121
|
-
| null;
|
|
2122
|
-
|
|
2123
|
-
supergroup?: string | null;
|
|
2124
|
-
}
|
|
2125
|
-
|
|
2126
|
-
export interface Recipient1 {
|
|
2127
|
-
supergroup: string;
|
|
2128
|
-
|
|
2129
|
-
/**
|
|
2130
|
-
* Email type
|
|
2131
|
-
*/
|
|
2132
|
-
emailType?:
|
|
2133
|
-
| 'work_or_personal_email'
|
|
2134
|
-
| 'work_email_only'
|
|
2135
|
-
| 'personal_email_only'
|
|
2136
|
-
| 'work_and_personal_email'
|
|
2137
|
-
| null;
|
|
2138
|
-
|
|
2139
|
-
externalEmails?: Array<string> | null;
|
|
2140
|
-
}
|
|
2141
|
-
|
|
2142
|
-
export interface Recipient2 {
|
|
2143
|
-
externalEmails: Array<string>;
|
|
2144
|
-
|
|
2145
|
-
/**
|
|
2146
|
-
* Email type
|
|
2147
|
-
*/
|
|
2148
|
-
emailType?:
|
|
2149
|
-
| 'work_or_personal_email'
|
|
2150
|
-
| 'work_email_only'
|
|
2151
|
-
| 'personal_email_only'
|
|
2152
|
-
| 'work_and_personal_email'
|
|
2153
|
-
| null;
|
|
2154
|
-
|
|
2155
|
-
supergroup?: string | null;
|
|
2156
|
-
}
|
|
2157
|
-
|
|
2158
|
-
export interface Recipient1 {
|
|
2159
|
-
supergroup: string;
|
|
2160
|
-
|
|
2161
|
-
/**
|
|
2162
|
-
* Email type
|
|
2163
|
-
*/
|
|
2164
|
-
emailType?:
|
|
2165
|
-
| 'work_or_personal_email'
|
|
2166
|
-
| 'work_email_only'
|
|
2167
|
-
| 'personal_email_only'
|
|
2168
|
-
| 'work_and_personal_email'
|
|
2169
|
-
| null;
|
|
2170
|
-
|
|
2171
|
-
externalEmails?: Array<string> | null;
|
|
2172
|
-
}
|
|
2173
|
-
|
|
2174
|
-
export interface Recipient2 {
|
|
2175
|
-
externalEmails: Array<string>;
|
|
2176
|
-
|
|
2177
|
-
/**
|
|
2178
|
-
* Email type
|
|
2179
|
-
*/
|
|
2180
|
-
emailType?:
|
|
2181
|
-
| 'work_or_personal_email'
|
|
2182
|
-
| 'work_email_only'
|
|
2183
|
-
| 'personal_email_only'
|
|
2184
|
-
| 'work_and_personal_email'
|
|
2185
|
-
| null;
|
|
2186
|
-
|
|
2187
|
-
supergroup?: string | null;
|
|
2188
|
-
}
|
|
2189
|
-
}
|
|
2190
|
-
}
|
|
2191
|
-
}
|
|
2192
|
-
|
|
2193
|
-
export interface SendDocumentActionRequest {
|
|
2194
|
-
action_type: 'send_document';
|
|
2195
|
-
|
|
2196
|
-
/**
|
|
2197
|
-
* Sends a document to employees
|
|
2198
|
-
*/
|
|
2199
|
-
payload: SendDocumentActionRequest.Payload;
|
|
2200
|
-
|
|
2201
|
-
workflow_definition_id: string;
|
|
2202
|
-
}
|
|
2203
|
-
|
|
2204
|
-
export namespace SendDocumentActionRequest {
|
|
2205
|
-
/**
|
|
2206
|
-
* Sends a document to employees
|
|
2207
|
-
*/
|
|
2208
|
-
export interface Payload {
|
|
2209
|
-
document: string;
|
|
2210
|
-
|
|
2211
|
-
/**
|
|
2212
|
-
* Maximum recipients: 500
|
|
2213
|
-
*/
|
|
2214
|
-
recipients: string;
|
|
2215
|
-
|
|
2216
|
-
/**
|
|
2217
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
2218
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
2219
|
-
* back to synchronous execution.
|
|
2220
|
-
*/
|
|
2221
|
-
run_id?: string | null;
|
|
2222
|
-
}
|
|
2223
|
-
}
|
|
2224
|
-
|
|
2225
|
-
export interface AccrueLeaveActionRequest {
|
|
2226
|
-
action_type: 'accrue_leave';
|
|
2227
|
-
|
|
2228
|
-
/**
|
|
2229
|
-
* Adjust time off balance of a leave policy or a leave type
|
|
2230
|
-
*/
|
|
2231
|
-
payload:
|
|
2232
|
-
| AccrueLeaveActionRequest.AccrueLeaveLeavePolicyPayload
|
|
2233
|
-
| AccrueLeaveActionRequest.AccrueLeaveCompanyLeaveTypePayload;
|
|
2234
|
-
|
|
2235
|
-
workflow_definition_id: string;
|
|
2236
|
-
}
|
|
2237
|
-
|
|
2238
|
-
export namespace AccrueLeaveActionRequest {
|
|
2239
|
-
/**
|
|
2240
|
-
* Adjust time off balance of a leave policy or a leave type
|
|
2241
|
-
*/
|
|
2242
|
-
export interface AccrueLeaveLeavePolicyPayload {
|
|
2243
|
-
/**
|
|
2244
|
-
* Choose how to adjust the employee's leave balance
|
|
2245
|
-
*/
|
|
2246
|
-
balance_action_type: 'ADD_BALANCE' | 'DEDUCT_BALANCE';
|
|
2247
|
-
|
|
2248
|
-
balance_increment: number | string;
|
|
2249
|
-
|
|
2250
|
-
/**
|
|
2251
|
-
* The unit of time to accrue leave in
|
|
2252
|
-
*/
|
|
2253
|
-
balance_unit: 'HOURS' | 'DAYS' | 'WEEKS';
|
|
2254
|
-
|
|
2255
|
-
leave_policy: string;
|
|
2256
|
-
|
|
2257
|
-
pto_type: 'LEAVE_POLICY';
|
|
2258
|
-
|
|
2259
|
-
recipients: string;
|
|
2260
|
-
|
|
2261
|
-
/**
|
|
2262
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
2263
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
2264
|
-
* back to synchronous execution.
|
|
2265
|
-
*/
|
|
2266
|
-
run_id?: string | null;
|
|
2267
|
-
}
|
|
2268
|
-
|
|
2269
|
-
/**
|
|
2270
|
-
* Adjust time off balance of a leave policy or a leave type
|
|
2271
|
-
*/
|
|
2272
|
-
export interface AccrueLeaveCompanyLeaveTypePayload {
|
|
2273
|
-
/**
|
|
2274
|
-
* Choose how to adjust the employee's leave balance
|
|
2275
|
-
*/
|
|
2276
|
-
balance_action_type: 'ADD_BALANCE' | 'DEDUCT_BALANCE';
|
|
2277
|
-
|
|
2278
|
-
balance_increment: number | string;
|
|
2279
|
-
|
|
2280
|
-
/**
|
|
2281
|
-
* The unit of time to accrue leave in
|
|
2282
|
-
*/
|
|
2283
|
-
balance_unit: 'HOURS' | 'DAYS' | 'WEEKS';
|
|
2284
|
-
|
|
2285
|
-
company_leave_type: string;
|
|
2286
|
-
|
|
2287
|
-
pto_type: 'COMPANY_LEAVE_TYPE';
|
|
2288
|
-
|
|
2289
|
-
recipients: string;
|
|
2290
|
-
|
|
2291
|
-
/**
|
|
2292
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
2293
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
2294
|
-
* back to synchronous execution.
|
|
2295
|
-
*/
|
|
2296
|
-
run_id?: string | null;
|
|
2297
|
-
}
|
|
2298
|
-
}
|
|
2299
|
-
|
|
2300
|
-
export interface MakePaymentActionRequest {
|
|
2301
|
-
action_type: 'make_payment';
|
|
2302
|
-
|
|
2303
|
-
/**
|
|
2304
|
-
* Send a payment to employee(s). This payment will be applied to the next upcoming
|
|
2305
|
-
* payroll run.
|
|
2306
|
-
*/
|
|
2307
|
-
payload: MakePaymentActionRequest.Payload;
|
|
2308
|
-
|
|
2309
|
-
workflow_definition_id: string;
|
|
2310
|
-
}
|
|
2311
|
-
|
|
2312
|
-
export namespace MakePaymentActionRequest {
|
|
2313
|
-
/**
|
|
2314
|
-
* Send a payment to employee(s). This payment will be applied to the next upcoming
|
|
2315
|
-
* payroll run.
|
|
2316
|
-
*/
|
|
2317
|
-
export interface Payload {
|
|
2318
|
-
/**
|
|
2319
|
-
* Set a max amount that can be earned under this workflow
|
|
2320
|
-
*/
|
|
2321
|
-
apply_cap: boolean;
|
|
2322
|
-
|
|
2323
|
-
description: string;
|
|
2324
|
-
|
|
2325
|
-
payment_amount: number | string;
|
|
2326
|
-
|
|
2327
|
-
recipients: string;
|
|
2328
|
-
|
|
2329
|
-
/**
|
|
2330
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
2331
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
2332
|
-
* back to synchronous execution.
|
|
2333
|
-
*/
|
|
2334
|
-
run_id?: string | null;
|
|
2335
|
-
}
|
|
2336
|
-
}
|
|
2337
|
-
|
|
2338
|
-
export interface RunQueryActionRequest {
|
|
2339
|
-
action_type: 'run_query';
|
|
2340
|
-
|
|
2341
|
-
payload: RunQueryActionRequest.Payload;
|
|
2342
|
-
|
|
2343
|
-
workflow_definition_id: string;
|
|
2344
|
-
}
|
|
34
|
+
workflow_definition_id: string;
|
|
35
|
+
}
|
|
2345
36
|
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
37
|
+
export namespace WorkflowActionExecutionCreateParams {
|
|
38
|
+
export interface Payload {
|
|
39
|
+
query: string;
|
|
2349
40
|
|
|
2350
|
-
|
|
2351
|
-
}
|
|
41
|
+
product_name?: string | null;
|
|
2352
42
|
}
|
|
2353
43
|
}
|
|
2354
44
|
|