@rippling/rippling-sdk 0.2.0-alpha.23 → 0.2.0-alpha.25
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 +7 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +7 -4
- package/client.d.ts.map +1 -1
- package/client.js +4 -0
- package/client.js.map +1 -1
- package/client.mjs +4 -0
- package/client.mjs.map +1 -1
- package/functions.d.mts +3 -0
- package/functions.d.mts.map +1 -1
- package/functions.d.ts +3 -0
- package/functions.d.ts.map +1 -1
- package/functions.js.map +1 -1
- package/functions.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/business-partner-groups.d.mts +1 -0
- package/resources/business-partner-groups.d.mts.map +1 -1
- package/resources/business-partner-groups.d.ts +1 -0
- package/resources/business-partner-groups.d.ts.map +1 -1
- package/resources/business-partners.d.mts +1 -0
- package/resources/business-partners.d.mts.map +1 -1
- package/resources/business-partners.d.ts +1 -0
- package/resources/business-partners.d.ts.map +1 -1
- package/resources/candidate-applications.d.mts +1 -0
- package/resources/candidate-applications.d.mts.map +1 -1
- package/resources/candidate-applications.d.ts +1 -0
- package/resources/candidate-applications.d.ts.map +1 -1
- package/resources/candidates.d.mts +1 -0
- package/resources/candidates.d.mts.map +1 -1
- package/resources/candidates.d.ts +1 -0
- package/resources/candidates.d.ts.map +1 -1
- package/resources/companies.d.mts +1 -0
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +1 -0
- package/resources/companies.d.ts.map +1 -1
- package/resources/compensations.d.mts +1 -0
- package/resources/compensations.d.mts.map +1 -1
- package/resources/compensations.d.ts +1 -0
- package/resources/compensations.d.ts.map +1 -1
- package/resources/custom-fields.d.mts +1 -0
- package/resources/custom-fields.d.mts.map +1 -1
- package/resources/custom-fields.d.ts +1 -0
- package/resources/custom-fields.d.ts.map +1 -1
- package/resources/departments.d.mts +1 -0
- package/resources/departments.d.mts.map +1 -1
- package/resources/departments.d.ts +1 -0
- package/resources/departments.d.ts.map +1 -1
- package/resources/employment-types.d.mts +1 -0
- package/resources/employment-types.d.mts.map +1 -1
- package/resources/employment-types.d.ts +1 -0
- package/resources/employment-types.d.ts.map +1 -1
- package/resources/headcount-positions.d.mts +1 -0
- package/resources/headcount-positions.d.mts.map +1 -1
- package/resources/headcount-positions.d.ts +1 -0
- package/resources/headcount-positions.d.ts.map +1 -1
- package/resources/headcount-priorities.d.mts +1 -0
- package/resources/headcount-priorities.d.mts.map +1 -1
- package/resources/headcount-priorities.d.ts +1 -0
- package/resources/headcount-priorities.d.ts.map +1 -1
- package/resources/index.d.mts +3 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/job-assignments.d.mts +2 -0
- package/resources/job-assignments.d.mts.map +1 -1
- package/resources/job-assignments.d.ts +2 -0
- package/resources/job-assignments.d.ts.map +1 -1
- package/resources/job-codes.d.mts +2 -0
- package/resources/job-codes.d.mts.map +1 -1
- package/resources/job-codes.d.ts +2 -0
- package/resources/job-codes.d.ts.map +1 -1
- package/resources/job-dimensions.d.mts +1 -0
- package/resources/job-dimensions.d.mts.map +1 -1
- package/resources/job-dimensions.d.ts +1 -0
- package/resources/job-dimensions.d.ts.map +1 -1
- package/resources/job-functions.d.mts +1 -0
- package/resources/job-functions.d.mts.map +1 -1
- package/resources/job-functions.d.ts +1 -0
- package/resources/job-functions.d.ts.map +1 -1
- package/resources/job-pay-rate-exceptions.d.mts +2 -0
- package/resources/job-pay-rate-exceptions.d.mts.map +1 -1
- package/resources/job-pay-rate-exceptions.d.ts +2 -0
- package/resources/job-pay-rate-exceptions.d.ts.map +1 -1
- package/resources/job-requisitions.d.mts +1 -0
- package/resources/job-requisitions.d.mts.map +1 -1
- package/resources/job-requisitions.d.ts +1 -0
- package/resources/job-requisitions.d.ts.map +1 -1
- package/resources/kiosk-badges.d.mts +1 -0
- package/resources/kiosk-badges.d.mts.map +1 -1
- package/resources/kiosk-badges.d.ts +1 -0
- package/resources/kiosk-badges.d.ts.map +1 -1
- package/resources/leave-balances.d.mts +1 -0
- package/resources/leave-balances.d.mts.map +1 -1
- package/resources/leave-balances.d.ts +1 -0
- package/resources/leave-balances.d.ts.map +1 -1
- package/resources/leave-requests.d.mts +1 -0
- package/resources/leave-requests.d.mts.map +1 -1
- package/resources/leave-requests.d.ts +1 -0
- package/resources/leave-requests.d.ts.map +1 -1
- package/resources/leave-types.d.mts +1 -0
- package/resources/leave-types.d.mts.map +1 -1
- package/resources/leave-types.d.ts +1 -0
- package/resources/leave-types.d.ts.map +1 -1
- package/resources/legal-entities.d.mts +1 -0
- package/resources/legal-entities.d.mts.map +1 -1
- package/resources/legal-entities.d.ts +1 -0
- package/resources/legal-entities.d.ts.map +1 -1
- package/resources/levels.d.mts +1 -0
- package/resources/levels.d.mts.map +1 -1
- package/resources/levels.d.ts +1 -0
- package/resources/levels.d.ts.map +1 -1
- package/resources/location-factors.d.mts +1 -0
- package/resources/location-factors.d.mts.map +1 -1
- package/resources/location-factors.d.ts +1 -0
- package/resources/location-factors.d.ts.map +1 -1
- package/resources/schedules.d.mts +110 -1
- package/resources/schedules.d.mts.map +1 -1
- package/resources/schedules.d.ts +110 -1
- package/resources/schedules.d.ts.map +1 -1
- package/resources/schedules.js +6 -0
- package/resources/schedules.js.map +1 -1
- package/resources/schedules.mjs +6 -0
- package/resources/schedules.mjs.map +1 -1
- package/resources/shift-inputs.d.mts +1 -0
- package/resources/shift-inputs.d.mts.map +1 -1
- package/resources/shift-inputs.d.ts +1 -0
- package/resources/shift-inputs.d.ts.map +1 -1
- package/resources/shiftassignments.d.mts +836 -143
- package/resources/shiftassignments.d.mts.map +1 -1
- package/resources/shiftassignments.d.ts +836 -143
- package/resources/shiftassignments.d.ts.map +1 -1
- package/resources/shiftassignments.js +12 -0
- package/resources/shiftassignments.js.map +1 -1
- package/resources/shiftassignments.mjs +12 -0
- package/resources/shiftassignments.mjs.map +1 -1
- package/resources/sso-me.d.mts +1 -0
- package/resources/sso-me.d.mts.map +1 -1
- package/resources/sso-me.d.ts +1 -0
- package/resources/sso-me.d.ts.map +1 -1
- package/resources/supergroups/exclusion-members.d.mts +2 -0
- package/resources/supergroups/exclusion-members.d.mts.map +1 -1
- package/resources/supergroups/exclusion-members.d.ts +2 -0
- package/resources/supergroups/exclusion-members.d.ts.map +1 -1
- package/resources/supergroups/exclusion-members.js +1 -0
- package/resources/supergroups/exclusion-members.js.map +1 -1
- package/resources/supergroups/exclusion-members.mjs +1 -0
- package/resources/supergroups/exclusion-members.mjs.map +1 -1
- package/resources/supergroups/inclusion-members.d.mts +2 -0
- package/resources/supergroups/inclusion-members.d.mts.map +1 -1
- package/resources/supergroups/inclusion-members.d.ts +2 -0
- package/resources/supergroups/inclusion-members.d.ts.map +1 -1
- package/resources/supergroups/inclusion-members.js +1 -0
- package/resources/supergroups/inclusion-members.js.map +1 -1
- package/resources/supergroups/inclusion-members.mjs +1 -0
- package/resources/supergroups/inclusion-members.mjs.map +1 -1
- package/resources/supergroups/members.d.mts +13 -0
- package/resources/supergroups/members.d.mts.map +1 -1
- package/resources/supergroups/members.d.ts +13 -0
- package/resources/supergroups/members.d.ts.map +1 -1
- package/resources/supergroups/members.js +1 -0
- package/resources/supergroups/members.js.map +1 -1
- package/resources/supergroups/members.mjs +1 -0
- package/resources/supergroups/members.mjs.map +1 -1
- package/resources/teams.d.mts +1 -0
- package/resources/teams.d.mts.map +1 -1
- package/resources/teams.d.ts +1 -0
- package/resources/teams.d.ts.map +1 -1
- package/resources/time-cards.d.mts +1 -0
- package/resources/time-cards.d.mts.map +1 -1
- package/resources/time-cards.d.ts +1 -0
- package/resources/time-cards.d.ts.map +1 -1
- package/resources/time-entries.d.mts +1 -0
- package/resources/time-entries.d.mts.map +1 -1
- package/resources/time-entries.d.ts +1 -0
- package/resources/time-entries.d.ts.map +1 -1
- package/resources/tracks.d.mts +1 -0
- package/resources/tracks.d.mts.map +1 -1
- package/resources/tracks.d.ts +1 -0
- package/resources/tracks.d.ts.map +1 -1
- package/resources/unassignedshifts.d.mts +866 -0
- package/resources/unassignedshifts.d.mts.map +1 -0
- package/resources/unassignedshifts.d.ts +866 -0
- package/resources/unassignedshifts.d.ts.map +1 -0
- package/resources/unassignedshifts.js +38 -0
- package/resources/unassignedshifts.js.map +1 -0
- package/resources/unassignedshifts.mjs +34 -0
- package/resources/unassignedshifts.mjs.map +1 -0
- package/resources/users.d.mts +1 -0
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +1 -0
- package/resources/users.d.ts.map +1 -1
- package/resources/work-locations.d.mts +1 -0
- package/resources/work-locations.d.mts.map +1 -1
- package/resources/work-locations.d.ts +1 -0
- package/resources/work-locations.d.ts.map +1 -1
- package/resources/workers.d.mts +1 -0
- package/resources/workers.d.mts.map +1 -1
- package/resources/workers.d.ts +1 -0
- package/resources/workers.d.ts.map +1 -1
- package/src/client.ts +36 -0
- package/src/functions.ts +6 -0
- package/src/resources/business-partner-groups.ts +2 -0
- package/src/resources/business-partners.ts +2 -0
- package/src/resources/candidate-applications.ts +2 -0
- package/src/resources/candidates.ts +2 -0
- package/src/resources/companies.ts +2 -0
- package/src/resources/compensations.ts +2 -0
- package/src/resources/custom-fields.ts +2 -0
- package/src/resources/departments.ts +2 -0
- package/src/resources/employment-types.ts +2 -0
- package/src/resources/headcount-positions.ts +2 -0
- package/src/resources/headcount-priorities.ts +2 -0
- package/src/resources/index.ts +16 -0
- package/src/resources/job-assignments.ts +4 -0
- package/src/resources/job-codes.ts +4 -0
- package/src/resources/job-dimensions.ts +2 -0
- package/src/resources/job-functions.ts +2 -0
- package/src/resources/job-pay-rate-exceptions.ts +4 -0
- package/src/resources/job-requisitions.ts +2 -0
- package/src/resources/kiosk-badges.ts +2 -0
- package/src/resources/leave-balances.ts +2 -0
- package/src/resources/leave-requests.ts +2 -0
- package/src/resources/leave-types.ts +2 -0
- package/src/resources/legal-entities.ts +2 -0
- package/src/resources/levels.ts +2 -0
- package/src/resources/location-factors.ts +2 -0
- package/src/resources/schedules.ts +138 -0
- package/src/resources/shift-inputs.ts +2 -0
- package/src/resources/shiftassignments.ts +1010 -167
- package/src/resources/sso-me.ts +2 -0
- package/src/resources/supergroups/exclusion-members.ts +3 -0
- package/src/resources/supergroups/inclusion-members.ts +3 -0
- package/src/resources/supergroups/members.ts +16 -0
- package/src/resources/teams.ts +2 -0
- package/src/resources/time-cards.ts +2 -0
- package/src/resources/time-entries.ts +2 -0
- package/src/resources/tracks.ts +2 -0
- package/src/resources/unassignedshifts.ts +1067 -0
- package/src/resources/users.ts +2 -0
- package/src/resources/work-locations.ts +2 -0
- package/src/resources/workers.ts +2 -0
- 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
|
@@ -15,10 +15,18 @@ export declare class Shiftassignments extends APIResource {
|
|
|
15
15
|
* - Sortable fields: `id`, `created_at`, `updated_at`
|
|
16
16
|
*/
|
|
17
17
|
list(query?: ShiftassignmentListParams | null | undefined, options?: RequestOptions): PagePromise<ShiftassignmentListResponsesPageCursorURL, ShiftassignmentListResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Create a new shift assignment
|
|
20
|
+
*/
|
|
21
|
+
create(body: ShiftassignmentCreateParams, options?: RequestOptions): APIPromise<ShiftassignmentCreateResponse>;
|
|
18
22
|
/**
|
|
19
23
|
* Retrieve a specific shift assignment
|
|
20
24
|
*/
|
|
21
25
|
retrieve(id: string, query?: ShiftassignmentRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<ShiftassignmentRetrieveResponse>;
|
|
26
|
+
/**
|
|
27
|
+
* Updated a specific shift assignment
|
|
28
|
+
*/
|
|
29
|
+
update(id: string, body: ShiftassignmentUpdateParams, options?: RequestOptions): APIPromise<ShiftassignmentUpdateResponse>;
|
|
22
30
|
}
|
|
23
31
|
export type ShiftassignmentListResponsesPageCursorURL = PageCursorURL<ShiftassignmentListResponse>;
|
|
24
32
|
export interface ShiftassignmentListResponse {
|
|
@@ -26,10 +34,6 @@ export interface ShiftassignmentListResponse {
|
|
|
26
34
|
* Identifier field
|
|
27
35
|
*/
|
|
28
36
|
id: string;
|
|
29
|
-
/**
|
|
30
|
-
* Whether the shift assignment can be edited
|
|
31
|
-
*/
|
|
32
|
-
can_edit: boolean;
|
|
33
37
|
/**
|
|
34
38
|
* Record creation date
|
|
35
39
|
*/
|
|
@@ -39,10 +43,27 @@ export interface ShiftassignmentListResponse {
|
|
|
39
43
|
* be the same as the shift_data
|
|
40
44
|
*/
|
|
41
45
|
is_published: boolean;
|
|
46
|
+
/**
|
|
47
|
+
* The ID of the schedule
|
|
48
|
+
*/
|
|
49
|
+
schedule_id: string;
|
|
50
|
+
/**
|
|
51
|
+
* The data of the shift
|
|
52
|
+
*/
|
|
53
|
+
shift_data: ShiftassignmentListResponse.ShiftData;
|
|
42
54
|
/**
|
|
43
55
|
* Record update date
|
|
44
56
|
*/
|
|
45
57
|
updated_at: string;
|
|
58
|
+
/**
|
|
59
|
+
* The ID of the worker. Empty string '' to unassign if shift is from an open/empty
|
|
60
|
+
* shift.
|
|
61
|
+
*/
|
|
62
|
+
worker_id: string;
|
|
63
|
+
/**
|
|
64
|
+
* Whether the shift assignment can be edited
|
|
65
|
+
*/
|
|
66
|
+
can_edit?: boolean;
|
|
46
67
|
/**
|
|
47
68
|
* The published version of the shift assignment, if it exists. If filled but
|
|
48
69
|
* is_published is false, the shift_data is the latest version.
|
|
@@ -54,54 +75,102 @@ export interface ShiftassignmentListResponse {
|
|
|
54
75
|
* Expandable field
|
|
55
76
|
*/
|
|
56
77
|
schedule?: ShiftassignmentListResponse.Schedule;
|
|
57
|
-
/**
|
|
58
|
-
* The ID of the schedule
|
|
59
|
-
*/
|
|
60
|
-
schedule_id?: string;
|
|
61
|
-
/**
|
|
62
|
-
* The data of the shift
|
|
63
|
-
*/
|
|
64
|
-
shift_data?: ShiftassignmentListResponse.ShiftData;
|
|
65
78
|
/**
|
|
66
79
|
* The worker
|
|
67
80
|
*
|
|
68
81
|
* Expandable field
|
|
69
82
|
*/
|
|
70
83
|
worker?: WorkersAPI.Worker;
|
|
71
|
-
/**
|
|
72
|
-
* The ID of the worker
|
|
73
|
-
*/
|
|
74
|
-
worker_id?: string;
|
|
75
84
|
}
|
|
76
85
|
export declare namespace ShiftassignmentListResponse {
|
|
77
86
|
/**
|
|
78
|
-
* The
|
|
79
|
-
* is_published is false, the shift_data is the latest version.
|
|
87
|
+
* The data of the shift
|
|
80
88
|
*/
|
|
81
|
-
interface
|
|
89
|
+
interface ShiftData {
|
|
82
90
|
/**
|
|
83
91
|
* The end time of the shift
|
|
84
92
|
*/
|
|
85
93
|
end_time: string;
|
|
94
|
+
/**
|
|
95
|
+
* The start time of the shift
|
|
96
|
+
*/
|
|
97
|
+
start_time: string;
|
|
86
98
|
/**
|
|
87
99
|
* The breaks of the shift
|
|
88
100
|
*/
|
|
89
|
-
shift_breaks
|
|
101
|
+
shift_breaks?: Array<ShiftData.ShiftBreak>;
|
|
90
102
|
/**
|
|
91
103
|
* The segments of the shift
|
|
92
104
|
*/
|
|
93
|
-
shift_segments
|
|
105
|
+
shift_segments?: Array<ShiftData.ShiftSegment>;
|
|
106
|
+
}
|
|
107
|
+
namespace ShiftData {
|
|
108
|
+
interface ShiftBreak {
|
|
109
|
+
/**
|
|
110
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
111
|
+
*/
|
|
112
|
+
duration_minutes: number;
|
|
113
|
+
/**
|
|
114
|
+
* The start time of the shift break
|
|
115
|
+
*/
|
|
116
|
+
start_time: string;
|
|
117
|
+
/**
|
|
118
|
+
* The type of the shift break
|
|
119
|
+
*/
|
|
120
|
+
type: 'MEAL' | 'REST';
|
|
121
|
+
/**
|
|
122
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
123
|
+
*/
|
|
124
|
+
end_time?: string;
|
|
125
|
+
}
|
|
126
|
+
interface ShiftSegment {
|
|
127
|
+
/**
|
|
128
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
129
|
+
*/
|
|
130
|
+
duration_minutes: number;
|
|
131
|
+
/**
|
|
132
|
+
* The start time of the shift segment
|
|
133
|
+
*/
|
|
134
|
+
start_time: string;
|
|
135
|
+
/**
|
|
136
|
+
* The end time of the shift segment (calculated from start_time +
|
|
137
|
+
* duration_minutes)
|
|
138
|
+
*/
|
|
139
|
+
end_time?: string;
|
|
140
|
+
/**
|
|
141
|
+
* The IDs of the job codes associated with the shift segment
|
|
142
|
+
*/
|
|
143
|
+
job_codes_id?: Array<string>;
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* The published version of the shift assignment, if it exists. If filled but
|
|
148
|
+
* is_published is false, the shift_data is the latest version.
|
|
149
|
+
*/
|
|
150
|
+
interface PublishedVersion {
|
|
151
|
+
/**
|
|
152
|
+
* The end time of the shift
|
|
153
|
+
*/
|
|
154
|
+
end_time: string;
|
|
94
155
|
/**
|
|
95
156
|
* The start time of the shift
|
|
96
157
|
*/
|
|
97
158
|
start_time: string;
|
|
159
|
+
/**
|
|
160
|
+
* The breaks of the shift
|
|
161
|
+
*/
|
|
162
|
+
shift_breaks?: Array<PublishedVersion.ShiftBreak>;
|
|
163
|
+
/**
|
|
164
|
+
* The segments of the shift
|
|
165
|
+
*/
|
|
166
|
+
shift_segments?: Array<PublishedVersion.ShiftSegment>;
|
|
98
167
|
}
|
|
99
168
|
namespace PublishedVersion {
|
|
100
169
|
interface ShiftBreak {
|
|
101
170
|
/**
|
|
102
|
-
* The
|
|
171
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
103
172
|
*/
|
|
104
|
-
|
|
173
|
+
duration_minutes: number;
|
|
105
174
|
/**
|
|
106
175
|
* The start time of the shift break
|
|
107
176
|
*/
|
|
@@ -109,17 +178,26 @@ export declare namespace ShiftassignmentListResponse {
|
|
|
109
178
|
/**
|
|
110
179
|
* The type of the shift break
|
|
111
180
|
*/
|
|
112
|
-
type:
|
|
181
|
+
type: 'MEAL' | 'REST';
|
|
182
|
+
/**
|
|
183
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
184
|
+
*/
|
|
185
|
+
end_time?: string;
|
|
113
186
|
}
|
|
114
187
|
interface ShiftSegment {
|
|
115
188
|
/**
|
|
116
|
-
* The
|
|
189
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
117
190
|
*/
|
|
118
|
-
|
|
191
|
+
duration_minutes: number;
|
|
119
192
|
/**
|
|
120
193
|
* The start time of the shift segment
|
|
121
194
|
*/
|
|
122
195
|
start_time: string;
|
|
196
|
+
/**
|
|
197
|
+
* The end time of the shift segment (calculated from start_time +
|
|
198
|
+
* duration_minutes)
|
|
199
|
+
*/
|
|
200
|
+
end_time?: string;
|
|
123
201
|
/**
|
|
124
202
|
* The IDs of the job codes associated with the shift segment
|
|
125
203
|
*/
|
|
@@ -200,6 +278,61 @@ export declare namespace ShiftassignmentListResponse {
|
|
|
200
278
|
timezone?: string;
|
|
201
279
|
}
|
|
202
280
|
}
|
|
281
|
+
}
|
|
282
|
+
export interface ShiftassignmentCreateResponse {
|
|
283
|
+
/**
|
|
284
|
+
* Identifier field
|
|
285
|
+
*/
|
|
286
|
+
id: string;
|
|
287
|
+
/**
|
|
288
|
+
* Record creation date
|
|
289
|
+
*/
|
|
290
|
+
created_at: string;
|
|
291
|
+
/**
|
|
292
|
+
* Whether the shift assignment is published. If true, the published_version will
|
|
293
|
+
* be the same as the shift_data
|
|
294
|
+
*/
|
|
295
|
+
is_published: boolean;
|
|
296
|
+
/**
|
|
297
|
+
* The ID of the schedule
|
|
298
|
+
*/
|
|
299
|
+
schedule_id: string;
|
|
300
|
+
/**
|
|
301
|
+
* The data of the shift
|
|
302
|
+
*/
|
|
303
|
+
shift_data: ShiftassignmentCreateResponse.ShiftData;
|
|
304
|
+
/**
|
|
305
|
+
* Record update date
|
|
306
|
+
*/
|
|
307
|
+
updated_at: string;
|
|
308
|
+
/**
|
|
309
|
+
* The ID of the worker. Empty string '' to unassign if shift is from an open/empty
|
|
310
|
+
* shift.
|
|
311
|
+
*/
|
|
312
|
+
worker_id: string;
|
|
313
|
+
/**
|
|
314
|
+
* Whether the shift assignment can be edited
|
|
315
|
+
*/
|
|
316
|
+
can_edit?: boolean;
|
|
317
|
+
/**
|
|
318
|
+
* The published version of the shift assignment, if it exists. If filled but
|
|
319
|
+
* is_published is false, the shift_data is the latest version.
|
|
320
|
+
*/
|
|
321
|
+
published_version?: ShiftassignmentCreateResponse.PublishedVersion;
|
|
322
|
+
/**
|
|
323
|
+
* The schedule
|
|
324
|
+
*
|
|
325
|
+
* Expandable field
|
|
326
|
+
*/
|
|
327
|
+
schedule?: ShiftassignmentCreateResponse.Schedule;
|
|
328
|
+
/**
|
|
329
|
+
* The worker
|
|
330
|
+
*
|
|
331
|
+
* Expandable field
|
|
332
|
+
*/
|
|
333
|
+
worker?: WorkersAPI.Worker;
|
|
334
|
+
}
|
|
335
|
+
export declare namespace ShiftassignmentCreateResponse {
|
|
203
336
|
/**
|
|
204
337
|
* The data of the shift
|
|
205
338
|
*/
|
|
@@ -209,24 +342,24 @@ export declare namespace ShiftassignmentListResponse {
|
|
|
209
342
|
*/
|
|
210
343
|
end_time: string;
|
|
211
344
|
/**
|
|
212
|
-
* The
|
|
345
|
+
* The start time of the shift
|
|
213
346
|
*/
|
|
214
|
-
|
|
347
|
+
start_time: string;
|
|
215
348
|
/**
|
|
216
|
-
* The
|
|
349
|
+
* The breaks of the shift
|
|
217
350
|
*/
|
|
218
|
-
|
|
351
|
+
shift_breaks?: Array<ShiftData.ShiftBreak>;
|
|
219
352
|
/**
|
|
220
|
-
* The
|
|
353
|
+
* The segments of the shift
|
|
221
354
|
*/
|
|
222
|
-
|
|
355
|
+
shift_segments?: Array<ShiftData.ShiftSegment>;
|
|
223
356
|
}
|
|
224
357
|
namespace ShiftData {
|
|
225
358
|
interface ShiftBreak {
|
|
226
359
|
/**
|
|
227
|
-
* The
|
|
360
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
228
361
|
*/
|
|
229
|
-
|
|
362
|
+
duration_minutes: number;
|
|
230
363
|
/**
|
|
231
364
|
* The start time of the shift break
|
|
232
365
|
*/
|
|
@@ -234,80 +367,32 @@ export declare namespace ShiftassignmentListResponse {
|
|
|
234
367
|
/**
|
|
235
368
|
* The type of the shift break
|
|
236
369
|
*/
|
|
237
|
-
type:
|
|
370
|
+
type: 'MEAL' | 'REST';
|
|
371
|
+
/**
|
|
372
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
373
|
+
*/
|
|
374
|
+
end_time?: string;
|
|
238
375
|
}
|
|
239
376
|
interface ShiftSegment {
|
|
240
377
|
/**
|
|
241
|
-
* The
|
|
378
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
242
379
|
*/
|
|
243
|
-
|
|
380
|
+
duration_minutes: number;
|
|
244
381
|
/**
|
|
245
382
|
* The start time of the shift segment
|
|
246
383
|
*/
|
|
247
384
|
start_time: string;
|
|
385
|
+
/**
|
|
386
|
+
* The end time of the shift segment (calculated from start_time +
|
|
387
|
+
* duration_minutes)
|
|
388
|
+
*/
|
|
389
|
+
end_time?: string;
|
|
248
390
|
/**
|
|
249
391
|
* The IDs of the job codes associated with the shift segment
|
|
250
392
|
*/
|
|
251
393
|
job_codes_id?: Array<string>;
|
|
252
394
|
}
|
|
253
395
|
}
|
|
254
|
-
}
|
|
255
|
-
/**
|
|
256
|
-
* Meta information for the response.
|
|
257
|
-
*/
|
|
258
|
-
export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
259
|
-
/**
|
|
260
|
-
* Identifier field
|
|
261
|
-
*/
|
|
262
|
-
id: string;
|
|
263
|
-
/**
|
|
264
|
-
* Whether the shift assignment can be edited
|
|
265
|
-
*/
|
|
266
|
-
can_edit: boolean;
|
|
267
|
-
/**
|
|
268
|
-
* Record creation date
|
|
269
|
-
*/
|
|
270
|
-
created_at: string;
|
|
271
|
-
/**
|
|
272
|
-
* Whether the shift assignment is published. If true, the published_version will
|
|
273
|
-
* be the same as the shift_data
|
|
274
|
-
*/
|
|
275
|
-
is_published: boolean;
|
|
276
|
-
/**
|
|
277
|
-
* Record update date
|
|
278
|
-
*/
|
|
279
|
-
updated_at: string;
|
|
280
|
-
/**
|
|
281
|
-
* The published version of the shift assignment, if it exists. If filled but
|
|
282
|
-
* is_published is false, the shift_data is the latest version.
|
|
283
|
-
*/
|
|
284
|
-
published_version?: ShiftassignmentRetrieveResponse.PublishedVersion;
|
|
285
|
-
/**
|
|
286
|
-
* The schedule
|
|
287
|
-
*
|
|
288
|
-
* Expandable field
|
|
289
|
-
*/
|
|
290
|
-
schedule?: ShiftassignmentRetrieveResponse.Schedule;
|
|
291
|
-
/**
|
|
292
|
-
* The ID of the schedule
|
|
293
|
-
*/
|
|
294
|
-
schedule_id?: string;
|
|
295
|
-
/**
|
|
296
|
-
* The data of the shift
|
|
297
|
-
*/
|
|
298
|
-
shift_data?: ShiftassignmentRetrieveResponse.ShiftData;
|
|
299
|
-
/**
|
|
300
|
-
* The worker
|
|
301
|
-
*
|
|
302
|
-
* Expandable field
|
|
303
|
-
*/
|
|
304
|
-
worker?: WorkersAPI.Worker;
|
|
305
|
-
/**
|
|
306
|
-
* The ID of the worker
|
|
307
|
-
*/
|
|
308
|
-
worker_id?: string;
|
|
309
|
-
}
|
|
310
|
-
export declare namespace ShiftassignmentRetrieveResponse {
|
|
311
396
|
/**
|
|
312
397
|
* The published version of the shift assignment, if it exists. If filled but
|
|
313
398
|
* is_published is false, the shift_data is the latest version.
|
|
@@ -318,24 +403,24 @@ export declare namespace ShiftassignmentRetrieveResponse {
|
|
|
318
403
|
*/
|
|
319
404
|
end_time: string;
|
|
320
405
|
/**
|
|
321
|
-
* The
|
|
406
|
+
* The start time of the shift
|
|
322
407
|
*/
|
|
323
|
-
|
|
408
|
+
start_time: string;
|
|
324
409
|
/**
|
|
325
|
-
* The
|
|
410
|
+
* The breaks of the shift
|
|
326
411
|
*/
|
|
327
|
-
|
|
412
|
+
shift_breaks?: Array<PublishedVersion.ShiftBreak>;
|
|
328
413
|
/**
|
|
329
|
-
* The
|
|
414
|
+
* The segments of the shift
|
|
330
415
|
*/
|
|
331
|
-
|
|
416
|
+
shift_segments?: Array<PublishedVersion.ShiftSegment>;
|
|
332
417
|
}
|
|
333
418
|
namespace PublishedVersion {
|
|
334
419
|
interface ShiftBreak {
|
|
335
420
|
/**
|
|
336
|
-
* The
|
|
421
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
337
422
|
*/
|
|
338
|
-
|
|
423
|
+
duration_minutes: number;
|
|
339
424
|
/**
|
|
340
425
|
* The start time of the shift break
|
|
341
426
|
*/
|
|
@@ -343,17 +428,26 @@ export declare namespace ShiftassignmentRetrieveResponse {
|
|
|
343
428
|
/**
|
|
344
429
|
* The type of the shift break
|
|
345
430
|
*/
|
|
346
|
-
type:
|
|
431
|
+
type: 'MEAL' | 'REST';
|
|
432
|
+
/**
|
|
433
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
434
|
+
*/
|
|
435
|
+
end_time?: string;
|
|
347
436
|
}
|
|
348
437
|
interface ShiftSegment {
|
|
349
438
|
/**
|
|
350
|
-
* The
|
|
439
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
351
440
|
*/
|
|
352
|
-
|
|
441
|
+
duration_minutes: number;
|
|
353
442
|
/**
|
|
354
443
|
* The start time of the shift segment
|
|
355
444
|
*/
|
|
356
445
|
start_time: string;
|
|
446
|
+
/**
|
|
447
|
+
* The end time of the shift segment (calculated from start_time +
|
|
448
|
+
* duration_minutes)
|
|
449
|
+
*/
|
|
450
|
+
end_time?: string;
|
|
357
451
|
/**
|
|
358
452
|
* The IDs of the job codes associated with the shift segment
|
|
359
453
|
*/
|
|
@@ -434,67 +528,666 @@ export declare namespace ShiftassignmentRetrieveResponse {
|
|
|
434
528
|
timezone?: string;
|
|
435
529
|
}
|
|
436
530
|
}
|
|
531
|
+
}
|
|
532
|
+
/**
|
|
533
|
+
* Meta information for the response.
|
|
534
|
+
*/
|
|
535
|
+
export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
|
|
536
|
+
/**
|
|
537
|
+
* Identifier field
|
|
538
|
+
*/
|
|
539
|
+
id: string;
|
|
540
|
+
/**
|
|
541
|
+
* Record creation date
|
|
542
|
+
*/
|
|
543
|
+
created_at: string;
|
|
544
|
+
/**
|
|
545
|
+
* Whether the shift assignment is published. If true, the published_version will
|
|
546
|
+
* be the same as the shift_data
|
|
547
|
+
*/
|
|
548
|
+
is_published: boolean;
|
|
549
|
+
/**
|
|
550
|
+
* The ID of the schedule
|
|
551
|
+
*/
|
|
552
|
+
schedule_id: string;
|
|
437
553
|
/**
|
|
438
554
|
* The data of the shift
|
|
439
555
|
*/
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
556
|
+
shift_data: ShiftassignmentRetrieveResponse.ShiftData;
|
|
557
|
+
/**
|
|
558
|
+
* Record update date
|
|
559
|
+
*/
|
|
560
|
+
updated_at: string;
|
|
561
|
+
/**
|
|
562
|
+
* The ID of the worker. Empty string '' to unassign if shift is from an open/empty
|
|
563
|
+
* shift.
|
|
564
|
+
*/
|
|
565
|
+
worker_id: string;
|
|
566
|
+
/**
|
|
567
|
+
* Whether the shift assignment can be edited
|
|
568
|
+
*/
|
|
569
|
+
can_edit?: boolean;
|
|
570
|
+
/**
|
|
571
|
+
* The published version of the shift assignment, if it exists. If filled but
|
|
572
|
+
* is_published is false, the shift_data is the latest version.
|
|
573
|
+
*/
|
|
574
|
+
published_version?: ShiftassignmentRetrieveResponse.PublishedVersion;
|
|
575
|
+
/**
|
|
576
|
+
* The schedule
|
|
577
|
+
*
|
|
578
|
+
* Expandable field
|
|
579
|
+
*/
|
|
580
|
+
schedule?: ShiftassignmentRetrieveResponse.Schedule;
|
|
581
|
+
/**
|
|
582
|
+
* The worker
|
|
583
|
+
*
|
|
584
|
+
* Expandable field
|
|
585
|
+
*/
|
|
586
|
+
worker?: WorkersAPI.Worker;
|
|
587
|
+
}
|
|
588
|
+
export declare namespace ShiftassignmentRetrieveResponse {
|
|
589
|
+
/**
|
|
590
|
+
* The data of the shift
|
|
591
|
+
*/
|
|
592
|
+
interface ShiftData {
|
|
593
|
+
/**
|
|
594
|
+
* The end time of the shift
|
|
595
|
+
*/
|
|
596
|
+
end_time: string;
|
|
597
|
+
/**
|
|
598
|
+
* The start time of the shift
|
|
599
|
+
*/
|
|
600
|
+
start_time: string;
|
|
601
|
+
/**
|
|
602
|
+
* The breaks of the shift
|
|
603
|
+
*/
|
|
604
|
+
shift_breaks?: Array<ShiftData.ShiftBreak>;
|
|
605
|
+
/**
|
|
606
|
+
* The segments of the shift
|
|
607
|
+
*/
|
|
608
|
+
shift_segments?: Array<ShiftData.ShiftSegment>;
|
|
609
|
+
}
|
|
610
|
+
namespace ShiftData {
|
|
611
|
+
interface ShiftBreak {
|
|
612
|
+
/**
|
|
613
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
614
|
+
*/
|
|
615
|
+
duration_minutes: number;
|
|
616
|
+
/**
|
|
617
|
+
* The start time of the shift break
|
|
618
|
+
*/
|
|
619
|
+
start_time: string;
|
|
620
|
+
/**
|
|
621
|
+
* The type of the shift break
|
|
622
|
+
*/
|
|
623
|
+
type: 'MEAL' | 'REST';
|
|
624
|
+
/**
|
|
625
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
626
|
+
*/
|
|
627
|
+
end_time?: string;
|
|
628
|
+
}
|
|
629
|
+
interface ShiftSegment {
|
|
630
|
+
/**
|
|
631
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
632
|
+
*/
|
|
633
|
+
duration_minutes: number;
|
|
634
|
+
/**
|
|
635
|
+
* The start time of the shift segment
|
|
636
|
+
*/
|
|
637
|
+
start_time: string;
|
|
638
|
+
/**
|
|
639
|
+
* The end time of the shift segment (calculated from start_time +
|
|
640
|
+
* duration_minutes)
|
|
641
|
+
*/
|
|
642
|
+
end_time?: string;
|
|
643
|
+
/**
|
|
644
|
+
* The IDs of the job codes associated with the shift segment
|
|
645
|
+
*/
|
|
646
|
+
job_codes_id?: Array<string>;
|
|
647
|
+
}
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* The published version of the shift assignment, if it exists. If filled but
|
|
651
|
+
* is_published is false, the shift_data is the latest version.
|
|
652
|
+
*/
|
|
653
|
+
interface PublishedVersion {
|
|
654
|
+
/**
|
|
655
|
+
* The end time of the shift
|
|
656
|
+
*/
|
|
657
|
+
end_time: string;
|
|
658
|
+
/**
|
|
659
|
+
* The start time of the shift
|
|
660
|
+
*/
|
|
661
|
+
start_time: string;
|
|
662
|
+
/**
|
|
663
|
+
* The breaks of the shift
|
|
664
|
+
*/
|
|
665
|
+
shift_breaks?: Array<PublishedVersion.ShiftBreak>;
|
|
666
|
+
/**
|
|
667
|
+
* The segments of the shift
|
|
668
|
+
*/
|
|
669
|
+
shift_segments?: Array<PublishedVersion.ShiftSegment>;
|
|
670
|
+
}
|
|
671
|
+
namespace PublishedVersion {
|
|
672
|
+
interface ShiftBreak {
|
|
673
|
+
/**
|
|
674
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
675
|
+
*/
|
|
676
|
+
duration_minutes: number;
|
|
677
|
+
/**
|
|
678
|
+
* The start time of the shift break
|
|
679
|
+
*/
|
|
680
|
+
start_time: string;
|
|
681
|
+
/**
|
|
682
|
+
* The type of the shift break
|
|
683
|
+
*/
|
|
684
|
+
type: 'MEAL' | 'REST';
|
|
685
|
+
/**
|
|
686
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
687
|
+
*/
|
|
688
|
+
end_time?: string;
|
|
689
|
+
}
|
|
690
|
+
interface ShiftSegment {
|
|
691
|
+
/**
|
|
692
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
693
|
+
*/
|
|
694
|
+
duration_minutes: number;
|
|
695
|
+
/**
|
|
696
|
+
* The start time of the shift segment
|
|
697
|
+
*/
|
|
698
|
+
start_time: string;
|
|
699
|
+
/**
|
|
700
|
+
* The end time of the shift segment (calculated from start_time +
|
|
701
|
+
* duration_minutes)
|
|
702
|
+
*/
|
|
703
|
+
end_time?: string;
|
|
704
|
+
/**
|
|
705
|
+
* The IDs of the job codes associated with the shift segment
|
|
706
|
+
*/
|
|
707
|
+
job_codes_id?: Array<string>;
|
|
708
|
+
}
|
|
709
|
+
}
|
|
710
|
+
/**
|
|
711
|
+
* The schedule
|
|
712
|
+
*
|
|
713
|
+
* Expandable field
|
|
714
|
+
*/
|
|
715
|
+
interface Schedule {
|
|
716
|
+
/**
|
|
717
|
+
* Identifier field
|
|
718
|
+
*/
|
|
719
|
+
id: string;
|
|
720
|
+
/**
|
|
721
|
+
* Record creation date
|
|
722
|
+
*/
|
|
723
|
+
created_at: string;
|
|
724
|
+
/**
|
|
725
|
+
* Record update date
|
|
726
|
+
*/
|
|
727
|
+
updated_at: string;
|
|
728
|
+
/**
|
|
729
|
+
* Whether the requesting role can edit the schedule.
|
|
730
|
+
*/
|
|
731
|
+
can_edit?: boolean;
|
|
732
|
+
/**
|
|
733
|
+
* The managers of the schedule.
|
|
734
|
+
*
|
|
735
|
+
* Expandable field
|
|
736
|
+
*/
|
|
737
|
+
managers?: Array<WorkersAPI.Worker>;
|
|
738
|
+
/**
|
|
739
|
+
* The IDs of the managers of the schedule.
|
|
740
|
+
*/
|
|
741
|
+
managers_id?: Array<string>;
|
|
742
|
+
/**
|
|
743
|
+
* The members of the schedule.
|
|
744
|
+
*
|
|
745
|
+
* Expandable field
|
|
746
|
+
*/
|
|
747
|
+
members?: Array<WorkersAPI.Worker>;
|
|
748
|
+
/**
|
|
749
|
+
* The IDs of the members of the schedule.
|
|
750
|
+
*/
|
|
751
|
+
members_id?: Array<string>;
|
|
752
|
+
/**
|
|
753
|
+
* The name of the schedule.
|
|
754
|
+
*/
|
|
755
|
+
name?: string;
|
|
756
|
+
/**
|
|
757
|
+
* The observers of the schedule.
|
|
758
|
+
*
|
|
759
|
+
* Expandable field
|
|
760
|
+
*/
|
|
761
|
+
observers?: Array<WorkersAPI.Worker>;
|
|
762
|
+
/**
|
|
763
|
+
* The IDs of the observers of the schedule.
|
|
764
|
+
*/
|
|
765
|
+
observers_id?: Array<string>;
|
|
766
|
+
/**
|
|
767
|
+
* The settings of the schedule.
|
|
768
|
+
*/
|
|
769
|
+
settings?: Schedule.Settings;
|
|
770
|
+
}
|
|
771
|
+
namespace Schedule {
|
|
772
|
+
/**
|
|
773
|
+
* The settings of the schedule.
|
|
774
|
+
*/
|
|
775
|
+
interface Settings {
|
|
776
|
+
/**
|
|
777
|
+
* The IANA timezone identifier for the schedule (e.g., 'America/New_York').
|
|
778
|
+
* Accepted values are defined by the tz database, listed here:
|
|
779
|
+
* https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
|
780
|
+
*/
|
|
781
|
+
timezone?: string;
|
|
782
|
+
}
|
|
783
|
+
}
|
|
784
|
+
}
|
|
785
|
+
export interface ShiftassignmentUpdateResponse {
|
|
786
|
+
/**
|
|
787
|
+
* Identifier field
|
|
788
|
+
*/
|
|
789
|
+
id: string;
|
|
790
|
+
/**
|
|
791
|
+
* Record creation date
|
|
792
|
+
*/
|
|
793
|
+
created_at: string;
|
|
794
|
+
/**
|
|
795
|
+
* Whether the shift assignment is published. If true, the published_version will
|
|
796
|
+
* be the same as the shift_data
|
|
797
|
+
*/
|
|
798
|
+
is_published: boolean;
|
|
799
|
+
/**
|
|
800
|
+
* The ID of the schedule
|
|
801
|
+
*/
|
|
802
|
+
schedule_id: string;
|
|
803
|
+
/**
|
|
804
|
+
* The data of the shift
|
|
805
|
+
*/
|
|
806
|
+
shift_data: ShiftassignmentUpdateResponse.ShiftData;
|
|
807
|
+
/**
|
|
808
|
+
* Record update date
|
|
809
|
+
*/
|
|
810
|
+
updated_at: string;
|
|
811
|
+
/**
|
|
812
|
+
* The ID of the worker. Empty string '' to unassign if shift is from an open/empty
|
|
813
|
+
* shift.
|
|
814
|
+
*/
|
|
815
|
+
worker_id: string;
|
|
816
|
+
/**
|
|
817
|
+
* Whether the shift assignment can be edited
|
|
818
|
+
*/
|
|
819
|
+
can_edit?: boolean;
|
|
820
|
+
/**
|
|
821
|
+
* The published version of the shift assignment, if it exists. If filled but
|
|
822
|
+
* is_published is false, the shift_data is the latest version.
|
|
823
|
+
*/
|
|
824
|
+
published_version?: ShiftassignmentUpdateResponse.PublishedVersion;
|
|
825
|
+
/**
|
|
826
|
+
* The schedule
|
|
827
|
+
*
|
|
828
|
+
* Expandable field
|
|
829
|
+
*/
|
|
830
|
+
schedule?: ShiftassignmentUpdateResponse.Schedule;
|
|
831
|
+
/**
|
|
832
|
+
* The worker
|
|
833
|
+
*
|
|
834
|
+
* Expandable field
|
|
835
|
+
*/
|
|
836
|
+
worker?: WorkersAPI.Worker;
|
|
837
|
+
}
|
|
838
|
+
export declare namespace ShiftassignmentUpdateResponse {
|
|
839
|
+
/**
|
|
840
|
+
* The data of the shift
|
|
841
|
+
*/
|
|
842
|
+
interface ShiftData {
|
|
843
|
+
/**
|
|
844
|
+
* The end time of the shift
|
|
845
|
+
*/
|
|
846
|
+
end_time: string;
|
|
847
|
+
/**
|
|
848
|
+
* The start time of the shift
|
|
849
|
+
*/
|
|
850
|
+
start_time: string;
|
|
851
|
+
/**
|
|
852
|
+
* The breaks of the shift
|
|
853
|
+
*/
|
|
854
|
+
shift_breaks?: Array<ShiftData.ShiftBreak>;
|
|
855
|
+
/**
|
|
856
|
+
* The segments of the shift
|
|
857
|
+
*/
|
|
858
|
+
shift_segments?: Array<ShiftData.ShiftSegment>;
|
|
859
|
+
}
|
|
860
|
+
namespace ShiftData {
|
|
861
|
+
interface ShiftBreak {
|
|
862
|
+
/**
|
|
863
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
476
864
|
*/
|
|
477
|
-
|
|
865
|
+
duration_minutes: number;
|
|
866
|
+
/**
|
|
867
|
+
* The start time of the shift break
|
|
868
|
+
*/
|
|
869
|
+
start_time: string;
|
|
870
|
+
/**
|
|
871
|
+
* The type of the shift break
|
|
872
|
+
*/
|
|
873
|
+
type: 'MEAL' | 'REST';
|
|
874
|
+
/**
|
|
875
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
876
|
+
*/
|
|
877
|
+
end_time?: string;
|
|
878
|
+
}
|
|
879
|
+
interface ShiftSegment {
|
|
880
|
+
/**
|
|
881
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
882
|
+
*/
|
|
883
|
+
duration_minutes: number;
|
|
884
|
+
/**
|
|
885
|
+
* The start time of the shift segment
|
|
886
|
+
*/
|
|
887
|
+
start_time: string;
|
|
888
|
+
/**
|
|
889
|
+
* The end time of the shift segment (calculated from start_time +
|
|
890
|
+
* duration_minutes)
|
|
891
|
+
*/
|
|
892
|
+
end_time?: string;
|
|
893
|
+
/**
|
|
894
|
+
* The IDs of the job codes associated with the shift segment
|
|
895
|
+
*/
|
|
896
|
+
job_codes_id?: Array<string>;
|
|
897
|
+
}
|
|
898
|
+
}
|
|
899
|
+
/**
|
|
900
|
+
* The published version of the shift assignment, if it exists. If filled but
|
|
901
|
+
* is_published is false, the shift_data is the latest version.
|
|
902
|
+
*/
|
|
903
|
+
interface PublishedVersion {
|
|
904
|
+
/**
|
|
905
|
+
* The end time of the shift
|
|
906
|
+
*/
|
|
907
|
+
end_time: string;
|
|
908
|
+
/**
|
|
909
|
+
* The start time of the shift
|
|
910
|
+
*/
|
|
911
|
+
start_time: string;
|
|
912
|
+
/**
|
|
913
|
+
* The breaks of the shift
|
|
914
|
+
*/
|
|
915
|
+
shift_breaks?: Array<PublishedVersion.ShiftBreak>;
|
|
916
|
+
/**
|
|
917
|
+
* The segments of the shift
|
|
918
|
+
*/
|
|
919
|
+
shift_segments?: Array<PublishedVersion.ShiftSegment>;
|
|
920
|
+
}
|
|
921
|
+
namespace PublishedVersion {
|
|
922
|
+
interface ShiftBreak {
|
|
923
|
+
/**
|
|
924
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
925
|
+
*/
|
|
926
|
+
duration_minutes: number;
|
|
927
|
+
/**
|
|
928
|
+
* The start time of the shift break
|
|
929
|
+
*/
|
|
930
|
+
start_time: string;
|
|
931
|
+
/**
|
|
932
|
+
* The type of the shift break
|
|
933
|
+
*/
|
|
934
|
+
type: 'MEAL' | 'REST';
|
|
935
|
+
/**
|
|
936
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
937
|
+
*/
|
|
938
|
+
end_time?: string;
|
|
939
|
+
}
|
|
940
|
+
interface ShiftSegment {
|
|
941
|
+
/**
|
|
942
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
943
|
+
*/
|
|
944
|
+
duration_minutes: number;
|
|
478
945
|
/**
|
|
479
946
|
* The start time of the shift segment
|
|
480
947
|
*/
|
|
481
948
|
start_time: string;
|
|
949
|
+
/**
|
|
950
|
+
* The end time of the shift segment (calculated from start_time +
|
|
951
|
+
* duration_minutes)
|
|
952
|
+
*/
|
|
953
|
+
end_time?: string;
|
|
482
954
|
/**
|
|
483
955
|
* The IDs of the job codes associated with the shift segment
|
|
484
956
|
*/
|
|
485
957
|
job_codes_id?: Array<string>;
|
|
486
958
|
}
|
|
487
959
|
}
|
|
960
|
+
/**
|
|
961
|
+
* The schedule
|
|
962
|
+
*
|
|
963
|
+
* Expandable field
|
|
964
|
+
*/
|
|
965
|
+
interface Schedule {
|
|
966
|
+
/**
|
|
967
|
+
* Identifier field
|
|
968
|
+
*/
|
|
969
|
+
id: string;
|
|
970
|
+
/**
|
|
971
|
+
* Record creation date
|
|
972
|
+
*/
|
|
973
|
+
created_at: string;
|
|
974
|
+
/**
|
|
975
|
+
* Record update date
|
|
976
|
+
*/
|
|
977
|
+
updated_at: string;
|
|
978
|
+
/**
|
|
979
|
+
* Whether the requesting role can edit the schedule.
|
|
980
|
+
*/
|
|
981
|
+
can_edit?: boolean;
|
|
982
|
+
/**
|
|
983
|
+
* The managers of the schedule.
|
|
984
|
+
*
|
|
985
|
+
* Expandable field
|
|
986
|
+
*/
|
|
987
|
+
managers?: Array<WorkersAPI.Worker>;
|
|
988
|
+
/**
|
|
989
|
+
* The IDs of the managers of the schedule.
|
|
990
|
+
*/
|
|
991
|
+
managers_id?: Array<string>;
|
|
992
|
+
/**
|
|
993
|
+
* The members of the schedule.
|
|
994
|
+
*
|
|
995
|
+
* Expandable field
|
|
996
|
+
*/
|
|
997
|
+
members?: Array<WorkersAPI.Worker>;
|
|
998
|
+
/**
|
|
999
|
+
* The IDs of the members of the schedule.
|
|
1000
|
+
*/
|
|
1001
|
+
members_id?: Array<string>;
|
|
1002
|
+
/**
|
|
1003
|
+
* The name of the schedule.
|
|
1004
|
+
*/
|
|
1005
|
+
name?: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* The observers of the schedule.
|
|
1008
|
+
*
|
|
1009
|
+
* Expandable field
|
|
1010
|
+
*/
|
|
1011
|
+
observers?: Array<WorkersAPI.Worker>;
|
|
1012
|
+
/**
|
|
1013
|
+
* The IDs of the observers of the schedule.
|
|
1014
|
+
*/
|
|
1015
|
+
observers_id?: Array<string>;
|
|
1016
|
+
/**
|
|
1017
|
+
* The settings of the schedule.
|
|
1018
|
+
*/
|
|
1019
|
+
settings?: Schedule.Settings;
|
|
1020
|
+
}
|
|
1021
|
+
namespace Schedule {
|
|
1022
|
+
/**
|
|
1023
|
+
* The settings of the schedule.
|
|
1024
|
+
*/
|
|
1025
|
+
interface Settings {
|
|
1026
|
+
/**
|
|
1027
|
+
* The IANA timezone identifier for the schedule (e.g., 'America/New_York').
|
|
1028
|
+
* Accepted values are defined by the tz database, listed here:
|
|
1029
|
+
* https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
|
1030
|
+
*/
|
|
1031
|
+
timezone?: string;
|
|
1032
|
+
}
|
|
1033
|
+
}
|
|
488
1034
|
}
|
|
489
1035
|
export interface ShiftassignmentListParams {
|
|
1036
|
+
cursor?: string;
|
|
490
1037
|
expand?: string;
|
|
491
1038
|
filter?: string;
|
|
492
1039
|
order_by?: string;
|
|
493
1040
|
}
|
|
1041
|
+
export interface ShiftassignmentCreateParams {
|
|
1042
|
+
/**
|
|
1043
|
+
* Whether the shift assignment is published. If true, the published_version will
|
|
1044
|
+
* be the same as the shift_data
|
|
1045
|
+
*/
|
|
1046
|
+
is_published: boolean;
|
|
1047
|
+
/**
|
|
1048
|
+
* The ID of the schedule
|
|
1049
|
+
*/
|
|
1050
|
+
schedule_id: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* The data of the shift
|
|
1053
|
+
*/
|
|
1054
|
+
shift_data: ShiftassignmentCreateParams.ShiftData;
|
|
1055
|
+
/**
|
|
1056
|
+
* The ID of the worker. Empty string '' to unassign if shift is from an open/empty
|
|
1057
|
+
* shift.
|
|
1058
|
+
*/
|
|
1059
|
+
worker_id: string;
|
|
1060
|
+
}
|
|
1061
|
+
export declare namespace ShiftassignmentCreateParams {
|
|
1062
|
+
/**
|
|
1063
|
+
* The data of the shift
|
|
1064
|
+
*/
|
|
1065
|
+
interface ShiftData {
|
|
1066
|
+
/**
|
|
1067
|
+
* The end time of the shift
|
|
1068
|
+
*/
|
|
1069
|
+
end_time: string;
|
|
1070
|
+
/**
|
|
1071
|
+
* The start time of the shift
|
|
1072
|
+
*/
|
|
1073
|
+
start_time: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* The breaks of the shift
|
|
1076
|
+
*/
|
|
1077
|
+
shift_breaks?: Array<ShiftData.ShiftBreak>;
|
|
1078
|
+
/**
|
|
1079
|
+
* The segments of the shift
|
|
1080
|
+
*/
|
|
1081
|
+
shift_segments?: Array<ShiftData.ShiftSegment>;
|
|
1082
|
+
}
|
|
1083
|
+
namespace ShiftData {
|
|
1084
|
+
interface ShiftBreak {
|
|
1085
|
+
/**
|
|
1086
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
1087
|
+
*/
|
|
1088
|
+
duration_minutes: number;
|
|
1089
|
+
/**
|
|
1090
|
+
* The start time of the shift break
|
|
1091
|
+
*/
|
|
1092
|
+
start_time: string;
|
|
1093
|
+
/**
|
|
1094
|
+
* The type of the shift break
|
|
1095
|
+
*/
|
|
1096
|
+
type: 'MEAL' | 'REST';
|
|
1097
|
+
}
|
|
1098
|
+
interface ShiftSegment {
|
|
1099
|
+
/**
|
|
1100
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
1101
|
+
*/
|
|
1102
|
+
duration_minutes: number;
|
|
1103
|
+
/**
|
|
1104
|
+
* The start time of the shift segment
|
|
1105
|
+
*/
|
|
1106
|
+
start_time: string;
|
|
1107
|
+
/**
|
|
1108
|
+
* The IDs of the job codes associated with the shift segment
|
|
1109
|
+
*/
|
|
1110
|
+
job_codes_id?: Array<string>;
|
|
1111
|
+
}
|
|
1112
|
+
}
|
|
1113
|
+
}
|
|
494
1114
|
export interface ShiftassignmentRetrieveParams {
|
|
495
1115
|
expand?: string;
|
|
496
1116
|
}
|
|
1117
|
+
export interface ShiftassignmentUpdateParams {
|
|
1118
|
+
/**
|
|
1119
|
+
* Whether the shift assignment is published. If true, the published_version will
|
|
1120
|
+
* be the same as the shift_data
|
|
1121
|
+
*/
|
|
1122
|
+
is_published: boolean;
|
|
1123
|
+
/**
|
|
1124
|
+
* The ID of the schedule
|
|
1125
|
+
*/
|
|
1126
|
+
schedule_id: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* The data of the shift
|
|
1129
|
+
*/
|
|
1130
|
+
shift_data: ShiftassignmentUpdateParams.ShiftData;
|
|
1131
|
+
/**
|
|
1132
|
+
* The ID of the worker. Empty string '' to unassign if shift is from an open/empty
|
|
1133
|
+
* shift.
|
|
1134
|
+
*/
|
|
1135
|
+
worker_id: string;
|
|
1136
|
+
}
|
|
1137
|
+
export declare namespace ShiftassignmentUpdateParams {
|
|
1138
|
+
/**
|
|
1139
|
+
* The data of the shift
|
|
1140
|
+
*/
|
|
1141
|
+
interface ShiftData {
|
|
1142
|
+
/**
|
|
1143
|
+
* The end time of the shift
|
|
1144
|
+
*/
|
|
1145
|
+
end_time: string;
|
|
1146
|
+
/**
|
|
1147
|
+
* The start time of the shift
|
|
1148
|
+
*/
|
|
1149
|
+
start_time: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* The breaks of the shift
|
|
1152
|
+
*/
|
|
1153
|
+
shift_breaks?: Array<ShiftData.ShiftBreak>;
|
|
1154
|
+
/**
|
|
1155
|
+
* The segments of the shift
|
|
1156
|
+
*/
|
|
1157
|
+
shift_segments?: Array<ShiftData.ShiftSegment>;
|
|
1158
|
+
}
|
|
1159
|
+
namespace ShiftData {
|
|
1160
|
+
interface ShiftBreak {
|
|
1161
|
+
/**
|
|
1162
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
1163
|
+
*/
|
|
1164
|
+
duration_minutes: number;
|
|
1165
|
+
/**
|
|
1166
|
+
* The start time of the shift break
|
|
1167
|
+
*/
|
|
1168
|
+
start_time: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* The type of the shift break
|
|
1171
|
+
*/
|
|
1172
|
+
type: 'MEAL' | 'REST';
|
|
1173
|
+
}
|
|
1174
|
+
interface ShiftSegment {
|
|
1175
|
+
/**
|
|
1176
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
1177
|
+
*/
|
|
1178
|
+
duration_minutes: number;
|
|
1179
|
+
/**
|
|
1180
|
+
* The start time of the shift segment
|
|
1181
|
+
*/
|
|
1182
|
+
start_time: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* The IDs of the job codes associated with the shift segment
|
|
1185
|
+
*/
|
|
1186
|
+
job_codes_id?: Array<string>;
|
|
1187
|
+
}
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
497
1190
|
export declare namespace Shiftassignments {
|
|
498
|
-
export { type ShiftassignmentListResponse as ShiftassignmentListResponse, type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse, type ShiftassignmentListResponsesPageCursorURL as ShiftassignmentListResponsesPageCursorURL, type ShiftassignmentListParams as ShiftassignmentListParams, type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams, };
|
|
1191
|
+
export { type ShiftassignmentListResponse as ShiftassignmentListResponse, type ShiftassignmentCreateResponse as ShiftassignmentCreateResponse, type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse, type ShiftassignmentUpdateResponse as ShiftassignmentUpdateResponse, type ShiftassignmentListResponsesPageCursorURL as ShiftassignmentListResponsesPageCursorURL, type ShiftassignmentListParams as ShiftassignmentListParams, type ShiftassignmentCreateParams as ShiftassignmentCreateParams, type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams, type ShiftassignmentUpdateParams as ShiftassignmentUpdateParams, };
|
|
499
1192
|
}
|
|
500
1193
|
//# sourceMappingURL=shiftassignments.d.ts.map
|