@rippling/rippling-sdk 0.2.0-alpha.106 → 0.2.0-alpha.108

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 (110) hide show
  1. package/client.d.mts +7 -1
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +7 -1
  4. package/client.d.ts.map +1 -1
  5. package/client.js +7 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs +7 -1
  8. package/client.mjs.map +1 -1
  9. package/package.json +1 -1
  10. package/resources/card-transactions.d.mts +579 -0
  11. package/resources/card-transactions.d.mts.map +1 -0
  12. package/resources/card-transactions.d.ts +579 -0
  13. package/resources/card-transactions.d.ts.map +1 -0
  14. package/resources/card-transactions.js +116 -0
  15. package/resources/card-transactions.js.map +1 -0
  16. package/resources/card-transactions.mjs +112 -0
  17. package/resources/card-transactions.mjs.map +1 -0
  18. package/resources/custom-settings.d.mts +1 -1
  19. package/resources/custom-settings.d.ts +1 -1
  20. package/resources/custom-settings.js +1 -1
  21. package/resources/custom-settings.mjs +1 -1
  22. package/resources/earning-types.d.mts +50 -10
  23. package/resources/earning-types.d.mts.map +1 -1
  24. package/resources/earning-types.d.ts +50 -10
  25. package/resources/earning-types.d.ts.map +1 -1
  26. package/resources/earning-types.js +21 -2
  27. package/resources/earning-types.js.map +1 -1
  28. package/resources/earning-types.mjs +21 -2
  29. package/resources/earning-types.mjs.map +1 -1
  30. package/resources/hires.d.mts +0 -5
  31. package/resources/hires.d.mts.map +1 -1
  32. package/resources/hires.d.ts +0 -5
  33. package/resources/hires.d.ts.map +1 -1
  34. package/resources/hires.js +0 -1
  35. package/resources/hires.js.map +1 -1
  36. package/resources/hires.mjs +0 -1
  37. package/resources/hires.mjs.map +1 -1
  38. package/resources/index.d.mts +3 -1
  39. package/resources/index.d.mts.map +1 -1
  40. package/resources/index.d.ts +3 -1
  41. package/resources/index.d.ts.map +1 -1
  42. package/resources/index.js +8 -4
  43. package/resources/index.js.map +1 -1
  44. package/resources/index.mjs +3 -1
  45. package/resources/index.mjs.map +1 -1
  46. package/resources/payroll-payment-mode-changes.d.mts +66 -18
  47. package/resources/payroll-payment-mode-changes.d.mts.map +1 -1
  48. package/resources/payroll-payment-mode-changes.d.ts +66 -18
  49. package/resources/payroll-payment-mode-changes.d.ts.map +1 -1
  50. package/resources/payroll-payment-mode-changes.js +16 -4
  51. package/resources/payroll-payment-mode-changes.js.map +1 -1
  52. package/resources/payroll-payment-mode-changes.mjs +16 -4
  53. package/resources/payroll-payment-mode-changes.mjs.map +1 -1
  54. package/resources/reimbursements.d.mts +954 -0
  55. package/resources/reimbursements.d.mts.map +1 -0
  56. package/resources/reimbursements.d.ts +954 -0
  57. package/resources/reimbursements.d.ts.map +1 -0
  58. package/resources/reimbursements.js +140 -0
  59. package/resources/reimbursements.js.map +1 -0
  60. package/resources/reimbursements.mjs +136 -0
  61. package/resources/reimbursements.mjs.map +1 -0
  62. package/resources/workflows/executions.d.mts +153 -0
  63. package/resources/workflows/executions.d.mts.map +1 -0
  64. package/resources/workflows/executions.d.ts +153 -0
  65. package/resources/workflows/executions.d.ts.map +1 -0
  66. package/resources/workflows/executions.js +74 -0
  67. package/resources/workflows/executions.js.map +1 -0
  68. package/resources/workflows/executions.mjs +70 -0
  69. package/resources/workflows/executions.mjs.map +1 -0
  70. package/resources/workflows/index.d.mts +3 -0
  71. package/resources/workflows/index.d.mts.map +1 -0
  72. package/resources/workflows/index.d.ts +3 -0
  73. package/resources/workflows/index.d.ts.map +1 -0
  74. package/resources/workflows/index.js +9 -0
  75. package/resources/workflows/index.js.map +1 -0
  76. package/resources/workflows/index.mjs +4 -0
  77. package/resources/workflows/index.mjs.map +1 -0
  78. package/resources/workflows/workflows.d.mts +977 -0
  79. package/resources/workflows/workflows.d.mts.map +1 -0
  80. package/resources/workflows/workflows.d.ts +977 -0
  81. package/resources/workflows/workflows.d.ts.map +1 -0
  82. package/resources/workflows/workflows.js +246 -0
  83. package/resources/workflows/workflows.js.map +1 -0
  84. package/resources/workflows/workflows.mjs +241 -0
  85. package/resources/workflows/workflows.mjs.map +1 -0
  86. package/resources/workflows.d.mts +1 -957
  87. package/resources/workflows.d.mts.map +1 -1
  88. package/resources/workflows.d.ts +1 -957
  89. package/resources/workflows.d.ts.map +1 -1
  90. package/resources/workflows.js +2 -234
  91. package/resources/workflows.js.map +1 -1
  92. package/resources/workflows.mjs +1 -232
  93. package/resources/workflows.mjs.map +1 -1
  94. package/src/client.ts +46 -12
  95. package/src/resources/card-transactions.ts +718 -0
  96. package/src/resources/custom-settings.ts +1 -1
  97. package/src/resources/earning-types.ts +52 -10
  98. package/src/resources/hires.ts +0 -6
  99. package/src/resources/index.ts +15 -1
  100. package/src/resources/payroll-payment-mode-changes.ts +79 -18
  101. package/src/resources/reimbursements.ts +1157 -0
  102. package/src/resources/workflows/executions.ts +191 -0
  103. package/src/resources/workflows/index.ts +15 -0
  104. package/src/resources/workflows/workflows.ts +1661 -0
  105. package/src/resources/workflows.ts +1 -1622
  106. package/src/version.ts +1 -1
  107. package/version.d.mts +1 -1
  108. package/version.d.ts +1 -1
  109. package/version.js +1 -1
  110. package/version.mjs +1 -1
