@rippling/rippling-sdk 0.2.0-alpha.30 → 0.2.0-alpha.32
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 +6 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +6 -0
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +6 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/earnings-inputs.d.mts +71 -0
- package/resources/earnings-inputs.d.mts.map +1 -0
- package/resources/earnings-inputs.d.ts +71 -0
- package/resources/earnings-inputs.d.ts.map +1 -0
- package/resources/earnings-inputs.js +21 -0
- package/resources/earnings-inputs.js.map +1 -0
- package/resources/earnings-inputs.mjs +17 -0
- package/resources/earnings-inputs.mjs.map +1 -0
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +4 -2
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/job-codes.d.mts +20 -0
- package/resources/job-codes.d.mts.map +1 -1
- package/resources/job-codes.d.ts +20 -0
- package/resources/job-codes.d.ts.map +1 -1
- package/resources/workflow-action-executions.d.mts +861 -32
- package/resources/workflow-action-executions.d.mts.map +1 -1
- package/resources/workflow-action-executions.d.ts +861 -32
- package/resources/workflow-action-executions.d.ts.map +1 -1
- package/src/client.ts +16 -0
- package/src/resources/earnings-inputs.ts +93 -0
- package/src/resources/index.ts +5 -0
- package/src/resources/job-codes.ts +24 -0
- package/src/resources/workflow-action-executions.ts +1145 -31
- 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
|
@@ -43,7 +43,12 @@ export interface WorkflowActionExecutionCreateParams {
|
|
|
43
43
|
| 'send_teams'
|
|
44
44
|
| 'assign_review'
|
|
45
45
|
| 'send_report_sftp'
|
|
46
|
-
| 'run_query'
|
|
46
|
+
| 'run_query'
|
|
47
|
+
| 'enroll_into_course'
|
|
48
|
+
| 'enroll_into_learning_path'
|
|
49
|
+
| 'report_email'
|
|
50
|
+
| 'send_document'
|
|
51
|
+
| 'accrue_leave';
|
|
47
52
|
|
|
48
53
|
/**
|
|
49
54
|
* An action that sends an email.
|
|
@@ -84,6 +89,19 @@ export interface WorkflowActionExecutionCreateParams {
|
|
|
84
89
|
| WorkflowActionExecutionCreateParams.SendReportSftpPasswordCsvPayload
|
|
85
90
|
| WorkflowActionExecutionCreateParams.SendReportSftpSSHKeyExcelPayload
|
|
86
91
|
| WorkflowActionExecutionCreateParams.SendReportSftpSSHKeyCsvPayload
|
|
92
|
+
| WorkflowActionExecutionCreateParams.EnrollIntoCourse1WeekPayload
|
|
93
|
+
| WorkflowActionExecutionCreateParams.EnrollIntoCourse2WeeksPayload
|
|
94
|
+
| WorkflowActionExecutionCreateParams.EnrollIntoCourse1MonthPayload
|
|
95
|
+
| WorkflowActionExecutionCreateParams.EnrollIntoCourse3MonthsPayload
|
|
96
|
+
| WorkflowActionExecutionCreateParams.EnrollIntoCourse6MonthsPayload
|
|
97
|
+
| WorkflowActionExecutionCreateParams.EnrollIntoCourse12MonthsPayload
|
|
98
|
+
| WorkflowActionExecutionCreateParams.EnrollIntoCourseCustomPayload
|
|
99
|
+
| WorkflowActionExecutionCreateParams.EnrollIntoLearningPathPayload
|
|
100
|
+
| WorkflowActionExecutionCreateParams.SendReportEmailExcelPayload
|
|
101
|
+
| WorkflowActionExecutionCreateParams.SendReportEmailCsvPayload
|
|
102
|
+
| WorkflowActionExecutionCreateParams.SendDocumentPayload
|
|
103
|
+
| WorkflowActionExecutionCreateParams.AccrueLeaveLeavePolicyPayload
|
|
104
|
+
| WorkflowActionExecutionCreateParams.AccrueLeaveCompanyLeaveTypePayload
|
|
87
105
|
| WorkflowActionExecutionCreateParams.RunQueryPayload;
|
|
88
106
|
|
|
89
107
|
workflow_definition_id?: string;
|
|
@@ -96,15 +114,133 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
96
114
|
* docs</helpdocslink>
|
|
97
115
|
*/
|
|
98
116
|
export interface SendEmailPayload {
|
|
117
|
+
/**
|
|
118
|
+
* Email mode
|
|
119
|
+
*/
|
|
99
120
|
action_type: 'INDIVIDUAL_EMAILS' | 'GROUP_EMAIL';
|
|
100
121
|
|
|
101
122
|
body: string;
|
|
102
123
|
|
|
103
|
-
send_to:
|
|
124
|
+
send_to: SendEmailPayload.SendTo;
|
|
104
125
|
|
|
105
126
|
subject: string;
|
|
106
127
|
|
|
107
|
-
|
|
128
|
+
/**
|
|
129
|
+
* Maximum total attachment size: 20MB
|
|
130
|
+
*/
|
|
131
|
+
attachments?: Array<SendEmailPayload.Attachment> | null;
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
export namespace SendEmailPayload {
|
|
135
|
+
export interface SendTo {
|
|
136
|
+
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
137
|
+
|
|
138
|
+
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
139
|
+
|
|
140
|
+
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
export namespace SendTo {
|
|
144
|
+
export interface Recipient1 {
|
|
145
|
+
supergroup: Array<string>;
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Email type
|
|
149
|
+
*/
|
|
150
|
+
emailType?:
|
|
151
|
+
| 'work_or_personal_email'
|
|
152
|
+
| 'work_email_only'
|
|
153
|
+
| 'personal_email_only'
|
|
154
|
+
| 'work_and_personal_email'
|
|
155
|
+
| null;
|
|
156
|
+
|
|
157
|
+
externalEmails?: Array<string> | null;
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
export interface Recipient2 {
|
|
161
|
+
externalEmails: Array<string>;
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* Email type
|
|
165
|
+
*/
|
|
166
|
+
emailType?:
|
|
167
|
+
| 'work_or_personal_email'
|
|
168
|
+
| 'work_email_only'
|
|
169
|
+
| 'personal_email_only'
|
|
170
|
+
| 'work_and_personal_email'
|
|
171
|
+
| null;
|
|
172
|
+
|
|
173
|
+
supergroup?: Array<string> | null;
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
export interface Recipient1 {
|
|
177
|
+
supergroup: Array<string>;
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* Email type
|
|
181
|
+
*/
|
|
182
|
+
emailType?:
|
|
183
|
+
| 'work_or_personal_email'
|
|
184
|
+
| 'work_email_only'
|
|
185
|
+
| 'personal_email_only'
|
|
186
|
+
| 'work_and_personal_email'
|
|
187
|
+
| null;
|
|
188
|
+
|
|
189
|
+
externalEmails?: Array<string> | null;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
export interface Recipient2 {
|
|
193
|
+
externalEmails: Array<string>;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* Email type
|
|
197
|
+
*/
|
|
198
|
+
emailType?:
|
|
199
|
+
| 'work_or_personal_email'
|
|
200
|
+
| 'work_email_only'
|
|
201
|
+
| 'personal_email_only'
|
|
202
|
+
| 'work_and_personal_email'
|
|
203
|
+
| null;
|
|
204
|
+
|
|
205
|
+
supergroup?: Array<string> | null;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
export interface Recipient1 {
|
|
209
|
+
supergroup: Array<string>;
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Email type
|
|
213
|
+
*/
|
|
214
|
+
emailType?:
|
|
215
|
+
| 'work_or_personal_email'
|
|
216
|
+
| 'work_email_only'
|
|
217
|
+
| 'personal_email_only'
|
|
218
|
+
| 'work_and_personal_email'
|
|
219
|
+
| null;
|
|
220
|
+
|
|
221
|
+
externalEmails?: Array<string> | null;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
export interface Recipient2 {
|
|
225
|
+
externalEmails: Array<string>;
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* Email type
|
|
229
|
+
*/
|
|
230
|
+
emailType?:
|
|
231
|
+
| 'work_or_personal_email'
|
|
232
|
+
| 'work_email_only'
|
|
233
|
+
| 'personal_email_only'
|
|
234
|
+
| 'work_and_personal_email'
|
|
235
|
+
| null;
|
|
236
|
+
|
|
237
|
+
supergroup?: Array<string> | null;
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
export interface Attachment {
|
|
242
|
+
fileName: string;
|
|
243
|
+
}
|
|
108
244
|
}
|
|
109
245
|
|
|
110
246
|
/**
|
|
@@ -115,6 +251,11 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
115
251
|
export interface SendSlackSingleDirectMessagePayload {
|
|
116
252
|
action_type: 'SINGLE_DIRECT_MESSAGE';
|
|
117
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
|
+
*/
|
|
118
259
|
body: string;
|
|
119
260
|
|
|
120
261
|
recipients: Array<string>;
|
|
@@ -128,6 +269,11 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
128
269
|
export interface SendSlackGroupDirectMessagePayload {
|
|
129
270
|
action_type: 'GROUP_DIRECT_MESSAGE';
|
|
130
271
|
|
|
272
|
+
/**
|
|
273
|
+
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
274
|
+
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
275
|
+
* markup options</a>
|
|
276
|
+
*/
|
|
131
277
|
body: string;
|
|
132
278
|
|
|
133
279
|
recipients: Array<string>;
|
|
@@ -141,6 +287,11 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
141
287
|
export interface SendSlackPublicChannelMessagePayload {
|
|
142
288
|
action_type: 'PUBLIC_CHANNEL_MESSAGE';
|
|
143
289
|
|
|
290
|
+
/**
|
|
291
|
+
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
292
|
+
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
293
|
+
* markup options</a>
|
|
294
|
+
*/
|
|
144
295
|
body: string;
|
|
145
296
|
|
|
146
297
|
channel: string;
|
|
@@ -154,6 +305,11 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
154
305
|
export interface SendSlackPrivateChannelMessagePayload {
|
|
155
306
|
action_type: 'PRIVATE_CHANNEL_MESSAGE';
|
|
156
307
|
|
|
308
|
+
/**
|
|
309
|
+
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
310
|
+
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
311
|
+
* markup options</a>
|
|
312
|
+
*/
|
|
157
313
|
body: string;
|
|
158
314
|
|
|
159
315
|
channel: string;
|
|
@@ -171,7 +327,17 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
171
327
|
|
|
172
328
|
subject: string;
|
|
173
329
|
|
|
174
|
-
dueDate?:
|
|
330
|
+
dueDate?: CreateAppNotificationPayload.DueDate | CreateAppNotificationPayload.DueDate1 | null;
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
export namespace CreateAppNotificationPayload {
|
|
334
|
+
export interface DueDate {
|
|
335
|
+
date: string;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
export interface DueDate1 {
|
|
339
|
+
daysFromNow: number;
|
|
340
|
+
}
|
|
175
341
|
}
|
|
176
342
|
|
|
177
343
|
/**
|
|
@@ -180,6 +346,9 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
180
346
|
* docs</helpdocslink>
|
|
181
347
|
*/
|
|
182
348
|
export interface SendSMSPayload {
|
|
349
|
+
/**
|
|
350
|
+
* Maximum characters: 500
|
|
351
|
+
*/
|
|
183
352
|
message: string;
|
|
184
353
|
|
|
185
354
|
recipients: Array<string>;
|
|
@@ -192,8 +361,14 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
192
361
|
* docs</helpdocslink>
|
|
193
362
|
*/
|
|
194
363
|
export interface SendPushNotificationPayload {
|
|
364
|
+
/**
|
|
365
|
+
* Maximum character count: 65
|
|
366
|
+
*/
|
|
195
367
|
header: string;
|
|
196
368
|
|
|
369
|
+
/**
|
|
370
|
+
* In many devices, your description will be truncated after 178 characters.
|
|
371
|
+
*/
|
|
197
372
|
message: string;
|
|
198
373
|
|
|
199
374
|
recipients: Array<string>;
|
|
@@ -209,15 +384,18 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
209
384
|
export interface SendHTTPRequestPayload {
|
|
210
385
|
url: string;
|
|
211
386
|
|
|
212
|
-
customHTTPHeaders?:
|
|
387
|
+
customHTTPHeaders?: { [key: string]: string } | null;
|
|
213
388
|
|
|
214
389
|
expectedResponseSchema?: unknown | null;
|
|
215
390
|
|
|
391
|
+
/**
|
|
392
|
+
* HTTP method
|
|
393
|
+
*/
|
|
216
394
|
method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | null;
|
|
217
395
|
|
|
218
396
|
payload?: unknown | null;
|
|
219
397
|
|
|
220
|
-
queryParams?:
|
|
398
|
+
queryParams?: { [key: string]: string } | null;
|
|
221
399
|
}
|
|
222
400
|
|
|
223
401
|
/**
|
|
@@ -267,11 +445,20 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
267
445
|
export interface EvaluateRqlQueryPayload {
|
|
268
446
|
queryType: 'QUERY';
|
|
269
447
|
|
|
448
|
+
/**
|
|
449
|
+
* Data type
|
|
450
|
+
*/
|
|
270
451
|
dataType?: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'OBJECT_ID' | 'DATE' | 'DATETIME' | null;
|
|
271
452
|
|
|
272
453
|
isAList?: boolean | null;
|
|
273
454
|
|
|
274
|
-
rqlFormula?:
|
|
455
|
+
rqlFormula?: EvaluateRqlQueryPayload.RqlFormula | null;
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
export namespace EvaluateRqlQueryPayload {
|
|
459
|
+
export interface RqlFormula {
|
|
460
|
+
rqlFormula?: string | null;
|
|
461
|
+
}
|
|
275
462
|
}
|
|
276
463
|
|
|
277
464
|
/**
|
|
@@ -303,7 +490,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
303
490
|
|
|
304
491
|
description: string;
|
|
305
492
|
|
|
306
|
-
end:
|
|
493
|
+
end: CreateGcalEventWorkflowOwnerNullPayload.End;
|
|
307
494
|
|
|
308
495
|
organizer_type: 'WORKFLOW_OWNER';
|
|
309
496
|
|
|
@@ -311,7 +498,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
311
498
|
|
|
312
499
|
spoke_owner: string;
|
|
313
500
|
|
|
314
|
-
start:
|
|
501
|
+
start: CreateGcalEventWorkflowOwnerNullPayload.Start;
|
|
315
502
|
|
|
316
503
|
timezone: string;
|
|
317
504
|
|
|
@@ -325,11 +512,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
325
512
|
|
|
326
513
|
guestsCanSeeOtherGuests?: boolean | null;
|
|
327
514
|
|
|
515
|
+
/**
|
|
516
|
+
* Show me as
|
|
517
|
+
*/
|
|
328
518
|
transparency?: 'opaque' | 'transparent' | null;
|
|
329
519
|
|
|
520
|
+
/**
|
|
521
|
+
* Calendar Visibility
|
|
522
|
+
*/
|
|
330
523
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
331
524
|
}
|
|
332
525
|
|
|
526
|
+
export namespace CreateGcalEventWorkflowOwnerNullPayload {
|
|
527
|
+
export interface End {
|
|
528
|
+
date: string;
|
|
529
|
+
|
|
530
|
+
time: string;
|
|
531
|
+
}
|
|
532
|
+
|
|
533
|
+
export interface Start {
|
|
534
|
+
date: string;
|
|
535
|
+
|
|
536
|
+
time: string;
|
|
537
|
+
}
|
|
538
|
+
}
|
|
539
|
+
|
|
333
540
|
/**
|
|
334
541
|
* This action will create a Google Calendar event with the specified organizer and
|
|
335
542
|
* attendees
|
|
@@ -341,7 +548,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
341
548
|
|
|
342
549
|
description: string;
|
|
343
550
|
|
|
344
|
-
end:
|
|
551
|
+
end: CreateGcalEventWorkflowOwnerDailyPayload.End;
|
|
345
552
|
|
|
346
553
|
organizer_type: 'WORKFLOW_OWNER';
|
|
347
554
|
|
|
@@ -349,7 +556,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
349
556
|
|
|
350
557
|
spoke_owner: string;
|
|
351
558
|
|
|
352
|
-
start:
|
|
559
|
+
start: CreateGcalEventWorkflowOwnerDailyPayload.Start;
|
|
353
560
|
|
|
354
561
|
timezone: string;
|
|
355
562
|
|
|
@@ -365,11 +572,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
365
572
|
|
|
366
573
|
recurrence_has_end?: boolean | null;
|
|
367
574
|
|
|
575
|
+
/**
|
|
576
|
+
* Show me as
|
|
577
|
+
*/
|
|
368
578
|
transparency?: 'opaque' | 'transparent' | null;
|
|
369
579
|
|
|
580
|
+
/**
|
|
581
|
+
* Calendar Visibility
|
|
582
|
+
*/
|
|
370
583
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
371
584
|
}
|
|
372
585
|
|
|
586
|
+
export namespace CreateGcalEventWorkflowOwnerDailyPayload {
|
|
587
|
+
export interface End {
|
|
588
|
+
date: string;
|
|
589
|
+
|
|
590
|
+
time: string;
|
|
591
|
+
}
|
|
592
|
+
|
|
593
|
+
export interface Start {
|
|
594
|
+
date: string;
|
|
595
|
+
|
|
596
|
+
time: string;
|
|
597
|
+
}
|
|
598
|
+
}
|
|
599
|
+
|
|
373
600
|
/**
|
|
374
601
|
* This action will create a Google Calendar event with the specified organizer and
|
|
375
602
|
* attendees
|
|
@@ -381,7 +608,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
381
608
|
|
|
382
609
|
description: string;
|
|
383
610
|
|
|
384
|
-
end:
|
|
611
|
+
end: CreateGcalEventWorkflowOwnerWeeklyPayload.End;
|
|
385
612
|
|
|
386
613
|
organizer_type: 'WORKFLOW_OWNER';
|
|
387
614
|
|
|
@@ -389,7 +616,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
389
616
|
|
|
390
617
|
spoke_owner: string;
|
|
391
618
|
|
|
392
|
-
start:
|
|
619
|
+
start: CreateGcalEventWorkflowOwnerWeeklyPayload.Start;
|
|
393
620
|
|
|
394
621
|
timezone: string;
|
|
395
622
|
|
|
@@ -405,11 +632,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
405
632
|
|
|
406
633
|
recurrence_has_end?: boolean | null;
|
|
407
634
|
|
|
635
|
+
/**
|
|
636
|
+
* Show me as
|
|
637
|
+
*/
|
|
408
638
|
transparency?: 'opaque' | 'transparent' | null;
|
|
409
639
|
|
|
640
|
+
/**
|
|
641
|
+
* Calendar Visibility
|
|
642
|
+
*/
|
|
410
643
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
411
644
|
}
|
|
412
645
|
|
|
646
|
+
export namespace CreateGcalEventWorkflowOwnerWeeklyPayload {
|
|
647
|
+
export interface End {
|
|
648
|
+
date: string;
|
|
649
|
+
|
|
650
|
+
time: string;
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
export interface Start {
|
|
654
|
+
date: string;
|
|
655
|
+
|
|
656
|
+
time: string;
|
|
657
|
+
}
|
|
658
|
+
}
|
|
659
|
+
|
|
413
660
|
/**
|
|
414
661
|
* This action will create a Google Calendar event with the specified organizer and
|
|
415
662
|
* attendees
|
|
@@ -421,7 +668,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
421
668
|
|
|
422
669
|
description: string;
|
|
423
670
|
|
|
424
|
-
end:
|
|
671
|
+
end: CreateGcalEventWorkflowOwnerMonthlyPayload.End;
|
|
425
672
|
|
|
426
673
|
organizer_type: 'WORKFLOW_OWNER';
|
|
427
674
|
|
|
@@ -429,7 +676,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
429
676
|
|
|
430
677
|
spoke_owner: string;
|
|
431
678
|
|
|
432
|
-
start:
|
|
679
|
+
start: CreateGcalEventWorkflowOwnerMonthlyPayload.Start;
|
|
433
680
|
|
|
434
681
|
timezone: string;
|
|
435
682
|
|
|
@@ -445,11 +692,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
445
692
|
|
|
446
693
|
recurrence_has_end?: boolean | null;
|
|
447
694
|
|
|
695
|
+
/**
|
|
696
|
+
* Show me as
|
|
697
|
+
*/
|
|
448
698
|
transparency?: 'opaque' | 'transparent' | null;
|
|
449
699
|
|
|
700
|
+
/**
|
|
701
|
+
* Calendar Visibility
|
|
702
|
+
*/
|
|
450
703
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
451
704
|
}
|
|
452
705
|
|
|
706
|
+
export namespace CreateGcalEventWorkflowOwnerMonthlyPayload {
|
|
707
|
+
export interface End {
|
|
708
|
+
date: string;
|
|
709
|
+
|
|
710
|
+
time: string;
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
export interface Start {
|
|
714
|
+
date: string;
|
|
715
|
+
|
|
716
|
+
time: string;
|
|
717
|
+
}
|
|
718
|
+
}
|
|
719
|
+
|
|
453
720
|
/**
|
|
454
721
|
* This action will create a Google Calendar event with the specified organizer and
|
|
455
722
|
* attendees
|
|
@@ -461,7 +728,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
461
728
|
|
|
462
729
|
description: string;
|
|
463
730
|
|
|
464
|
-
end:
|
|
731
|
+
end: CreateGcalEventWorkflowOwnerYearlyPayload.End;
|
|
465
732
|
|
|
466
733
|
organizer_type: 'WORKFLOW_OWNER';
|
|
467
734
|
|
|
@@ -469,7 +736,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
469
736
|
|
|
470
737
|
spoke_owner: string;
|
|
471
738
|
|
|
472
|
-
start:
|
|
739
|
+
start: CreateGcalEventWorkflowOwnerYearlyPayload.Start;
|
|
473
740
|
|
|
474
741
|
timezone: string;
|
|
475
742
|
|
|
@@ -485,11 +752,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
485
752
|
|
|
486
753
|
recurrence_has_end?: boolean | null;
|
|
487
754
|
|
|
755
|
+
/**
|
|
756
|
+
* Show me as
|
|
757
|
+
*/
|
|
488
758
|
transparency?: 'opaque' | 'transparent' | null;
|
|
489
759
|
|
|
760
|
+
/**
|
|
761
|
+
* Calendar Visibility
|
|
762
|
+
*/
|
|
490
763
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
491
764
|
}
|
|
492
765
|
|
|
766
|
+
export namespace CreateGcalEventWorkflowOwnerYearlyPayload {
|
|
767
|
+
export interface End {
|
|
768
|
+
date: string;
|
|
769
|
+
|
|
770
|
+
time: string;
|
|
771
|
+
}
|
|
772
|
+
|
|
773
|
+
export interface Start {
|
|
774
|
+
date: string;
|
|
775
|
+
|
|
776
|
+
time: string;
|
|
777
|
+
}
|
|
778
|
+
}
|
|
779
|
+
|
|
493
780
|
/**
|
|
494
781
|
* This action will create a Google Calendar event with the specified organizer and
|
|
495
782
|
* attendees
|
|
@@ -501,7 +788,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
501
788
|
|
|
502
789
|
description: string;
|
|
503
790
|
|
|
504
|
-
end:
|
|
791
|
+
end: CreateGcalEventSupergroupNullPayload.End;
|
|
505
792
|
|
|
506
793
|
organizer: Array<string>;
|
|
507
794
|
|
|
@@ -511,7 +798,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
511
798
|
|
|
512
799
|
spoke_owner: string;
|
|
513
800
|
|
|
514
|
-
start:
|
|
801
|
+
start: CreateGcalEventSupergroupNullPayload.Start;
|
|
515
802
|
|
|
516
803
|
timezone: string;
|
|
517
804
|
|
|
@@ -525,11 +812,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
525
812
|
|
|
526
813
|
guestsCanSeeOtherGuests?: boolean | null;
|
|
527
814
|
|
|
815
|
+
/**
|
|
816
|
+
* Show me as
|
|
817
|
+
*/
|
|
528
818
|
transparency?: 'opaque' | 'transparent' | null;
|
|
529
819
|
|
|
820
|
+
/**
|
|
821
|
+
* Calendar Visibility
|
|
822
|
+
*/
|
|
530
823
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
531
824
|
}
|
|
532
825
|
|
|
826
|
+
export namespace CreateGcalEventSupergroupNullPayload {
|
|
827
|
+
export interface End {
|
|
828
|
+
date: string;
|
|
829
|
+
|
|
830
|
+
time: string;
|
|
831
|
+
}
|
|
832
|
+
|
|
833
|
+
export interface Start {
|
|
834
|
+
date: string;
|
|
835
|
+
|
|
836
|
+
time: string;
|
|
837
|
+
}
|
|
838
|
+
}
|
|
839
|
+
|
|
533
840
|
/**
|
|
534
841
|
* This action will create a Google Calendar event with the specified organizer and
|
|
535
842
|
* attendees
|
|
@@ -541,7 +848,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
541
848
|
|
|
542
849
|
description: string;
|
|
543
850
|
|
|
544
|
-
end:
|
|
851
|
+
end: CreateGcalEventSupergroupDailyPayload.End;
|
|
545
852
|
|
|
546
853
|
organizer: Array<string>;
|
|
547
854
|
|
|
@@ -551,7 +858,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
551
858
|
|
|
552
859
|
spoke_owner: string;
|
|
553
860
|
|
|
554
|
-
start:
|
|
861
|
+
start: CreateGcalEventSupergroupDailyPayload.Start;
|
|
555
862
|
|
|
556
863
|
timezone: string;
|
|
557
864
|
|
|
@@ -567,11 +874,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
567
874
|
|
|
568
875
|
recurrence_has_end?: boolean | null;
|
|
569
876
|
|
|
877
|
+
/**
|
|
878
|
+
* Show me as
|
|
879
|
+
*/
|
|
570
880
|
transparency?: 'opaque' | 'transparent' | null;
|
|
571
881
|
|
|
882
|
+
/**
|
|
883
|
+
* Calendar Visibility
|
|
884
|
+
*/
|
|
572
885
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
573
886
|
}
|
|
574
887
|
|
|
888
|
+
export namespace CreateGcalEventSupergroupDailyPayload {
|
|
889
|
+
export interface End {
|
|
890
|
+
date: string;
|
|
891
|
+
|
|
892
|
+
time: string;
|
|
893
|
+
}
|
|
894
|
+
|
|
895
|
+
export interface Start {
|
|
896
|
+
date: string;
|
|
897
|
+
|
|
898
|
+
time: string;
|
|
899
|
+
}
|
|
900
|
+
}
|
|
901
|
+
|
|
575
902
|
/**
|
|
576
903
|
* This action will create a Google Calendar event with the specified organizer and
|
|
577
904
|
* attendees
|
|
@@ -583,7 +910,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
583
910
|
|
|
584
911
|
description: string;
|
|
585
912
|
|
|
586
|
-
end:
|
|
913
|
+
end: CreateGcalEventSupergroupWeeklyPayload.End;
|
|
587
914
|
|
|
588
915
|
organizer: Array<string>;
|
|
589
916
|
|
|
@@ -593,7 +920,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
593
920
|
|
|
594
921
|
spoke_owner: string;
|
|
595
922
|
|
|
596
|
-
start:
|
|
923
|
+
start: CreateGcalEventSupergroupWeeklyPayload.Start;
|
|
597
924
|
|
|
598
925
|
timezone: string;
|
|
599
926
|
|
|
@@ -609,11 +936,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
609
936
|
|
|
610
937
|
recurrence_has_end?: boolean | null;
|
|
611
938
|
|
|
939
|
+
/**
|
|
940
|
+
* Show me as
|
|
941
|
+
*/
|
|
612
942
|
transparency?: 'opaque' | 'transparent' | null;
|
|
613
943
|
|
|
944
|
+
/**
|
|
945
|
+
* Calendar Visibility
|
|
946
|
+
*/
|
|
614
947
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
615
948
|
}
|
|
616
949
|
|
|
950
|
+
export namespace CreateGcalEventSupergroupWeeklyPayload {
|
|
951
|
+
export interface End {
|
|
952
|
+
date: string;
|
|
953
|
+
|
|
954
|
+
time: string;
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
export interface Start {
|
|
958
|
+
date: string;
|
|
959
|
+
|
|
960
|
+
time: string;
|
|
961
|
+
}
|
|
962
|
+
}
|
|
963
|
+
|
|
617
964
|
/**
|
|
618
965
|
* This action will create a Google Calendar event with the specified organizer and
|
|
619
966
|
* attendees
|
|
@@ -625,7 +972,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
625
972
|
|
|
626
973
|
description: string;
|
|
627
974
|
|
|
628
|
-
end:
|
|
975
|
+
end: CreateGcalEventSupergroupMonthlyPayload.End;
|
|
629
976
|
|
|
630
977
|
organizer: Array<string>;
|
|
631
978
|
|
|
@@ -635,7 +982,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
635
982
|
|
|
636
983
|
spoke_owner: string;
|
|
637
984
|
|
|
638
|
-
start:
|
|
985
|
+
start: CreateGcalEventSupergroupMonthlyPayload.Start;
|
|
639
986
|
|
|
640
987
|
timezone: string;
|
|
641
988
|
|
|
@@ -651,11 +998,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
651
998
|
|
|
652
999
|
recurrence_has_end?: boolean | null;
|
|
653
1000
|
|
|
1001
|
+
/**
|
|
1002
|
+
* Show me as
|
|
1003
|
+
*/
|
|
654
1004
|
transparency?: 'opaque' | 'transparent' | null;
|
|
655
1005
|
|
|
1006
|
+
/**
|
|
1007
|
+
* Calendar Visibility
|
|
1008
|
+
*/
|
|
656
1009
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
657
1010
|
}
|
|
658
1011
|
|
|
1012
|
+
export namespace CreateGcalEventSupergroupMonthlyPayload {
|
|
1013
|
+
export interface End {
|
|
1014
|
+
date: string;
|
|
1015
|
+
|
|
1016
|
+
time: string;
|
|
1017
|
+
}
|
|
1018
|
+
|
|
1019
|
+
export interface Start {
|
|
1020
|
+
date: string;
|
|
1021
|
+
|
|
1022
|
+
time: string;
|
|
1023
|
+
}
|
|
1024
|
+
}
|
|
1025
|
+
|
|
659
1026
|
/**
|
|
660
1027
|
* This action will create a Google Calendar event with the specified organizer and
|
|
661
1028
|
* attendees
|
|
@@ -667,7 +1034,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
667
1034
|
|
|
668
1035
|
description: string;
|
|
669
1036
|
|
|
670
|
-
end:
|
|
1037
|
+
end: CreateGcalEventSupergroupYearlyPayload.End;
|
|
671
1038
|
|
|
672
1039
|
organizer: Array<string>;
|
|
673
1040
|
|
|
@@ -677,7 +1044,7 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
677
1044
|
|
|
678
1045
|
spoke_owner: string;
|
|
679
1046
|
|
|
680
|
-
start:
|
|
1047
|
+
start: CreateGcalEventSupergroupYearlyPayload.Start;
|
|
681
1048
|
|
|
682
1049
|
timezone: string;
|
|
683
1050
|
|
|
@@ -693,11 +1060,31 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
693
1060
|
|
|
694
1061
|
recurrence_has_end?: boolean | null;
|
|
695
1062
|
|
|
1063
|
+
/**
|
|
1064
|
+
* Show me as
|
|
1065
|
+
*/
|
|
696
1066
|
transparency?: 'opaque' | 'transparent' | null;
|
|
697
1067
|
|
|
1068
|
+
/**
|
|
1069
|
+
* Calendar Visibility
|
|
1070
|
+
*/
|
|
698
1071
|
visibility?: 'default' | 'public' | 'private' | null;
|
|
699
1072
|
}
|
|
700
1073
|
|
|
1074
|
+
export namespace CreateGcalEventSupergroupYearlyPayload {
|
|
1075
|
+
export interface End {
|
|
1076
|
+
date: string;
|
|
1077
|
+
|
|
1078
|
+
time: string;
|
|
1079
|
+
}
|
|
1080
|
+
|
|
1081
|
+
export interface Start {
|
|
1082
|
+
date: string;
|
|
1083
|
+
|
|
1084
|
+
time: string;
|
|
1085
|
+
}
|
|
1086
|
+
}
|
|
1087
|
+
|
|
701
1088
|
/**
|
|
702
1089
|
* An action that sends a teams message
|
|
703
1090
|
* <helpdocslink href='https://help.rippling.com/article?articleId=558988438231'>Help
|
|
@@ -736,6 +1123,9 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
736
1123
|
|
|
737
1124
|
reviewees: Array<string>;
|
|
738
1125
|
|
|
1126
|
+
/**
|
|
1127
|
+
* Maximum reviewees: 500
|
|
1128
|
+
*/
|
|
739
1129
|
reviewers: Array<string>;
|
|
740
1130
|
}
|
|
741
1131
|
|
|
@@ -751,6 +1141,9 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
751
1141
|
|
|
752
1142
|
reviewees: Array<string>;
|
|
753
1143
|
|
|
1144
|
+
/**
|
|
1145
|
+
* Maximum reviewees: 500
|
|
1146
|
+
*/
|
|
754
1147
|
reviewers: Array<string>;
|
|
755
1148
|
}
|
|
756
1149
|
|
|
@@ -763,32 +1156,63 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
763
1156
|
export interface SendReportSftpPasswordExcelPayload {
|
|
764
1157
|
authentication_type: 'PASSWORD';
|
|
765
1158
|
|
|
1159
|
+
/**
|
|
1160
|
+
* Specify the full path where the file should be stored on the remote server,
|
|
1161
|
+
* starting from the root directory. Example: /rippling-workflows
|
|
1162
|
+
*/
|
|
766
1163
|
file_path: string;
|
|
767
1164
|
|
|
768
1165
|
file_type: 'EXCEL';
|
|
769
1166
|
|
|
1167
|
+
/**
|
|
1168
|
+
* sftp://username@[hostname]
|
|
1169
|
+
*/
|
|
770
1170
|
host_name: string;
|
|
771
1171
|
|
|
1172
|
+
/**
|
|
1173
|
+
* Not all report types are supported in workflows, like change and trend reports
|
|
1174
|
+
*/
|
|
772
1175
|
report_id: string;
|
|
773
1176
|
|
|
1177
|
+
/**
|
|
1178
|
+
* sftp://[username]@hostname
|
|
1179
|
+
*/
|
|
774
1180
|
user_name: string;
|
|
775
1181
|
|
|
776
1182
|
add_role_referenced_id_column?: boolean | null;
|
|
777
1183
|
|
|
778
|
-
|
|
1184
|
+
/**
|
|
1185
|
+
* CSV quoting
|
|
1186
|
+
*/
|
|
1187
|
+
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
779
1188
|
|
|
1189
|
+
/**
|
|
1190
|
+
* Currency field formatting
|
|
1191
|
+
*/
|
|
780
1192
|
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
781
1193
|
|
|
1194
|
+
/**
|
|
1195
|
+
* Date & time formatting
|
|
1196
|
+
*/
|
|
782
1197
|
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
783
1198
|
|
|
1199
|
+
/**
|
|
1200
|
+
* Files will be automatically named if the file name is empty
|
|
1201
|
+
*/
|
|
784
1202
|
file_name?: string | null;
|
|
785
1203
|
|
|
1204
|
+
/**
|
|
1205
|
+
* File name suffix
|
|
1206
|
+
*/
|
|
786
1207
|
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
787
1208
|
|
|
788
1209
|
port?: number | null;
|
|
789
1210
|
|
|
790
1211
|
show_sub_totals?: boolean | null;
|
|
791
1212
|
|
|
1213
|
+
/**
|
|
1214
|
+
* Time zones
|
|
1215
|
+
*/
|
|
792
1216
|
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
793
1217
|
}
|
|
794
1218
|
|
|
@@ -801,34 +1225,68 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
801
1225
|
export interface SendReportSftpPasswordCsvPayload {
|
|
802
1226
|
authentication_type: 'PASSWORD';
|
|
803
1227
|
|
|
1228
|
+
/**
|
|
1229
|
+
* Specify the full path where the file should be stored on the remote server,
|
|
1230
|
+
* starting from the root directory. Example: /rippling-workflows
|
|
1231
|
+
*/
|
|
804
1232
|
file_path: string;
|
|
805
1233
|
|
|
806
1234
|
file_type: 'CSV';
|
|
807
1235
|
|
|
1236
|
+
/**
|
|
1237
|
+
* sftp://username@[hostname]
|
|
1238
|
+
*/
|
|
808
1239
|
host_name: string;
|
|
809
1240
|
|
|
1241
|
+
/**
|
|
1242
|
+
* Not all report types are supported in workflows, like change and trend reports
|
|
1243
|
+
*/
|
|
810
1244
|
report_id: string;
|
|
811
1245
|
|
|
1246
|
+
/**
|
|
1247
|
+
* sftp://[username]@hostname
|
|
1248
|
+
*/
|
|
812
1249
|
user_name: string;
|
|
813
1250
|
|
|
814
1251
|
add_role_referenced_id_column?: boolean | null;
|
|
815
1252
|
|
|
816
|
-
|
|
1253
|
+
/**
|
|
1254
|
+
* CSV quoting
|
|
1255
|
+
*/
|
|
1256
|
+
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
817
1257
|
|
|
1258
|
+
/**
|
|
1259
|
+
* Custom separator
|
|
1260
|
+
*/
|
|
818
1261
|
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
819
1262
|
|
|
1263
|
+
/**
|
|
1264
|
+
* Currency field formatting
|
|
1265
|
+
*/
|
|
820
1266
|
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
821
1267
|
|
|
1268
|
+
/**
|
|
1269
|
+
* Date & time formatting
|
|
1270
|
+
*/
|
|
822
1271
|
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
823
1272
|
|
|
1273
|
+
/**
|
|
1274
|
+
* Files will be automatically named if the file name is empty
|
|
1275
|
+
*/
|
|
824
1276
|
file_name?: string | null;
|
|
825
1277
|
|
|
1278
|
+
/**
|
|
1279
|
+
* File name suffix
|
|
1280
|
+
*/
|
|
826
1281
|
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
827
1282
|
|
|
828
1283
|
port?: number | null;
|
|
829
1284
|
|
|
830
1285
|
show_sub_totals?: boolean | null;
|
|
831
1286
|
|
|
1287
|
+
/**
|
|
1288
|
+
* Time zones
|
|
1289
|
+
*/
|
|
832
1290
|
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
833
1291
|
}
|
|
834
1292
|
|
|
@@ -841,32 +1299,63 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
841
1299
|
export interface SendReportSftpSSHKeyExcelPayload {
|
|
842
1300
|
authentication_type: 'SSH_KEY';
|
|
843
1301
|
|
|
1302
|
+
/**
|
|
1303
|
+
* Specify the full path where the file should be stored on the remote server,
|
|
1304
|
+
* starting from the root directory. Example: /rippling-workflows
|
|
1305
|
+
*/
|
|
844
1306
|
file_path: string;
|
|
845
1307
|
|
|
846
1308
|
file_type: 'EXCEL';
|
|
847
1309
|
|
|
1310
|
+
/**
|
|
1311
|
+
* sftp://username@[hostname]
|
|
1312
|
+
*/
|
|
848
1313
|
host_name: string;
|
|
849
1314
|
|
|
1315
|
+
/**
|
|
1316
|
+
* Not all report types are supported in workflows, like change and trend reports
|
|
1317
|
+
*/
|
|
850
1318
|
report_id: string;
|
|
851
1319
|
|
|
1320
|
+
/**
|
|
1321
|
+
* sftp://[username]@hostname
|
|
1322
|
+
*/
|
|
852
1323
|
user_name: string;
|
|
853
1324
|
|
|
854
1325
|
add_role_referenced_id_column?: boolean | null;
|
|
855
1326
|
|
|
856
|
-
|
|
1327
|
+
/**
|
|
1328
|
+
* CSV quoting
|
|
1329
|
+
*/
|
|
1330
|
+
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
857
1331
|
|
|
1332
|
+
/**
|
|
1333
|
+
* Currency field formatting
|
|
1334
|
+
*/
|
|
858
1335
|
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
859
1336
|
|
|
1337
|
+
/**
|
|
1338
|
+
* Date & time formatting
|
|
1339
|
+
*/
|
|
860
1340
|
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
861
1341
|
|
|
1342
|
+
/**
|
|
1343
|
+
* Files will be automatically named if the file name is empty
|
|
1344
|
+
*/
|
|
862
1345
|
file_name?: string | null;
|
|
863
1346
|
|
|
1347
|
+
/**
|
|
1348
|
+
* File name suffix
|
|
1349
|
+
*/
|
|
864
1350
|
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
865
1351
|
|
|
866
1352
|
port?: number | null;
|
|
867
1353
|
|
|
868
1354
|
show_sub_totals?: boolean | null;
|
|
869
1355
|
|
|
1356
|
+
/**
|
|
1357
|
+
* Time zones
|
|
1358
|
+
*/
|
|
870
1359
|
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
871
1360
|
}
|
|
872
1361
|
|
|
@@ -879,37 +1368,662 @@ export namespace WorkflowActionExecutionCreateParams {
|
|
|
879
1368
|
export interface SendReportSftpSSHKeyCsvPayload {
|
|
880
1369
|
authentication_type: 'SSH_KEY';
|
|
881
1370
|
|
|
1371
|
+
/**
|
|
1372
|
+
* Specify the full path where the file should be stored on the remote server,
|
|
1373
|
+
* starting from the root directory. Example: /rippling-workflows
|
|
1374
|
+
*/
|
|
882
1375
|
file_path: string;
|
|
883
1376
|
|
|
884
1377
|
file_type: 'CSV';
|
|
885
1378
|
|
|
1379
|
+
/**
|
|
1380
|
+
* sftp://username@[hostname]
|
|
1381
|
+
*/
|
|
886
1382
|
host_name: string;
|
|
887
1383
|
|
|
1384
|
+
/**
|
|
1385
|
+
* Not all report types are supported in workflows, like change and trend reports
|
|
1386
|
+
*/
|
|
888
1387
|
report_id: string;
|
|
889
1388
|
|
|
1389
|
+
/**
|
|
1390
|
+
* sftp://[username]@hostname
|
|
1391
|
+
*/
|
|
890
1392
|
user_name: string;
|
|
891
1393
|
|
|
892
1394
|
add_role_referenced_id_column?: boolean | null;
|
|
893
1395
|
|
|
894
|
-
|
|
1396
|
+
/**
|
|
1397
|
+
* CSV quoting
|
|
1398
|
+
*/
|
|
1399
|
+
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
895
1400
|
|
|
1401
|
+
/**
|
|
1402
|
+
* Custom separator
|
|
1403
|
+
*/
|
|
896
1404
|
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
897
1405
|
|
|
1406
|
+
/**
|
|
1407
|
+
* Currency field formatting
|
|
1408
|
+
*/
|
|
898
1409
|
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
899
1410
|
|
|
1411
|
+
/**
|
|
1412
|
+
* Date & time formatting
|
|
1413
|
+
*/
|
|
900
1414
|
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
901
1415
|
|
|
1416
|
+
/**
|
|
1417
|
+
* Files will be automatically named if the file name is empty
|
|
1418
|
+
*/
|
|
902
1419
|
file_name?: string | null;
|
|
903
1420
|
|
|
1421
|
+
/**
|
|
1422
|
+
* File name suffix
|
|
1423
|
+
*/
|
|
904
1424
|
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
905
1425
|
|
|
906
1426
|
port?: number | null;
|
|
907
1427
|
|
|
908
1428
|
show_sub_totals?: boolean | null;
|
|
909
1429
|
|
|
1430
|
+
/**
|
|
1431
|
+
* Time zones
|
|
1432
|
+
*/
|
|
1433
|
+
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1434
|
+
}
|
|
1435
|
+
|
|
1436
|
+
/**
|
|
1437
|
+
* Automatically enroll people into a course
|
|
1438
|
+
*/
|
|
1439
|
+
export interface EnrollIntoCourse1WeekPayload {
|
|
1440
|
+
/**
|
|
1441
|
+
* Select a course to enroll people in
|
|
1442
|
+
*/
|
|
1443
|
+
course_id: string;
|
|
1444
|
+
|
|
1445
|
+
due_date: '1_week';
|
|
1446
|
+
|
|
1447
|
+
/**
|
|
1448
|
+
* Select people to enroll in this course
|
|
1449
|
+
*/
|
|
1450
|
+
role_ids: Array<string>;
|
|
1451
|
+
|
|
1452
|
+
/**
|
|
1453
|
+
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1454
|
+
*/
|
|
1455
|
+
skip_if_certified?: boolean | null;
|
|
1456
|
+
}
|
|
1457
|
+
|
|
1458
|
+
/**
|
|
1459
|
+
* Automatically enroll people into a course
|
|
1460
|
+
*/
|
|
1461
|
+
export interface EnrollIntoCourse2WeeksPayload {
|
|
1462
|
+
/**
|
|
1463
|
+
* Select a course to enroll people in
|
|
1464
|
+
*/
|
|
1465
|
+
course_id: string;
|
|
1466
|
+
|
|
1467
|
+
due_date: '2_weeks';
|
|
1468
|
+
|
|
1469
|
+
/**
|
|
1470
|
+
* Select people to enroll in this course
|
|
1471
|
+
*/
|
|
1472
|
+
role_ids: Array<string>;
|
|
1473
|
+
|
|
1474
|
+
/**
|
|
1475
|
+
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1476
|
+
*/
|
|
1477
|
+
skip_if_certified?: boolean | null;
|
|
1478
|
+
}
|
|
1479
|
+
|
|
1480
|
+
/**
|
|
1481
|
+
* Automatically enroll people into a course
|
|
1482
|
+
*/
|
|
1483
|
+
export interface EnrollIntoCourse1MonthPayload {
|
|
1484
|
+
/**
|
|
1485
|
+
* Select a course to enroll people in
|
|
1486
|
+
*/
|
|
1487
|
+
course_id: string;
|
|
1488
|
+
|
|
1489
|
+
due_date: '1_month';
|
|
1490
|
+
|
|
1491
|
+
/**
|
|
1492
|
+
* Select people to enroll in this course
|
|
1493
|
+
*/
|
|
1494
|
+
role_ids: Array<string>;
|
|
1495
|
+
|
|
1496
|
+
/**
|
|
1497
|
+
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1498
|
+
*/
|
|
1499
|
+
skip_if_certified?: boolean | null;
|
|
1500
|
+
}
|
|
1501
|
+
|
|
1502
|
+
/**
|
|
1503
|
+
* Automatically enroll people into a course
|
|
1504
|
+
*/
|
|
1505
|
+
export interface EnrollIntoCourse3MonthsPayload {
|
|
1506
|
+
/**
|
|
1507
|
+
* Select a course to enroll people in
|
|
1508
|
+
*/
|
|
1509
|
+
course_id: string;
|
|
1510
|
+
|
|
1511
|
+
due_date: '3_months';
|
|
1512
|
+
|
|
1513
|
+
/**
|
|
1514
|
+
* Select people to enroll in this course
|
|
1515
|
+
*/
|
|
1516
|
+
role_ids: Array<string>;
|
|
1517
|
+
|
|
1518
|
+
/**
|
|
1519
|
+
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1520
|
+
*/
|
|
1521
|
+
skip_if_certified?: boolean | null;
|
|
1522
|
+
}
|
|
1523
|
+
|
|
1524
|
+
/**
|
|
1525
|
+
* Automatically enroll people into a course
|
|
1526
|
+
*/
|
|
1527
|
+
export interface EnrollIntoCourse6MonthsPayload {
|
|
1528
|
+
/**
|
|
1529
|
+
* Select a course to enroll people in
|
|
1530
|
+
*/
|
|
1531
|
+
course_id: string;
|
|
1532
|
+
|
|
1533
|
+
due_date: '6_months';
|
|
1534
|
+
|
|
1535
|
+
/**
|
|
1536
|
+
* Select people to enroll in this course
|
|
1537
|
+
*/
|
|
1538
|
+
role_ids: Array<string>;
|
|
1539
|
+
|
|
1540
|
+
/**
|
|
1541
|
+
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1542
|
+
*/
|
|
1543
|
+
skip_if_certified?: boolean | null;
|
|
1544
|
+
}
|
|
1545
|
+
|
|
1546
|
+
/**
|
|
1547
|
+
* Automatically enroll people into a course
|
|
1548
|
+
*/
|
|
1549
|
+
export interface EnrollIntoCourse12MonthsPayload {
|
|
1550
|
+
/**
|
|
1551
|
+
* Select a course to enroll people in
|
|
1552
|
+
*/
|
|
1553
|
+
course_id: string;
|
|
1554
|
+
|
|
1555
|
+
due_date: '12_months';
|
|
1556
|
+
|
|
1557
|
+
/**
|
|
1558
|
+
* Select people to enroll in this course
|
|
1559
|
+
*/
|
|
1560
|
+
role_ids: Array<string>;
|
|
1561
|
+
|
|
1562
|
+
/**
|
|
1563
|
+
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1564
|
+
*/
|
|
1565
|
+
skip_if_certified?: boolean | null;
|
|
1566
|
+
}
|
|
1567
|
+
|
|
1568
|
+
/**
|
|
1569
|
+
* Automatically enroll people into a course
|
|
1570
|
+
*/
|
|
1571
|
+
export interface EnrollIntoCourseCustomPayload {
|
|
1572
|
+
/**
|
|
1573
|
+
* Select a course to enroll people in
|
|
1574
|
+
*/
|
|
1575
|
+
course_id: string;
|
|
1576
|
+
|
|
1577
|
+
due_date: 'custom';
|
|
1578
|
+
|
|
1579
|
+
/**
|
|
1580
|
+
* Select people to enroll in this course
|
|
1581
|
+
*/
|
|
1582
|
+
role_ids: Array<string>;
|
|
1583
|
+
|
|
1584
|
+
/**
|
|
1585
|
+
* Time unit
|
|
1586
|
+
*/
|
|
1587
|
+
custom_due_duration?: 'day' | 'week' | 'month' | 'year' | null;
|
|
1588
|
+
|
|
1589
|
+
/**
|
|
1590
|
+
* Number of days/weeks/months/years
|
|
1591
|
+
*/
|
|
1592
|
+
custom_due_value?: number | null;
|
|
1593
|
+
|
|
1594
|
+
/**
|
|
1595
|
+
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1596
|
+
*/
|
|
1597
|
+
skip_if_certified?: boolean | null;
|
|
1598
|
+
}
|
|
1599
|
+
|
|
1600
|
+
/**
|
|
1601
|
+
* Automatically enroll people into a learning path
|
|
1602
|
+
*/
|
|
1603
|
+
export interface EnrollIntoLearningPathPayload {
|
|
1604
|
+
/**
|
|
1605
|
+
* Select a learning path to enroll people in
|
|
1606
|
+
*/
|
|
1607
|
+
learning_path_id: string;
|
|
1608
|
+
|
|
1609
|
+
/**
|
|
1610
|
+
* Select people to enroll in this learning path
|
|
1611
|
+
*/
|
|
1612
|
+
role_ids: Array<string>;
|
|
1613
|
+
|
|
1614
|
+
/**
|
|
1615
|
+
* Time unit
|
|
1616
|
+
*/
|
|
1617
|
+
custom_due_unit?: 'day' | 'week' | 'month' | 'year' | null;
|
|
1618
|
+
|
|
1619
|
+
/**
|
|
1620
|
+
* Number of days/weeks/months/years
|
|
1621
|
+
*/
|
|
1622
|
+
custom_due_value?: number | null;
|
|
1623
|
+
|
|
1624
|
+
/**
|
|
1625
|
+
* Number of days after completing one course before the next is due
|
|
1626
|
+
*/
|
|
1627
|
+
days_between_courses?: number | null;
|
|
1628
|
+
|
|
1629
|
+
/**
|
|
1630
|
+
* Due date type
|
|
1631
|
+
*/
|
|
1632
|
+
due_date_type?: 'global' | 'relative' | null;
|
|
1633
|
+
|
|
1634
|
+
/**
|
|
1635
|
+
* Due in
|
|
1636
|
+
*/
|
|
1637
|
+
due_in?: '1_week' | '2_weeks' | '1_month' | '3_months' | '6_months' | '12_months' | 'custom' | null;
|
|
1638
|
+
|
|
1639
|
+
/**
|
|
1640
|
+
* Give credit for courses the employee has already completed
|
|
1641
|
+
*/
|
|
1642
|
+
induct_completed_enrollments?: boolean | null;
|
|
1643
|
+
|
|
1644
|
+
/**
|
|
1645
|
+
* Skip enrollment if the employee already completed this learning path
|
|
1646
|
+
*/
|
|
1647
|
+
skip_if_completed?: boolean | null;
|
|
1648
|
+
}
|
|
1649
|
+
|
|
1650
|
+
/**
|
|
1651
|
+
* Send Report via Email.
|
|
1652
|
+
* <helpdocslink href='https://help.rippling.com/article?articleId=382019482598'>Help
|
|
1653
|
+
* docs</helpdocslink>
|
|
1654
|
+
*/
|
|
1655
|
+
export interface SendReportEmailExcelPayload {
|
|
1656
|
+
file_type: 'EXCEL';
|
|
1657
|
+
|
|
1658
|
+
/**
|
|
1659
|
+
* Not all report types are supported in workflows, like change and trend reports
|
|
1660
|
+
*/
|
|
1661
|
+
report_id: string;
|
|
1662
|
+
|
|
1663
|
+
/**
|
|
1664
|
+
* Whose report view should be used to generate this report? (Only the workflow
|
|
1665
|
+
* owner's access level will be available if external emails are included.)
|
|
1666
|
+
*/
|
|
1667
|
+
run_report_perms: 'RECIPIENT' | 'WORKFLOW_OWNER';
|
|
1668
|
+
|
|
1669
|
+
send_to: SendReportEmailExcelPayload.SendTo;
|
|
1670
|
+
|
|
1671
|
+
add_role_referenced_id_column?: boolean | null;
|
|
1672
|
+
|
|
1673
|
+
/**
|
|
1674
|
+
* CSV quoting
|
|
1675
|
+
*/
|
|
1676
|
+
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1677
|
+
|
|
1678
|
+
/**
|
|
1679
|
+
* Currency field formatting
|
|
1680
|
+
*/
|
|
1681
|
+
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1682
|
+
|
|
1683
|
+
/**
|
|
1684
|
+
* Date & time formatting
|
|
1685
|
+
*/
|
|
1686
|
+
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1687
|
+
|
|
1688
|
+
show_sub_totals?: boolean | null;
|
|
1689
|
+
|
|
1690
|
+
/**
|
|
1691
|
+
* Time zones
|
|
1692
|
+
*/
|
|
910
1693
|
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
911
1694
|
}
|
|
912
1695
|
|
|
1696
|
+
export namespace SendReportEmailExcelPayload {
|
|
1697
|
+
export interface SendTo {
|
|
1698
|
+
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1699
|
+
|
|
1700
|
+
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1701
|
+
|
|
1702
|
+
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1703
|
+
}
|
|
1704
|
+
|
|
1705
|
+
export namespace SendTo {
|
|
1706
|
+
export interface Recipient1 {
|
|
1707
|
+
supergroup: Array<string>;
|
|
1708
|
+
|
|
1709
|
+
/**
|
|
1710
|
+
* Email type
|
|
1711
|
+
*/
|
|
1712
|
+
emailType?:
|
|
1713
|
+
| 'work_or_personal_email'
|
|
1714
|
+
| 'work_email_only'
|
|
1715
|
+
| 'personal_email_only'
|
|
1716
|
+
| 'work_and_personal_email'
|
|
1717
|
+
| null;
|
|
1718
|
+
|
|
1719
|
+
externalEmails?: Array<string> | null;
|
|
1720
|
+
}
|
|
1721
|
+
|
|
1722
|
+
export interface Recipient2 {
|
|
1723
|
+
externalEmails: Array<string>;
|
|
1724
|
+
|
|
1725
|
+
/**
|
|
1726
|
+
* Email type
|
|
1727
|
+
*/
|
|
1728
|
+
emailType?:
|
|
1729
|
+
| 'work_or_personal_email'
|
|
1730
|
+
| 'work_email_only'
|
|
1731
|
+
| 'personal_email_only'
|
|
1732
|
+
| 'work_and_personal_email'
|
|
1733
|
+
| null;
|
|
1734
|
+
|
|
1735
|
+
supergroup?: Array<string> | null;
|
|
1736
|
+
}
|
|
1737
|
+
|
|
1738
|
+
export interface Recipient1 {
|
|
1739
|
+
supergroup: Array<string>;
|
|
1740
|
+
|
|
1741
|
+
/**
|
|
1742
|
+
* Email type
|
|
1743
|
+
*/
|
|
1744
|
+
emailType?:
|
|
1745
|
+
| 'work_or_personal_email'
|
|
1746
|
+
| 'work_email_only'
|
|
1747
|
+
| 'personal_email_only'
|
|
1748
|
+
| 'work_and_personal_email'
|
|
1749
|
+
| null;
|
|
1750
|
+
|
|
1751
|
+
externalEmails?: Array<string> | null;
|
|
1752
|
+
}
|
|
1753
|
+
|
|
1754
|
+
export interface Recipient2 {
|
|
1755
|
+
externalEmails: Array<string>;
|
|
1756
|
+
|
|
1757
|
+
/**
|
|
1758
|
+
* Email type
|
|
1759
|
+
*/
|
|
1760
|
+
emailType?:
|
|
1761
|
+
| 'work_or_personal_email'
|
|
1762
|
+
| 'work_email_only'
|
|
1763
|
+
| 'personal_email_only'
|
|
1764
|
+
| 'work_and_personal_email'
|
|
1765
|
+
| null;
|
|
1766
|
+
|
|
1767
|
+
supergroup?: Array<string> | null;
|
|
1768
|
+
}
|
|
1769
|
+
|
|
1770
|
+
export interface Recipient1 {
|
|
1771
|
+
supergroup: Array<string>;
|
|
1772
|
+
|
|
1773
|
+
/**
|
|
1774
|
+
* Email type
|
|
1775
|
+
*/
|
|
1776
|
+
emailType?:
|
|
1777
|
+
| 'work_or_personal_email'
|
|
1778
|
+
| 'work_email_only'
|
|
1779
|
+
| 'personal_email_only'
|
|
1780
|
+
| 'work_and_personal_email'
|
|
1781
|
+
| null;
|
|
1782
|
+
|
|
1783
|
+
externalEmails?: Array<string> | null;
|
|
1784
|
+
}
|
|
1785
|
+
|
|
1786
|
+
export interface Recipient2 {
|
|
1787
|
+
externalEmails: Array<string>;
|
|
1788
|
+
|
|
1789
|
+
/**
|
|
1790
|
+
* Email type
|
|
1791
|
+
*/
|
|
1792
|
+
emailType?:
|
|
1793
|
+
| 'work_or_personal_email'
|
|
1794
|
+
| 'work_email_only'
|
|
1795
|
+
| 'personal_email_only'
|
|
1796
|
+
| 'work_and_personal_email'
|
|
1797
|
+
| null;
|
|
1798
|
+
|
|
1799
|
+
supergroup?: Array<string> | null;
|
|
1800
|
+
}
|
|
1801
|
+
}
|
|
1802
|
+
}
|
|
1803
|
+
|
|
1804
|
+
/**
|
|
1805
|
+
* Send Report via Email.
|
|
1806
|
+
* <helpdocslink href='https://help.rippling.com/article?articleId=382019482598'>Help
|
|
1807
|
+
* docs</helpdocslink>
|
|
1808
|
+
*/
|
|
1809
|
+
export interface SendReportEmailCsvPayload {
|
|
1810
|
+
file_type: 'CSV';
|
|
1811
|
+
|
|
1812
|
+
/**
|
|
1813
|
+
* Not all report types are supported in workflows, like change and trend reports
|
|
1814
|
+
*/
|
|
1815
|
+
report_id: string;
|
|
1816
|
+
|
|
1817
|
+
/**
|
|
1818
|
+
* Whose report view should be used to generate this report? (Only the workflow
|
|
1819
|
+
* owner's access level will be available if external emails are included.)
|
|
1820
|
+
*/
|
|
1821
|
+
run_report_perms: 'RECIPIENT' | 'WORKFLOW_OWNER';
|
|
1822
|
+
|
|
1823
|
+
send_to: SendReportEmailCsvPayload.SendTo;
|
|
1824
|
+
|
|
1825
|
+
add_role_referenced_id_column?: boolean | null;
|
|
1826
|
+
|
|
1827
|
+
/**
|
|
1828
|
+
* CSV quoting
|
|
1829
|
+
*/
|
|
1830
|
+
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1831
|
+
|
|
1832
|
+
/**
|
|
1833
|
+
* Custom separator
|
|
1834
|
+
*/
|
|
1835
|
+
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
1836
|
+
|
|
1837
|
+
/**
|
|
1838
|
+
* Currency field formatting
|
|
1839
|
+
*/
|
|
1840
|
+
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1841
|
+
|
|
1842
|
+
/**
|
|
1843
|
+
* Date & time formatting
|
|
1844
|
+
*/
|
|
1845
|
+
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1846
|
+
|
|
1847
|
+
show_sub_totals?: boolean | null;
|
|
1848
|
+
|
|
1849
|
+
/**
|
|
1850
|
+
* Time zones
|
|
1851
|
+
*/
|
|
1852
|
+
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1853
|
+
}
|
|
1854
|
+
|
|
1855
|
+
export namespace SendReportEmailCsvPayload {
|
|
1856
|
+
export interface SendTo {
|
|
1857
|
+
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1858
|
+
|
|
1859
|
+
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1860
|
+
|
|
1861
|
+
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1862
|
+
}
|
|
1863
|
+
|
|
1864
|
+
export namespace SendTo {
|
|
1865
|
+
export interface Recipient1 {
|
|
1866
|
+
supergroup: Array<string>;
|
|
1867
|
+
|
|
1868
|
+
/**
|
|
1869
|
+
* Email type
|
|
1870
|
+
*/
|
|
1871
|
+
emailType?:
|
|
1872
|
+
| 'work_or_personal_email'
|
|
1873
|
+
| 'work_email_only'
|
|
1874
|
+
| 'personal_email_only'
|
|
1875
|
+
| 'work_and_personal_email'
|
|
1876
|
+
| null;
|
|
1877
|
+
|
|
1878
|
+
externalEmails?: Array<string> | null;
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1881
|
+
export interface Recipient2 {
|
|
1882
|
+
externalEmails: Array<string>;
|
|
1883
|
+
|
|
1884
|
+
/**
|
|
1885
|
+
* Email type
|
|
1886
|
+
*/
|
|
1887
|
+
emailType?:
|
|
1888
|
+
| 'work_or_personal_email'
|
|
1889
|
+
| 'work_email_only'
|
|
1890
|
+
| 'personal_email_only'
|
|
1891
|
+
| 'work_and_personal_email'
|
|
1892
|
+
| null;
|
|
1893
|
+
|
|
1894
|
+
supergroup?: Array<string> | null;
|
|
1895
|
+
}
|
|
1896
|
+
|
|
1897
|
+
export interface Recipient1 {
|
|
1898
|
+
supergroup: Array<string>;
|
|
1899
|
+
|
|
1900
|
+
/**
|
|
1901
|
+
* Email type
|
|
1902
|
+
*/
|
|
1903
|
+
emailType?:
|
|
1904
|
+
| 'work_or_personal_email'
|
|
1905
|
+
| 'work_email_only'
|
|
1906
|
+
| 'personal_email_only'
|
|
1907
|
+
| 'work_and_personal_email'
|
|
1908
|
+
| null;
|
|
1909
|
+
|
|
1910
|
+
externalEmails?: Array<string> | null;
|
|
1911
|
+
}
|
|
1912
|
+
|
|
1913
|
+
export interface Recipient2 {
|
|
1914
|
+
externalEmails: Array<string>;
|
|
1915
|
+
|
|
1916
|
+
/**
|
|
1917
|
+
* Email type
|
|
1918
|
+
*/
|
|
1919
|
+
emailType?:
|
|
1920
|
+
| 'work_or_personal_email'
|
|
1921
|
+
| 'work_email_only'
|
|
1922
|
+
| 'personal_email_only'
|
|
1923
|
+
| 'work_and_personal_email'
|
|
1924
|
+
| null;
|
|
1925
|
+
|
|
1926
|
+
supergroup?: Array<string> | null;
|
|
1927
|
+
}
|
|
1928
|
+
|
|
1929
|
+
export interface Recipient1 {
|
|
1930
|
+
supergroup: Array<string>;
|
|
1931
|
+
|
|
1932
|
+
/**
|
|
1933
|
+
* Email type
|
|
1934
|
+
*/
|
|
1935
|
+
emailType?:
|
|
1936
|
+
| 'work_or_personal_email'
|
|
1937
|
+
| 'work_email_only'
|
|
1938
|
+
| 'personal_email_only'
|
|
1939
|
+
| 'work_and_personal_email'
|
|
1940
|
+
| null;
|
|
1941
|
+
|
|
1942
|
+
externalEmails?: Array<string> | null;
|
|
1943
|
+
}
|
|
1944
|
+
|
|
1945
|
+
export interface Recipient2 {
|
|
1946
|
+
externalEmails: Array<string>;
|
|
1947
|
+
|
|
1948
|
+
/**
|
|
1949
|
+
* Email type
|
|
1950
|
+
*/
|
|
1951
|
+
emailType?:
|
|
1952
|
+
| 'work_or_personal_email'
|
|
1953
|
+
| 'work_email_only'
|
|
1954
|
+
| 'personal_email_only'
|
|
1955
|
+
| 'work_and_personal_email'
|
|
1956
|
+
| null;
|
|
1957
|
+
|
|
1958
|
+
supergroup?: Array<string> | null;
|
|
1959
|
+
}
|
|
1960
|
+
}
|
|
1961
|
+
}
|
|
1962
|
+
|
|
1963
|
+
/**
|
|
1964
|
+
* Sends a document to employees
|
|
1965
|
+
* <helpdocslink href='https://help.rippling.com/article?articleId=5M7eDUNcGIZndtJQv99mjW'>Help
|
|
1966
|
+
* docs</helpdocslink>
|
|
1967
|
+
*/
|
|
1968
|
+
export interface SendDocumentPayload {
|
|
1969
|
+
document: string;
|
|
1970
|
+
|
|
1971
|
+
/**
|
|
1972
|
+
* Maximum recipients: 500
|
|
1973
|
+
*/
|
|
1974
|
+
recipients: Array<string>;
|
|
1975
|
+
}
|
|
1976
|
+
|
|
1977
|
+
/**
|
|
1978
|
+
* Adjust time off balance of a leave policy or a leave type
|
|
1979
|
+
* <helpdocslink href='https://help.rippling.com/article?articleId=807953794978'>Help
|
|
1980
|
+
* docs</helpdocslink>
|
|
1981
|
+
*/
|
|
1982
|
+
export interface AccrueLeaveLeavePolicyPayload {
|
|
1983
|
+
/**
|
|
1984
|
+
* Choose how to adjust the employee's leave balance
|
|
1985
|
+
*/
|
|
1986
|
+
balance_action_type: 'ADD_BALANCE' | 'DEDUCT_BALANCE';
|
|
1987
|
+
|
|
1988
|
+
balance_increment: number;
|
|
1989
|
+
|
|
1990
|
+
/**
|
|
1991
|
+
* The unit of time to accrue leave in
|
|
1992
|
+
*/
|
|
1993
|
+
balance_unit: 'HOURS' | 'DAYS' | 'WEEKS';
|
|
1994
|
+
|
|
1995
|
+
leave_policy: string;
|
|
1996
|
+
|
|
1997
|
+
pto_type: 'LEAVE_POLICY';
|
|
1998
|
+
|
|
1999
|
+
recipients: Array<string>;
|
|
2000
|
+
}
|
|
2001
|
+
|
|
2002
|
+
/**
|
|
2003
|
+
* Adjust time off balance of a leave policy or a leave type
|
|
2004
|
+
* <helpdocslink href='https://help.rippling.com/article?articleId=807953794978'>Help
|
|
2005
|
+
* docs</helpdocslink>
|
|
2006
|
+
*/
|
|
2007
|
+
export interface AccrueLeaveCompanyLeaveTypePayload {
|
|
2008
|
+
/**
|
|
2009
|
+
* Choose how to adjust the employee's leave balance
|
|
2010
|
+
*/
|
|
2011
|
+
balance_action_type: 'ADD_BALANCE' | 'DEDUCT_BALANCE';
|
|
2012
|
+
|
|
2013
|
+
balance_increment: number;
|
|
2014
|
+
|
|
2015
|
+
/**
|
|
2016
|
+
* The unit of time to accrue leave in
|
|
2017
|
+
*/
|
|
2018
|
+
balance_unit: 'HOURS' | 'DAYS' | 'WEEKS';
|
|
2019
|
+
|
|
2020
|
+
company_leave_type: string;
|
|
2021
|
+
|
|
2022
|
+
pto_type: 'COMPANY_LEAVE_TYPE';
|
|
2023
|
+
|
|
2024
|
+
recipients: Array<string>;
|
|
2025
|
+
}
|
|
2026
|
+
|
|
913
2027
|
export interface RunQueryPayload {
|
|
914
2028
|
query: string;
|
|
915
2029
|
|