@rippling/rippling-sdk 0.2.0-alpha.71 → 0.2.0-alpha.73
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/examples/functions/durable.ts +41 -52
- package/examples/manifest/custom-object-creation-workflow/custom-object-creation-workflow.ts +2 -2
- package/examples/manifest/dental-practice-management/dental-practice-management.ts +7 -7
- package/examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts +2 -2
- package/examples/manifest/field-service-dispatch/field-service-dispatch.ts +9 -9
- package/examples/manifest/grant-program-management/grant-program-management.ts +9 -9
- package/examples/manifest/gym-membership-management/gym-membership-management.ts +23 -7
- package/examples/manifest/procurement-approval-hub/procurement-approval-hub.ts +10 -10
- package/examples/manifest/simple-todo-app/simple-todo-app.ts +20 -4
- package/package.json +1 -1
- package/resources/workflow-action-executions.d.mts +9 -1627
- package/resources/workflow-action-executions.d.mts.map +1 -1
- package/resources/workflow-action-executions.d.ts +9 -1627
- package/resources/workflow-action-executions.d.ts.map +1 -1
- package/resources/workflow-action-executions.js +1 -1
- package/resources/workflow-action-executions.mjs +1 -1
- package/src/functions.md +19 -30
- package/src/resources/workflow-action-executions.ts +10 -2320
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -6,7 +6,7 @@ import { RequestOptions } from "../internal/request-options.mjs";
|
|
|
6
6
|
*/
|
|
7
7
|
export declare class WorkflowActionExecutions extends APIResource {
|
|
8
8
|
/**
|
|
9
|
-
* Execute a workflow action
|
|
9
|
+
* Execute a workflow action from Rippling Functions
|
|
10
10
|
*/
|
|
11
11
|
create(body: WorkflowActionExecutionCreateParams, options?: RequestOptions): APIPromise<WorkflowActionExecutionCreateResponse>;
|
|
12
12
|
}
|
|
@@ -16,1633 +16,15 @@ export interface WorkflowActionExecutionCreateResponse {
|
|
|
16
16
|
*/
|
|
17
17
|
result: unknown;
|
|
18
18
|
}
|
|
19
|
-
export
|
|
19
|
+
export interface WorkflowActionExecutionCreateParams {
|
|
20
|
+
action_type: 'run_query';
|
|
21
|
+
payload: WorkflowActionExecutionCreateParams.Payload;
|
|
22
|
+
workflow_definition_id: string;
|
|
23
|
+
}
|
|
20
24
|
export declare namespace WorkflowActionExecutionCreateParams {
|
|
21
|
-
interface
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
* An action that sends an email.
|
|
25
|
-
*/
|
|
26
|
-
payload: SendEmailActionRequest.Payload;
|
|
27
|
-
workflow_definition_id: string;
|
|
28
|
-
}
|
|
29
|
-
namespace SendEmailActionRequest {
|
|
30
|
-
/**
|
|
31
|
-
* An action that sends an email.
|
|
32
|
-
*/
|
|
33
|
-
interface Payload {
|
|
34
|
-
/**
|
|
35
|
-
* Email mode
|
|
36
|
-
*/
|
|
37
|
-
action_type: 'INDIVIDUAL_EMAILS' | 'GROUP_EMAIL';
|
|
38
|
-
body: string;
|
|
39
|
-
send_to: Payload.SendTo;
|
|
40
|
-
subject: string;
|
|
41
|
-
/**
|
|
42
|
-
* Maximum total attachment size: 20MB
|
|
43
|
-
*/
|
|
44
|
-
attachments?: Array<Payload.Attachment> | null;
|
|
45
|
-
}
|
|
46
|
-
namespace Payload {
|
|
47
|
-
interface SendTo {
|
|
48
|
-
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
49
|
-
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
50
|
-
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
51
|
-
}
|
|
52
|
-
namespace SendTo {
|
|
53
|
-
interface Recipient1 {
|
|
54
|
-
supergroup: string;
|
|
55
|
-
/**
|
|
56
|
-
* Email type
|
|
57
|
-
*/
|
|
58
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
59
|
-
externalEmails?: Array<string> | null;
|
|
60
|
-
}
|
|
61
|
-
interface Recipient2 {
|
|
62
|
-
externalEmails: Array<string>;
|
|
63
|
-
/**
|
|
64
|
-
* Email type
|
|
65
|
-
*/
|
|
66
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
67
|
-
supergroup?: string | null;
|
|
68
|
-
}
|
|
69
|
-
interface Recipient1 {
|
|
70
|
-
supergroup: string;
|
|
71
|
-
/**
|
|
72
|
-
* Email type
|
|
73
|
-
*/
|
|
74
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
75
|
-
externalEmails?: Array<string> | null;
|
|
76
|
-
}
|
|
77
|
-
interface Recipient2 {
|
|
78
|
-
externalEmails: Array<string>;
|
|
79
|
-
/**
|
|
80
|
-
* Email type
|
|
81
|
-
*/
|
|
82
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
83
|
-
supergroup?: string | null;
|
|
84
|
-
}
|
|
85
|
-
interface Recipient1 {
|
|
86
|
-
supergroup: string;
|
|
87
|
-
/**
|
|
88
|
-
* Email type
|
|
89
|
-
*/
|
|
90
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
91
|
-
externalEmails?: Array<string> | null;
|
|
92
|
-
}
|
|
93
|
-
interface Recipient2 {
|
|
94
|
-
externalEmails: Array<string>;
|
|
95
|
-
/**
|
|
96
|
-
* Email type
|
|
97
|
-
*/
|
|
98
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
99
|
-
supergroup?: string | null;
|
|
100
|
-
}
|
|
101
|
-
}
|
|
102
|
-
interface Attachment {
|
|
103
|
-
fileName: string;
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
-
}
|
|
107
|
-
interface SendSlackActionRequest {
|
|
108
|
-
action_type: 'send_slack';
|
|
109
|
-
/**
|
|
110
|
-
* An action that sends a slack message
|
|
111
|
-
*/
|
|
112
|
-
payload: SendSlackActionRequest.SendSlackSingleDirectMessagePayload | SendSlackActionRequest.SendSlackGroupDirectMessagePayload | SendSlackActionRequest.SendSlackPublicChannelMessagePayload | SendSlackActionRequest.SendSlackPrivateChannelMessagePayload;
|
|
113
|
-
workflow_definition_id: string;
|
|
114
|
-
}
|
|
115
|
-
namespace SendSlackActionRequest {
|
|
116
|
-
/**
|
|
117
|
-
* An action that sends a slack message
|
|
118
|
-
*/
|
|
119
|
-
interface SendSlackSingleDirectMessagePayload {
|
|
120
|
-
action_type: 'SINGLE_DIRECT_MESSAGE';
|
|
121
|
-
/**
|
|
122
|
-
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
123
|
-
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
124
|
-
* markup options</a>
|
|
125
|
-
*/
|
|
126
|
-
body: string;
|
|
127
|
-
recipients: string;
|
|
128
|
-
}
|
|
129
|
-
/**
|
|
130
|
-
* An action that sends a slack message
|
|
131
|
-
*/
|
|
132
|
-
interface SendSlackGroupDirectMessagePayload {
|
|
133
|
-
action_type: 'GROUP_DIRECT_MESSAGE';
|
|
134
|
-
/**
|
|
135
|
-
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
136
|
-
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
137
|
-
* markup options</a>
|
|
138
|
-
*/
|
|
139
|
-
body: string;
|
|
140
|
-
recipients: string;
|
|
141
|
-
}
|
|
142
|
-
/**
|
|
143
|
-
* An action that sends a slack message
|
|
144
|
-
*/
|
|
145
|
-
interface SendSlackPublicChannelMessagePayload {
|
|
146
|
-
action_type: 'PUBLIC_CHANNEL_MESSAGE';
|
|
147
|
-
/**
|
|
148
|
-
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
149
|
-
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
150
|
-
* markup options</a>
|
|
151
|
-
*/
|
|
152
|
-
body: string;
|
|
153
|
-
channel: string;
|
|
154
|
-
}
|
|
155
|
-
/**
|
|
156
|
-
* An action that sends a slack message
|
|
157
|
-
*/
|
|
158
|
-
interface SendSlackPrivateChannelMessagePayload {
|
|
159
|
-
action_type: 'PRIVATE_CHANNEL_MESSAGE';
|
|
160
|
-
/**
|
|
161
|
-
* Advanced formatting (Slack mentions, links, and channels) is supported through
|
|
162
|
-
* <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
|
|
163
|
-
* markup options</a>
|
|
164
|
-
*/
|
|
165
|
-
body: string;
|
|
166
|
-
channel: string;
|
|
167
|
-
}
|
|
168
|
-
}
|
|
169
|
-
interface CreateAppNotificationActionRequest {
|
|
170
|
-
action_type: 'create_app_notification';
|
|
171
|
-
/**
|
|
172
|
-
* Assign tasks to configurable recipients
|
|
173
|
-
*/
|
|
174
|
-
payload: CreateAppNotificationActionRequest.Payload;
|
|
175
|
-
workflow_definition_id: string;
|
|
176
|
-
}
|
|
177
|
-
namespace CreateAppNotificationActionRequest {
|
|
178
|
-
/**
|
|
179
|
-
* Assign tasks to configurable recipients
|
|
180
|
-
*/
|
|
181
|
-
interface Payload {
|
|
182
|
-
description: string;
|
|
183
|
-
recipients: string;
|
|
184
|
-
subject: string;
|
|
185
|
-
dueDate?: Payload.DueDate | Payload.DueDate1 | null;
|
|
186
|
-
}
|
|
187
|
-
namespace Payload {
|
|
188
|
-
interface DueDate {
|
|
189
|
-
date: string;
|
|
190
|
-
}
|
|
191
|
-
interface DueDate1 {
|
|
192
|
-
daysFromNow: number | string;
|
|
193
|
-
}
|
|
194
|
-
}
|
|
195
|
-
}
|
|
196
|
-
interface SendSMSActionRequest {
|
|
197
|
-
action_type: 'send_sms';
|
|
198
|
-
/**
|
|
199
|
-
* An action that sends a text message.
|
|
200
|
-
*/
|
|
201
|
-
payload: SendSMSActionRequest.Payload;
|
|
202
|
-
workflow_definition_id: string;
|
|
203
|
-
}
|
|
204
|
-
namespace SendSMSActionRequest {
|
|
205
|
-
/**
|
|
206
|
-
* An action that sends a text message.
|
|
207
|
-
*/
|
|
208
|
-
interface Payload {
|
|
209
|
-
/**
|
|
210
|
-
* Maximum characters: 500
|
|
211
|
-
*/
|
|
212
|
-
message: string;
|
|
213
|
-
recipients: string;
|
|
214
|
-
}
|
|
215
|
-
}
|
|
216
|
-
interface SendPushNotificationActionRequest {
|
|
217
|
-
action_type: 'send_push_notification';
|
|
218
|
-
/**
|
|
219
|
-
* Sends a push notification to mobile devices. Recipients require the Rippling
|
|
220
|
-
* mobile app to receive this notification.
|
|
221
|
-
*/
|
|
222
|
-
payload: SendPushNotificationActionRequest.Payload;
|
|
223
|
-
workflow_definition_id: string;
|
|
224
|
-
}
|
|
225
|
-
namespace SendPushNotificationActionRequest {
|
|
226
|
-
/**
|
|
227
|
-
* Sends a push notification to mobile devices. Recipients require the Rippling
|
|
228
|
-
* mobile app to receive this notification.
|
|
229
|
-
*/
|
|
230
|
-
interface Payload {
|
|
231
|
-
/**
|
|
232
|
-
* Maximum character count: 65
|
|
233
|
-
*/
|
|
234
|
-
header: string;
|
|
235
|
-
/**
|
|
236
|
-
* In many devices, your description will be truncated after 178 characters.
|
|
237
|
-
*/
|
|
238
|
-
message: string;
|
|
239
|
-
recipients: string;
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
|
-
interface SendHTTPRequestActionRequest {
|
|
243
|
-
action_type: 'send_http_request';
|
|
244
|
-
/**
|
|
245
|
-
* An action that sends an HTTP request with a JSON payload. The following keys -
|
|
246
|
-
* Authorization, Api-Key, and Token - in URL query parameters and custom headers
|
|
247
|
-
* are masked due to their sensitive nature
|
|
248
|
-
*/
|
|
249
|
-
payload: SendHTTPRequestActionRequest.Payload;
|
|
250
|
-
workflow_definition_id: string;
|
|
251
|
-
}
|
|
252
|
-
namespace SendHTTPRequestActionRequest {
|
|
253
|
-
/**
|
|
254
|
-
* An action that sends an HTTP request with a JSON payload. The following keys -
|
|
255
|
-
* Authorization, Api-Key, and Token - in URL query parameters and custom headers
|
|
256
|
-
* are masked due to their sensitive nature
|
|
257
|
-
*/
|
|
258
|
-
interface Payload {
|
|
259
|
-
url: string;
|
|
260
|
-
customHTTPHeaders?: {
|
|
261
|
-
[key: string]: string;
|
|
262
|
-
} | null;
|
|
263
|
-
expectedResponseSchema?: unknown | null;
|
|
264
|
-
/**
|
|
265
|
-
* HTTP method
|
|
266
|
-
*/
|
|
267
|
-
method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | null;
|
|
268
|
-
payload?: unknown | null;
|
|
269
|
-
queryParams?: {
|
|
270
|
-
[key: string]: string;
|
|
271
|
-
} | null;
|
|
272
|
-
}
|
|
273
|
-
}
|
|
274
|
-
interface DeleteCustomObjectRecordActionRequest {
|
|
275
|
-
action_type: 'delete_custom_object_record';
|
|
276
|
-
/**
|
|
277
|
-
* An action that deletes a custom object record.
|
|
278
|
-
*/
|
|
279
|
-
payload: DeleteCustomObjectRecordActionRequest.Payload;
|
|
280
|
-
workflow_definition_id: string;
|
|
281
|
-
}
|
|
282
|
-
namespace DeleteCustomObjectRecordActionRequest {
|
|
283
|
-
/**
|
|
284
|
-
* An action that deletes a custom object record.
|
|
285
|
-
*/
|
|
286
|
-
interface Payload {
|
|
287
|
-
customObjectAPIName: string;
|
|
288
|
-
recordID: string;
|
|
289
|
-
}
|
|
290
|
-
}
|
|
291
|
-
interface SendSurveyActionRequest {
|
|
292
|
-
action_type: 'send_survey';
|
|
293
|
-
/**
|
|
294
|
-
* An action that sends a survey.
|
|
295
|
-
*/
|
|
296
|
-
payload: SendSurveyActionRequest.Payload;
|
|
297
|
-
workflow_definition_id: string;
|
|
298
|
-
}
|
|
299
|
-
namespace SendSurveyActionRequest {
|
|
300
|
-
/**
|
|
301
|
-
* An action that sends a survey.
|
|
302
|
-
*/
|
|
303
|
-
interface Payload {
|
|
304
|
-
body: string;
|
|
305
|
-
recipients: string;
|
|
306
|
-
subject: string;
|
|
307
|
-
surveyID: string;
|
|
308
|
-
expiryDays?: number | string | null;
|
|
309
|
-
}
|
|
310
|
-
}
|
|
311
|
-
interface EvaluateRqlActionRequest {
|
|
312
|
-
action_type: 'evaluate_rql';
|
|
313
|
-
/**
|
|
314
|
-
* Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
|
|
315
|
-
* returns matching record IDs for a chosen Rippling model via a wizard-built
|
|
316
|
-
* filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
|
|
317
|
-
* of any RQL type (scalar or list). Always express filtering inside this action
|
|
318
|
-
* (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
|
|
319
|
-
* and filter in code downstream.
|
|
320
|
-
*/
|
|
321
|
-
payload: EvaluateRqlActionRequest.EvaluateRqlSelectionPayload | EvaluateRqlActionRequest.EvaluateRqlQueryPayload;
|
|
322
|
-
workflow_definition_id: string;
|
|
323
|
-
}
|
|
324
|
-
namespace EvaluateRqlActionRequest {
|
|
325
|
-
/**
|
|
326
|
-
* Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
|
|
327
|
-
* returns matching record IDs for a chosen Rippling model via a wizard-built
|
|
328
|
-
* filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
|
|
329
|
-
* of any RQL type (scalar or list). Always express filtering inside this action
|
|
330
|
-
* (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
|
|
331
|
-
* and filter in code downstream.
|
|
332
|
-
*/
|
|
333
|
-
interface EvaluateRqlSelectionPayload {
|
|
334
|
-
queryType: 'SELECTION';
|
|
335
|
-
rqlModelName?: string | null;
|
|
336
|
-
}
|
|
337
|
-
/**
|
|
338
|
-
* Query and retrieve records from Rippling. Pick a Query mode: Basic (SELECTION)
|
|
339
|
-
* returns matching record IDs for a chosen Rippling model via a wizard-built
|
|
340
|
-
* filter; Advanced (QUERY) evaluates a free-form RQL formula and returns a value
|
|
341
|
-
* of any RQL type (scalar or list). Always express filtering inside this action
|
|
342
|
-
* (via the SELECTION filter wizard or the QUERY formula) — do not fetch records
|
|
343
|
-
* and filter in code downstream.
|
|
344
|
-
*/
|
|
345
|
-
interface EvaluateRqlQueryPayload {
|
|
346
|
-
queryType: 'QUERY';
|
|
347
|
-
/**
|
|
348
|
-
* Data type
|
|
349
|
-
*/
|
|
350
|
-
dataType?: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'OBJECT_ID' | 'DATE' | 'DATETIME' | null;
|
|
351
|
-
isAList?: boolean | null;
|
|
352
|
-
rqlFormula?: EvaluateRqlQueryPayload.RqlFormula | null;
|
|
353
|
-
}
|
|
354
|
-
namespace EvaluateRqlQueryPayload {
|
|
355
|
-
interface RqlFormula {
|
|
356
|
-
rqlFormula?: string | null;
|
|
357
|
-
}
|
|
358
|
-
}
|
|
359
|
-
}
|
|
360
|
-
interface UpsertCustomObjectActionRequest {
|
|
361
|
-
action_type: 'upsert_custom_object';
|
|
362
|
-
/**
|
|
363
|
-
* An action that creates a custom object record.
|
|
364
|
-
*/
|
|
365
|
-
payload: UpsertCustomObjectActionRequest.Payload;
|
|
366
|
-
workflow_definition_id: string;
|
|
367
|
-
}
|
|
368
|
-
namespace UpsertCustomObjectActionRequest {
|
|
369
|
-
/**
|
|
370
|
-
* An action that creates a custom object record.
|
|
371
|
-
*/
|
|
372
|
-
interface Payload {
|
|
373
|
-
customObjectAPIName: string;
|
|
374
|
-
}
|
|
375
|
-
}
|
|
376
|
-
interface UpdateCustomObjectRecordActionRequest {
|
|
377
|
-
action_type: 'update_custom_object_record';
|
|
378
|
-
/**
|
|
379
|
-
* An action that updates a custom object record.
|
|
380
|
-
*/
|
|
381
|
-
payload: UpdateCustomObjectRecordActionRequest.Payload;
|
|
382
|
-
workflow_definition_id: string;
|
|
383
|
-
}
|
|
384
|
-
namespace UpdateCustomObjectRecordActionRequest {
|
|
385
|
-
/**
|
|
386
|
-
* An action that updates a custom object record.
|
|
387
|
-
*/
|
|
388
|
-
interface Payload {
|
|
389
|
-
customObjectAPIName: string;
|
|
390
|
-
}
|
|
391
|
-
}
|
|
392
|
-
interface CreateGcalEventActionRequest {
|
|
393
|
-
action_type: 'create_gcal_event';
|
|
394
|
-
/**
|
|
395
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
396
|
-
* attendees
|
|
397
|
-
*/
|
|
398
|
-
payload: CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerNullPayload | CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerDailyPayload | CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerWeeklyPayload | CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerMonthlyPayload | CreateGcalEventActionRequest.CreateGcalEventWorkflowOwnerYearlyPayload | CreateGcalEventActionRequest.CreateGcalEventSupergroupNullPayload | CreateGcalEventActionRequest.CreateGcalEventSupergroupDailyPayload | CreateGcalEventActionRequest.CreateGcalEventSupergroupWeeklyPayload | CreateGcalEventActionRequest.CreateGcalEventSupergroupMonthlyPayload | CreateGcalEventActionRequest.CreateGcalEventSupergroupYearlyPayload;
|
|
399
|
-
workflow_definition_id: string;
|
|
400
|
-
}
|
|
401
|
-
namespace CreateGcalEventActionRequest {
|
|
402
|
-
/**
|
|
403
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
404
|
-
* attendees
|
|
405
|
-
*/
|
|
406
|
-
interface CreateGcalEventWorkflowOwnerNullPayload {
|
|
407
|
-
attendees: string;
|
|
408
|
-
description: string;
|
|
409
|
-
end: CreateGcalEventWorkflowOwnerNullPayload.End;
|
|
410
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
411
|
-
recurrence_frequency: 'null';
|
|
412
|
-
spoke_owner: string;
|
|
413
|
-
start: CreateGcalEventWorkflowOwnerNullPayload.Start;
|
|
414
|
-
timezone: string;
|
|
415
|
-
title: string;
|
|
416
|
-
all_day_event?: boolean | null;
|
|
417
|
-
guestsCanInviteOthers?: boolean | null;
|
|
418
|
-
guestsCanModify?: boolean | null;
|
|
419
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
420
|
-
/**
|
|
421
|
-
* Show me as
|
|
422
|
-
*/
|
|
423
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
424
|
-
/**
|
|
425
|
-
* Calendar Visibility
|
|
426
|
-
*/
|
|
427
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
428
|
-
}
|
|
429
|
-
namespace CreateGcalEventWorkflowOwnerNullPayload {
|
|
430
|
-
interface End {
|
|
431
|
-
date: string;
|
|
432
|
-
time: string;
|
|
433
|
-
}
|
|
434
|
-
interface Start {
|
|
435
|
-
date: string;
|
|
436
|
-
time: string;
|
|
437
|
-
}
|
|
438
|
-
}
|
|
439
|
-
/**
|
|
440
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
441
|
-
* attendees
|
|
442
|
-
*/
|
|
443
|
-
interface CreateGcalEventWorkflowOwnerDailyPayload {
|
|
444
|
-
attendees: string;
|
|
445
|
-
description: string;
|
|
446
|
-
end: CreateGcalEventWorkflowOwnerDailyPayload.End;
|
|
447
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
448
|
-
recurrence_frequency: 'DAILY';
|
|
449
|
-
spoke_owner: string;
|
|
450
|
-
start: CreateGcalEventWorkflowOwnerDailyPayload.Start;
|
|
451
|
-
timezone: string;
|
|
452
|
-
title: string;
|
|
453
|
-
all_day_event?: boolean | null;
|
|
454
|
-
guestsCanInviteOthers?: boolean | null;
|
|
455
|
-
guestsCanModify?: boolean | null;
|
|
456
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
457
|
-
recurrence_has_end?: boolean | null;
|
|
458
|
-
/**
|
|
459
|
-
* Show me as
|
|
460
|
-
*/
|
|
461
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
462
|
-
/**
|
|
463
|
-
* Calendar Visibility
|
|
464
|
-
*/
|
|
465
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
466
|
-
}
|
|
467
|
-
namespace CreateGcalEventWorkflowOwnerDailyPayload {
|
|
468
|
-
interface End {
|
|
469
|
-
date: string;
|
|
470
|
-
time: string;
|
|
471
|
-
}
|
|
472
|
-
interface Start {
|
|
473
|
-
date: string;
|
|
474
|
-
time: string;
|
|
475
|
-
}
|
|
476
|
-
}
|
|
477
|
-
/**
|
|
478
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
479
|
-
* attendees
|
|
480
|
-
*/
|
|
481
|
-
interface CreateGcalEventWorkflowOwnerWeeklyPayload {
|
|
482
|
-
attendees: string;
|
|
483
|
-
description: string;
|
|
484
|
-
end: CreateGcalEventWorkflowOwnerWeeklyPayload.End;
|
|
485
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
486
|
-
recurrence_frequency: 'WEEKLY';
|
|
487
|
-
spoke_owner: string;
|
|
488
|
-
start: CreateGcalEventWorkflowOwnerWeeklyPayload.Start;
|
|
489
|
-
timezone: string;
|
|
490
|
-
title: string;
|
|
491
|
-
all_day_event?: boolean | null;
|
|
492
|
-
guestsCanInviteOthers?: boolean | null;
|
|
493
|
-
guestsCanModify?: boolean | null;
|
|
494
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
495
|
-
recurrence_has_end?: boolean | null;
|
|
496
|
-
/**
|
|
497
|
-
* Show me as
|
|
498
|
-
*/
|
|
499
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
500
|
-
/**
|
|
501
|
-
* Calendar Visibility
|
|
502
|
-
*/
|
|
503
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
504
|
-
}
|
|
505
|
-
namespace CreateGcalEventWorkflowOwnerWeeklyPayload {
|
|
506
|
-
interface End {
|
|
507
|
-
date: string;
|
|
508
|
-
time: string;
|
|
509
|
-
}
|
|
510
|
-
interface Start {
|
|
511
|
-
date: string;
|
|
512
|
-
time: string;
|
|
513
|
-
}
|
|
514
|
-
}
|
|
515
|
-
/**
|
|
516
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
517
|
-
* attendees
|
|
518
|
-
*/
|
|
519
|
-
interface CreateGcalEventWorkflowOwnerMonthlyPayload {
|
|
520
|
-
attendees: string;
|
|
521
|
-
description: string;
|
|
522
|
-
end: CreateGcalEventWorkflowOwnerMonthlyPayload.End;
|
|
523
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
524
|
-
recurrence_frequency: 'MONTHLY';
|
|
525
|
-
spoke_owner: string;
|
|
526
|
-
start: CreateGcalEventWorkflowOwnerMonthlyPayload.Start;
|
|
527
|
-
timezone: string;
|
|
528
|
-
title: string;
|
|
529
|
-
all_day_event?: boolean | null;
|
|
530
|
-
guestsCanInviteOthers?: boolean | null;
|
|
531
|
-
guestsCanModify?: boolean | null;
|
|
532
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
533
|
-
recurrence_has_end?: boolean | null;
|
|
534
|
-
/**
|
|
535
|
-
* Show me as
|
|
536
|
-
*/
|
|
537
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
538
|
-
/**
|
|
539
|
-
* Calendar Visibility
|
|
540
|
-
*/
|
|
541
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
542
|
-
}
|
|
543
|
-
namespace CreateGcalEventWorkflowOwnerMonthlyPayload {
|
|
544
|
-
interface End {
|
|
545
|
-
date: string;
|
|
546
|
-
time: string;
|
|
547
|
-
}
|
|
548
|
-
interface Start {
|
|
549
|
-
date: string;
|
|
550
|
-
time: string;
|
|
551
|
-
}
|
|
552
|
-
}
|
|
553
|
-
/**
|
|
554
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
555
|
-
* attendees
|
|
556
|
-
*/
|
|
557
|
-
interface CreateGcalEventWorkflowOwnerYearlyPayload {
|
|
558
|
-
attendees: string;
|
|
559
|
-
description: string;
|
|
560
|
-
end: CreateGcalEventWorkflowOwnerYearlyPayload.End;
|
|
561
|
-
organizer_type: 'WORKFLOW_OWNER';
|
|
562
|
-
recurrence_frequency: 'YEARLY';
|
|
563
|
-
spoke_owner: string;
|
|
564
|
-
start: CreateGcalEventWorkflowOwnerYearlyPayload.Start;
|
|
565
|
-
timezone: string;
|
|
566
|
-
title: string;
|
|
567
|
-
all_day_event?: boolean | null;
|
|
568
|
-
guestsCanInviteOthers?: boolean | null;
|
|
569
|
-
guestsCanModify?: boolean | null;
|
|
570
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
571
|
-
recurrence_has_end?: boolean | null;
|
|
572
|
-
/**
|
|
573
|
-
* Show me as
|
|
574
|
-
*/
|
|
575
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
576
|
-
/**
|
|
577
|
-
* Calendar Visibility
|
|
578
|
-
*/
|
|
579
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
580
|
-
}
|
|
581
|
-
namespace CreateGcalEventWorkflowOwnerYearlyPayload {
|
|
582
|
-
interface End {
|
|
583
|
-
date: string;
|
|
584
|
-
time: string;
|
|
585
|
-
}
|
|
586
|
-
interface Start {
|
|
587
|
-
date: string;
|
|
588
|
-
time: string;
|
|
589
|
-
}
|
|
590
|
-
}
|
|
591
|
-
/**
|
|
592
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
593
|
-
* attendees
|
|
594
|
-
*/
|
|
595
|
-
interface CreateGcalEventSupergroupNullPayload {
|
|
596
|
-
attendees: string;
|
|
597
|
-
description: string;
|
|
598
|
-
end: CreateGcalEventSupergroupNullPayload.End;
|
|
599
|
-
organizer: string;
|
|
600
|
-
organizer_type: 'SUPERGROUP';
|
|
601
|
-
recurrence_frequency: 'null';
|
|
602
|
-
spoke_owner: string;
|
|
603
|
-
start: CreateGcalEventSupergroupNullPayload.Start;
|
|
604
|
-
timezone: string;
|
|
605
|
-
title: string;
|
|
606
|
-
all_day_event?: boolean | null;
|
|
607
|
-
guestsCanInviteOthers?: boolean | null;
|
|
608
|
-
guestsCanModify?: boolean | null;
|
|
609
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
610
|
-
/**
|
|
611
|
-
* Show me as
|
|
612
|
-
*/
|
|
613
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
614
|
-
/**
|
|
615
|
-
* Calendar Visibility
|
|
616
|
-
*/
|
|
617
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
618
|
-
}
|
|
619
|
-
namespace CreateGcalEventSupergroupNullPayload {
|
|
620
|
-
interface End {
|
|
621
|
-
date: string;
|
|
622
|
-
time: string;
|
|
623
|
-
}
|
|
624
|
-
interface Start {
|
|
625
|
-
date: string;
|
|
626
|
-
time: string;
|
|
627
|
-
}
|
|
628
|
-
}
|
|
629
|
-
/**
|
|
630
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
631
|
-
* attendees
|
|
632
|
-
*/
|
|
633
|
-
interface CreateGcalEventSupergroupDailyPayload {
|
|
634
|
-
attendees: string;
|
|
635
|
-
description: string;
|
|
636
|
-
end: CreateGcalEventSupergroupDailyPayload.End;
|
|
637
|
-
organizer: string;
|
|
638
|
-
organizer_type: 'SUPERGROUP';
|
|
639
|
-
recurrence_frequency: 'DAILY';
|
|
640
|
-
spoke_owner: string;
|
|
641
|
-
start: CreateGcalEventSupergroupDailyPayload.Start;
|
|
642
|
-
timezone: string;
|
|
643
|
-
title: string;
|
|
644
|
-
all_day_event?: boolean | null;
|
|
645
|
-
guestsCanInviteOthers?: boolean | null;
|
|
646
|
-
guestsCanModify?: boolean | null;
|
|
647
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
648
|
-
recurrence_has_end?: boolean | null;
|
|
649
|
-
/**
|
|
650
|
-
* Show me as
|
|
651
|
-
*/
|
|
652
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
653
|
-
/**
|
|
654
|
-
* Calendar Visibility
|
|
655
|
-
*/
|
|
656
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
657
|
-
}
|
|
658
|
-
namespace CreateGcalEventSupergroupDailyPayload {
|
|
659
|
-
interface End {
|
|
660
|
-
date: string;
|
|
661
|
-
time: string;
|
|
662
|
-
}
|
|
663
|
-
interface Start {
|
|
664
|
-
date: string;
|
|
665
|
-
time: string;
|
|
666
|
-
}
|
|
667
|
-
}
|
|
668
|
-
/**
|
|
669
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
670
|
-
* attendees
|
|
671
|
-
*/
|
|
672
|
-
interface CreateGcalEventSupergroupWeeklyPayload {
|
|
673
|
-
attendees: string;
|
|
674
|
-
description: string;
|
|
675
|
-
end: CreateGcalEventSupergroupWeeklyPayload.End;
|
|
676
|
-
organizer: string;
|
|
677
|
-
organizer_type: 'SUPERGROUP';
|
|
678
|
-
recurrence_frequency: 'WEEKLY';
|
|
679
|
-
spoke_owner: string;
|
|
680
|
-
start: CreateGcalEventSupergroupWeeklyPayload.Start;
|
|
681
|
-
timezone: string;
|
|
682
|
-
title: string;
|
|
683
|
-
all_day_event?: boolean | null;
|
|
684
|
-
guestsCanInviteOthers?: boolean | null;
|
|
685
|
-
guestsCanModify?: boolean | null;
|
|
686
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
687
|
-
recurrence_has_end?: boolean | null;
|
|
688
|
-
/**
|
|
689
|
-
* Show me as
|
|
690
|
-
*/
|
|
691
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
692
|
-
/**
|
|
693
|
-
* Calendar Visibility
|
|
694
|
-
*/
|
|
695
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
696
|
-
}
|
|
697
|
-
namespace CreateGcalEventSupergroupWeeklyPayload {
|
|
698
|
-
interface End {
|
|
699
|
-
date: string;
|
|
700
|
-
time: string;
|
|
701
|
-
}
|
|
702
|
-
interface Start {
|
|
703
|
-
date: string;
|
|
704
|
-
time: string;
|
|
705
|
-
}
|
|
706
|
-
}
|
|
707
|
-
/**
|
|
708
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
709
|
-
* attendees
|
|
710
|
-
*/
|
|
711
|
-
interface CreateGcalEventSupergroupMonthlyPayload {
|
|
712
|
-
attendees: string;
|
|
713
|
-
description: string;
|
|
714
|
-
end: CreateGcalEventSupergroupMonthlyPayload.End;
|
|
715
|
-
organizer: string;
|
|
716
|
-
organizer_type: 'SUPERGROUP';
|
|
717
|
-
recurrence_frequency: 'MONTHLY';
|
|
718
|
-
spoke_owner: string;
|
|
719
|
-
start: CreateGcalEventSupergroupMonthlyPayload.Start;
|
|
720
|
-
timezone: string;
|
|
721
|
-
title: string;
|
|
722
|
-
all_day_event?: boolean | null;
|
|
723
|
-
guestsCanInviteOthers?: boolean | null;
|
|
724
|
-
guestsCanModify?: boolean | null;
|
|
725
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
726
|
-
recurrence_has_end?: boolean | null;
|
|
727
|
-
/**
|
|
728
|
-
* Show me as
|
|
729
|
-
*/
|
|
730
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
731
|
-
/**
|
|
732
|
-
* Calendar Visibility
|
|
733
|
-
*/
|
|
734
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
735
|
-
}
|
|
736
|
-
namespace CreateGcalEventSupergroupMonthlyPayload {
|
|
737
|
-
interface End {
|
|
738
|
-
date: string;
|
|
739
|
-
time: string;
|
|
740
|
-
}
|
|
741
|
-
interface Start {
|
|
742
|
-
date: string;
|
|
743
|
-
time: string;
|
|
744
|
-
}
|
|
745
|
-
}
|
|
746
|
-
/**
|
|
747
|
-
* This action will create a Google Calendar event with the specified organizer and
|
|
748
|
-
* attendees
|
|
749
|
-
*/
|
|
750
|
-
interface CreateGcalEventSupergroupYearlyPayload {
|
|
751
|
-
attendees: string;
|
|
752
|
-
description: string;
|
|
753
|
-
end: CreateGcalEventSupergroupYearlyPayload.End;
|
|
754
|
-
organizer: string;
|
|
755
|
-
organizer_type: 'SUPERGROUP';
|
|
756
|
-
recurrence_frequency: 'YEARLY';
|
|
757
|
-
spoke_owner: string;
|
|
758
|
-
start: CreateGcalEventSupergroupYearlyPayload.Start;
|
|
759
|
-
timezone: string;
|
|
760
|
-
title: string;
|
|
761
|
-
all_day_event?: boolean | null;
|
|
762
|
-
guestsCanInviteOthers?: boolean | null;
|
|
763
|
-
guestsCanModify?: boolean | null;
|
|
764
|
-
guestsCanSeeOtherGuests?: boolean | null;
|
|
765
|
-
recurrence_has_end?: boolean | null;
|
|
766
|
-
/**
|
|
767
|
-
* Show me as
|
|
768
|
-
*/
|
|
769
|
-
transparency?: 'opaque' | 'transparent' | null;
|
|
770
|
-
/**
|
|
771
|
-
* Calendar Visibility
|
|
772
|
-
*/
|
|
773
|
-
visibility?: 'default' | 'public' | 'private' | null;
|
|
774
|
-
}
|
|
775
|
-
namespace CreateGcalEventSupergroupYearlyPayload {
|
|
776
|
-
interface End {
|
|
777
|
-
date: string;
|
|
778
|
-
time: string;
|
|
779
|
-
}
|
|
780
|
-
interface Start {
|
|
781
|
-
date: string;
|
|
782
|
-
time: string;
|
|
783
|
-
}
|
|
784
|
-
}
|
|
785
|
-
}
|
|
786
|
-
interface SendTeamsActionRequest {
|
|
787
|
-
action_type: 'send_teams';
|
|
788
|
-
/**
|
|
789
|
-
* An action that sends a teams message
|
|
790
|
-
*/
|
|
791
|
-
payload: SendTeamsActionRequest.SendTeamsPublicChannelMessagePayload | SendTeamsActionRequest.SendTeamsSingleDirectMessagePayload;
|
|
792
|
-
workflow_definition_id: string;
|
|
793
|
-
}
|
|
794
|
-
namespace SendTeamsActionRequest {
|
|
795
|
-
/**
|
|
796
|
-
* An action that sends a teams message
|
|
797
|
-
*/
|
|
798
|
-
interface SendTeamsPublicChannelMessagePayload {
|
|
799
|
-
action_type: 'PUBLIC_CHANNEL_MESSAGE';
|
|
800
|
-
message: string;
|
|
801
|
-
/**
|
|
802
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
803
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
804
|
-
* back to synchronous execution.
|
|
805
|
-
*/
|
|
806
|
-
run_id?: string | null;
|
|
807
|
-
team_id?: string | null;
|
|
808
|
-
}
|
|
809
|
-
/**
|
|
810
|
-
* An action that sends a teams message
|
|
811
|
-
*/
|
|
812
|
-
interface SendTeamsSingleDirectMessagePayload {
|
|
813
|
-
action_type: 'SINGLE_DIRECT_MESSAGE';
|
|
814
|
-
message: string;
|
|
815
|
-
recipients?: string | null;
|
|
816
|
-
/**
|
|
817
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
818
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
819
|
-
* back to synchronous execution.
|
|
820
|
-
*/
|
|
821
|
-
run_id?: string | null;
|
|
822
|
-
}
|
|
823
|
-
}
|
|
824
|
-
interface AssignReviewActionRequest {
|
|
825
|
-
action_type: 'assign_review';
|
|
826
|
-
/**
|
|
827
|
-
* Select a cycle and reviewers for the employee that triggered the workflow
|
|
828
|
-
*/
|
|
829
|
-
payload: AssignReviewActionRequest.AssignReviewReviewerRelativeToRevieweePayload | AssignReviewActionRequest.AssignReviewReviewerRelativeToTriggerPayload;
|
|
830
|
-
workflow_definition_id: string;
|
|
831
|
-
}
|
|
832
|
-
namespace AssignReviewActionRequest {
|
|
833
|
-
/**
|
|
834
|
-
* Select a cycle and reviewers for the employee that triggered the workflow
|
|
835
|
-
*/
|
|
836
|
-
interface AssignReviewReviewerRelativeToRevieweePayload {
|
|
837
|
-
cycle_id: string;
|
|
838
|
-
is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_REVIEWEE';
|
|
839
|
-
reviewees: string;
|
|
840
|
-
/**
|
|
841
|
-
* Maximum reviewees: 500
|
|
842
|
-
*/
|
|
843
|
-
reviewers: string;
|
|
844
|
-
/**
|
|
845
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
846
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
847
|
-
* back to synchronous execution.
|
|
848
|
-
*/
|
|
849
|
-
run_id?: string | null;
|
|
850
|
-
}
|
|
851
|
-
/**
|
|
852
|
-
* Select a cycle and reviewers for the employee that triggered the workflow
|
|
853
|
-
*/
|
|
854
|
-
interface AssignReviewReviewerRelativeToTriggerPayload {
|
|
855
|
-
cycle_id: string;
|
|
856
|
-
is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_TRIGGER';
|
|
857
|
-
reviewees: string;
|
|
858
|
-
/**
|
|
859
|
-
* Maximum reviewees: 500
|
|
860
|
-
*/
|
|
861
|
-
reviewers: string;
|
|
862
|
-
/**
|
|
863
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
864
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
865
|
-
* back to synchronous execution.
|
|
866
|
-
*/
|
|
867
|
-
run_id?: string | null;
|
|
868
|
-
}
|
|
869
|
-
}
|
|
870
|
-
interface SendReportSftpActionRequest {
|
|
871
|
-
action_type: 'send_report_sftp';
|
|
872
|
-
/**
|
|
873
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
874
|
-
* specified SFTP server
|
|
875
|
-
*/
|
|
876
|
-
payload: SendReportSftpActionRequest.SendReportSftpPasswordExcelPayload | SendReportSftpActionRequest.SendReportSftpPasswordCsvPayload | SendReportSftpActionRequest.SendReportSftpSSHKeyExcelPayload | SendReportSftpActionRequest.SendReportSftpSSHKeyCsvPayload;
|
|
877
|
-
workflow_definition_id: string;
|
|
878
|
-
}
|
|
879
|
-
namespace SendReportSftpActionRequest {
|
|
880
|
-
/**
|
|
881
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
882
|
-
* specified SFTP server
|
|
883
|
-
*/
|
|
884
|
-
interface SendReportSftpPasswordExcelPayload {
|
|
885
|
-
authentication_type: 'PASSWORD';
|
|
886
|
-
/**
|
|
887
|
-
* Specify the full path where the file should be stored on the remote server,
|
|
888
|
-
* starting from the root directory. Example: /rippling-workflows
|
|
889
|
-
*/
|
|
890
|
-
file_path: string;
|
|
891
|
-
file_type: 'EXCEL';
|
|
892
|
-
/**
|
|
893
|
-
* sftp://username@[hostname]
|
|
894
|
-
*/
|
|
895
|
-
host_name: string;
|
|
896
|
-
/**
|
|
897
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
898
|
-
*/
|
|
899
|
-
report_id: string;
|
|
900
|
-
/**
|
|
901
|
-
* sftp://[username]@hostname
|
|
902
|
-
*/
|
|
903
|
-
user_name: string;
|
|
904
|
-
add_role_referenced_id_column?: boolean | null;
|
|
905
|
-
/**
|
|
906
|
-
* CSV quoting
|
|
907
|
-
*/
|
|
908
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
909
|
-
/**
|
|
910
|
-
* Currency field formatting
|
|
911
|
-
*/
|
|
912
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
913
|
-
/**
|
|
914
|
-
* Date & time formatting
|
|
915
|
-
*/
|
|
916
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
917
|
-
/**
|
|
918
|
-
* Files will be automatically named if the file name is empty
|
|
919
|
-
*/
|
|
920
|
-
file_name?: string | null;
|
|
921
|
-
/**
|
|
922
|
-
* File name suffix
|
|
923
|
-
*/
|
|
924
|
-
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
925
|
-
port?: number | null;
|
|
926
|
-
/**
|
|
927
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
928
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
929
|
-
* back to synchronous execution.
|
|
930
|
-
*/
|
|
931
|
-
run_id?: string | null;
|
|
932
|
-
show_sub_totals?: boolean | null;
|
|
933
|
-
/**
|
|
934
|
-
* Time zones
|
|
935
|
-
*/
|
|
936
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
937
|
-
}
|
|
938
|
-
/**
|
|
939
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
940
|
-
* specified SFTP server
|
|
941
|
-
*/
|
|
942
|
-
interface SendReportSftpPasswordCsvPayload {
|
|
943
|
-
authentication_type: 'PASSWORD';
|
|
944
|
-
/**
|
|
945
|
-
* Specify the full path where the file should be stored on the remote server,
|
|
946
|
-
* starting from the root directory. Example: /rippling-workflows
|
|
947
|
-
*/
|
|
948
|
-
file_path: string;
|
|
949
|
-
file_type: 'CSV';
|
|
950
|
-
/**
|
|
951
|
-
* sftp://username@[hostname]
|
|
952
|
-
*/
|
|
953
|
-
host_name: string;
|
|
954
|
-
/**
|
|
955
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
956
|
-
*/
|
|
957
|
-
report_id: string;
|
|
958
|
-
/**
|
|
959
|
-
* sftp://[username]@hostname
|
|
960
|
-
*/
|
|
961
|
-
user_name: string;
|
|
962
|
-
add_role_referenced_id_column?: boolean | null;
|
|
963
|
-
/**
|
|
964
|
-
* CSV quoting
|
|
965
|
-
*/
|
|
966
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
967
|
-
/**
|
|
968
|
-
* Custom separator
|
|
969
|
-
*/
|
|
970
|
-
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
971
|
-
/**
|
|
972
|
-
* Currency field formatting
|
|
973
|
-
*/
|
|
974
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
975
|
-
/**
|
|
976
|
-
* Date & time formatting
|
|
977
|
-
*/
|
|
978
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
979
|
-
/**
|
|
980
|
-
* Files will be automatically named if the file name is empty
|
|
981
|
-
*/
|
|
982
|
-
file_name?: string | null;
|
|
983
|
-
/**
|
|
984
|
-
* File name suffix
|
|
985
|
-
*/
|
|
986
|
-
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
987
|
-
port?: number | null;
|
|
988
|
-
/**
|
|
989
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
990
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
991
|
-
* back to synchronous execution.
|
|
992
|
-
*/
|
|
993
|
-
run_id?: string | null;
|
|
994
|
-
show_sub_totals?: boolean | null;
|
|
995
|
-
/**
|
|
996
|
-
* Time zones
|
|
997
|
-
*/
|
|
998
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
999
|
-
}
|
|
1000
|
-
/**
|
|
1001
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
1002
|
-
* specified SFTP server
|
|
1003
|
-
*/
|
|
1004
|
-
interface SendReportSftpSSHKeyExcelPayload {
|
|
1005
|
-
authentication_type: 'SSH_KEY';
|
|
1006
|
-
/**
|
|
1007
|
-
* Specify the full path where the file should be stored on the remote server,
|
|
1008
|
-
* starting from the root directory. Example: /rippling-workflows
|
|
1009
|
-
*/
|
|
1010
|
-
file_path: string;
|
|
1011
|
-
file_type: 'EXCEL';
|
|
1012
|
-
/**
|
|
1013
|
-
* sftp://username@[hostname]
|
|
1014
|
-
*/
|
|
1015
|
-
host_name: string;
|
|
1016
|
-
/**
|
|
1017
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1018
|
-
*/
|
|
1019
|
-
report_id: string;
|
|
1020
|
-
/**
|
|
1021
|
-
* sftp://[username]@hostname
|
|
1022
|
-
*/
|
|
1023
|
-
user_name: string;
|
|
1024
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1025
|
-
/**
|
|
1026
|
-
* CSV quoting
|
|
1027
|
-
*/
|
|
1028
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1029
|
-
/**
|
|
1030
|
-
* Currency field formatting
|
|
1031
|
-
*/
|
|
1032
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1033
|
-
/**
|
|
1034
|
-
* Date & time formatting
|
|
1035
|
-
*/
|
|
1036
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1037
|
-
/**
|
|
1038
|
-
* Files will be automatically named if the file name is empty
|
|
1039
|
-
*/
|
|
1040
|
-
file_name?: string | null;
|
|
1041
|
-
/**
|
|
1042
|
-
* File name suffix
|
|
1043
|
-
*/
|
|
1044
|
-
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
1045
|
-
port?: number | null;
|
|
1046
|
-
/**
|
|
1047
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1048
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1049
|
-
* back to synchronous execution.
|
|
1050
|
-
*/
|
|
1051
|
-
run_id?: string | null;
|
|
1052
|
-
show_sub_totals?: boolean | null;
|
|
1053
|
-
/**
|
|
1054
|
-
* Time zones
|
|
1055
|
-
*/
|
|
1056
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1057
|
-
}
|
|
1058
|
-
/**
|
|
1059
|
-
* Automatically generates a scheduled report and transfers it securely to a
|
|
1060
|
-
* specified SFTP server
|
|
1061
|
-
*/
|
|
1062
|
-
interface SendReportSftpSSHKeyCsvPayload {
|
|
1063
|
-
authentication_type: 'SSH_KEY';
|
|
1064
|
-
/**
|
|
1065
|
-
* Specify the full path where the file should be stored on the remote server,
|
|
1066
|
-
* starting from the root directory. Example: /rippling-workflows
|
|
1067
|
-
*/
|
|
1068
|
-
file_path: string;
|
|
1069
|
-
file_type: 'CSV';
|
|
1070
|
-
/**
|
|
1071
|
-
* sftp://username@[hostname]
|
|
1072
|
-
*/
|
|
1073
|
-
host_name: string;
|
|
1074
|
-
/**
|
|
1075
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1076
|
-
*/
|
|
1077
|
-
report_id: string;
|
|
1078
|
-
/**
|
|
1079
|
-
* sftp://[username]@hostname
|
|
1080
|
-
*/
|
|
1081
|
-
user_name: string;
|
|
1082
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1083
|
-
/**
|
|
1084
|
-
* CSV quoting
|
|
1085
|
-
*/
|
|
1086
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1087
|
-
/**
|
|
1088
|
-
* Custom separator
|
|
1089
|
-
*/
|
|
1090
|
-
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
1091
|
-
/**
|
|
1092
|
-
* Currency field formatting
|
|
1093
|
-
*/
|
|
1094
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1095
|
-
/**
|
|
1096
|
-
* Date & time formatting
|
|
1097
|
-
*/
|
|
1098
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1099
|
-
/**
|
|
1100
|
-
* Files will be automatically named if the file name is empty
|
|
1101
|
-
*/
|
|
1102
|
-
file_name?: string | null;
|
|
1103
|
-
/**
|
|
1104
|
-
* File name suffix
|
|
1105
|
-
*/
|
|
1106
|
-
file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
|
|
1107
|
-
port?: number | null;
|
|
1108
|
-
/**
|
|
1109
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1110
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1111
|
-
* back to synchronous execution.
|
|
1112
|
-
*/
|
|
1113
|
-
run_id?: string | null;
|
|
1114
|
-
show_sub_totals?: boolean | null;
|
|
1115
|
-
/**
|
|
1116
|
-
* Time zones
|
|
1117
|
-
*/
|
|
1118
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1119
|
-
}
|
|
1120
|
-
}
|
|
1121
|
-
interface EnrollIntoCourseActionRequest {
|
|
1122
|
-
action_type: 'enroll_into_course';
|
|
1123
|
-
/**
|
|
1124
|
-
* Automatically enroll people into a course
|
|
1125
|
-
*/
|
|
1126
|
-
payload: EnrollIntoCourseActionRequest.EnrollIntoCourse1WeekPayload | EnrollIntoCourseActionRequest.EnrollIntoCourse2WeeksPayload | EnrollIntoCourseActionRequest.EnrollIntoCourse1MonthPayload | EnrollIntoCourseActionRequest.EnrollIntoCourse3MonthsPayload | EnrollIntoCourseActionRequest.EnrollIntoCourse6MonthsPayload | EnrollIntoCourseActionRequest.EnrollIntoCourse12MonthsPayload | EnrollIntoCourseActionRequest.EnrollIntoCourseCustomPayload;
|
|
1127
|
-
workflow_definition_id: string;
|
|
1128
|
-
}
|
|
1129
|
-
namespace EnrollIntoCourseActionRequest {
|
|
1130
|
-
/**
|
|
1131
|
-
* Automatically enroll people into a course
|
|
1132
|
-
*/
|
|
1133
|
-
interface EnrollIntoCourse1WeekPayload {
|
|
1134
|
-
/**
|
|
1135
|
-
* Select a course to enroll people in
|
|
1136
|
-
*/
|
|
1137
|
-
course_id: string;
|
|
1138
|
-
due_date: '1_week';
|
|
1139
|
-
/**
|
|
1140
|
-
* Select people to enroll in this course
|
|
1141
|
-
*/
|
|
1142
|
-
role_ids: string;
|
|
1143
|
-
/**
|
|
1144
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1145
|
-
*/
|
|
1146
|
-
skip_if_certified?: boolean | null;
|
|
1147
|
-
}
|
|
1148
|
-
/**
|
|
1149
|
-
* Automatically enroll people into a course
|
|
1150
|
-
*/
|
|
1151
|
-
interface EnrollIntoCourse2WeeksPayload {
|
|
1152
|
-
/**
|
|
1153
|
-
* Select a course to enroll people in
|
|
1154
|
-
*/
|
|
1155
|
-
course_id: string;
|
|
1156
|
-
due_date: '2_weeks';
|
|
1157
|
-
/**
|
|
1158
|
-
* Select people to enroll in this course
|
|
1159
|
-
*/
|
|
1160
|
-
role_ids: string;
|
|
1161
|
-
/**
|
|
1162
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1163
|
-
*/
|
|
1164
|
-
skip_if_certified?: boolean | null;
|
|
1165
|
-
}
|
|
1166
|
-
/**
|
|
1167
|
-
* Automatically enroll people into a course
|
|
1168
|
-
*/
|
|
1169
|
-
interface EnrollIntoCourse1MonthPayload {
|
|
1170
|
-
/**
|
|
1171
|
-
* Select a course to enroll people in
|
|
1172
|
-
*/
|
|
1173
|
-
course_id: string;
|
|
1174
|
-
due_date: '1_month';
|
|
1175
|
-
/**
|
|
1176
|
-
* Select people to enroll in this course
|
|
1177
|
-
*/
|
|
1178
|
-
role_ids: string;
|
|
1179
|
-
/**
|
|
1180
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1181
|
-
*/
|
|
1182
|
-
skip_if_certified?: boolean | null;
|
|
1183
|
-
}
|
|
1184
|
-
/**
|
|
1185
|
-
* Automatically enroll people into a course
|
|
1186
|
-
*/
|
|
1187
|
-
interface EnrollIntoCourse3MonthsPayload {
|
|
1188
|
-
/**
|
|
1189
|
-
* Select a course to enroll people in
|
|
1190
|
-
*/
|
|
1191
|
-
course_id: string;
|
|
1192
|
-
due_date: '3_months';
|
|
1193
|
-
/**
|
|
1194
|
-
* Select people to enroll in this course
|
|
1195
|
-
*/
|
|
1196
|
-
role_ids: string;
|
|
1197
|
-
/**
|
|
1198
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1199
|
-
*/
|
|
1200
|
-
skip_if_certified?: boolean | null;
|
|
1201
|
-
}
|
|
1202
|
-
/**
|
|
1203
|
-
* Automatically enroll people into a course
|
|
1204
|
-
*/
|
|
1205
|
-
interface EnrollIntoCourse6MonthsPayload {
|
|
1206
|
-
/**
|
|
1207
|
-
* Select a course to enroll people in
|
|
1208
|
-
*/
|
|
1209
|
-
course_id: string;
|
|
1210
|
-
due_date: '6_months';
|
|
1211
|
-
/**
|
|
1212
|
-
* Select people to enroll in this course
|
|
1213
|
-
*/
|
|
1214
|
-
role_ids: string;
|
|
1215
|
-
/**
|
|
1216
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1217
|
-
*/
|
|
1218
|
-
skip_if_certified?: boolean | null;
|
|
1219
|
-
}
|
|
1220
|
-
/**
|
|
1221
|
-
* Automatically enroll people into a course
|
|
1222
|
-
*/
|
|
1223
|
-
interface EnrollIntoCourse12MonthsPayload {
|
|
1224
|
-
/**
|
|
1225
|
-
* Select a course to enroll people in
|
|
1226
|
-
*/
|
|
1227
|
-
course_id: string;
|
|
1228
|
-
due_date: '12_months';
|
|
1229
|
-
/**
|
|
1230
|
-
* Select people to enroll in this course
|
|
1231
|
-
*/
|
|
1232
|
-
role_ids: string;
|
|
1233
|
-
/**
|
|
1234
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1235
|
-
*/
|
|
1236
|
-
skip_if_certified?: boolean | null;
|
|
1237
|
-
}
|
|
1238
|
-
/**
|
|
1239
|
-
* Automatically enroll people into a course
|
|
1240
|
-
*/
|
|
1241
|
-
interface EnrollIntoCourseCustomPayload {
|
|
1242
|
-
/**
|
|
1243
|
-
* Select a course to enroll people in
|
|
1244
|
-
*/
|
|
1245
|
-
course_id: string;
|
|
1246
|
-
due_date: 'custom';
|
|
1247
|
-
/**
|
|
1248
|
-
* Select people to enroll in this course
|
|
1249
|
-
*/
|
|
1250
|
-
role_ids: string;
|
|
1251
|
-
/**
|
|
1252
|
-
* Time unit
|
|
1253
|
-
*/
|
|
1254
|
-
custom_due_duration?: 'day' | 'week' | 'month' | 'year' | null;
|
|
1255
|
-
/**
|
|
1256
|
-
* Number of days/weeks/months/years
|
|
1257
|
-
*/
|
|
1258
|
-
custom_due_value?: number | null;
|
|
1259
|
-
/**
|
|
1260
|
-
* Skip enrollment if the employee already has a valid certificate for this course
|
|
1261
|
-
*/
|
|
1262
|
-
skip_if_certified?: boolean | null;
|
|
1263
|
-
}
|
|
1264
|
-
}
|
|
1265
|
-
interface EnrollIntoLearningPathActionRequest {
|
|
1266
|
-
action_type: 'enroll_into_learning_path';
|
|
1267
|
-
/**
|
|
1268
|
-
* Automatically enroll people into a learning path
|
|
1269
|
-
*/
|
|
1270
|
-
payload: EnrollIntoLearningPathActionRequest.Payload;
|
|
1271
|
-
workflow_definition_id: string;
|
|
1272
|
-
}
|
|
1273
|
-
namespace EnrollIntoLearningPathActionRequest {
|
|
1274
|
-
/**
|
|
1275
|
-
* Automatically enroll people into a learning path
|
|
1276
|
-
*/
|
|
1277
|
-
interface Payload {
|
|
1278
|
-
/**
|
|
1279
|
-
* Select a learning path to enroll people in
|
|
1280
|
-
*/
|
|
1281
|
-
learning_path_id: string;
|
|
1282
|
-
/**
|
|
1283
|
-
* Select people to enroll in this learning path
|
|
1284
|
-
*/
|
|
1285
|
-
role_ids: string;
|
|
1286
|
-
/**
|
|
1287
|
-
* Time unit
|
|
1288
|
-
*/
|
|
1289
|
-
custom_due_unit?: 'day' | 'week' | 'month' | 'year' | null;
|
|
1290
|
-
/**
|
|
1291
|
-
* Number of days/weeks/months/years
|
|
1292
|
-
*/
|
|
1293
|
-
custom_due_value?: number | null;
|
|
1294
|
-
/**
|
|
1295
|
-
* Number of days after completing one course before the next is due
|
|
1296
|
-
*/
|
|
1297
|
-
days_between_courses?: number | null;
|
|
1298
|
-
/**
|
|
1299
|
-
* Due date type
|
|
1300
|
-
*/
|
|
1301
|
-
due_date_type?: 'global' | 'relative' | null;
|
|
1302
|
-
/**
|
|
1303
|
-
* Due in
|
|
1304
|
-
*/
|
|
1305
|
-
due_in?: '1_week' | '2_weeks' | '1_month' | '3_months' | '6_months' | '12_months' | 'custom' | null;
|
|
1306
|
-
/**
|
|
1307
|
-
* Give credit for courses the employee has already completed
|
|
1308
|
-
*/
|
|
1309
|
-
induct_completed_enrollments?: boolean | null;
|
|
1310
|
-
/**
|
|
1311
|
-
* Skip enrollment if the employee already completed this learning path
|
|
1312
|
-
*/
|
|
1313
|
-
skip_if_completed?: boolean | null;
|
|
1314
|
-
}
|
|
1315
|
-
}
|
|
1316
|
-
interface SendReportEmailActionRequest {
|
|
1317
|
-
action_type: 'report_email';
|
|
1318
|
-
/**
|
|
1319
|
-
* Send Report via Email.
|
|
1320
|
-
*/
|
|
1321
|
-
payload: SendReportEmailActionRequest.SendReportEmailExcelPayload | SendReportEmailActionRequest.SendReportEmailCsvPayload;
|
|
1322
|
-
workflow_definition_id: string;
|
|
1323
|
-
}
|
|
1324
|
-
namespace SendReportEmailActionRequest {
|
|
1325
|
-
/**
|
|
1326
|
-
* Send Report via Email.
|
|
1327
|
-
*/
|
|
1328
|
-
interface SendReportEmailExcelPayload {
|
|
1329
|
-
file_type: 'EXCEL';
|
|
1330
|
-
/**
|
|
1331
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1332
|
-
*/
|
|
1333
|
-
report_id: string;
|
|
1334
|
-
/**
|
|
1335
|
-
* Whose report view should be used to generate this report? (Only the workflow
|
|
1336
|
-
* owner's access level will be available if external emails are included.)
|
|
1337
|
-
*/
|
|
1338
|
-
run_report_perms: 'RECIPIENT' | 'WORKFLOW_OWNER';
|
|
1339
|
-
send_to: SendReportEmailExcelPayload.SendTo;
|
|
1340
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1341
|
-
/**
|
|
1342
|
-
* CSV quoting
|
|
1343
|
-
*/
|
|
1344
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1345
|
-
/**
|
|
1346
|
-
* Currency field formatting
|
|
1347
|
-
*/
|
|
1348
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1349
|
-
/**
|
|
1350
|
-
* Date & time formatting
|
|
1351
|
-
*/
|
|
1352
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1353
|
-
/**
|
|
1354
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1355
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1356
|
-
* back to synchronous execution.
|
|
1357
|
-
*/
|
|
1358
|
-
run_id?: string | null;
|
|
1359
|
-
show_sub_totals?: boolean | null;
|
|
1360
|
-
/**
|
|
1361
|
-
* Time zones
|
|
1362
|
-
*/
|
|
1363
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1364
|
-
}
|
|
1365
|
-
namespace SendReportEmailExcelPayload {
|
|
1366
|
-
interface SendTo {
|
|
1367
|
-
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1368
|
-
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1369
|
-
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1370
|
-
}
|
|
1371
|
-
namespace SendTo {
|
|
1372
|
-
interface Recipient1 {
|
|
1373
|
-
supergroup: string;
|
|
1374
|
-
/**
|
|
1375
|
-
* Email type
|
|
1376
|
-
*/
|
|
1377
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1378
|
-
externalEmails?: Array<string> | null;
|
|
1379
|
-
}
|
|
1380
|
-
interface Recipient2 {
|
|
1381
|
-
externalEmails: Array<string>;
|
|
1382
|
-
/**
|
|
1383
|
-
* Email type
|
|
1384
|
-
*/
|
|
1385
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1386
|
-
supergroup?: string | null;
|
|
1387
|
-
}
|
|
1388
|
-
interface Recipient1 {
|
|
1389
|
-
supergroup: string;
|
|
1390
|
-
/**
|
|
1391
|
-
* Email type
|
|
1392
|
-
*/
|
|
1393
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1394
|
-
externalEmails?: Array<string> | null;
|
|
1395
|
-
}
|
|
1396
|
-
interface Recipient2 {
|
|
1397
|
-
externalEmails: Array<string>;
|
|
1398
|
-
/**
|
|
1399
|
-
* Email type
|
|
1400
|
-
*/
|
|
1401
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1402
|
-
supergroup?: string | null;
|
|
1403
|
-
}
|
|
1404
|
-
interface Recipient1 {
|
|
1405
|
-
supergroup: string;
|
|
1406
|
-
/**
|
|
1407
|
-
* Email type
|
|
1408
|
-
*/
|
|
1409
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1410
|
-
externalEmails?: Array<string> | null;
|
|
1411
|
-
}
|
|
1412
|
-
interface Recipient2 {
|
|
1413
|
-
externalEmails: Array<string>;
|
|
1414
|
-
/**
|
|
1415
|
-
* Email type
|
|
1416
|
-
*/
|
|
1417
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1418
|
-
supergroup?: string | null;
|
|
1419
|
-
}
|
|
1420
|
-
}
|
|
1421
|
-
}
|
|
1422
|
-
/**
|
|
1423
|
-
* Send Report via Email.
|
|
1424
|
-
*/
|
|
1425
|
-
interface SendReportEmailCsvPayload {
|
|
1426
|
-
file_type: 'CSV';
|
|
1427
|
-
/**
|
|
1428
|
-
* Not all report types are supported in workflows, like change and trend reports
|
|
1429
|
-
*/
|
|
1430
|
-
report_id: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* Whose report view should be used to generate this report? (Only the workflow
|
|
1433
|
-
* owner's access level will be available if external emails are included.)
|
|
1434
|
-
*/
|
|
1435
|
-
run_report_perms: 'RECIPIENT' | 'WORKFLOW_OWNER';
|
|
1436
|
-
send_to: SendReportEmailCsvPayload.SendTo;
|
|
1437
|
-
add_role_referenced_id_column?: boolean | null;
|
|
1438
|
-
/**
|
|
1439
|
-
* CSV quoting
|
|
1440
|
-
*/
|
|
1441
|
-
csv_quoting?: 1 | 0 | 2 | 3 | null;
|
|
1442
|
-
/**
|
|
1443
|
-
* Custom separator
|
|
1444
|
-
*/
|
|
1445
|
-
csv_separator?: ',' | ';' | '\t' | '|' | null;
|
|
1446
|
-
/**
|
|
1447
|
-
* Currency field formatting
|
|
1448
|
-
*/
|
|
1449
|
-
currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
|
|
1450
|
-
/**
|
|
1451
|
-
* Date & time formatting
|
|
1452
|
-
*/
|
|
1453
|
-
date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
|
|
1454
|
-
/**
|
|
1455
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1456
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1457
|
-
* back to synchronous execution.
|
|
1458
|
-
*/
|
|
1459
|
-
run_id?: string | null;
|
|
1460
|
-
show_sub_totals?: boolean | null;
|
|
1461
|
-
/**
|
|
1462
|
-
* Time zones
|
|
1463
|
-
*/
|
|
1464
|
-
time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
|
|
1465
|
-
}
|
|
1466
|
-
namespace SendReportEmailCsvPayload {
|
|
1467
|
-
interface SendTo {
|
|
1468
|
-
bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1469
|
-
cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1470
|
-
to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
|
|
1471
|
-
}
|
|
1472
|
-
namespace SendTo {
|
|
1473
|
-
interface Recipient1 {
|
|
1474
|
-
supergroup: string;
|
|
1475
|
-
/**
|
|
1476
|
-
* Email type
|
|
1477
|
-
*/
|
|
1478
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1479
|
-
externalEmails?: Array<string> | null;
|
|
1480
|
-
}
|
|
1481
|
-
interface Recipient2 {
|
|
1482
|
-
externalEmails: Array<string>;
|
|
1483
|
-
/**
|
|
1484
|
-
* Email type
|
|
1485
|
-
*/
|
|
1486
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1487
|
-
supergroup?: string | null;
|
|
1488
|
-
}
|
|
1489
|
-
interface Recipient1 {
|
|
1490
|
-
supergroup: string;
|
|
1491
|
-
/**
|
|
1492
|
-
* Email type
|
|
1493
|
-
*/
|
|
1494
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1495
|
-
externalEmails?: Array<string> | null;
|
|
1496
|
-
}
|
|
1497
|
-
interface Recipient2 {
|
|
1498
|
-
externalEmails: Array<string>;
|
|
1499
|
-
/**
|
|
1500
|
-
* Email type
|
|
1501
|
-
*/
|
|
1502
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1503
|
-
supergroup?: string | null;
|
|
1504
|
-
}
|
|
1505
|
-
interface Recipient1 {
|
|
1506
|
-
supergroup: string;
|
|
1507
|
-
/**
|
|
1508
|
-
* Email type
|
|
1509
|
-
*/
|
|
1510
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1511
|
-
externalEmails?: Array<string> | null;
|
|
1512
|
-
}
|
|
1513
|
-
interface Recipient2 {
|
|
1514
|
-
externalEmails: Array<string>;
|
|
1515
|
-
/**
|
|
1516
|
-
* Email type
|
|
1517
|
-
*/
|
|
1518
|
-
emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
|
|
1519
|
-
supergroup?: string | null;
|
|
1520
|
-
}
|
|
1521
|
-
}
|
|
1522
|
-
}
|
|
1523
|
-
}
|
|
1524
|
-
interface SendDocumentActionRequest {
|
|
1525
|
-
action_type: 'send_document';
|
|
1526
|
-
/**
|
|
1527
|
-
* Sends a document to employees
|
|
1528
|
-
*/
|
|
1529
|
-
payload: SendDocumentActionRequest.Payload;
|
|
1530
|
-
workflow_definition_id: string;
|
|
1531
|
-
}
|
|
1532
|
-
namespace SendDocumentActionRequest {
|
|
1533
|
-
/**
|
|
1534
|
-
* Sends a document to employees
|
|
1535
|
-
*/
|
|
1536
|
-
interface Payload {
|
|
1537
|
-
document: string;
|
|
1538
|
-
/**
|
|
1539
|
-
* Maximum recipients: 500
|
|
1540
|
-
*/
|
|
1541
|
-
recipients: string;
|
|
1542
|
-
/**
|
|
1543
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1544
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1545
|
-
* back to synchronous execution.
|
|
1546
|
-
*/
|
|
1547
|
-
run_id?: string | null;
|
|
1548
|
-
}
|
|
1549
|
-
}
|
|
1550
|
-
interface AccrueLeaveActionRequest {
|
|
1551
|
-
action_type: 'accrue_leave';
|
|
1552
|
-
/**
|
|
1553
|
-
* Adjust time off balance of a leave policy or a leave type
|
|
1554
|
-
*/
|
|
1555
|
-
payload: AccrueLeaveActionRequest.AccrueLeaveLeavePolicyPayload | AccrueLeaveActionRequest.AccrueLeaveCompanyLeaveTypePayload;
|
|
1556
|
-
workflow_definition_id: string;
|
|
1557
|
-
}
|
|
1558
|
-
namespace AccrueLeaveActionRequest {
|
|
1559
|
-
/**
|
|
1560
|
-
* Adjust time off balance of a leave policy or a leave type
|
|
1561
|
-
*/
|
|
1562
|
-
interface AccrueLeaveLeavePolicyPayload {
|
|
1563
|
-
/**
|
|
1564
|
-
* Choose how to adjust the employee's leave balance
|
|
1565
|
-
*/
|
|
1566
|
-
balance_action_type: 'ADD_BALANCE' | 'DEDUCT_BALANCE';
|
|
1567
|
-
balance_increment: number | string;
|
|
1568
|
-
/**
|
|
1569
|
-
* The unit of time to accrue leave in
|
|
1570
|
-
*/
|
|
1571
|
-
balance_unit: 'HOURS' | 'DAYS' | 'WEEKS';
|
|
1572
|
-
leave_policy: string;
|
|
1573
|
-
pto_type: 'LEAVE_POLICY';
|
|
1574
|
-
recipients: string;
|
|
1575
|
-
/**
|
|
1576
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1577
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1578
|
-
* back to synchronous execution.
|
|
1579
|
-
*/
|
|
1580
|
-
run_id?: string | null;
|
|
1581
|
-
}
|
|
1582
|
-
/**
|
|
1583
|
-
* Adjust time off balance of a leave policy or a leave type
|
|
1584
|
-
*/
|
|
1585
|
-
interface AccrueLeaveCompanyLeaveTypePayload {
|
|
1586
|
-
/**
|
|
1587
|
-
* Choose how to adjust the employee's leave balance
|
|
1588
|
-
*/
|
|
1589
|
-
balance_action_type: 'ADD_BALANCE' | 'DEDUCT_BALANCE';
|
|
1590
|
-
balance_increment: number | string;
|
|
1591
|
-
/**
|
|
1592
|
-
* The unit of time to accrue leave in
|
|
1593
|
-
*/
|
|
1594
|
-
balance_unit: 'HOURS' | 'DAYS' | 'WEEKS';
|
|
1595
|
-
company_leave_type: string;
|
|
1596
|
-
pto_type: 'COMPANY_LEAVE_TYPE';
|
|
1597
|
-
recipients: string;
|
|
1598
|
-
/**
|
|
1599
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1600
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1601
|
-
* back to synchronous execution.
|
|
1602
|
-
*/
|
|
1603
|
-
run_id?: string | null;
|
|
1604
|
-
}
|
|
1605
|
-
}
|
|
1606
|
-
interface MakePaymentActionRequest {
|
|
1607
|
-
action_type: 'make_payment';
|
|
1608
|
-
/**
|
|
1609
|
-
* Send a payment to employee(s). This payment will be applied to the next upcoming
|
|
1610
|
-
* payroll run.
|
|
1611
|
-
*/
|
|
1612
|
-
payload: MakePaymentActionRequest.Payload;
|
|
1613
|
-
workflow_definition_id: string;
|
|
1614
|
-
}
|
|
1615
|
-
namespace MakePaymentActionRequest {
|
|
1616
|
-
/**
|
|
1617
|
-
* Send a payment to employee(s). This payment will be applied to the next upcoming
|
|
1618
|
-
* payroll run.
|
|
1619
|
-
*/
|
|
1620
|
-
interface Payload {
|
|
1621
|
-
/**
|
|
1622
|
-
* Set a max amount that can be earned under this workflow
|
|
1623
|
-
*/
|
|
1624
|
-
apply_cap: boolean;
|
|
1625
|
-
description: string;
|
|
1626
|
-
payment_amount: number | string;
|
|
1627
|
-
recipients: string;
|
|
1628
|
-
/**
|
|
1629
|
-
* Functions Service run_id. When provided, the request returns 202 and completion
|
|
1630
|
-
* is delivered back to the run via SendRunEvent. When omitted, the action falls
|
|
1631
|
-
* back to synchronous execution.
|
|
1632
|
-
*/
|
|
1633
|
-
run_id?: string | null;
|
|
1634
|
-
}
|
|
1635
|
-
}
|
|
1636
|
-
interface RunQueryActionRequest {
|
|
1637
|
-
action_type: 'run_query';
|
|
1638
|
-
payload: RunQueryActionRequest.Payload;
|
|
1639
|
-
workflow_definition_id: string;
|
|
1640
|
-
}
|
|
1641
|
-
namespace RunQueryActionRequest {
|
|
1642
|
-
interface Payload {
|
|
1643
|
-
query: string;
|
|
1644
|
-
product_name?: string | null;
|
|
1645
|
-
}
|
|
25
|
+
interface Payload {
|
|
26
|
+
query: string;
|
|
27
|
+
product_name?: string | null;
|
|
1646
28
|
}
|
|
1647
29
|
}
|
|
1648
30
|
export declare namespace WorkflowActionExecutions {
|