@rippling/rippling-sdk 0.2.0-alpha.107 → 0.2.0-alpha.109

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.
Files changed (189) hide show
  1. package/client.d.mts +10 -1
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +10 -1
  4. package/client.d.ts.map +1 -1
  5. package/client.js +10 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs +10 -1
  8. package/client.mjs.map +1 -1
  9. package/lib/charts/builders.d.mts +18 -19
  10. package/lib/charts/builders.d.mts.map +1 -1
  11. package/lib/charts/builders.d.ts +18 -19
  12. package/lib/charts/builders.d.ts.map +1 -1
  13. package/lib/charts/builders.js +35 -28
  14. package/lib/charts/builders.js.map +1 -1
  15. package/lib/charts/builders.mjs +35 -28
  16. package/lib/charts/builders.mjs.map +1 -1
  17. package/lib/charts/describe.d.mts +6 -7
  18. package/lib/charts/describe.d.mts.map +1 -1
  19. package/lib/charts/describe.d.ts +6 -7
  20. package/lib/charts/describe.d.ts.map +1 -1
  21. package/lib/charts/describe.js +26 -27
  22. package/lib/charts/describe.js.map +1 -1
  23. package/lib/charts/describe.mjs +27 -28
  24. package/lib/charts/describe.mjs.map +1 -1
  25. package/lib/charts/errors.d.mts +2 -6
  26. package/lib/charts/errors.d.mts.map +1 -1
  27. package/lib/charts/errors.d.ts +2 -6
  28. package/lib/charts/errors.d.ts.map +1 -1
  29. package/lib/charts/errors.js +2 -6
  30. package/lib/charts/errors.js.map +1 -1
  31. package/lib/charts/errors.mjs +2 -6
  32. package/lib/charts/errors.mjs.map +1 -1
  33. package/lib/charts/evaluate.d.mts +5 -7
  34. package/lib/charts/evaluate.d.mts.map +1 -1
  35. package/lib/charts/evaluate.d.ts +5 -7
  36. package/lib/charts/evaluate.d.ts.map +1 -1
  37. package/lib/charts/evaluate.js +21 -35
  38. package/lib/charts/evaluate.js.map +1 -1
  39. package/lib/charts/evaluate.mjs +22 -36
  40. package/lib/charts/evaluate.mjs.map +1 -1
  41. package/lib/charts/schema.d.mts +8 -97
  42. package/lib/charts/schema.d.mts.map +1 -1
  43. package/lib/charts/schema.d.ts +8 -97
  44. package/lib/charts/schema.d.ts.map +1 -1
  45. package/lib/charts/schema.js +186 -65
  46. package/lib/charts/schema.js.map +1 -1
  47. package/lib/charts/schema.mjs +185 -65
  48. package/lib/charts/schema.mjs.map +1 -1
  49. package/lib/charts/types.d.mts +40 -25
  50. package/lib/charts/types.d.mts.map +1 -1
  51. package/lib/charts/types.d.ts +40 -25
  52. package/lib/charts/types.d.ts.map +1 -1
  53. package/lib/charts/types.js +8 -10
  54. package/lib/charts/types.js.map +1 -1
  55. package/lib/charts/types.mjs +8 -10
  56. package/lib/charts/types.mjs.map +1 -1
  57. package/lib/charts/visualization-grammar.d.mts +66 -0
  58. package/lib/charts/visualization-grammar.d.mts.map +1 -0
  59. package/lib/charts/visualization-grammar.d.ts +66 -0
  60. package/lib/charts/visualization-grammar.d.ts.map +1 -0
  61. package/lib/charts/visualization-grammar.js +70 -0
  62. package/lib/charts/visualization-grammar.js.map +1 -0
  63. package/lib/charts/visualization-grammar.mjs +67 -0
  64. package/lib/charts/visualization-grammar.mjs.map +1 -0
  65. package/lib/charts/vocabulary.d.mts +7 -0
  66. package/lib/charts/vocabulary.d.mts.map +1 -0
  67. package/lib/charts/vocabulary.d.ts +7 -0
  68. package/lib/charts/vocabulary.d.ts.map +1 -0
  69. package/lib/charts/vocabulary.js +10 -0
  70. package/lib/charts/vocabulary.js.map +1 -0
  71. package/lib/charts/vocabulary.mjs +7 -0
  72. package/lib/charts/vocabulary.mjs.map +1 -0
  73. package/lib/charts.d.mts +3 -3
  74. package/lib/charts.d.mts.map +1 -1
  75. package/lib/charts.d.ts +3 -3
  76. package/lib/charts.d.ts.map +1 -1
  77. package/lib/charts.js +2 -1
  78. package/lib/charts.js.map +1 -1
  79. package/lib/charts.mjs +1 -1
  80. package/lib/charts.mjs.map +1 -1
  81. package/package.json +4 -2
  82. package/resources/card-transactions.d.mts +579 -0
  83. package/resources/card-transactions.d.mts.map +1 -0
  84. package/resources/card-transactions.d.ts +579 -0
  85. package/resources/card-transactions.d.ts.map +1 -0
  86. package/resources/card-transactions.js +116 -0
  87. package/resources/card-transactions.js.map +1 -0
  88. package/resources/card-transactions.mjs +112 -0
  89. package/resources/card-transactions.mjs.map +1 -0
  90. package/resources/earning-types.d.mts +50 -10
  91. package/resources/earning-types.d.mts.map +1 -1
  92. package/resources/earning-types.d.ts +50 -10
  93. package/resources/earning-types.d.ts.map +1 -1
  94. package/resources/earning-types.js +21 -2
  95. package/resources/earning-types.js.map +1 -1
  96. package/resources/earning-types.mjs +21 -2
  97. package/resources/earning-types.mjs.map +1 -1
  98. package/resources/index.d.mts +4 -1
  99. package/resources/index.d.mts.map +1 -1
  100. package/resources/index.d.ts +4 -1
  101. package/resources/index.d.ts.map +1 -1
  102. package/resources/index.js +10 -4
  103. package/resources/index.js.map +1 -1
  104. package/resources/index.mjs +4 -1
  105. package/resources/index.mjs.map +1 -1
  106. package/resources/reimbursements.d.mts +954 -0
  107. package/resources/reimbursements.d.mts.map +1 -0
  108. package/resources/reimbursements.d.ts +954 -0
  109. package/resources/reimbursements.d.ts.map +1 -0
  110. package/resources/reimbursements.js +140 -0
  111. package/resources/reimbursements.js.map +1 -0
  112. package/resources/reimbursements.mjs +136 -0
  113. package/resources/reimbursements.mjs.map +1 -0
  114. package/resources/spend-categories.d.mts +140 -0
  115. package/resources/spend-categories.d.mts.map +1 -0
  116. package/resources/spend-categories.d.ts +140 -0
  117. package/resources/spend-categories.d.ts.map +1 -0
  118. package/resources/spend-categories.js +83 -0
  119. package/resources/spend-categories.js.map +1 -0
  120. package/resources/spend-categories.mjs +79 -0
  121. package/resources/spend-categories.mjs.map +1 -0
  122. package/resources/workflows/executions.d.mts +153 -0
  123. package/resources/workflows/executions.d.mts.map +1 -0
  124. package/resources/workflows/executions.d.ts +153 -0
  125. package/resources/workflows/executions.d.ts.map +1 -0
  126. package/resources/workflows/executions.js +74 -0
  127. package/resources/workflows/executions.js.map +1 -0
  128. package/resources/workflows/executions.mjs +70 -0
  129. package/resources/workflows/executions.mjs.map +1 -0
  130. package/resources/workflows/index.d.mts +3 -0
  131. package/resources/workflows/index.d.mts.map +1 -0
  132. package/resources/workflows/index.d.ts +3 -0
  133. package/resources/workflows/index.d.ts.map +1 -0
  134. package/resources/workflows/index.js +9 -0
  135. package/resources/workflows/index.js.map +1 -0
  136. package/resources/workflows/index.mjs +4 -0
  137. package/resources/workflows/index.mjs.map +1 -0
  138. package/resources/workflows/workflows.d.mts +977 -0
  139. package/resources/workflows/workflows.d.mts.map +1 -0
  140. package/resources/workflows/workflows.d.ts +977 -0
  141. package/resources/workflows/workflows.d.ts.map +1 -0
  142. package/resources/workflows/workflows.js +246 -0
  143. package/resources/workflows/workflows.js.map +1 -0
  144. package/resources/workflows/workflows.mjs +241 -0
  145. package/resources/workflows/workflows.mjs.map +1 -0
  146. package/resources/workflows.d.mts +1 -972
  147. package/resources/workflows.d.mts.map +1 -1
  148. package/resources/workflows.d.ts +1 -972
  149. package/resources/workflows.d.ts.map +1 -1
  150. package/resources/workflows.js +2 -234
  151. package/resources/workflows.js.map +1 -1
  152. package/resources/workflows.mjs +1 -232
  153. package/resources/workflows.mjs.map +1 -1
  154. package/src/client.ts +63 -12
  155. package/src/lib/charts/README.md +35 -28
  156. package/src/lib/charts/agent-reference.md +73 -0
  157. package/src/lib/charts/builders.ts +51 -35
  158. package/src/lib/charts/capabilities.json +96 -0
  159. package/src/lib/charts/describe.ts +31 -29
  160. package/src/lib/charts/errors.ts +2 -6
  161. package/src/lib/charts/evaluate.ts +25 -38
  162. package/src/lib/charts/schema.ts +232 -66
  163. package/src/lib/charts/types.ts +42 -31
  164. package/src/lib/charts/visualization-grammar.ts +67 -0
  165. package/src/lib/charts/vocabulary.ts +7 -0
  166. package/src/lib/charts.ts +8 -1
  167. package/src/resources/card-transactions.ts +718 -0
  168. package/src/resources/earning-types.ts +52 -10
  169. package/src/resources/index.ts +22 -1
  170. package/src/resources/reimbursements.ts +1157 -0
  171. package/src/resources/spend-categories.ts +175 -0
  172. package/src/resources/workflows/executions.ts +191 -0
  173. package/src/resources/workflows/index.ts +15 -0
  174. package/src/resources/workflows/workflows.ts +1661 -0
  175. package/src/resources/workflows.ts +1 -1647
  176. package/src/version.ts +1 -1
  177. package/version.d.mts +1 -1
  178. package/version.d.ts +1 -1
  179. package/version.js +1 -1
  180. package/version.mjs +1 -1
  181. package/lib/charts/guards.d.mts +0 -15
  182. package/lib/charts/guards.d.mts.map +0 -1
  183. package/lib/charts/guards.d.ts +0 -15
  184. package/lib/charts/guards.d.ts.map +0 -1
  185. package/lib/charts/guards.js +0 -38
  186. package/lib/charts/guards.js.map +0 -1
  187. package/lib/charts/guards.mjs +0 -34
  188. package/lib/charts/guards.mjs.map +0 -1
  189. package/src/lib/charts/guards.ts +0 -42
