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