@@ -1,958 +1,2 @@
1
- import { APIResource } from "../core/resource.js";
2
- import { APIPromise } from "../core/api-promise.js";
3
- import { PageCursorURL, PagePromise } from "../core/pagination.js";
4
- import { RequestOptions } from "../internal/request-options.js";
5
- /**
6
- * Execute workflow actions like sending emails, Slack messages, and notifications
7
- */
8
- export declare class Workflows extends APIResource {
9
- /**
10
- * List workflows
11
- *
12
- * @example HTTP
13
- * Representative request and response shapes.
14
- * ```
15
- * GET /workflows/?limit=50&cursor=cursor HTTP/1.1
16
- * Host: rest.ripplingapis.com
17
- * Accept: application/json
18
- * Rippling-Api-Version: 2024-08-01
19
- *
20
- * HTTP/1.1 200 OK
21
- * Content-Type: application/json
22
- *
23
- * {
24
- * "results": [
25
- * {
26
- * "id": "string",
27
- * "version_id": "string",
28
- * "name": "string",
29
- * "description": "string",
30
- * "status": "draft",
31
- * "enabled": false,
32
- * "owner_id": "string",
33
- * "has_draft": false,
34
- * "created_at": "2025-01-01T00:00:00Z",
35
- * "updated_at": "2025-01-01T00:00:00Z"
36
- * }
37
- * ],
38
- * "next_link": "string"
39
- * }
40
- * ```
41
- */
42
- list(query?: WorkflowListParams | null | undefined, options?: RequestOptions): PagePromise<WorkflowListResponsesPageCursorURL, WorkflowListResponse>;
43
- /**
44
- * Create a workflow
45
- *
46
- * @example HTTP
47
- * Representative request and response shapes.
48
- * ```
49
- * POST /workflows/ HTTP/1.1
50
- * Host: rest.ripplingapis.com
51
- * Content-Type: application/json
52
- * Accept: application/json
53
- * Rippling-Api-Version: 2024-08-01
54
- *
55
- * {
56
- * "actions": [
57
- * {
58
- * "id": "x",
59
- * "implementation_config": "x",
60
- * "kind": "registered_callback",
61
- * "owner_id": "x",
62
- * "owner_type": "x"
63
- * }
64
- * ],
65
- * "name": "x",
66
- * "trigger": {
67
- * "hour": 0,
68
- * "kind": "daily_schedule",
69
- * "timezone": "timezone"
70
- * }
71
- * }
72
- *
73
- * HTTP/1.1 201 Created
74
- * Content-Type: application/json
75
- *
76
- * {
77
- * "id": "string",
78
- * "version_id": "string",
79
- * "name": "string",
80
- * "description": "string",
81
- * "status": "draft",
82
- * "enabled": false,
83
- * "owner_id": "string",
84
- * "has_draft": false,
85
- * "created_at": "2025-01-01T00:00:00Z",
86
- * "updated_at": "2025-01-01T00:00:00Z",
87
- * "definition": {
88
- * "kind": "editable",
89
- * "trigger": {},
90
- * "actions": [
91
- * {}
92
- * ]
93
- * },
94
- * "authoring": {
95
- * "mode": "full",
96
- * "patchable_fields": [
97
- * "name"
98
- * ],
99
- * "reason_codes": [
100
- * "unsupported_trigger"
101
- * ]
102
- * },
103
- * "deletable": false
104
- * }
105
- * ```
106
- */
107
- create(body: WorkflowCreateParams, options?: RequestOptions): APIPromise<WorkflowCreateResponse>;
108
- /**
109
- * Retrieve a workflow
110
- *
111
- * @example HTTP
112
- * Representative request and response shapes.
113
- * ```
114
- * GET /workflows/{id}/?version_id=version_id HTTP/1.1
115
- * Host: rest.ripplingapis.com
116
- * Accept: application/json
117
- * Rippling-Api-Version: 2024-08-01
118
- *
119
- * HTTP/1.1 200 OK
120
- * Content-Type: application/json
121
- *
122
- * {
123
- * "id": "string",
124
- * "version_id": "string",
125
- * "name": "string",
126
- * "description": "string",
127
- * "status": "draft",
128
- * "enabled": false,
129
- * "owner_id": "string",
130
- * "has_draft": false,
131
- * "created_at": "2025-01-01T00:00:00Z",
132
- * "updated_at": "2025-01-01T00:00:00Z",
133
- * "definition": {
134
- * "kind": "editable",
135
- * "trigger": {},
136
- * "actions": [
137
- * {}
138
- * ]
139
- * },
140
- * "authoring": {
141
- * "mode": "full",
142
- * "patchable_fields": [
143
- * "name"
144
- * ],
145
- * "reason_codes": [
146
- * "unsupported_trigger"
147
- * ]
148
- * },
149
- * "deletable": false
150
- * }
151
- * ```
152
- */
153
- retrieve(id: string, query?: WorkflowRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<WorkflowRetrieveResponse>;
154
- /**
155
- * Update a workflow
156
- *
157
- * @example HTTP
158
- * Representative request and response shapes.
159
- * ```
160
- * PATCH /workflows/{id}/ HTTP/1.1
161
- * Host: rest.ripplingapis.com
162
- * Content-Type: application/json
163
- * Accept: application/json
164
- * Rippling-Api-Version: 2024-08-01
165
- *
166
- * {
167
- * "version_id": "x"
168
- * }
169
- *
170
- * HTTP/1.1 200 OK
171
- * Content-Type: application/json
172
- *
173
- * {
174
- * "id": "string",
175
- * "version_id": "string",
176
- * "name": "string",
177
- * "description": "string",
178
- * "status": "draft",
179
- * "enabled": false,
180
- * "owner_id": "string",
181
- * "has_draft": false,
182
- * "created_at": "2025-01-01T00:00:00Z",
183
- * "updated_at": "2025-01-01T00:00:00Z",
184
- * "definition": {
185
- * "kind": "editable",
186
- * "trigger": {},
187
- * "actions": [
188
- * {}
189
- * ]
190
- * },
191
- * "authoring": {
192
- * "mode": "full",
193
- * "patchable_fields": [
194
- * "name"
195
- * ],
196
- * "reason_codes": [
197
- * "unsupported_trigger"
198
- * ]
199
- * },
200
- * "deletable": false
201
- * }
202
- * ```
203
- */
204
- update(id: string, body: WorkflowUpdateParams, options?: RequestOptions): APIPromise<WorkflowUpdateResponse>;
205
- /**
206
- * Delete a workflow
207
- *
208
- * @example HTTP
209
- * Representative request and response shapes.
210
- * ```
211
- * DELETE /workflows/{id}/ HTTP/1.1
212
- * Host: rest.ripplingapis.com
213
- * Rippling-Api-Version: 2024-08-01
214
- *
215
- * HTTP/1.1 204 No Content
216
- * ```
217
- */
218
- delete(id: string, options?: RequestOptions): APIPromise<void>;
219
- }
220
- export type WorkflowListResponsesPageCursorURL = PageCursorURL<WorkflowListResponse>;
221
- export interface WorkflowListResponse {
222
- id: string;
223
- created_at: string;
224
- description: string | null;
225
- enabled: boolean;
226
- has_draft: boolean;
227
- name: string;
228
- owner_id: string;
229
- status: 'draft' | 'published' | 'unknown';
230
- updated_at: string;
231
- version_id: string;
232
- }
233
- export interface WorkflowCreateResponse {
234
- id: string;
235
- authoring: WorkflowCreateResponse.Authoring;
236
- created_at: string;
237
- definition: WorkflowCreateResponse.EditableWorkflowDefinition | WorkflowCreateResponse.ReadOnlyWorkflowDefinition;
238
- deletable: boolean;
239
- enabled: boolean;
240
- has_draft: boolean;
241
- name: string;
242
- owner_id: string;
243
- status: 'draft' | 'published' | 'unknown';
244
- updated_at: string;
245
- version_id: string;
246
- description?: string | null;
247
- }
248
- export declare namespace WorkflowCreateResponse {
249
- interface Authoring {
250
- mode: 'full' | 'metadata_only' | 'read_only';
251
- patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
252
- reason_codes: Array<'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'>;
253
- }
254
- interface EditableWorkflowDefinition {
255
- actions: Array<EditableWorkflowDefinition.Action>;
256
- kind: 'editable';
257
- trigger: EditableWorkflowDefinition.DailyScheduleTrigger | EditableWorkflowDefinition.BusinessEventTrigger | EditableWorkflowDefinition.WeekdayScheduleTrigger | EditableWorkflowDefinition.WeeklyScheduleTrigger | EditableWorkflowDefinition.BiweeklyScheduleTrigger | EditableWorkflowDefinition.MonthlyScheduleTrigger | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger | EditableWorkflowDefinition.QuarterlyScheduleTrigger | EditableWorkflowDefinition.AnnualScheduleTrigger | EditableWorkflowDefinition.OneTimeScheduleTrigger | EditableWorkflowDefinition.CustomScheduleTrigger | EditableWorkflowDefinition.CronScheduleTrigger | EditableWorkflowDefinition.SlackTrigger | EditableWorkflowDefinition.InboundEmailTrigger;
258
- }
259
- namespace EditableWorkflowDefinition {
260
- interface Action {
261
- id: string;
262
- implementation_config: string;
263
- kind: 'registered_callback';
264
- owner_id: string;
265
- owner_type: string;
266
- }
267
- interface DailyScheduleTrigger {
268
- hour: number;
269
- kind: 'daily_schedule';
270
- timezone: string;
271
- minute?: number;
272
- }
273
- interface BusinessEventTrigger {
274
- event_name: string;
275
- kind: 'business_event';
276
- }
277
- interface WeekdayScheduleTrigger {
278
- hour: number;
279
- kind: 'weekday_schedule';
280
- timezone: string;
281
- minute?: number;
282
- }
283
- interface WeeklyScheduleTrigger {
284
- days_of_week: Array<number>;
285
- hour: number;
286
- kind: 'weekly_schedule';
287
- timezone: string;
288
- minute?: number;
289
- }
290
- interface BiweeklyScheduleTrigger {
291
- days_of_week: Array<number>;
292
- hour: number;
293
- kind: 'biweekly_schedule';
294
- timezone: string;
295
- minute?: number;
296
- }
297
- interface MonthlyScheduleTrigger {
298
- day_of_month: number;
299
- hour: number;
300
- kind: 'monthly_schedule';
301
- timezone: string;
302
- minute?: number;
303
- }
304
- interface MonthlyOnDayOfWeekScheduleTrigger {
305
- day_of_week: number;
306
- hour: number;
307
- kind: 'monthly_on_day_of_week_schedule';
308
- timezone: string;
309
- week_of_month: number;
310
- minute?: number;
311
- }
312
- interface QuarterlyScheduleTrigger {
313
- day_of_month: number;
314
- hour: number;
315
- kind: 'quarterly_schedule';
316
- month_of_year: number;
317
- timezone: string;
318
- minute?: number;
319
- }
320
- interface AnnualScheduleTrigger {
321
- day_of_month: number;
322
- hour: number;
323
- kind: 'annual_schedule';
324
- month_of_year: number;
325
- timezone: string;
326
- minute?: number;
327
- }
328
- interface OneTimeScheduleTrigger {
329
- day_of_month: number;
330
- hour: number;
331
- kind: 'one_time_schedule';
332
- month_of_year: number;
333
- timezone: string;
334
- year: number;
335
- minute?: number;
336
- }
337
- interface CustomScheduleTrigger {
338
- interval: number;
339
- kind: 'custom_schedule';
340
- timezone: string;
341
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
342
- day_of_month?: number | null;
343
- days_of_week?: Array<number> | null;
344
- hour?: number;
345
- minute?: number;
346
- month_of_year?: number | null;
347
- start_month?: number | null;
348
- }
349
- interface CronScheduleTrigger {
350
- expression: string;
351
- kind: 'cron_schedule';
352
- timezone: string;
353
- }
354
- interface SlackTrigger {
355
- channel_ids: Array<string>;
356
- event_type: 'message_posted' | 'reaction_added';
357
- kind: 'slack';
358
- allowed_sender_group_id?: string | null;
359
- include_thread_replies?: boolean;
360
- message_text_regex?: string | null;
361
- reaction_names?: Array<string>;
362
- }
363
- interface InboundEmailTrigger {
364
- kind: 'inbound_email';
365
- recipient_email: string;
366
- body_contains?: string | null;
367
- has_attachment?: boolean;
368
- subject_contains?: string | null;
369
- }
370
- }
371
- interface ReadOnlyWorkflowDefinition {
372
- kind: 'read_only';
373
- steps: Array<ReadOnlyWorkflowDefinition.Step>;
374
- trigger: ReadOnlyWorkflowDefinition.Trigger;
375
- }
376
- namespace ReadOnlyWorkflowDefinition {
377
- interface Step {
378
- id: string;
379
- kind: 'read_only';
380
- name: string;
381
- next_ids: Array<string>;
382
- source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
383
- }
384
- interface Trigger {
385
- kind: 'read_only';
386
- source_type: 'business_event' | 'record_change' | 'scheduled' | 'manual' | 'webhook' | 'date_relative' | 'integration' | 'unknown';
387
- summary: string;
388
- }
389
- }
390
- }
391
- export interface WorkflowRetrieveResponse {
392
- id: string;
393
- authoring: WorkflowRetrieveResponse.Authoring;
394
- created_at: string;
395
- definition: WorkflowRetrieveResponse.EditableWorkflowDefinition | WorkflowRetrieveResponse.ReadOnlyWorkflowDefinition;
396
- deletable: boolean;
397
- enabled: boolean;
398
- has_draft: boolean;
399
- name: string;
400
- owner_id: string;
401
- status: 'draft' | 'published' | 'unknown';
402
- updated_at: string;
403
- version_id: string;
404
- description?: string | null;
405
- }
406
- export declare namespace WorkflowRetrieveResponse {
407
- interface Authoring {
408
- mode: 'full' | 'metadata_only' | 'read_only';
409
- patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
410
- reason_codes: Array<'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'>;
411
- }
412
- interface EditableWorkflowDefinition {
413
- actions: Array<EditableWorkflowDefinition.Action>;
414
- kind: 'editable';
415
- trigger: EditableWorkflowDefinition.DailyScheduleTrigger | EditableWorkflowDefinition.BusinessEventTrigger | EditableWorkflowDefinition.WeekdayScheduleTrigger | EditableWorkflowDefinition.WeeklyScheduleTrigger | EditableWorkflowDefinition.BiweeklyScheduleTrigger | EditableWorkflowDefinition.MonthlyScheduleTrigger | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger | EditableWorkflowDefinition.QuarterlyScheduleTrigger | EditableWorkflowDefinition.AnnualScheduleTrigger | EditableWorkflowDefinition.OneTimeScheduleTrigger | EditableWorkflowDefinition.CustomScheduleTrigger | EditableWorkflowDefinition.CronScheduleTrigger | EditableWorkflowDefinition.SlackTrigger | EditableWorkflowDefinition.InboundEmailTrigger;
416
- }
417
- namespace EditableWorkflowDefinition {
418
- interface Action {
419
- id: string;
420
- implementation_config: string;
421
- kind: 'registered_callback';
422
- owner_id: string;
423
- owner_type: string;
424
- }
425
- interface DailyScheduleTrigger {
426
- hour: number;
427
- kind: 'daily_schedule';
428
- timezone: string;
429
- minute?: number;
430
- }
431
- interface BusinessEventTrigger {
432
- event_name: string;
433
- kind: 'business_event';
434
- }
435
- interface WeekdayScheduleTrigger {
436
- hour: number;
437
- kind: 'weekday_schedule';
438
- timezone: string;
439
- minute?: number;
440
- }
441
- interface WeeklyScheduleTrigger {
442
- days_of_week: Array<number>;
443
- hour: number;
444
- kind: 'weekly_schedule';
445
- timezone: string;
446
- minute?: number;
447
- }
448
- interface BiweeklyScheduleTrigger {
449
- days_of_week: Array<number>;
450
- hour: number;
451
- kind: 'biweekly_schedule';
452
- timezone: string;
453
- minute?: number;
454
- }
455
- interface MonthlyScheduleTrigger {
456
- day_of_month: number;
457
- hour: number;
458
- kind: 'monthly_schedule';
459
- timezone: string;
460
- minute?: number;
461
- }
462
- interface MonthlyOnDayOfWeekScheduleTrigger {
463
- day_of_week: number;
464
- hour: number;
465
- kind: 'monthly_on_day_of_week_schedule';
466
- timezone: string;
467
- week_of_month: number;
468
- minute?: number;
469
- }
470
- interface QuarterlyScheduleTrigger {
471
- day_of_month: number;
472
- hour: number;
473
- kind: 'quarterly_schedule';
474
- month_of_year: number;
475
- timezone: string;
476
- minute?: number;
477
- }
478
- interface AnnualScheduleTrigger {
479
- day_of_month: number;
480
- hour: number;
481
- kind: 'annual_schedule';
482
- month_of_year: number;
483
- timezone: string;
484
- minute?: number;
485
- }
486
- interface OneTimeScheduleTrigger {
487
- day_of_month: number;
488
- hour: number;
489
- kind: 'one_time_schedule';
490
- month_of_year: number;
491
- timezone: string;
492
- year: number;
493
- minute?: number;
494
- }
495
- interface CustomScheduleTrigger {
496
- interval: number;
497
- kind: 'custom_schedule';
498
- timezone: string;
499
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
500
- day_of_month?: number | null;
501
- days_of_week?: Array<number> | null;
502
- hour?: number;
503
- minute?: number;
504
- month_of_year?: number | null;
505
- start_month?: number | null;
506
- }
507
- interface CronScheduleTrigger {
508
- expression: string;
509
- kind: 'cron_schedule';
510
- timezone: string;
511
- }
512
- interface SlackTrigger {
513
- channel_ids: Array<string>;
514
- event_type: 'message_posted' | 'reaction_added';
515
- kind: 'slack';
516
- allowed_sender_group_id?: string | null;
517
- include_thread_replies?: boolean;
518
- message_text_regex?: string | null;
519
- reaction_names?: Array<string>;
520
- }
521
- interface InboundEmailTrigger {
522
- kind: 'inbound_email';
523
- recipient_email: string;
524
- body_contains?: string | null;
525
- has_attachment?: boolean;
526
- subject_contains?: string | null;
527
- }
528
- }
529
- interface ReadOnlyWorkflowDefinition {
530
- kind: 'read_only';
531
- steps: Array<ReadOnlyWorkflowDefinition.Step>;
532
- trigger: ReadOnlyWorkflowDefinition.Trigger;
533
- }
534
- namespace ReadOnlyWorkflowDefinition {
535
- interface Step {
536
- id: string;
537
- kind: 'read_only';
538
- name: string;
539
- next_ids: Array<string>;
540
- source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
541
- }
542
- interface Trigger {
543
- kind: 'read_only';
544
- source_type: 'business_event' | 'record_change' | 'scheduled' | 'manual' | 'webhook' | 'date_relative' | 'integration' | 'unknown';
545
- summary: string;
546
- }
547
- }
548
- }
549
- export interface WorkflowUpdateResponse {
550
- id: string;
551
- authoring: WorkflowUpdateResponse.Authoring;
552
- created_at: string;
553
- definition: WorkflowUpdateResponse.EditableWorkflowDefinition | WorkflowUpdateResponse.ReadOnlyWorkflowDefinition;
554
- deletable: boolean;
555
- enabled: boolean;
556
- has_draft: boolean;
557
- name: string;
558
- owner_id: string;
559
- status: 'draft' | 'published' | 'unknown';
560
- updated_at: string;
561
- version_id: string;
562
- description?: string | null;
563
- }
564
- export declare namespace WorkflowUpdateResponse {
565
- interface Authoring {
566
- mode: 'full' | 'metadata_only' | 'read_only';
567
- patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
568
- reason_codes: Array<'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'>;
569
- }
570
- interface EditableWorkflowDefinition {
571
- actions: Array<EditableWorkflowDefinition.Action>;
572
- kind: 'editable';
573
- trigger: EditableWorkflowDefinition.DailyScheduleTrigger | EditableWorkflowDefinition.BusinessEventTrigger | EditableWorkflowDefinition.WeekdayScheduleTrigger | EditableWorkflowDefinition.WeeklyScheduleTrigger | EditableWorkflowDefinition.BiweeklyScheduleTrigger | EditableWorkflowDefinition.MonthlyScheduleTrigger | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger | EditableWorkflowDefinition.QuarterlyScheduleTrigger | EditableWorkflowDefinition.AnnualScheduleTrigger | EditableWorkflowDefinition.OneTimeScheduleTrigger | EditableWorkflowDefinition.CustomScheduleTrigger | EditableWorkflowDefinition.CronScheduleTrigger | EditableWorkflowDefinition.SlackTrigger | EditableWorkflowDefinition.InboundEmailTrigger;
574
- }
575
- namespace EditableWorkflowDefinition {
576
- interface Action {
577
- id: string;
578
- implementation_config: string;
579
- kind: 'registered_callback';
580
- owner_id: string;
581
- owner_type: string;
582
- }
583
- interface DailyScheduleTrigger {
584
- hour: number;
585
- kind: 'daily_schedule';
586
- timezone: string;
587
- minute?: number;
588
- }
589
- interface BusinessEventTrigger {
590
- event_name: string;
591
- kind: 'business_event';
592
- }
593
- interface WeekdayScheduleTrigger {
594
- hour: number;
595
- kind: 'weekday_schedule';
596
- timezone: string;
597
- minute?: number;
598
- }
599
- interface WeeklyScheduleTrigger {
600
- days_of_week: Array<number>;
601
- hour: number;
602
- kind: 'weekly_schedule';
603
- timezone: string;
604
- minute?: number;
605
- }
606
- interface BiweeklyScheduleTrigger {
607
- days_of_week: Array<number>;
608
- hour: number;
609
- kind: 'biweekly_schedule';
610
- timezone: string;
611
- minute?: number;
612
- }
613
- interface MonthlyScheduleTrigger {
614
- day_of_month: number;
615
- hour: number;
616
- kind: 'monthly_schedule';
617
- timezone: string;
618
- minute?: number;
619
- }
620
- interface MonthlyOnDayOfWeekScheduleTrigger {
621
- day_of_week: number;
622
- hour: number;
623
- kind: 'monthly_on_day_of_week_schedule';
624
- timezone: string;
625
- week_of_month: number;
626
- minute?: number;
627
- }
628
- interface QuarterlyScheduleTrigger {
629
- day_of_month: number;
630
- hour: number;
631
- kind: 'quarterly_schedule';
632
- month_of_year: number;
633
- timezone: string;
634
- minute?: number;
635
- }
636
- interface AnnualScheduleTrigger {
637
- day_of_month: number;
638
- hour: number;
639
- kind: 'annual_schedule';
640
- month_of_year: number;
641
- timezone: string;
642
- minute?: number;
643
- }
644
- interface OneTimeScheduleTrigger {
645
- day_of_month: number;
646
- hour: number;
647
- kind: 'one_time_schedule';
648
- month_of_year: number;
649
- timezone: string;
650
- year: number;
651
- minute?: number;
652
- }
653
- interface CustomScheduleTrigger {
654
- interval: number;
655
- kind: 'custom_schedule';
656
- timezone: string;
657
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
658
- day_of_month?: number | null;
659
- days_of_week?: Array<number> | null;
660
- hour?: number;
661
- minute?: number;
662
- month_of_year?: number | null;
663
- start_month?: number | null;
664
- }
665
- interface CronScheduleTrigger {
666
- expression: string;
667
- kind: 'cron_schedule';
668
- timezone: string;
669
- }
670
- interface SlackTrigger {
671
- channel_ids: Array<string>;
672
- event_type: 'message_posted' | 'reaction_added';
673
- kind: 'slack';
674
- allowed_sender_group_id?: string | null;
675
- include_thread_replies?: boolean;
676
- message_text_regex?: string | null;
677
- reaction_names?: Array<string>;
678
- }
679
- interface InboundEmailTrigger {
680
- kind: 'inbound_email';
681
- recipient_email: string;
682
- body_contains?: string | null;
683
- has_attachment?: boolean;
684
- subject_contains?: string | null;
685
- }
686
- }
687
- interface ReadOnlyWorkflowDefinition {
688
- kind: 'read_only';
689
- steps: Array<ReadOnlyWorkflowDefinition.Step>;
690
- trigger: ReadOnlyWorkflowDefinition.Trigger;
691
- }
692
- namespace ReadOnlyWorkflowDefinition {
693
- interface Step {
694
- id: string;
695
- kind: 'read_only';
696
- name: string;
697
- next_ids: Array<string>;
698
- source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
699
- }
700
- interface Trigger {
701
- kind: 'read_only';
702
- source_type: 'business_event' | 'record_change' | 'scheduled' | 'manual' | 'webhook' | 'date_relative' | 'integration' | 'unknown';
703
- summary: string;
704
- }
705
- }
706
- }
707
- export interface WorkflowListParams {
708
- cursor?: string;
709
- limit?: number;
710
- }
711
- export interface WorkflowCreateParams {
712
- actions: Array<WorkflowCreateParams.Action>;
713
- name: string;
714
- trigger: WorkflowCreateParams.DailyScheduleTrigger | WorkflowCreateParams.BusinessEventTrigger | WorkflowCreateParams.WeekdayScheduleTrigger | WorkflowCreateParams.WeeklyScheduleTrigger | WorkflowCreateParams.BiweeklyScheduleTrigger | WorkflowCreateParams.MonthlyScheduleTrigger | WorkflowCreateParams.MonthlyOnDayOfWeekScheduleTrigger | WorkflowCreateParams.QuarterlyScheduleTrigger | WorkflowCreateParams.AnnualScheduleTrigger | WorkflowCreateParams.OneTimeScheduleTrigger | WorkflowCreateParams.CustomScheduleTrigger | WorkflowCreateParams.CronScheduleTrigger | WorkflowCreateParams.SlackTrigger | WorkflowCreateParams.InboundEmailTrigger;
715
- description?: string | null;
716
- enabled?: boolean;
717
- status?: 'draft' | 'published';
718
- }
719
- export declare namespace WorkflowCreateParams {
720
- interface Action {
721
- id: string;
722
- implementation_config: string;
723
- kind: 'registered_callback';
724
- owner_id: string;
725
- owner_type: string;
726
- }
727
- interface DailyScheduleTrigger {
728
- hour: number;
729
- kind: 'daily_schedule';
730
- timezone: string;
731
- minute?: number;
732
- }
733
- interface BusinessEventTrigger {
734
- event_name: string;
735
- kind: 'business_event';
736
- }
737
- interface WeekdayScheduleTrigger {
738
- hour: number;
739
- kind: 'weekday_schedule';
740
- timezone: string;
741
- minute?: number;
742
- }
743
- interface WeeklyScheduleTrigger {
744
- days_of_week: Array<number>;
745
- hour: number;
746
- kind: 'weekly_schedule';
747
- timezone: string;
748
- minute?: number;
749
- }
750
- interface BiweeklyScheduleTrigger {
751
- days_of_week: Array<number>;
752
- hour: number;
753
- kind: 'biweekly_schedule';
754
- timezone: string;
755
- minute?: number;
756
- }
757
- interface MonthlyScheduleTrigger {
758
- day_of_month: number;
759
- hour: number;
760
- kind: 'monthly_schedule';
761
- timezone: string;
762
- minute?: number;
763
- }
764
- interface MonthlyOnDayOfWeekScheduleTrigger {
765
- day_of_week: number;
766
- hour: number;
767
- kind: 'monthly_on_day_of_week_schedule';
768
- timezone: string;
769
- week_of_month: number;
770
- minute?: number;
771
- }
772
- interface QuarterlyScheduleTrigger {
773
- day_of_month: number;
774
- hour: number;
775
- kind: 'quarterly_schedule';
776
- month_of_year: number;
777
- timezone: string;
778
- minute?: number;
779
- }
780
- interface AnnualScheduleTrigger {
781
- day_of_month: number;
782
- hour: number;
783
- kind: 'annual_schedule';
784
- month_of_year: number;
785
- timezone: string;
786
- minute?: number;
787
- }
788
- interface OneTimeScheduleTrigger {
789
- day_of_month: number;
790
- hour: number;
791
- kind: 'one_time_schedule';
792
- month_of_year: number;
793
- timezone: string;
794
- year: number;
795
- minute?: number;
796
- }
797
- interface CustomScheduleTrigger {
798
- interval: number;
799
- kind: 'custom_schedule';
800
- timezone: string;
801
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
802
- day_of_month?: number | null;
803
- days_of_week?: Array<number> | null;
804
- hour?: number;
805
- minute?: number;
806
- month_of_year?: number | null;
807
- start_month?: number | null;
808
- }
809
- interface CronScheduleTrigger {
810
- expression: string;
811
- kind: 'cron_schedule';
812
- timezone: string;
813
- }
814
- interface SlackTrigger {
815
- channel_ids: Array<string>;
816
- event_type: 'message_posted' | 'reaction_added';
817
- kind: 'slack';
818
- allowed_sender_group_id?: string | null;
819
- include_thread_replies?: boolean;
820
- message_text_regex?: string | null;
821
- reaction_names?: Array<string>;
822
- }
823
- interface InboundEmailTrigger {
824
- kind: 'inbound_email';
825
- recipient_email: string;
826
- body_contains?: string | null;
827
- has_attachment?: boolean;
828
- subject_contains?: string | null;
829
- }
830
- }
831
- export interface WorkflowRetrieveParams {
832
- version_id?: string;
833
- }
834
- export interface WorkflowUpdateParams {
835
- version_id: string;
836
- actions?: Array<WorkflowUpdateParams.Action>;
837
- description?: string | null;
838
- enabled?: boolean;
839
- name?: string;
840
- status?: 'draft' | 'published';
841
- trigger?: WorkflowUpdateParams.DailyScheduleTrigger | WorkflowUpdateParams.BusinessEventTrigger | WorkflowUpdateParams.WeekdayScheduleTrigger | WorkflowUpdateParams.WeeklyScheduleTrigger | WorkflowUpdateParams.BiweeklyScheduleTrigger | WorkflowUpdateParams.MonthlyScheduleTrigger | WorkflowUpdateParams.MonthlyOnDayOfWeekScheduleTrigger | WorkflowUpdateParams.QuarterlyScheduleTrigger | WorkflowUpdateParams.AnnualScheduleTrigger | WorkflowUpdateParams.OneTimeScheduleTrigger | WorkflowUpdateParams.CustomScheduleTrigger | WorkflowUpdateParams.CronScheduleTrigger | WorkflowUpdateParams.SlackTrigger | WorkflowUpdateParams.InboundEmailTrigger;
842
- }
843
- export declare namespace WorkflowUpdateParams {
844
- interface Action {
845
- id: string;
846
- implementation_config: string;
847
- kind: 'registered_callback';
848
- owner_id: string;
849
- owner_type: string;
850
- }
851
- interface DailyScheduleTrigger {
852
- hour: number;
853
- kind: 'daily_schedule';
854
- timezone: string;
855
- minute?: number;
856
- }
857
- interface BusinessEventTrigger {
858
- event_name: string;
859
- kind: 'business_event';
860
- }
861
- interface WeekdayScheduleTrigger {
862
- hour: number;
863
- kind: 'weekday_schedule';
864
- timezone: string;
865
- minute?: number;
866
- }
867
- interface WeeklyScheduleTrigger {
868
- days_of_week: Array<number>;
869
- hour: number;
870
- kind: 'weekly_schedule';
871
- timezone: string;
872
- minute?: number;
873
- }
874
- interface BiweeklyScheduleTrigger {
875
- days_of_week: Array<number>;
876
- hour: number;
877
- kind: 'biweekly_schedule';
878
- timezone: string;
879
- minute?: number;
880
- }
881
- interface MonthlyScheduleTrigger {
882
- day_of_month: number;
883
- hour: number;
884
- kind: 'monthly_schedule';
885
- timezone: string;
886
- minute?: number;
887
- }
888
- interface MonthlyOnDayOfWeekScheduleTrigger {
889
- day_of_week: number;
890
- hour: number;
891
- kind: 'monthly_on_day_of_week_schedule';
892
- timezone: string;
893
- week_of_month: number;
894
- minute?: number;
895
- }
896
- interface QuarterlyScheduleTrigger {
897
- day_of_month: number;
898
- hour: number;
899
- kind: 'quarterly_schedule';
900
- month_of_year: number;
901
- timezone: string;
902
- minute?: number;
903
- }
904
- interface AnnualScheduleTrigger {
905
- day_of_month: number;
906
- hour: number;
907
- kind: 'annual_schedule';
908
- month_of_year: number;
909
- timezone: string;
910
- minute?: number;
911
- }
912
- interface OneTimeScheduleTrigger {
913
- day_of_month: number;
914
- hour: number;
915
- kind: 'one_time_schedule';
916
- month_of_year: number;
917
- timezone: string;
918
- year: number;
919
- minute?: number;
920
- }
921
- interface CustomScheduleTrigger {
922
- interval: number;
923
- kind: 'custom_schedule';
924
- timezone: string;
925
- unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
926
- day_of_month?: number | null;
927
- days_of_week?: Array<number> | null;
928
- hour?: number;
929
- minute?: number;
930
- month_of_year?: number | null;
931
- start_month?: number | null;
932
- }
933
- interface CronScheduleTrigger {
934
- expression: string;
935
- kind: 'cron_schedule';
936
- timezone: string;
937
- }
938
- interface SlackTrigger {
939
- channel_ids: Array<string>;
940
- event_type: 'message_posted' | 'reaction_added';
941
- kind: 'slack';
942
- allowed_sender_group_id?: string | null;
943
- include_thread_replies?: boolean;
944
- message_text_regex?: string | null;
945
- reaction_names?: Array<string>;
946
- }
947
- interface InboundEmailTrigger {
948
- kind: 'inbound_email';
949
- recipient_email: string;
950
- body_contains?: string | null;
951
- has_attachment?: boolean;
952
- subject_contains?: string | null;
953
- }
954
- }
955
- export declare namespace Workflows {
956
- export { type WorkflowListResponse as WorkflowListResponse, type WorkflowCreateResponse as WorkflowCreateResponse, type WorkflowRetrieveResponse as WorkflowRetrieveResponse, type WorkflowUpdateResponse as WorkflowUpdateResponse, type WorkflowListResponsesPageCursorURL as WorkflowListResponsesPageCursorURL, type WorkflowListParams as WorkflowListParams, type WorkflowCreateParams as WorkflowCreateParams, type WorkflowRetrieveParams as WorkflowRetrieveParams, type WorkflowUpdateParams as WorkflowUpdateParams, };
957
- }
1
+ export * from "./workflows/index.js";
958
2
  //# sourceMappingURL=workflows.d.ts.map