@@ -1,1649 +1,3 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
- import { APIResource } from '../core/resource';
4
- import { APIPromise } from '../core/api-promise';
5
- import { PageCursorURL, PagePromise } from '../core/pagination';
6
- import { buildHeaders } from '../internal/headers';
7
- import { RequestOptions } from '../internal/request-options';
8
- import { path } from '../internal/utils/path';
9
-
10
- /**
11
- * Execute workflow actions like sending emails, Slack messages, and notifications
12
- */
13
- export class Workflows extends APIResource {
14
- /**
15
- * List workflows
16
- *
17
- * @example HTTP
18
- * Representative request and response shapes.
19
- * ```
20
- * GET /workflows/?limit=50&cursor=cursor HTTP/1.1
21
- * Host: rest.ripplingapis.com
22
- * Accept: application/json
23
- * Rippling-Api-Version: 2024-08-01
24
- *
25
- * HTTP/1.1 200 OK
26
- * Content-Type: application/json
27
- *
28
- * {
29
- * "results": [
30
- * {
31
- * "id": "string",
32
- * "version_id": "string",
33
- * "name": "string",
34
- * "description": "string",
35
- * "status": "draft",
36
- * "enabled": false,
37
- * "owner_id": "string",
38
- * "has_draft": false,
39
- * "created_at": "2025-01-01T00:00:00Z",
40
- * "updated_at": "2025-01-01T00:00:00Z"
41
- * }
42
- * ],
43
- * "next_link": "string"
44
- * }
45
- * ```
46
- */
47
- list(
48
- query: WorkflowListParams | null | undefined = {},
49
- options?: RequestOptions,
50
- ): PagePromise<WorkflowListResponsesPageCursorURL, WorkflowListResponse> {
51
- return this._client.getAPIList('/workflows/', PageCursorURL<WorkflowListResponse>, { query, ...options });
52
- }
53
-
54
- /**
55
- * Create a workflow
56
- *
57
- * @example HTTP
58
- * Representative request and response shapes.
59
- * ```
60
- * POST /workflows/ HTTP/1.1
61
- * Host: rest.ripplingapis.com
62
- * Content-Type: application/json
63
- * Accept: application/json
64
- * Rippling-Api-Version: 2024-08-01
65
- *
66
- * {
67
- * "actions": [
68
- * {
69
- * "id": "x",
70
- * "implementation_config": "x",
71
- * "kind": "registered_callback",
72
- * "owner_id": "x",
73
- * "owner_type": "x"
74
- * }
75
- * ],
76
- * "name": "x",
77
- * "trigger": {
78
- * "hour": 0,
79
- * "kind": "daily_schedule",
80
- * "timezone": "timezone"
81
- * }
82
- * }
83
- *
84
- * HTTP/1.1 201 Created
85
- * Content-Type: application/json
86
- *
87
- * {
88
- * "id": "string",
89
- * "version_id": "string",
90
- * "name": "string",
91
- * "description": "string",
92
- * "status": "draft",
93
- * "enabled": false,
94
- * "owner_id": "string",
95
- * "has_draft": false,
96
- * "created_at": "2025-01-01T00:00:00Z",
97
- * "updated_at": "2025-01-01T00:00:00Z",
98
- * "definition": {
99
- * "kind": "editable",
100
- * "trigger": {},
101
- * "actions": [
102
- * {}
103
- * ]
104
- * },
105
- * "authoring": {
106
- * "mode": "full",
107
- * "patchable_fields": [
108
- * "name"
109
- * ],
110
- * "reason_codes": [
111
- * "unsupported_trigger"
112
- * ]
113
- * },
114
- * "deletable": false
115
- * }
116
- * ```
117
- */
118
- create(body: WorkflowCreateParams, options?: RequestOptions): APIPromise<WorkflowCreateResponse> {
119
- return this._client.post('/workflows/', { body, ...options });
120
- }
121
-
122
- /**
123
- * Retrieve a workflow
124
- *
125
- * @example HTTP
126
- * Representative request and response shapes.
127
- * ```
128
- * GET /workflows/{id}/?version_id=version_id HTTP/1.1
129
- * Host: rest.ripplingapis.com
130
- * Accept: application/json
131
- * Rippling-Api-Version: 2024-08-01
132
- *
133
- * HTTP/1.1 200 OK
134
- * Content-Type: application/json
135
- *
136
- * {
137
- * "id": "string",
138
- * "version_id": "string",
139
- * "name": "string",
140
- * "description": "string",
141
- * "status": "draft",
142
- * "enabled": false,
143
- * "owner_id": "string",
144
- * "has_draft": false,
145
- * "created_at": "2025-01-01T00:00:00Z",
146
- * "updated_at": "2025-01-01T00:00:00Z",
147
- * "definition": {
148
- * "kind": "editable",
149
- * "trigger": {},
150
- * "actions": [
151
- * {}
152
- * ]
153
- * },
154
- * "authoring": {
155
- * "mode": "full",
156
- * "patchable_fields": [
157
- * "name"
158
- * ],
159
- * "reason_codes": [
160
- * "unsupported_trigger"
161
- * ]
162
- * },
163
- * "deletable": false
164
- * }
165
- * ```
166
- */
167
- retrieve(
168
- id: string,
169
- query: WorkflowRetrieveParams | null | undefined = {},
170
- options?: RequestOptions,
171
- ): APIPromise<WorkflowRetrieveResponse> {
172
- return this._client.get(path`/workflows/${id}/`, { query, ...options });
173
- }
174
-
175
- /**
176
- * Update a workflow
177
- *
178
- * @example HTTP
179
- * Representative request and response shapes.
180
- * ```
181
- * PATCH /workflows/{id}/ HTTP/1.1
182
- * Host: rest.ripplingapis.com
183
- * Content-Type: application/json
184
- * Accept: application/json
185
- * Rippling-Api-Version: 2024-08-01
186
- *
187
- * {
188
- * "version_id": "x"
189
- * }
190
- *
191
- * HTTP/1.1 200 OK
192
- * Content-Type: application/json
193
- *
194
- * {
195
- * "id": "string",
196
- * "version_id": "string",
197
- * "name": "string",
198
- * "description": "string",
199
- * "status": "draft",
200
- * "enabled": false,
201
- * "owner_id": "string",
202
- * "has_draft": false,
203
- * "created_at": "2025-01-01T00:00:00Z",
204
- * "updated_at": "2025-01-01T00:00:00Z",
205
- * "definition": {
206
- * "kind": "editable",
207
- * "trigger": {},
208
- * "actions": [
209
- * {}
210
- * ]
211
- * },
212
- * "authoring": {
213
- * "mode": "full",
214
- * "patchable_fields": [
215
- * "name"
216
- * ],
217
- * "reason_codes": [
218
- * "unsupported_trigger"
219
- * ]
220
- * },
221
- * "deletable": false
222
- * }
223
- * ```
224
- */
225
- update(
226
- id: string,
227
- body: WorkflowUpdateParams,
228
- options?: RequestOptions,
229
- ): APIPromise<WorkflowUpdateResponse> {
230
- return this._client.patch(path`/workflows/${id}/`, { body, ...options });
231
- }
232
-
233
- /**
234
- * Delete a workflow
235
- *
236
- * @example HTTP
237
- * Representative request and response shapes.
238
- * ```
239
- * DELETE /workflows/{id}/ HTTP/1.1
240
- * Host: rest.ripplingapis.com
241
- * Rippling-Api-Version: 2024-08-01
242
- *
243
- * HTTP/1.1 204 No Content
244
- * ```
245
- */
246
- delete(id: string, options?: RequestOptions): APIPromise<void> {
247
- return this._client.delete(path`/workflows/${id}/`, {
248
- ...options,
249
- headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
250
- });
251
- }
252
- }
253
-
254
- export type WorkflowListResponsesPageCursorURL = PageCursorURL<WorkflowListResponse>;
255
-
256
- export interface WorkflowListResponse {
257
- id: string;
258
-
259
- created_at: string;
260
-
261
- description: string | null;
262
-
263
- enabled: boolean;
264
-
265
- has_draft: boolean;
266
-
267
- name: string;
268
-
269
- owner_id: string;
270
-
271
- status: 'draft' | 'published' | 'unknown';
272
-
273
- updated_at: string;
274
-
275
- version_id: string;
276
- }
277
-
278
- export interface WorkflowCreateResponse {
279
- id: string;
280
-
281
- authoring: WorkflowCreateResponse.Authoring;
282
-
283
- created_at: string;
284
-
285
- definition:
286
- | WorkflowCreateResponse.EditableWorkflowDefinition
287
- | WorkflowCreateResponse.ReadOnlyWorkflowDefinition;
288
-
289
- deletable: boolean;
290
-
291
- enabled: boolean;
292
-
293
- has_draft: boolean;
294
-
295
- name: string;
296
-
297
- owner_id: string;
298
-
299
- status: 'draft' | 'published' | 'unknown';
300
-
301
- updated_at: string;
302
-
303
- version_id: string;
304
-
305
- description?: string | null;
306
- }
307
-
308
- export namespace WorkflowCreateResponse {
309
- export interface Authoring {
310
- mode: 'full' | 'metadata_only' | 'read_only';
311
-
312
- patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
313
-
314
- reason_codes: Array<
315
- 'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'
316
- >;
317
- }
318
-
319
- export interface EditableWorkflowDefinition {
320
- actions: Array<EditableWorkflowDefinition.Action>;
321
-
322
- kind: 'editable';
323
-
324
- trigger:
325
- | EditableWorkflowDefinition.DailyScheduleTrigger
326
- | EditableWorkflowDefinition.BusinessEventTrigger
327
- | EditableWorkflowDefinition.WeekdayScheduleTrigger
328
- | EditableWorkflowDefinition.WeeklyScheduleTrigger
329
- | EditableWorkflowDefinition.BiweeklyScheduleTrigger
330
- | EditableWorkflowDefinition.MonthlyScheduleTrigger
331
- | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger
332
- | EditableWorkflowDefinition.QuarterlyScheduleTrigger
333
- | EditableWorkflowDefinition.AnnualScheduleTrigger
334
- | EditableWorkflowDefinition.OneTimeScheduleTrigger
335
- | EditableWorkflowDefinition.CustomScheduleTrigger
336
- | EditableWorkflowDefinition.CronScheduleTrigger
337
- | EditableWorkflowDefinition.ManualTrigger
338
- | EditableWorkflowDefinition.SlackTrigger
339
- | EditableWorkflowDefinition.InboundEmailTrigger;
340
- }
341
-
342
- export namespace EditableWorkflowDefinition {
343
- export interface Action {
344
- id: string;
345
-
346
- implementation_config: string;
347
-
348
- kind: 'registered_callback';
349
-
350
- owner_id: string;
351
-
352
- owner_type: string;
353
- }
354
-
355
- export interface DailyScheduleTrigger {
356
- hour: number;
357
-
358
- kind: 'daily_schedule';
359
-
360
- timezone: string;
361
-
362
- minute?: number;
363
- }
364
-
365
- export interface BusinessEventTrigger {
366
- event_name: string;
367
-
368
- kind: 'business_event';
369
- }
370
-
371
- export interface WeekdayScheduleTrigger {
372
- hour: number;
373
-
374
- kind: 'weekday_schedule';
375
-
376
- timezone: string;
377
-
378
- minute?: number;
379
- }
380
-
381
- export interface WeeklyScheduleTrigger {
382
- days_of_week: Array<number>;
383
-
384
- hour: number;
385
-
386
- kind: 'weekly_schedule';
387
-
388
- timezone: string;
389
-
390
- minute?: number;
391
- }
392
-
393
- export interface BiweeklyScheduleTrigger {
394
- days_of_week: Array<number>;
395
-
396
- hour: number;
397
-
398
- kind: 'biweekly_schedule';
399
-
400
- timezone: string;
401
-
402
- minute?: number;
403
- }
404
-
405
- export interface MonthlyScheduleTrigger {
406
- day_of_month: number;
407
-
408
- hour: number;
409
-
410
- kind: 'monthly_schedule';
411
-
412
- timezone: string;
413
-
414
- minute?: number;
415
- }
416
-
417
- export interface MonthlyOnDayOfWeekScheduleTrigger {
418
- day_of_week: number;
419
-
420
- hour: number;
421
-
422
- kind: 'monthly_on_day_of_week_schedule';
423
-
424
- timezone: string;
425
-
426
- week_of_month: number;
427
-
428
- minute?: number;
429
- }
430
-
431
- export interface QuarterlyScheduleTrigger {
432
- day_of_month: number;
433
-
434
- hour: number;
435
-
436
- kind: 'quarterly_schedule';
437
-
438
- month_of_year: number;
439
-
440
- timezone: string;
441
-
442
- minute?: number;
443
- }
444
-
445
- export interface AnnualScheduleTrigger {
446
- day_of_month: number;
447
-
448
- hour: number;
449
-
450
- kind: 'annual_schedule';
451
-
452
- month_of_year: number;
453
-
454
- timezone: string;
455
-
456
- minute?: number;
457
- }
458
-
459
- export interface OneTimeScheduleTrigger {
460
- day_of_month: number;
461
-
462
- hour: number;
463
-
464
- kind: 'one_time_schedule';
465
-
466
- month_of_year: number;
467
-
468
- timezone: string;
469
-
470
- year: number;
471
-
472
- minute?: number;
473
- }
474
-
475
- export interface CustomScheduleTrigger {
476
- interval: number;
477
-
478
- kind: 'custom_schedule';
479
-
480
- timezone: string;
481
-
482
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
483
-
484
- day_of_month?: number | null;
485
-
486
- days_of_week?: Array<number> | null;
487
-
488
- hour?: number;
489
-
490
- minute?: number;
491
-
492
- month_of_year?: number | null;
493
-
494
- start_month?: number | null;
495
- }
496
-
497
- export interface CronScheduleTrigger {
498
- expression: string;
499
-
500
- kind: 'cron_schedule';
501
-
502
- timezone: string;
503
- }
504
-
505
- export interface ManualTrigger {
506
- kind: 'manual';
507
- }
508
-
509
- export interface SlackTrigger {
510
- channel_ids: Array<string>;
511
-
512
- event_type: 'message_posted' | 'reaction_added';
513
-
514
- kind: 'slack';
515
-
516
- allowed_sender_group_id?: string | null;
517
-
518
- include_thread_replies?: boolean;
519
-
520
- message_text_regex?: string | null;
521
-
522
- reaction_names?: Array<string>;
523
- }
524
-
525
- export interface InboundEmailTrigger {
526
- kind: 'inbound_email';
527
-
528
- recipient_email: string;
529
-
530
- body_contains?: string | null;
531
-
532
- has_attachment?: boolean;
533
-
534
- subject_contains?: string | null;
535
- }
536
- }
537
-
538
- export interface ReadOnlyWorkflowDefinition {
539
- kind: 'read_only';
540
-
541
- steps: Array<ReadOnlyWorkflowDefinition.Step>;
542
-
543
- trigger: ReadOnlyWorkflowDefinition.Trigger;
544
- }
545
-
546
- export namespace ReadOnlyWorkflowDefinition {
547
- export interface Step {
548
- id: string;
549
-
550
- kind: 'read_only';
551
-
552
- name: string;
553
-
554
- next_ids: Array<string>;
555
-
556
- source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
557
- }
558
-
559
- export interface Trigger {
560
- kind: 'read_only';
561
-
562
- source_type:
563
- | 'business_event'
564
- | 'record_change'
565
- | 'scheduled'
566
- | 'manual'
567
- | 'webhook'
568
- | 'date_relative'
569
- | 'integration'
570
- | 'unknown';
571
-
572
- summary: string;
573
- }
574
- }
575
- }
576
-
577
- export interface WorkflowRetrieveResponse {
578
- id: string;
579
-
580
- authoring: WorkflowRetrieveResponse.Authoring;
581
-
582
- created_at: string;
583
-
584
- definition:
585
- | WorkflowRetrieveResponse.EditableWorkflowDefinition
586
- | WorkflowRetrieveResponse.ReadOnlyWorkflowDefinition;
587
-
588
- deletable: boolean;
589
-
590
- enabled: boolean;
591
-
592
- has_draft: boolean;
593
-
594
- name: string;
595
-
596
- owner_id: string;
597
-
598
- status: 'draft' | 'published' | 'unknown';
599
-
600
- updated_at: string;
601
-
602
- version_id: string;
603
-
604
- description?: string | null;
605
- }
606
-
607
- export namespace WorkflowRetrieveResponse {
608
- export interface Authoring {
609
- mode: 'full' | 'metadata_only' | 'read_only';
610
-
611
- patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
612
-
613
- reason_codes: Array<
614
- 'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'
615
- >;
616
- }
617
-
618
- export interface EditableWorkflowDefinition {
619
- actions: Array<EditableWorkflowDefinition.Action>;
620
-
621
- kind: 'editable';
622
-
623
- trigger:
624
- | EditableWorkflowDefinition.DailyScheduleTrigger
625
- | EditableWorkflowDefinition.BusinessEventTrigger
626
- | EditableWorkflowDefinition.WeekdayScheduleTrigger
627
- | EditableWorkflowDefinition.WeeklyScheduleTrigger
628
- | EditableWorkflowDefinition.BiweeklyScheduleTrigger
629
- | EditableWorkflowDefinition.MonthlyScheduleTrigger
630
- | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger
631
- | EditableWorkflowDefinition.QuarterlyScheduleTrigger
632
- | EditableWorkflowDefinition.AnnualScheduleTrigger
633
- | EditableWorkflowDefinition.OneTimeScheduleTrigger
634
- | EditableWorkflowDefinition.CustomScheduleTrigger
635
- | EditableWorkflowDefinition.CronScheduleTrigger
636
- | EditableWorkflowDefinition.ManualTrigger
637
- | EditableWorkflowDefinition.SlackTrigger
638
- | EditableWorkflowDefinition.InboundEmailTrigger;
639
- }
640
-
641
- export namespace EditableWorkflowDefinition {
642
- export interface Action {
643
- id: string;
644
-
645
- implementation_config: string;
646
-
647
- kind: 'registered_callback';
648
-
649
- owner_id: string;
650
-
651
- owner_type: string;
652
- }
653
-
654
- export interface DailyScheduleTrigger {
655
- hour: number;
656
-
657
- kind: 'daily_schedule';
658
-
659
- timezone: string;
660
-
661
- minute?: number;
662
- }
663
-
664
- export interface BusinessEventTrigger {
665
- event_name: string;
666
-
667
- kind: 'business_event';
668
- }
669
-
670
- export interface WeekdayScheduleTrigger {
671
- hour: number;
672
-
673
- kind: 'weekday_schedule';
674
-
675
- timezone: string;
676
-
677
- minute?: number;
678
- }
679
-
680
- export interface WeeklyScheduleTrigger {
681
- days_of_week: Array<number>;
682
-
683
- hour: number;
684
-
685
- kind: 'weekly_schedule';
686
-
687
- timezone: string;
688
-
689
- minute?: number;
690
- }
691
-
692
- export interface BiweeklyScheduleTrigger {
693
- days_of_week: Array<number>;
694
-
695
- hour: number;
696
-
697
- kind: 'biweekly_schedule';
698
-
699
- timezone: string;
700
-
701
- minute?: number;
702
- }
703
-
704
- export interface MonthlyScheduleTrigger {
705
- day_of_month: number;
706
-
707
- hour: number;
708
-
709
- kind: 'monthly_schedule';
710
-
711
- timezone: string;
712
-
713
- minute?: number;
714
- }
715
-
716
- export interface MonthlyOnDayOfWeekScheduleTrigger {
717
- day_of_week: number;
718
-
719
- hour: number;
720
-
721
- kind: 'monthly_on_day_of_week_schedule';
722
-
723
- timezone: string;
724
-
725
- week_of_month: number;
726
-
727
- minute?: number;
728
- }
729
-
730
- export interface QuarterlyScheduleTrigger {
731
- day_of_month: number;
732
-
733
- hour: number;
734
-
735
- kind: 'quarterly_schedule';
736
-
737
- month_of_year: number;
738
-
739
- timezone: string;
740
-
741
- minute?: number;
742
- }
743
-
744
- export interface AnnualScheduleTrigger {
745
- day_of_month: number;
746
-
747
- hour: number;
748
-
749
- kind: 'annual_schedule';
750
-
751
- month_of_year: number;
752
-
753
- timezone: string;
754
-
755
- minute?: number;
756
- }
757
-
758
- export interface OneTimeScheduleTrigger {
759
- day_of_month: number;
760
-
761
- hour: number;
762
-
763
- kind: 'one_time_schedule';
764
-
765
- month_of_year: number;
766
-
767
- timezone: string;
768
-
769
- year: number;
770
-
771
- minute?: number;
772
- }
773
-
774
- export interface CustomScheduleTrigger {
775
- interval: number;
776
-
777
- kind: 'custom_schedule';
778
-
779
- timezone: string;
780
-
781
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
782
-
783
- day_of_month?: number | null;
784
-
785
- days_of_week?: Array<number> | null;
786
-
787
- hour?: number;
788
-
789
- minute?: number;
790
-
791
- month_of_year?: number | null;
792
-
793
- start_month?: number | null;
794
- }
795
-
796
- export interface CronScheduleTrigger {
797
- expression: string;
798
-
799
- kind: 'cron_schedule';
800
-
801
- timezone: string;
802
- }
803
-
804
- export interface ManualTrigger {
805
- kind: 'manual';
806
- }
807
-
808
- export interface SlackTrigger {
809
- channel_ids: Array<string>;
810
-
811
- event_type: 'message_posted' | 'reaction_added';
812
-
813
- kind: 'slack';
814
-
815
- allowed_sender_group_id?: string | null;
816
-
817
- include_thread_replies?: boolean;
818
-
819
- message_text_regex?: string | null;
820
-
821
- reaction_names?: Array<string>;
822
- }
823
-
824
- export interface InboundEmailTrigger {
825
- kind: 'inbound_email';
826
-
827
- recipient_email: string;
828
-
829
- body_contains?: string | null;
830
-
831
- has_attachment?: boolean;
832
-
833
- subject_contains?: string | null;
834
- }
835
- }
836
-
837
- export interface ReadOnlyWorkflowDefinition {
838
- kind: 'read_only';
839
-
840
- steps: Array<ReadOnlyWorkflowDefinition.Step>;
841
-
842
- trigger: ReadOnlyWorkflowDefinition.Trigger;
843
- }
844
-
845
- export namespace ReadOnlyWorkflowDefinition {
846
- export interface Step {
847
- id: string;
848
-
849
- kind: 'read_only';
850
-
851
- name: string;
852
-
853
- next_ids: Array<string>;
854
-
855
- source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
856
- }
857
-
858
- export interface Trigger {
859
- kind: 'read_only';
860
-
861
- source_type:
862
- | 'business_event'
863
- | 'record_change'
864
- | 'scheduled'
865
- | 'manual'
866
- | 'webhook'
867
- | 'date_relative'
868
- | 'integration'
869
- | 'unknown';
870
-
871
- summary: string;
872
- }
873
- }
874
- }
875
-
876
- export interface WorkflowUpdateResponse {
877
- id: string;
878
-
879
- authoring: WorkflowUpdateResponse.Authoring;
880
-
881
- created_at: string;
882
-
883
- definition:
884
- | WorkflowUpdateResponse.EditableWorkflowDefinition
885
- | WorkflowUpdateResponse.ReadOnlyWorkflowDefinition;
886
-
887
- deletable: boolean;
888
-
889
- enabled: boolean;
890
-
891
- has_draft: boolean;
892
-
893
- name: string;
894
-
895
- owner_id: string;
896
-
897
- status: 'draft' | 'published' | 'unknown';
898
-
899
- updated_at: string;
900
-
901
- version_id: string;
902
-
903
- description?: string | null;
904
- }
905
-
906
- export namespace WorkflowUpdateResponse {
907
- export interface Authoring {
908
- mode: 'full' | 'metadata_only' | 'read_only';
909
-
910
- patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
911
-
912
- reason_codes: Array<
913
- 'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'
914
- >;
915
- }
916
-
917
- export interface EditableWorkflowDefinition {
918
- actions: Array<EditableWorkflowDefinition.Action>;
919
-
920
- kind: 'editable';
921
-
922
- trigger:
923
- | EditableWorkflowDefinition.DailyScheduleTrigger
924
- | EditableWorkflowDefinition.BusinessEventTrigger
925
- | EditableWorkflowDefinition.WeekdayScheduleTrigger
926
- | EditableWorkflowDefinition.WeeklyScheduleTrigger
927
- | EditableWorkflowDefinition.BiweeklyScheduleTrigger
928
- | EditableWorkflowDefinition.MonthlyScheduleTrigger
929
- | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger
930
- | EditableWorkflowDefinition.QuarterlyScheduleTrigger
931
- | EditableWorkflowDefinition.AnnualScheduleTrigger
932
- | EditableWorkflowDefinition.OneTimeScheduleTrigger
933
- | EditableWorkflowDefinition.CustomScheduleTrigger
934
- | EditableWorkflowDefinition.CronScheduleTrigger
935
- | EditableWorkflowDefinition.ManualTrigger
936
- | EditableWorkflowDefinition.SlackTrigger
937
- | EditableWorkflowDefinition.InboundEmailTrigger;
938
- }
939
-
940
- export namespace EditableWorkflowDefinition {
941
- export interface Action {
942
- id: string;
943
-
944
- implementation_config: string;
945
-
946
- kind: 'registered_callback';
947
-
948
- owner_id: string;
949
-
950
- owner_type: string;
951
- }
952
-
953
- export interface DailyScheduleTrigger {
954
- hour: number;
955
-
956
- kind: 'daily_schedule';
957
-
958
- timezone: string;
959
-
960
- minute?: number;
961
- }
962
-
963
- export interface BusinessEventTrigger {
964
- event_name: string;
965
-
966
- kind: 'business_event';
967
- }
968
-
969
- export interface WeekdayScheduleTrigger {
970
- hour: number;
971
-
972
- kind: 'weekday_schedule';
973
-
974
- timezone: string;
975
-
976
- minute?: number;
977
- }
978
-
979
- export interface WeeklyScheduleTrigger {
980
- days_of_week: Array<number>;
981
-
982
- hour: number;
983
-
984
- kind: 'weekly_schedule';
985
-
986
- timezone: string;
987
-
988
- minute?: number;
989
- }
990
-
991
- export interface BiweeklyScheduleTrigger {
992
- days_of_week: Array<number>;
993
-
994
- hour: number;
995
-
996
- kind: 'biweekly_schedule';
997
-
998
- timezone: string;
999
-
1000
- minute?: number;
1001
- }
1002
-
1003
- export interface MonthlyScheduleTrigger {
1004
- day_of_month: number;
1005
-
1006
- hour: number;
1007
-
1008
- kind: 'monthly_schedule';
1009
-
1010
- timezone: string;
1011
-
1012
- minute?: number;
1013
- }
1014
-
1015
- export interface MonthlyOnDayOfWeekScheduleTrigger {
1016
- day_of_week: number;
1017
-
1018
- hour: number;
1019
-
1020
- kind: 'monthly_on_day_of_week_schedule';
1021
-
1022
- timezone: string;
1023
-
1024
- week_of_month: number;
1025
-
1026
- minute?: number;
1027
- }
1028
-
1029
- export interface QuarterlyScheduleTrigger {
1030
- day_of_month: number;
1031
-
1032
- hour: number;
1033
-
1034
- kind: 'quarterly_schedule';
1035
-
1036
- month_of_year: number;
1037
-
1038
- timezone: string;
1039
-
1040
- minute?: number;
1041
- }
1042
-
1043
- export interface AnnualScheduleTrigger {
1044
- day_of_month: number;
1045
-
1046
- hour: number;
1047
-
1048
- kind: 'annual_schedule';
1049
-
1050
- month_of_year: number;
1051
-
1052
- timezone: string;
1053
-
1054
- minute?: number;
1055
- }
1056
-
1057
- export interface OneTimeScheduleTrigger {
1058
- day_of_month: number;
1059
-
1060
- hour: number;
1061
-
1062
- kind: 'one_time_schedule';
1063
-
1064
- month_of_year: number;
1065
-
1066
- timezone: string;
1067
-
1068
- year: number;
1069
-
1070
- minute?: number;
1071
- }
1072
-
1073
- export interface CustomScheduleTrigger {
1074
- interval: number;
1075
-
1076
- kind: 'custom_schedule';
1077
-
1078
- timezone: string;
1079
-
1080
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
1081
-
1082
- day_of_month?: number | null;
1083
-
1084
- days_of_week?: Array<number> | null;
1085
-
1086
- hour?: number;
1087
-
1088
- minute?: number;
1089
-
1090
- month_of_year?: number | null;
1091
-
1092
- start_month?: number | null;
1093
- }
1094
-
1095
- export interface CronScheduleTrigger {
1096
- expression: string;
1097
-
1098
- kind: 'cron_schedule';
1099
-
1100
- timezone: string;
1101
- }
1102
-
1103
- export interface ManualTrigger {
1104
- kind: 'manual';
1105
- }
1106
-
1107
- export interface SlackTrigger {
1108
- channel_ids: Array<string>;
1109
-
1110
- event_type: 'message_posted' | 'reaction_added';
1111
-
1112
- kind: 'slack';
1113
-
1114
- allowed_sender_group_id?: string | null;
1115
-
1116
- include_thread_replies?: boolean;
1117
-
1118
- message_text_regex?: string | null;
1119
-
1120
- reaction_names?: Array<string>;
1121
- }
1122
-
1123
- export interface InboundEmailTrigger {
1124
- kind: 'inbound_email';
1125
-
1126
- recipient_email: string;
1127
-
1128
- body_contains?: string | null;
1129
-
1130
- has_attachment?: boolean;
1131
-
1132
- subject_contains?: string | null;
1133
- }
1134
- }
1135
-
1136
- export interface ReadOnlyWorkflowDefinition {
1137
- kind: 'read_only';
1138
-
1139
- steps: Array<ReadOnlyWorkflowDefinition.Step>;
1140
-
1141
- trigger: ReadOnlyWorkflowDefinition.Trigger;
1142
- }
1143
-
1144
- export namespace ReadOnlyWorkflowDefinition {
1145
- export interface Step {
1146
- id: string;
1147
-
1148
- kind: 'read_only';
1149
-
1150
- name: string;
1151
-
1152
- next_ids: Array<string>;
1153
-
1154
- source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
1155
- }
1156
-
1157
- export interface Trigger {
1158
- kind: 'read_only';
1159
-
1160
- source_type:
1161
- | 'business_event'
1162
- | 'record_change'
1163
- | 'scheduled'
1164
- | 'manual'
1165
- | 'webhook'
1166
- | 'date_relative'
1167
- | 'integration'
1168
- | 'unknown';
1169
-
1170
- summary: string;
1171
- }
1172
- }
1173
- }
1174
-
1175
- export interface WorkflowListParams {
1176
- cursor?: string;
1177
-
1178
- limit?: number;
1179
- }
1180
-
1181
- export interface WorkflowCreateParams {
1182
- actions: Array<WorkflowCreateParams.Action>;
1183
-
1184
- name: string;
1185
-
1186
- trigger:
1187
- | WorkflowCreateParams.DailyScheduleTrigger
1188
- | WorkflowCreateParams.BusinessEventTrigger
1189
- | WorkflowCreateParams.WeekdayScheduleTrigger
1190
- | WorkflowCreateParams.WeeklyScheduleTrigger
1191
- | WorkflowCreateParams.BiweeklyScheduleTrigger
1192
- | WorkflowCreateParams.MonthlyScheduleTrigger
1193
- | WorkflowCreateParams.MonthlyOnDayOfWeekScheduleTrigger
1194
- | WorkflowCreateParams.QuarterlyScheduleTrigger
1195
- | WorkflowCreateParams.AnnualScheduleTrigger
1196
- | WorkflowCreateParams.OneTimeScheduleTrigger
1197
- | WorkflowCreateParams.CustomScheduleTrigger
1198
- | WorkflowCreateParams.CronScheduleTrigger
1199
- | WorkflowCreateParams.ManualTrigger
1200
- | WorkflowCreateParams.SlackTrigger
1201
- | WorkflowCreateParams.InboundEmailTrigger;
1202
-
1203
- description?: string | null;
1204
-
1205
- enabled?: boolean;
1206
-
1207
- status?: 'draft' | 'published';
1208
- }
1209
-
1210
- export namespace WorkflowCreateParams {
1211
- export interface Action {
1212
- id: string;
1213
-
1214
- implementation_config: string;
1215
-
1216
- kind: 'registered_callback';
1217
-
1218
- owner_id: string;
1219
-
1220
- owner_type: string;
1221
- }
1222
-
1223
- export interface DailyScheduleTrigger {
1224
- hour: number;
1225
-
1226
- kind: 'daily_schedule';
1227
-
1228
- timezone: string;
1229
-
1230
- minute?: number;
1231
- }
1232
-
1233
- export interface BusinessEventTrigger {
1234
- event_name: string;
1235
-
1236
- kind: 'business_event';
1237
- }
1238
-
1239
- export interface WeekdayScheduleTrigger {
1240
- hour: number;
1241
-
1242
- kind: 'weekday_schedule';
1243
-
1244
- timezone: string;
1245
-
1246
- minute?: number;
1247
- }
1248
-
1249
- export interface WeeklyScheduleTrigger {
1250
- days_of_week: Array<number>;
1251
-
1252
- hour: number;
1253
-
1254
- kind: 'weekly_schedule';
1255
-
1256
- timezone: string;
1257
-
1258
- minute?: number;
1259
- }
1260
-
1261
- export interface BiweeklyScheduleTrigger {
1262
- days_of_week: Array<number>;
1263
-
1264
- hour: number;
1265
-
1266
- kind: 'biweekly_schedule';
1267
-
1268
- timezone: string;
1269
-
1270
- minute?: number;
1271
- }
1272
-
1273
- export interface MonthlyScheduleTrigger {
1274
- day_of_month: number;
1275
-
1276
- hour: number;
1277
-
1278
- kind: 'monthly_schedule';
1279
-
1280
- timezone: string;
1281
-
1282
- minute?: number;
1283
- }
1284
-
1285
- export interface MonthlyOnDayOfWeekScheduleTrigger {
1286
- day_of_week: number;
1287
-
1288
- hour: number;
1289
-
1290
- kind: 'monthly_on_day_of_week_schedule';
1291
-
1292
- timezone: string;
1293
-
1294
- week_of_month: number;
1295
-
1296
- minute?: number;
1297
- }
1298
-
1299
- export interface QuarterlyScheduleTrigger {
1300
- day_of_month: number;
1301
-
1302
- hour: number;
1303
-
1304
- kind: 'quarterly_schedule';
1305
-
1306
- month_of_year: number;
1307
-
1308
- timezone: string;
1309
-
1310
- minute?: number;
1311
- }
1312
-
1313
- export interface AnnualScheduleTrigger {
1314
- day_of_month: number;
1315
-
1316
- hour: number;
1317
-
1318
- kind: 'annual_schedule';
1319
-
1320
- month_of_year: number;
1321
-
1322
- timezone: string;
1323
-
1324
- minute?: number;
1325
- }
1326
-
1327
- export interface OneTimeScheduleTrigger {
1328
- day_of_month: number;
1329
-
1330
- hour: number;
1331
-
1332
- kind: 'one_time_schedule';
1333
-
1334
- month_of_year: number;
1335
-
1336
- timezone: string;
1337
-
1338
- year: number;
1339
-
1340
- minute?: number;
1341
- }
1342
-
1343
- export interface CustomScheduleTrigger {
1344
- interval: number;
1345
-
1346
- kind: 'custom_schedule';
1347
-
1348
- timezone: string;
1349
-
1350
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
1351
-
1352
- day_of_month?: number | null;
1353
-
1354
- days_of_week?: Array<number> | null;
1355
-
1356
- hour?: number;
1357
-
1358
- minute?: number;
1359
-
1360
- month_of_year?: number | null;
1361
-
1362
- start_month?: number | null;
1363
- }
1364
-
1365
- export interface CronScheduleTrigger {
1366
- expression: string;
1367
-
1368
- kind: 'cron_schedule';
1369
-
1370
- timezone: string;
1371
- }
1372
-
1373
- export interface ManualTrigger {
1374
- kind: 'manual';
1375
- }
1376
-
1377
- export interface SlackTrigger {
1378
- channel_ids: Array<string>;
1379
-
1380
- event_type: 'message_posted' | 'reaction_added';
1381
-
1382
- kind: 'slack';
1383
-
1384
- allowed_sender_group_id?: string | null;
1385
-
1386
- include_thread_replies?: boolean;
1387
-
1388
- message_text_regex?: string | null;
1389
-
1390
- reaction_names?: Array<string>;
1391
- }
1392
-
1393
- export interface InboundEmailTrigger {
1394
- kind: 'inbound_email';
1395
-
1396
- recipient_email: string;
1397
-
1398
- body_contains?: string | null;
1399
-
1400
- has_attachment?: boolean;
1401
-
1402
- subject_contains?: string | null;
1403
- }
1404
- }
1405
-
1406
- export interface WorkflowRetrieveParams {
1407
- version_id?: string;
1408
- }
1409
-
1410
- export interface WorkflowUpdateParams {
1411
- version_id: string;
1412
-
1413
- actions?: Array<WorkflowUpdateParams.Action>;
1414
-
1415
- description?: string | null;
1416
-
1417
- enabled?: boolean;
1418
-
1419
- name?: string;
1420
-
1421
- status?: 'draft' | 'published';
1422
-
1423
- trigger?:
1424
- | WorkflowUpdateParams.DailyScheduleTrigger
1425
- | WorkflowUpdateParams.BusinessEventTrigger
1426
- | WorkflowUpdateParams.WeekdayScheduleTrigger
1427
- | WorkflowUpdateParams.WeeklyScheduleTrigger
1428
- | WorkflowUpdateParams.BiweeklyScheduleTrigger
1429
- | WorkflowUpdateParams.MonthlyScheduleTrigger
1430
- | WorkflowUpdateParams.MonthlyOnDayOfWeekScheduleTrigger
1431
- | WorkflowUpdateParams.QuarterlyScheduleTrigger
1432
- | WorkflowUpdateParams.AnnualScheduleTrigger
1433
- | WorkflowUpdateParams.OneTimeScheduleTrigger
1434
- | WorkflowUpdateParams.CustomScheduleTrigger
1435
- | WorkflowUpdateParams.CronScheduleTrigger
1436
- | WorkflowUpdateParams.ManualTrigger
1437
- | WorkflowUpdateParams.SlackTrigger
1438
- | WorkflowUpdateParams.InboundEmailTrigger;
1439
- }
1440
-
1441
- export namespace WorkflowUpdateParams {
1442
- export interface Action {
1443
- id: string;
1444
-
1445
- implementation_config: string;
1446
-
1447
- kind: 'registered_callback';
1448
-
1449
- owner_id: string;
1450
-
1451
- owner_type: string;
1452
- }
1453
-
1454
- export interface DailyScheduleTrigger {
1455
- hour: number;
1456
-
1457
- kind: 'daily_schedule';
1458
-
1459
- timezone: string;
1460
-
1461
- minute?: number;
1462
- }
1463
-
1464
- export interface BusinessEventTrigger {
1465
- event_name: string;
1466
-
1467
- kind: 'business_event';
1468
- }
1469
-
1470
- export interface WeekdayScheduleTrigger {
1471
- hour: number;
1472
-
1473
- kind: 'weekday_schedule';
1474
-
1475
- timezone: string;
1476
-
1477
- minute?: number;
1478
- }
1479
-
1480
- export interface WeeklyScheduleTrigger {
1481
- days_of_week: Array<number>;
1482
-
1483
- hour: number;
1484
-
1485
- kind: 'weekly_schedule';
1486
-
1487
- timezone: string;
1488
-
1489
- minute?: number;
1490
- }
1491
-
1492
- export interface BiweeklyScheduleTrigger {
1493
- days_of_week: Array<number>;
1494
-
1495
- hour: number;
1496
-
1497
- kind: 'biweekly_schedule';
1498
-
1499
- timezone: string;
1500
-
1501
- minute?: number;
1502
- }
1503
-
1504
- export interface MonthlyScheduleTrigger {
1505
- day_of_month: number;
1506
-
1507
- hour: number;
1508
-
1509
- kind: 'monthly_schedule';
1510
-
1511
- timezone: string;
1512
-
1513
- minute?: number;
1514
- }
1515
-
1516
- export interface MonthlyOnDayOfWeekScheduleTrigger {
1517
- day_of_week: number;
1518
-
1519
- hour: number;
1520
-
1521
- kind: 'monthly_on_day_of_week_schedule';
1522
-
1523
- timezone: string;
1524
-
1525
- week_of_month: number;
1526
-
1527
- minute?: number;
1528
- }
1529
-
1530
- export interface QuarterlyScheduleTrigger {
1531
- day_of_month: number;
1532
-
1533
- hour: number;
1534
-
1535
- kind: 'quarterly_schedule';
1536
-
1537
- month_of_year: number;
1538
-
1539
- timezone: string;
1540
-
1541
- minute?: number;
1542
- }
1543
-
1544
- export interface AnnualScheduleTrigger {
1545
- day_of_month: number;
1546
-
1547
- hour: number;
1548
-
1549
- kind: 'annual_schedule';
1550
-
1551
- month_of_year: number;
1552
-
1553
- timezone: string;
1554
-
1555
- minute?: number;
1556
- }
1557
-
1558
- export interface OneTimeScheduleTrigger {
1559
- day_of_month: number;
1560
-
1561
- hour: number;
1562
-
1563
- kind: 'one_time_schedule';
1564
-
1565
- month_of_year: number;
1566
-
1567
- timezone: string;
1568
-
1569
- year: number;
1570
-
1571
- minute?: number;
1572
- }
1573
-
1574
- export interface CustomScheduleTrigger {
1575
- interval: number;
1576
-
1577
- kind: 'custom_schedule';
1578
-
1579
- timezone: string;
1580
-
1581
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
1582
-
1583
- day_of_month?: number | null;
1584
-
1585
- days_of_week?: Array<number> | null;
1586
-
1587
- hour?: number;
1588
-
1589
- minute?: number;
1590
-
1591
- month_of_year?: number | null;
1592
-
1593
- start_month?: number | null;
1594
- }
1595
-
1596
- export interface CronScheduleTrigger {
1597
- expression: string;
1598
-
1599
- kind: 'cron_schedule';
1600
-
1601
- timezone: string;
1602
- }
1603
-
1604
- export interface ManualTrigger {
1605
- kind: 'manual';
1606
- }
1607
-
1608
- export interface SlackTrigger {
1609
- channel_ids: Array<string>;
1610
-
1611
- event_type: 'message_posted' | 'reaction_added';
1612
-
1613
- kind: 'slack';
1614
-
1615
- allowed_sender_group_id?: string | null;
1616
-
1617
- include_thread_replies?: boolean;
1618
-
1619
- message_text_regex?: string | null;
1620
-
1621
- reaction_names?: Array<string>;
1622
- }
1623
-
1624
- export interface InboundEmailTrigger {
1625
- kind: 'inbound_email';
1626
-
1627
- recipient_email: string;
1628
-
1629
- body_contains?: string | null;
1630
-
1631
- has_attachment?: boolean;
1632
-
1633
- subject_contains?: string | null;
1634
- }
1635
- }
1636
-
1637
- export declare namespace Workflows {
1638
- export {
1639
- type WorkflowListResponse as WorkflowListResponse,
1640
- type WorkflowCreateResponse as WorkflowCreateResponse,
1641
- type WorkflowRetrieveResponse as WorkflowRetrieveResponse,
1642
- type WorkflowUpdateResponse as WorkflowUpdateResponse,
1643
- type WorkflowListResponsesPageCursorURL as WorkflowListResponsesPageCursorURL,
1644
- type WorkflowListParams as WorkflowListParams,
1645
- type WorkflowCreateParams as WorkflowCreateParams,
1646
- type WorkflowRetrieveParams as WorkflowRetrieveParams,
1647
- type WorkflowUpdateParams as WorkflowUpdateParams,
1648
- };
1649
- }
3
+ export * from './workflows/index';