@rippling/rippling-sdk 0.2.0-alpha.54 → 0.2.0-alpha.55

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