@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
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest-builder.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":";;;AAAA,8EAAmG;
|
|
1
|
+
{"version":3,"file":"manifest-builder.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":";;;AAAA,8EAAmG;AA2FnG;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,eAAe;IAO1B;;;OAGG;IACH,YAAY,KAA2B;QAPtB,gBAAW,GAAwB,EAAE,CAAC;QACtC,wBAAmB,GAAgC,EAAE,CAAC;QAOrE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAA8B;QACxD,OAAO,mDAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,MAA8B;QACnD,OAAO,mDAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,wBAAwB,CACtB,cAAwD,EACxD,UAA4B;QAE5B,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,OAAO,cAAc,CAAC,oBAAoB,KAAK,UAAU,EAAE,CAAC;YAC9D,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAC;QACnF,CAAC;QAED,MAAM,QAAQ,GAAG,cAAc,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;QACF,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAkB,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACzD,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,QAAQ,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAChE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF;AAnID,0CAmIC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest-builder.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAA+B,wCAAoC;
|
|
1
|
+
{"version":3,"file":"manifest-builder.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAA+B,wCAAoC;AA2FnG;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,eAAe;IAO1B;;;OAGG;IACH,YAAY,KAA2B;QAPtB,gBAAW,GAAwB,EAAE,CAAC;QACtC,wBAAmB,GAAgC,EAAE,CAAC;QAOrE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAA8B;QACxD,OAAO,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,MAA8B;QACnD,OAAO,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,wBAAwB,CACtB,cAAwD,EACxD,UAA4B;QAE5B,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,OAAO,cAAc,CAAC,oBAAoB,KAAK,UAAU,EAAE,CAAC;YAC9D,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAC;QACnF,CAAC;QAED,MAAM,QAAQ,GAAG,cAAc,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;QACF,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAkB,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACzD,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,QAAQ,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAChE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF"}
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import type { ManifestFunction } from "./manifest-function.mjs";
|
|
2
|
+
import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.mjs";
|
|
3
|
+
export type WorkflowAutomationEventType = 'AUTOMATION_EVENT_TYPE_BUSINESS' | 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE' | 'AUTOMATION_EVENT_TYPE_SCHEDULED' | 'AUTOMATION_EVENT_TYPE_MANUAL' | 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
|
|
4
|
+
export type WorkflowRecordChangeOperationType = 'RECORD_CHANGE_OPERATION_TYPE_CREATE' | 'RECORD_CHANGE_OPERATION_TYPE_UPDATE' | 'RECORD_CHANGE_OPERATION_TYPE_DELETE' | 'RECORD_CHANGE_OPERATION_TYPE_CREATE_OR_UPDATE';
|
|
5
|
+
export type WorkflowDateRelativeOperatorType = 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_EQ' | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_WITHIN' | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_BETWEEN';
|
|
6
|
+
export type WorkflowScheduledFrequencyType = 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_DAILY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKDAY_DAILY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_BIWEEKLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY_ON_DAY_OF_WEEK' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ONE_TIME' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_QUARTERLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ANNUALLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CUSTOM' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CRON';
|
|
7
|
+
export type WorkflowCustomScheduleFrequencyUnit = 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_DAYS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_WEEKS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MONTHS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_YEARS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_HOURS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MINUTES';
|
|
8
|
+
export interface WorkflowTimeOfDaySchedule {
|
|
9
|
+
hour_of_day: number;
|
|
10
|
+
minute_of_hour?: number;
|
|
11
|
+
}
|
|
12
|
+
export interface WorkflowOneTimeSchedule extends WorkflowTimeOfDaySchedule {
|
|
13
|
+
year: number;
|
|
14
|
+
month_of_year: number;
|
|
15
|
+
day_of_month: number;
|
|
16
|
+
}
|
|
17
|
+
export interface WorkflowWeeklySchedule extends WorkflowTimeOfDaySchedule {
|
|
18
|
+
day_of_week: number[];
|
|
19
|
+
}
|
|
20
|
+
export interface WorkflowMonthlySchedule extends WorkflowTimeOfDaySchedule {
|
|
21
|
+
day_of_month: number;
|
|
22
|
+
start_month?: number;
|
|
23
|
+
}
|
|
24
|
+
export interface WorkflowMonthlyOnDayOfWeekSchedule extends WorkflowTimeOfDaySchedule {
|
|
25
|
+
day_of_week: number;
|
|
26
|
+
day_of_month: number;
|
|
27
|
+
}
|
|
28
|
+
export interface WorkflowQuarterlySchedule extends WorkflowTimeOfDaySchedule {
|
|
29
|
+
day_of_month: number;
|
|
30
|
+
month_of_year: number;
|
|
31
|
+
}
|
|
32
|
+
export interface WorkflowAnnualSchedule extends WorkflowTimeOfDaySchedule {
|
|
33
|
+
day_of_month: number;
|
|
34
|
+
month_of_year: number;
|
|
35
|
+
start_month?: number;
|
|
36
|
+
}
|
|
37
|
+
export interface WorkflowCronSchedule {
|
|
38
|
+
cron_expression: string;
|
|
39
|
+
}
|
|
40
|
+
export interface WorkflowCustomSchedule extends WorkflowTimeOfDaySchedule {
|
|
41
|
+
custom_schedule_frequency: WorkflowCustomScheduleFrequencyUnit;
|
|
42
|
+
custom_schedule_frequency_value: number;
|
|
43
|
+
daily_schedule?: WorkflowTimeOfDaySchedule;
|
|
44
|
+
weekly_schedule?: WorkflowWeeklySchedule;
|
|
45
|
+
monthly_schedule?: WorkflowMonthlySchedule;
|
|
46
|
+
annual_schedule?: WorkflowAnnualSchedule;
|
|
47
|
+
}
|
|
48
|
+
export interface WorkflowTriggerBase {
|
|
49
|
+
automation_event_type: WorkflowAutomationEventType;
|
|
50
|
+
og_module?: string;
|
|
51
|
+
base_model?: string;
|
|
52
|
+
rql_formula?: string;
|
|
53
|
+
is_basic_workflow?: boolean;
|
|
54
|
+
og_category?: string;
|
|
55
|
+
condition_builder_mode?: string;
|
|
56
|
+
conditions_tree?: string;
|
|
57
|
+
}
|
|
58
|
+
export interface WorkflowBusinessTrigger extends WorkflowTriggerBase {
|
|
59
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_BUSINESS';
|
|
60
|
+
event_name: string;
|
|
61
|
+
business_event_trigger?: {
|
|
62
|
+
navigation_path?: string;
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
export interface WorkflowRecordChangeTrigger extends WorkflowTriggerBase {
|
|
66
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE';
|
|
67
|
+
record_change_operation_type: WorkflowRecordChangeOperationType;
|
|
68
|
+
}
|
|
69
|
+
export interface WorkflowDateRelativeTrigger extends WorkflowTriggerBase {
|
|
70
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
|
|
71
|
+
date_relative_trigger: {
|
|
72
|
+
hour_of_day: number;
|
|
73
|
+
minute_of_hour?: number;
|
|
74
|
+
timezone?: string;
|
|
75
|
+
base_model_date_field_rql_path?: string;
|
|
76
|
+
trigger_on_anniversary?: boolean;
|
|
77
|
+
date_range_operator?: WorkflowDateRelativeOperatorType;
|
|
78
|
+
should_trigger_exactly_once_per_trigger_object?: boolean;
|
|
79
|
+
operands?: Array<{
|
|
80
|
+
time_delta?: {
|
|
81
|
+
days: number;
|
|
82
|
+
};
|
|
83
|
+
}>;
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
export interface WorkflowScheduledTrigger extends WorkflowTriggerBase {
|
|
87
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_SCHEDULED';
|
|
88
|
+
scheduled_trigger: {
|
|
89
|
+
frequency: WorkflowScheduledFrequencyType;
|
|
90
|
+
timezone: string;
|
|
91
|
+
daily_schedule?: WorkflowTimeOfDaySchedule;
|
|
92
|
+
weekday_schedule?: WorkflowTimeOfDaySchedule;
|
|
93
|
+
one_time_schedule?: WorkflowOneTimeSchedule;
|
|
94
|
+
weekly_schedule?: WorkflowWeeklySchedule;
|
|
95
|
+
bi_weekly_schedule?: WorkflowWeeklySchedule;
|
|
96
|
+
monthly_schedule?: WorkflowMonthlySchedule;
|
|
97
|
+
monthly_on_day_of_week_schedule?: WorkflowMonthlyOnDayOfWeekSchedule;
|
|
98
|
+
quarterly_schedule?: WorkflowQuarterlySchedule;
|
|
99
|
+
annual_schedule?: WorkflowAnnualSchedule;
|
|
100
|
+
cron_schedule?: WorkflowCronSchedule;
|
|
101
|
+
custom_schedule?: WorkflowCustomSchedule;
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
export interface WorkflowManualTrigger extends WorkflowTriggerBase {
|
|
105
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_MANUAL';
|
|
106
|
+
}
|
|
107
|
+
export type WorkflowTrigger = WorkflowBusinessTrigger | WorkflowRecordChangeTrigger | WorkflowDateRelativeTrigger | WorkflowScheduledTrigger | WorkflowManualTrigger;
|
|
108
|
+
export interface WorkflowDeletionIdentifier {
|
|
109
|
+
definitionId: string;
|
|
110
|
+
}
|
|
111
|
+
export interface WorkflowProps {
|
|
112
|
+
/**
|
|
113
|
+
* Stable workflow definition id. Auto-generated when omitted.
|
|
114
|
+
*/
|
|
115
|
+
definitionId?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Workflow title shown to admins.
|
|
118
|
+
*/
|
|
119
|
+
title: string;
|
|
120
|
+
/**
|
|
121
|
+
* Short workflow description shown to admins.
|
|
122
|
+
*/
|
|
123
|
+
description: string;
|
|
124
|
+
/**
|
|
125
|
+
* The function this workflow runs. Pass a live {@link ManifestFunction} reference,
|
|
126
|
+
* or a raw api_name string for functions defined outside this manifest.
|
|
127
|
+
*
|
|
128
|
+
* Required.
|
|
129
|
+
*/
|
|
130
|
+
function: ManifestFunction | string;
|
|
131
|
+
/**
|
|
132
|
+
* Trigger definition in the workflows v2 proto JSON shape.
|
|
133
|
+
*/
|
|
134
|
+
trigger: WorkflowTrigger;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Defines a simple Workflow Studio workflow and registers it with the manifest.
|
|
138
|
+
*
|
|
139
|
+
* This intentionally models only the authoring inputs we need today: workflow
|
|
140
|
+
* metadata, trigger JSON, and the function reference. The installer/backend can
|
|
141
|
+
* derive the graph from these fields later.
|
|
142
|
+
*/
|
|
143
|
+
export declare class Workflow {
|
|
144
|
+
static readonly componentType: "WORKFLOW_DEFINITION";
|
|
145
|
+
static toDeletionIdentifier(identifier: WorkflowDeletionIdentifier | string): ManifestComponentDeletion;
|
|
146
|
+
private readonly _definitionId;
|
|
147
|
+
private readonly _title;
|
|
148
|
+
private readonly _description;
|
|
149
|
+
private readonly _functionApiName;
|
|
150
|
+
private readonly _trigger;
|
|
151
|
+
constructor(scope: ManifestScope, props: WorkflowProps);
|
|
152
|
+
getDefinitionId(): string;
|
|
153
|
+
toDict(): Record<string, any>;
|
|
154
|
+
}
|
|
155
|
+
//# sourceMappingURL=workflow.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/workflow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gCAA4B;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,+BAA2B;AAEnF,MAAM,MAAM,2BAA2B,GACnC,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,GACjC,8BAA8B,GAC9B,qCAAqC,CAAC;AAE1C,MAAM,MAAM,iCAAiC,GACzC,qCAAqC,GACrC,qCAAqC,GACrC,qCAAqC,GACrC,+CAA+C,CAAC;AAEpD,MAAM,MAAM,gCAAgC,GACxC,wCAAwC,GACxC,4CAA4C,GAC5C,6CAA6C,CAAC;AAElD,MAAM,MAAM,8BAA8B,GACtC,wCAAwC,GACxC,gDAAgD,GAChD,yCAAyC,GACzC,2CAA2C,GAC3C,0CAA0C,GAC1C,yDAAyD,GACzD,2CAA2C,GAC3C,4CAA4C,GAC5C,2CAA2C,GAC3C,yCAAyC,GACzC,uCAAuC,CAAC;AAE5C,MAAM,MAAM,mCAAmC,GAC3C,6CAA6C,GAC7C,8CAA8C,GAC9C,+CAA+C,GAC/C,8CAA8C,GAC9C,8CAA8C,GAC9C,gDAAgD,CAAC;AAErD,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACnF,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAA0B,SAAQ,yBAAyB;IAC1E,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,yBAAyB,EAAE,mCAAmC,CAAC;IAC/D,+BAA+B,EAAE,MAAM,CAAC;IACxC,cAAc,CAAC,EAAE,yBAAyB,CAAC;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC,qBAAqB,EAAE,2BAA2B,CAAC;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE,qBAAqB,EAAE,gCAAgC,CAAC;IACxD,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB,CAAC,EAAE;QACvB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,qBAAqB,EAAE,qCAAqC,CAAC;IAC7D,4BAA4B,EAAE,iCAAiC,CAAC;CACjE;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,qBAAqB,EAAE,qCAAqC,CAAC;IAC7D,qBAAqB,EAAE;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,8BAA8B,CAAC,EAAE,MAAM,CAAC;QACxC,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,mBAAmB,CAAC,EAAE,gCAAgC,CAAC;QACvD,8CAA8C,CAAC,EAAE,OAAO,CAAC;QACzD,QAAQ,CAAC,EAAE,KAAK,CAAC;YAAE,UAAU,CAAC,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC,CAAC;KACrD,CAAC;CACH;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE,qBAAqB,EAAE,iCAAiC,CAAC;IACzD,iBAAiB,EAAE;QACjB,SAAS,EAAE,8BAA8B,CAAC;QAC1C,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,yBAAyB,CAAC;QAC3C,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;QAC7C,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;QAC5C,eAAe,CAAC,EAAE,sBAAsB,CAAC;QACzC,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;QAC5C,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;QAC3C,+BAA+B,CAAC,EAAE,kCAAkC,CAAC;QACrE,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;QAC/C,eAAe,CAAC,EAAE,sBAAsB,CAAC;QACzC,aAAa,CAAC,EAAE,oBAAoB,CAAC;QACrC,eAAe,CAAC,EAAE,sBAAsB,CAAC;KAC1C,CAAC;CACH;AAED,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,qBAAqB,EAAE,8BAA8B,CAAC;CACvD;AAED,MAAM,MAAM,eAAe,GACvB,uBAAuB,GACvB,2BAA2B,GAC3B,2BAA2B,GAC3B,wBAAwB,GACxB,qBAAqB,CAAC;AAE1B,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACpC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,qBAAqB,CAAU;IAE/D,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,0BAA0B,GAAG,MAAM,GAAG,yBAAyB;IAQvG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;gBAE/B,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAUtD,eAAe,IAAI,MAAM;IAIzB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAe9B"}
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import type { ManifestFunction } from "./manifest-function.js";
|
|
2
|
+
import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.js";
|
|
3
|
+
export type WorkflowAutomationEventType = 'AUTOMATION_EVENT_TYPE_BUSINESS' | 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE' | 'AUTOMATION_EVENT_TYPE_SCHEDULED' | 'AUTOMATION_EVENT_TYPE_MANUAL' | 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
|
|
4
|
+
export type WorkflowRecordChangeOperationType = 'RECORD_CHANGE_OPERATION_TYPE_CREATE' | 'RECORD_CHANGE_OPERATION_TYPE_UPDATE' | 'RECORD_CHANGE_OPERATION_TYPE_DELETE' | 'RECORD_CHANGE_OPERATION_TYPE_CREATE_OR_UPDATE';
|
|
5
|
+
export type WorkflowDateRelativeOperatorType = 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_EQ' | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_WITHIN' | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_BETWEEN';
|
|
6
|
+
export type WorkflowScheduledFrequencyType = 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_DAILY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKDAY_DAILY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_BIWEEKLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY_ON_DAY_OF_WEEK' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ONE_TIME' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_QUARTERLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ANNUALLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CUSTOM' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CRON';
|
|
7
|
+
export type WorkflowCustomScheduleFrequencyUnit = 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_DAYS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_WEEKS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MONTHS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_YEARS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_HOURS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MINUTES';
|
|
8
|
+
export interface WorkflowTimeOfDaySchedule {
|
|
9
|
+
hour_of_day: number;
|
|
10
|
+
minute_of_hour?: number;
|
|
11
|
+
}
|
|
12
|
+
export interface WorkflowOneTimeSchedule extends WorkflowTimeOfDaySchedule {
|
|
13
|
+
year: number;
|
|
14
|
+
month_of_year: number;
|
|
15
|
+
day_of_month: number;
|
|
16
|
+
}
|
|
17
|
+
export interface WorkflowWeeklySchedule extends WorkflowTimeOfDaySchedule {
|
|
18
|
+
day_of_week: number[];
|
|
19
|
+
}
|
|
20
|
+
export interface WorkflowMonthlySchedule extends WorkflowTimeOfDaySchedule {
|
|
21
|
+
day_of_month: number;
|
|
22
|
+
start_month?: number;
|
|
23
|
+
}
|
|
24
|
+
export interface WorkflowMonthlyOnDayOfWeekSchedule extends WorkflowTimeOfDaySchedule {
|
|
25
|
+
day_of_week: number;
|
|
26
|
+
day_of_month: number;
|
|
27
|
+
}
|
|
28
|
+
export interface WorkflowQuarterlySchedule extends WorkflowTimeOfDaySchedule {
|
|
29
|
+
day_of_month: number;
|
|
30
|
+
month_of_year: number;
|
|
31
|
+
}
|
|
32
|
+
export interface WorkflowAnnualSchedule extends WorkflowTimeOfDaySchedule {
|
|
33
|
+
day_of_month: number;
|
|
34
|
+
month_of_year: number;
|
|
35
|
+
start_month?: number;
|
|
36
|
+
}
|
|
37
|
+
export interface WorkflowCronSchedule {
|
|
38
|
+
cron_expression: string;
|
|
39
|
+
}
|
|
40
|
+
export interface WorkflowCustomSchedule extends WorkflowTimeOfDaySchedule {
|
|
41
|
+
custom_schedule_frequency: WorkflowCustomScheduleFrequencyUnit;
|
|
42
|
+
custom_schedule_frequency_value: number;
|
|
43
|
+
daily_schedule?: WorkflowTimeOfDaySchedule;
|
|
44
|
+
weekly_schedule?: WorkflowWeeklySchedule;
|
|
45
|
+
monthly_schedule?: WorkflowMonthlySchedule;
|
|
46
|
+
annual_schedule?: WorkflowAnnualSchedule;
|
|
47
|
+
}
|
|
48
|
+
export interface WorkflowTriggerBase {
|
|
49
|
+
automation_event_type: WorkflowAutomationEventType;
|
|
50
|
+
og_module?: string;
|
|
51
|
+
base_model?: string;
|
|
52
|
+
rql_formula?: string;
|
|
53
|
+
is_basic_workflow?: boolean;
|
|
54
|
+
og_category?: string;
|
|
55
|
+
condition_builder_mode?: string;
|
|
56
|
+
conditions_tree?: string;
|
|
57
|
+
}
|
|
58
|
+
export interface WorkflowBusinessTrigger extends WorkflowTriggerBase {
|
|
59
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_BUSINESS';
|
|
60
|
+
event_name: string;
|
|
61
|
+
business_event_trigger?: {
|
|
62
|
+
navigation_path?: string;
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
export interface WorkflowRecordChangeTrigger extends WorkflowTriggerBase {
|
|
66
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE';
|
|
67
|
+
record_change_operation_type: WorkflowRecordChangeOperationType;
|
|
68
|
+
}
|
|
69
|
+
export interface WorkflowDateRelativeTrigger extends WorkflowTriggerBase {
|
|
70
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
|
|
71
|
+
date_relative_trigger: {
|
|
72
|
+
hour_of_day: number;
|
|
73
|
+
minute_of_hour?: number;
|
|
74
|
+
timezone?: string;
|
|
75
|
+
base_model_date_field_rql_path?: string;
|
|
76
|
+
trigger_on_anniversary?: boolean;
|
|
77
|
+
date_range_operator?: WorkflowDateRelativeOperatorType;
|
|
78
|
+
should_trigger_exactly_once_per_trigger_object?: boolean;
|
|
79
|
+
operands?: Array<{
|
|
80
|
+
time_delta?: {
|
|
81
|
+
days: number;
|
|
82
|
+
};
|
|
83
|
+
}>;
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
export interface WorkflowScheduledTrigger extends WorkflowTriggerBase {
|
|
87
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_SCHEDULED';
|
|
88
|
+
scheduled_trigger: {
|
|
89
|
+
frequency: WorkflowScheduledFrequencyType;
|
|
90
|
+
timezone: string;
|
|
91
|
+
daily_schedule?: WorkflowTimeOfDaySchedule;
|
|
92
|
+
weekday_schedule?: WorkflowTimeOfDaySchedule;
|
|
93
|
+
one_time_schedule?: WorkflowOneTimeSchedule;
|
|
94
|
+
weekly_schedule?: WorkflowWeeklySchedule;
|
|
95
|
+
bi_weekly_schedule?: WorkflowWeeklySchedule;
|
|
96
|
+
monthly_schedule?: WorkflowMonthlySchedule;
|
|
97
|
+
monthly_on_day_of_week_schedule?: WorkflowMonthlyOnDayOfWeekSchedule;
|
|
98
|
+
quarterly_schedule?: WorkflowQuarterlySchedule;
|
|
99
|
+
annual_schedule?: WorkflowAnnualSchedule;
|
|
100
|
+
cron_schedule?: WorkflowCronSchedule;
|
|
101
|
+
custom_schedule?: WorkflowCustomSchedule;
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
export interface WorkflowManualTrigger extends WorkflowTriggerBase {
|
|
105
|
+
automation_event_type: 'AUTOMATION_EVENT_TYPE_MANUAL';
|
|
106
|
+
}
|
|
107
|
+
export type WorkflowTrigger = WorkflowBusinessTrigger | WorkflowRecordChangeTrigger | WorkflowDateRelativeTrigger | WorkflowScheduledTrigger | WorkflowManualTrigger;
|
|
108
|
+
export interface WorkflowDeletionIdentifier {
|
|
109
|
+
definitionId: string;
|
|
110
|
+
}
|
|
111
|
+
export interface WorkflowProps {
|
|
112
|
+
/**
|
|
113
|
+
* Stable workflow definition id. Auto-generated when omitted.
|
|
114
|
+
*/
|
|
115
|
+
definitionId?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Workflow title shown to admins.
|
|
118
|
+
*/
|
|
119
|
+
title: string;
|
|
120
|
+
/**
|
|
121
|
+
* Short workflow description shown to admins.
|
|
122
|
+
*/
|
|
123
|
+
description: string;
|
|
124
|
+
/**
|
|
125
|
+
* The function this workflow runs. Pass a live {@link ManifestFunction} reference,
|
|
126
|
+
* or a raw api_name string for functions defined outside this manifest.
|
|
127
|
+
*
|
|
128
|
+
* Required.
|
|
129
|
+
*/
|
|
130
|
+
function: ManifestFunction | string;
|
|
131
|
+
/**
|
|
132
|
+
* Trigger definition in the workflows v2 proto JSON shape.
|
|
133
|
+
*/
|
|
134
|
+
trigger: WorkflowTrigger;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Defines a simple Workflow Studio workflow and registers it with the manifest.
|
|
138
|
+
*
|
|
139
|
+
* This intentionally models only the authoring inputs we need today: workflow
|
|
140
|
+
* metadata, trigger JSON, and the function reference. The installer/backend can
|
|
141
|
+
* derive the graph from these fields later.
|
|
142
|
+
*/
|
|
143
|
+
export declare class Workflow {
|
|
144
|
+
static readonly componentType: "WORKFLOW_DEFINITION";
|
|
145
|
+
static toDeletionIdentifier(identifier: WorkflowDeletionIdentifier | string): ManifestComponentDeletion;
|
|
146
|
+
private readonly _definitionId;
|
|
147
|
+
private readonly _title;
|
|
148
|
+
private readonly _description;
|
|
149
|
+
private readonly _functionApiName;
|
|
150
|
+
private readonly _trigger;
|
|
151
|
+
constructor(scope: ManifestScope, props: WorkflowProps);
|
|
152
|
+
getDefinitionId(): string;
|
|
153
|
+
toDict(): Record<string, any>;
|
|
154
|
+
}
|
|
155
|
+
//# sourceMappingURL=workflow.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/workflow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA4B;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAEnF,MAAM,MAAM,2BAA2B,GACnC,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,GACjC,8BAA8B,GAC9B,qCAAqC,CAAC;AAE1C,MAAM,MAAM,iCAAiC,GACzC,qCAAqC,GACrC,qCAAqC,GACrC,qCAAqC,GACrC,+CAA+C,CAAC;AAEpD,MAAM,MAAM,gCAAgC,GACxC,wCAAwC,GACxC,4CAA4C,GAC5C,6CAA6C,CAAC;AAElD,MAAM,MAAM,8BAA8B,GACtC,wCAAwC,GACxC,gDAAgD,GAChD,yCAAyC,GACzC,2CAA2C,GAC3C,0CAA0C,GAC1C,yDAAyD,GACzD,2CAA2C,GAC3C,4CAA4C,GAC5C,2CAA2C,GAC3C,yCAAyC,GACzC,uCAAuC,CAAC;AAE5C,MAAM,MAAM,mCAAmC,GAC3C,6CAA6C,GAC7C,8CAA8C,GAC9C,+CAA+C,GAC/C,8CAA8C,GAC9C,8CAA8C,GAC9C,gDAAgD,CAAC;AAErD,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACnF,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAA0B,SAAQ,yBAAyB;IAC1E,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,yBAAyB,EAAE,mCAAmC,CAAC;IAC/D,+BAA+B,EAAE,MAAM,CAAC;IACxC,cAAc,CAAC,EAAE,yBAAyB,CAAC;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC,qBAAqB,EAAE,2BAA2B,CAAC;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE,qBAAqB,EAAE,gCAAgC,CAAC;IACxD,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB,CAAC,EAAE;QACvB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,qBAAqB,EAAE,qCAAqC,CAAC;IAC7D,4BAA4B,EAAE,iCAAiC,CAAC;CACjE;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,qBAAqB,EAAE,qCAAqC,CAAC;IAC7D,qBAAqB,EAAE;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,8BAA8B,CAAC,EAAE,MAAM,CAAC;QACxC,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,mBAAmB,CAAC,EAAE,gCAAgC,CAAC;QACvD,8CAA8C,CAAC,EAAE,OAAO,CAAC;QACzD,QAAQ,CAAC,EAAE,KAAK,CAAC;YAAE,UAAU,CAAC,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC,CAAC;KACrD,CAAC;CACH;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE,qBAAqB,EAAE,iCAAiC,CAAC;IACzD,iBAAiB,EAAE;QACjB,SAAS,EAAE,8BAA8B,CAAC;QAC1C,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,yBAAyB,CAAC;QAC3C,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;QAC7C,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;QAC5C,eAAe,CAAC,EAAE,sBAAsB,CAAC;QACzC,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;QAC5C,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;QAC3C,+BAA+B,CAAC,EAAE,kCAAkC,CAAC;QACrE,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;QAC/C,eAAe,CAAC,EAAE,sBAAsB,CAAC;QACzC,aAAa,CAAC,EAAE,oBAAoB,CAAC;QACrC,eAAe,CAAC,EAAE,sBAAsB,CAAC;KAC1C,CAAC;CACH;AAED,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,qBAAqB,EAAE,8BAA8B,CAAC;CACvD;AAED,MAAM,MAAM,eAAe,GACvB,uBAAuB,GACvB,2BAA2B,GAC3B,2BAA2B,GAC3B,wBAAwB,GACxB,qBAAqB,CAAC;AAE1B,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACpC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,qBAAqB,CAAU;IAE/D,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,0BAA0B,GAAG,MAAM,GAAG,yBAAyB;IAQvG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;gBAE/B,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAUtD,eAAe,IAAI,MAAM;IAIzB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAe9B"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Workflow = void 0;
|
|
4
|
+
const _helpers_1 = require("./_helpers.js");
|
|
5
|
+
/**
|
|
6
|
+
* Defines a simple Workflow Studio workflow and registers it with the manifest.
|
|
7
|
+
*
|
|
8
|
+
* This intentionally models only the authoring inputs we need today: workflow
|
|
9
|
+
* metadata, trigger JSON, and the function reference. The installer/backend can
|
|
10
|
+
* derive the graph from these fields later.
|
|
11
|
+
*/
|
|
12
|
+
class Workflow {
|
|
13
|
+
static toDeletionIdentifier(identifier) {
|
|
14
|
+
const definitionId = typeof identifier === 'string' ? identifier : identifier.definitionId;
|
|
15
|
+
return {
|
|
16
|
+
type: Workflow.componentType,
|
|
17
|
+
definition_id: definitionId,
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
constructor(scope, props) {
|
|
21
|
+
if (!props.function)
|
|
22
|
+
throw new Error('function is required');
|
|
23
|
+
this._definitionId = props.definitionId ?? (0, _helpers_1.generateId)('workflow');
|
|
24
|
+
this._title = props.title;
|
|
25
|
+
this._description = props.description;
|
|
26
|
+
this._functionApiName = typeof props.function === 'string' ? props.function : props.function.getApiName();
|
|
27
|
+
this._trigger = props.trigger;
|
|
28
|
+
scope._register(this);
|
|
29
|
+
}
|
|
30
|
+
getDefinitionId() {
|
|
31
|
+
return this._definitionId;
|
|
32
|
+
}
|
|
33
|
+
toDict() {
|
|
34
|
+
const component = {
|
|
35
|
+
type: Workflow.componentType,
|
|
36
|
+
definition_id: this._definitionId,
|
|
37
|
+
version_status: 'VERSION_STATUS_DRAFT',
|
|
38
|
+
trigger_status: 'TRIGGER_STATUS_INACTIVE',
|
|
39
|
+
trigger: this._trigger,
|
|
40
|
+
workflow_meta: {
|
|
41
|
+
name: this._title,
|
|
42
|
+
description: this._description,
|
|
43
|
+
},
|
|
44
|
+
function_api_name: this._functionApiName,
|
|
45
|
+
};
|
|
46
|
+
return component;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
exports.Workflow = Workflow;
|
|
50
|
+
Workflow.componentType = 'WORKFLOW_DEFINITION';
|
|
51
|
+
//# sourceMappingURL=workflow.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow.js","sourceRoot":"","sources":["../../src/lib/manifest/workflow.ts"],"names":[],"mappings":";;;AAAA,4CAAwC;AA8LxC;;;;;;GAMG;AACH,MAAa,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAA+C;QACzE,MAAM,YAAY,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC;QAC3F,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,aAAa,EAAE,YAAY;SAC5B,CAAC;IACJ,CAAC;IAQD,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,IAAI,IAAA,qBAAU,EAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,sBAAsB;YACtC,cAAc,EAAE,yBAAyB;YACzC,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,aAAa,EAAE;gBACb,IAAI,EAAE,IAAI,CAAC,MAAM;gBACjB,WAAW,EAAE,IAAI,CAAC,YAAY;aAC/B;YACD,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;SACzC,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;;AA7CH,4BA8CC;AA7CiB,sBAAa,GAAG,qBAA8B,CAAC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { generateId } from "./_helpers.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Defines a simple Workflow Studio workflow and registers it with the manifest.
|
|
4
|
+
*
|
|
5
|
+
* This intentionally models only the authoring inputs we need today: workflow
|
|
6
|
+
* metadata, trigger JSON, and the function reference. The installer/backend can
|
|
7
|
+
* derive the graph from these fields later.
|
|
8
|
+
*/
|
|
9
|
+
export class Workflow {
|
|
10
|
+
static toDeletionIdentifier(identifier) {
|
|
11
|
+
const definitionId = typeof identifier === 'string' ? identifier : identifier.definitionId;
|
|
12
|
+
return {
|
|
13
|
+
type: Workflow.componentType,
|
|
14
|
+
definition_id: definitionId,
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
constructor(scope, props) {
|
|
18
|
+
if (!props.function)
|
|
19
|
+
throw new Error('function is required');
|
|
20
|
+
this._definitionId = props.definitionId ?? generateId('workflow');
|
|
21
|
+
this._title = props.title;
|
|
22
|
+
this._description = props.description;
|
|
23
|
+
this._functionApiName = typeof props.function === 'string' ? props.function : props.function.getApiName();
|
|
24
|
+
this._trigger = props.trigger;
|
|
25
|
+
scope._register(this);
|
|
26
|
+
}
|
|
27
|
+
getDefinitionId() {
|
|
28
|
+
return this._definitionId;
|
|
29
|
+
}
|
|
30
|
+
toDict() {
|
|
31
|
+
const component = {
|
|
32
|
+
type: Workflow.componentType,
|
|
33
|
+
definition_id: this._definitionId,
|
|
34
|
+
version_status: 'VERSION_STATUS_DRAFT',
|
|
35
|
+
trigger_status: 'TRIGGER_STATUS_INACTIVE',
|
|
36
|
+
trigger: this._trigger,
|
|
37
|
+
workflow_meta: {
|
|
38
|
+
name: this._title,
|
|
39
|
+
description: this._description,
|
|
40
|
+
},
|
|
41
|
+
function_api_name: this._functionApiName,
|
|
42
|
+
};
|
|
43
|
+
return component;
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
Workflow.componentType = 'WORKFLOW_DEFINITION';
|
|
47
|
+
//# sourceMappingURL=workflow.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"workflow.mjs","sourceRoot":"","sources":["../../src/lib/manifest/workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,uBAAmB;AA8LxC;;;;;;GAMG;AACH,MAAM,OAAO,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAA+C;QACzE,MAAM,YAAY,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC;QAC3F,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,aAAa,EAAE,YAAY;SAC5B,CAAC;IACJ,CAAC;IAQD,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,sBAAsB;YACtC,cAAc,EAAE,yBAAyB;YACzC,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,aAAa,EAAE;gBACb,IAAI,EAAE,IAAI,CAAC,MAAM;gBACjB,WAAW,EAAE,IAAI,CAAC,YAAY;aAC/B;YACD,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;SACzC,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;;AA5Ce,sBAAa,GAAG,qBAA8B,CAAC"}
|
package/package.json
CHANGED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as BusinessPartnersAPI from "./business-partners.mjs";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
+
import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
6
|
+
/**
|
|
7
|
+
* Break types configured by the company for time tracking
|
|
8
|
+
*/
|
|
9
|
+
export declare class BreakTypes extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* A list of break types.
|
|
12
|
+
*
|
|
13
|
+
* - Requires: `API Tier 2`
|
|
14
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
15
|
+
*/
|
|
16
|
+
list(query?: BreakTypeListParams | null | undefined, options?: RequestOptions): PagePromise<BreakTypeListResponsesPageCursorURL, BreakTypeListResponse>;
|
|
17
|
+
/**
|
|
18
|
+
* Retrieve a specific break type
|
|
19
|
+
*/
|
|
20
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse>;
|
|
21
|
+
}
|
|
22
|
+
export type BreakTypeListResponsesPageCursorURL = PageCursorURL<BreakTypeListResponse>;
|
|
23
|
+
export interface BreakTypeListResponse {
|
|
24
|
+
/**
|
|
25
|
+
* Identifier field
|
|
26
|
+
*/
|
|
27
|
+
id: string;
|
|
28
|
+
/**
|
|
29
|
+
* Record creation date
|
|
30
|
+
*/
|
|
31
|
+
created_at: string;
|
|
32
|
+
/**
|
|
33
|
+
* The display name of the break type.
|
|
34
|
+
*/
|
|
35
|
+
name: string;
|
|
36
|
+
/**
|
|
37
|
+
* Record update date
|
|
38
|
+
*/
|
|
39
|
+
updated_at: string;
|
|
40
|
+
/**
|
|
41
|
+
* The break category. One of: MEAL, REST, or OTHER.
|
|
42
|
+
*/
|
|
43
|
+
break_category?: 'MEAL' | 'REST' | 'OTHER';
|
|
44
|
+
/**
|
|
45
|
+
* Whether this is a paid break (true) or unpaid (false).
|
|
46
|
+
*/
|
|
47
|
+
is_paid?: boolean;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Meta information for the response.
|
|
51
|
+
*/
|
|
52
|
+
export interface BreakTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
53
|
+
/**
|
|
54
|
+
* Identifier field
|
|
55
|
+
*/
|
|
56
|
+
id: string;
|
|
57
|
+
/**
|
|
58
|
+
* Record creation date
|
|
59
|
+
*/
|
|
60
|
+
created_at: string;
|
|
61
|
+
/**
|
|
62
|
+
* The display name of the break type.
|
|
63
|
+
*/
|
|
64
|
+
name: string;
|
|
65
|
+
/**
|
|
66
|
+
* Record update date
|
|
67
|
+
*/
|
|
68
|
+
updated_at: string;
|
|
69
|
+
/**
|
|
70
|
+
* The break category. One of: MEAL, REST, or OTHER.
|
|
71
|
+
*/
|
|
72
|
+
break_category?: 'MEAL' | 'REST' | 'OTHER';
|
|
73
|
+
/**
|
|
74
|
+
* Whether this is a paid break (true) or unpaid (false).
|
|
75
|
+
*/
|
|
76
|
+
is_paid?: boolean;
|
|
77
|
+
}
|
|
78
|
+
export interface BreakTypeListParams {
|
|
79
|
+
cursor?: string;
|
|
80
|
+
order_by?: string;
|
|
81
|
+
}
|
|
82
|
+
export declare namespace BreakTypes {
|
|
83
|
+
export { type BreakTypeListResponse as BreakTypeListResponse, type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse, type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL, type BreakTypeListParams as BreakTypeListParams, };
|
|
84
|
+
}
|
|
85
|
+
//# sourceMappingURL=break-types.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"break-types.d.mts","sourceRoot":"","sources":["../src/resources/break-types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;IAO1E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGtF;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB,CAAC,IAAI;IACzE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import * as BusinessPartnersAPI from "./business-partners.js";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
4
|
+
import { PageCursorURL, PagePromise } from "../core/pagination.js";
|
|
5
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
6
|
+
/**
|
|
7
|
+
* Break types configured by the company for time tracking
|
|
8
|
+
*/
|
|
9
|
+
export declare class BreakTypes extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* A list of break types.
|
|
12
|
+
*
|
|
13
|
+
* - Requires: `API Tier 2`
|
|
14
|
+
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
15
|
+
*/
|
|
16
|
+
list(query?: BreakTypeListParams | null | undefined, options?: RequestOptions): PagePromise<BreakTypeListResponsesPageCursorURL, BreakTypeListResponse>;
|
|
17
|
+
/**
|
|
18
|
+
* Retrieve a specific break type
|
|
19
|
+
*/
|
|
20
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<BreakTypeRetrieveResponse>;
|
|
21
|
+
}
|
|
22
|
+
export type BreakTypeListResponsesPageCursorURL = PageCursorURL<BreakTypeListResponse>;
|
|
23
|
+
export interface BreakTypeListResponse {
|
|
24
|
+
/**
|
|
25
|
+
* Identifier field
|
|
26
|
+
*/
|
|
27
|
+
id: string;
|
|
28
|
+
/**
|
|
29
|
+
* Record creation date
|
|
30
|
+
*/
|
|
31
|
+
created_at: string;
|
|
32
|
+
/**
|
|
33
|
+
* The display name of the break type.
|
|
34
|
+
*/
|
|
35
|
+
name: string;
|
|
36
|
+
/**
|
|
37
|
+
* Record update date
|
|
38
|
+
*/
|
|
39
|
+
updated_at: string;
|
|
40
|
+
/**
|
|
41
|
+
* The break category. One of: MEAL, REST, or OTHER.
|
|
42
|
+
*/
|
|
43
|
+
break_category?: 'MEAL' | 'REST' | 'OTHER';
|
|
44
|
+
/**
|
|
45
|
+
* Whether this is a paid break (true) or unpaid (false).
|
|
46
|
+
*/
|
|
47
|
+
is_paid?: boolean;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Meta information for the response.
|
|
51
|
+
*/
|
|
52
|
+
export interface BreakTypeRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
53
|
+
/**
|
|
54
|
+
* Identifier field
|
|
55
|
+
*/
|
|
56
|
+
id: string;
|
|
57
|
+
/**
|
|
58
|
+
* Record creation date
|
|
59
|
+
*/
|
|
60
|
+
created_at: string;
|
|
61
|
+
/**
|
|
62
|
+
* The display name of the break type.
|
|
63
|
+
*/
|
|
64
|
+
name: string;
|
|
65
|
+
/**
|
|
66
|
+
* Record update date
|
|
67
|
+
*/
|
|
68
|
+
updated_at: string;
|
|
69
|
+
/**
|
|
70
|
+
* The break category. One of: MEAL, REST, or OTHER.
|
|
71
|
+
*/
|
|
72
|
+
break_category?: 'MEAL' | 'REST' | 'OTHER';
|
|
73
|
+
/**
|
|
74
|
+
* Whether this is a paid break (true) or unpaid (false).
|
|
75
|
+
*/
|
|
76
|
+
is_paid?: boolean;
|
|
77
|
+
}
|
|
78
|
+
export interface BreakTypeListParams {
|
|
79
|
+
cursor?: string;
|
|
80
|
+
order_by?: string;
|
|
81
|
+
}
|
|
82
|
+
export declare namespace BreakTypes {
|
|
83
|
+
export { type BreakTypeListResponse as BreakTypeListResponse, type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse, type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL, type BreakTypeListParams as BreakTypeListParams, };
|
|
84
|
+
}
|
|
85
|
+
//# sourceMappingURL=break-types.d.ts.map
|