@rippling/rippling-sdk 0.2.0-alpha.25 → 0.2.0-alpha.26
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/LICENSE +1 -1
- package/client.d.mts +33 -11
- package/client.d.mts.map +1 -1
- package/client.d.ts +33 -11
- package/client.d.ts.map +1 -1
- package/client.js +21 -0
- package/client.js.map +1 -1
- package/client.mjs +21 -0
- package/client.mjs.map +1 -1
- package/functions.d.mts +4 -0
- package/functions.d.mts.map +1 -1
- package/functions.d.ts +4 -0
- package/functions.d.ts.map +1 -1
- package/functions.js +13 -1
- package/functions.js.map +1 -1
- package/functions.mjs +11 -0
- package/functions.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/compensation-bands-details.d.mts +95 -0
- package/resources/compensation-bands-details.d.mts.map +1 -0
- package/resources/compensation-bands-details.d.ts +95 -0
- package/resources/compensation-bands-details.d.ts.map +1 -0
- package/resources/compensation-bands-details.js +29 -0
- package/resources/compensation-bands-details.js.map +1 -0
- package/resources/compensation-bands-details.mjs +25 -0
- package/resources/compensation-bands-details.mjs.map +1 -0
- package/resources/custom-settings.d.mts +270 -0
- package/resources/custom-settings.d.mts.map +1 -0
- package/resources/custom-settings.d.ts +270 -0
- package/resources/custom-settings.d.ts.map +1 -0
- package/resources/custom-settings.js +51 -0
- package/resources/custom-settings.js.map +1 -0
- package/resources/custom-settings.mjs +47 -0
- package/resources/custom-settings.mjs.map +1 -0
- package/resources/departments.d.mts +37 -1
- package/resources/departments.d.mts.map +1 -1
- package/resources/departments.d.ts +37 -1
- package/resources/departments.d.ts.map +1 -1
- package/resources/departments.js +12 -0
- package/resources/departments.js.map +1 -1
- package/resources/departments.mjs +12 -0
- package/resources/departments.mjs.map +1 -1
- package/resources/draft-hires.d.mts +27 -0
- package/resources/draft-hires.d.mts.map +1 -1
- package/resources/draft-hires.d.ts +27 -0
- package/resources/draft-hires.d.ts.map +1 -1
- package/resources/functions/executions.d.mts +6 -82
- package/resources/functions/executions.d.mts.map +1 -1
- package/resources/functions/executions.d.ts +6 -82
- package/resources/functions/executions.d.ts.map +1 -1
- package/resources/functions/executions.js.map +1 -1
- package/resources/functions/executions.mjs.map +1 -1
- package/resources/functions/functions.d.mts +2 -2
- package/resources/functions/functions.d.mts.map +1 -1
- package/resources/functions/functions.d.ts +2 -2
- package/resources/functions/functions.d.ts.map +1 -1
- package/resources/functions/functions.js.map +1 -1
- package/resources/functions/functions.mjs.map +1 -1
- package/resources/functions/index.d.mts +1 -1
- package/resources/functions/index.d.mts.map +1 -1
- package/resources/functions/index.d.ts +1 -1
- package/resources/functions/index.d.ts.map +1 -1
- package/resources/functions/index.js.map +1 -1
- package/resources/functions/index.mjs.map +1 -1
- package/resources/index.d.mts +12 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +12 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +15 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +7 -0
- package/resources/index.mjs.map +1 -1
- package/resources/job-assignments.d.mts +70 -6
- package/resources/job-assignments.d.mts.map +1 -1
- package/resources/job-assignments.d.ts +70 -6
- package/resources/job-assignments.d.ts.map +1 -1
- package/resources/job-assignments.js +22 -0
- package/resources/job-assignments.js.map +1 -1
- package/resources/job-assignments.mjs +22 -0
- package/resources/job-assignments.mjs.map +1 -1
- package/resources/job-codes.d.mts +47 -1
- package/resources/job-codes.d.mts.map +1 -1
- package/resources/job-codes.d.ts +47 -1
- package/resources/job-codes.d.ts.map +1 -1
- package/resources/job-dimensions.d.mts +20 -0
- package/resources/job-dimensions.d.mts.map +1 -1
- package/resources/job-dimensions.d.ts +20 -0
- package/resources/job-dimensions.d.ts.map +1 -1
- package/resources/job-requisitions-write.d.mts +257 -0
- package/resources/job-requisitions-write.d.mts.map +1 -0
- package/resources/job-requisitions-write.d.ts +257 -0
- package/resources/job-requisitions-write.d.ts.map +1 -0
- package/resources/job-requisitions-write.js +15 -0
- package/resources/job-requisitions-write.js.map +1 -0
- package/resources/job-requisitions-write.mjs +11 -0
- package/resources/job-requisitions-write.mjs.map +1 -0
- package/resources/leave-accruals.d.mts +112 -6
- package/resources/leave-accruals.d.mts.map +1 -1
- package/resources/leave-accruals.d.ts +112 -6
- package/resources/leave-accruals.d.ts.map +1 -1
- package/resources/leave-accruals.js +19 -3
- package/resources/leave-accruals.js.map +1 -1
- package/resources/leave-accruals.mjs +19 -3
- package/resources/leave-accruals.mjs.map +1 -1
- package/resources/report-runs.d.mts +149 -0
- package/resources/report-runs.d.mts.map +1 -0
- package/resources/report-runs.d.ts +149 -0
- package/resources/report-runs.d.ts.map +1 -0
- package/resources/report-runs.js +22 -0
- package/resources/report-runs.js.map +1 -0
- package/resources/report-runs.mjs +18 -0
- package/resources/report-runs.mjs.map +1 -0
- package/resources/shared.d.mts +35 -0
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +35 -0
- package/resources/shared.d.ts.map +1 -1
- package/resources/shift-assignments.d.mts +296 -0
- package/resources/shift-assignments.d.mts.map +1 -0
- package/resources/shift-assignments.d.ts +296 -0
- package/resources/shift-assignments.d.ts.map +1 -0
- package/resources/shift-assignments.js +25 -0
- package/resources/shift-assignments.js.map +1 -0
- package/resources/shift-assignments.mjs +21 -0
- package/resources/shift-assignments.mjs.map +1 -0
- package/resources/shiftassignments.d.mts +56 -4
- package/resources/shiftassignments.d.mts.map +1 -1
- package/resources/shiftassignments.d.ts +56 -4
- package/resources/shiftassignments.d.ts.map +1 -1
- package/resources/supergroups/exclusion-members.d.mts +3 -3
- package/resources/supergroups/exclusion-members.d.mts.map +1 -1
- package/resources/supergroups/exclusion-members.d.ts +3 -3
- package/resources/supergroups/exclusion-members.d.ts.map +1 -1
- package/resources/supergroups/exclusion-members.js.map +1 -1
- package/resources/supergroups/exclusion-members.mjs.map +1 -1
- package/resources/supergroups/inclusion-members.d.mts +3 -3
- package/resources/supergroups/inclusion-members.d.mts.map +1 -1
- package/resources/supergroups/inclusion-members.d.ts +3 -3
- package/resources/supergroups/inclusion-members.d.ts.map +1 -1
- package/resources/supergroups/inclusion-members.js.map +1 -1
- package/resources/supergroups/inclusion-members.mjs.map +1 -1
- package/resources/supergroups/index.d.mts +1 -1
- package/resources/supergroups/index.d.mts.map +1 -1
- package/resources/supergroups/index.d.ts +1 -1
- package/resources/supergroups/index.d.ts.map +1 -1
- package/resources/supergroups/index.js.map +1 -1
- package/resources/supergroups/index.mjs.map +1 -1
- package/resources/supergroups/members.d.mts +6 -37
- package/resources/supergroups/members.d.mts.map +1 -1
- package/resources/supergroups/members.d.ts +6 -37
- package/resources/supergroups/members.d.ts.map +1 -1
- package/resources/supergroups/members.js.map +1 -1
- package/resources/supergroups/members.mjs.map +1 -1
- package/resources/supergroups/supergroups.d.mts +2 -2
- package/resources/supergroups/supergroups.d.mts.map +1 -1
- package/resources/supergroups/supergroups.d.ts +2 -2
- package/resources/supergroups/supergroups.d.ts.map +1 -1
- package/resources/supergroups/supergroups.js.map +1 -1
- package/resources/supergroups/supergroups.mjs.map +1 -1
- package/resources/titles.d.mts +126 -0
- package/resources/titles.d.mts.map +1 -0
- package/resources/titles.d.ts +126 -0
- package/resources/titles.d.ts.map +1 -0
- package/resources/titles.js +48 -0
- package/resources/titles.js.map +1 -0
- package/resources/titles.mjs +44 -0
- package/resources/titles.mjs.map +1 -0
- package/resources/unassigned-shifts.d.mts +334 -0
- package/resources/unassigned-shifts.d.mts.map +1 -0
- package/resources/unassigned-shifts.d.ts +334 -0
- package/resources/unassigned-shifts.d.ts.map +1 -0
- package/resources/unassigned-shifts.js +42 -0
- package/resources/unassigned-shifts.js.map +1 -0
- package/resources/unassigned-shifts.mjs +38 -0
- package/resources/unassigned-shifts.mjs.map +1 -0
- package/resources/unassignedshifts.d.mts +382 -1
- package/resources/unassignedshifts.d.mts.map +1 -1
- package/resources/unassignedshifts.d.ts +382 -1
- package/resources/unassignedshifts.d.ts.map +1 -1
- package/resources/unassignedshifts.js +6 -0
- package/resources/unassignedshifts.js.map +1 -1
- package/resources/unassignedshifts.mjs +6 -0
- package/resources/unassignedshifts.mjs.map +1 -1
- package/resources/work-locations.d.mts +95 -1
- package/resources/work-locations.d.mts.map +1 -1
- package/resources/work-locations.d.ts +95 -1
- package/resources/work-locations.d.ts.map +1 -1
- package/resources/work-locations.js +12 -0
- package/resources/work-locations.js.map +1 -1
- package/resources/work-locations.mjs +12 -0
- package/resources/work-locations.mjs.map +1 -1
- package/src/client.ts +153 -3
- package/src/functions.ts +14 -0
- package/src/resources/compensation-bands-details.ts +140 -0
- package/src/resources/custom-settings.ts +371 -0
- package/src/resources/departments.ts +50 -0
- package/src/resources/draft-hires.ts +32 -0
- package/src/resources/functions/executions.ts +8 -104
- package/src/resources/functions/functions.ts +4 -8
- package/src/resources/functions/index.ts +2 -4
- package/src/resources/index.ts +66 -2
- package/src/resources/job-assignments.ts +95 -6
- package/src/resources/job-codes.ts +56 -1
- package/src/resources/job-dimensions.ts +24 -0
- package/src/resources/job-requisitions-write.ts +327 -0
- package/src/resources/leave-accruals.ts +229 -12
- package/src/resources/report-runs.ts +186 -0
- package/src/resources/shared.ts +44 -0
- package/src/resources/shift-assignments.ts +362 -0
- package/src/resources/shiftassignments.ts +70 -5
- package/src/resources/supergroups/exclusion-members.ts +4 -4
- package/src/resources/supergroups/inclusion-members.ts +4 -4
- package/src/resources/supergroups/index.ts +1 -1
- package/src/resources/supergroups/members.ts +7 -49
- package/src/resources/supergroups/supergroups.ts +2 -7
- package/src/resources/titles.ts +181 -0
- package/src/resources/unassigned-shifts.ts +415 -0
- package/src/resources/unassignedshifts.ts +467 -0
- package/src/resources/work-locations.ts +118 -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
|
@@ -48,6 +48,17 @@ export class Unassignedshifts extends APIResource {
|
|
|
48
48
|
): APIPromise<UnassignedshiftRetrieveResponse> {
|
|
49
49
|
return this._client.get(path`/unassignedshifts/${id}`, { query, ...options });
|
|
50
50
|
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Updated a specific unassigned shift
|
|
54
|
+
*/
|
|
55
|
+
update(
|
|
56
|
+
id: string,
|
|
57
|
+
body: UnassignedshiftUpdateParams,
|
|
58
|
+
options?: RequestOptions,
|
|
59
|
+
): APIPromise<UnassignedshiftUpdateResponse> {
|
|
60
|
+
return this._client.patch(path`/unassignedshifts/${id}`, { body, ...options });
|
|
61
|
+
}
|
|
51
62
|
}
|
|
52
63
|
|
|
53
64
|
export type UnassignedshiftListResponsesPageCursorURL = PageCursorURL<UnassignedshiftListResponse>;
|
|
@@ -98,6 +109,11 @@ export interface UnassignedshiftListResponse {
|
|
|
98
109
|
*/
|
|
99
110
|
assigned_shift_ids?: Array<string>;
|
|
100
111
|
|
|
112
|
+
/**
|
|
113
|
+
* Custom fields for the unassigned shift
|
|
114
|
+
*/
|
|
115
|
+
custom_fields?: Array<unknown>;
|
|
116
|
+
|
|
101
117
|
/**
|
|
102
118
|
* Configuration for an open shift. If present, this is an open shift (workers can
|
|
103
119
|
* sign up). If absent/None, this is an empty shift (placeholder).
|
|
@@ -132,6 +148,11 @@ export namespace UnassignedshiftListResponse {
|
|
|
132
148
|
*/
|
|
133
149
|
start_time: string;
|
|
134
150
|
|
|
151
|
+
/**
|
|
152
|
+
* Notes for the shift, max length 256 characters
|
|
153
|
+
*/
|
|
154
|
+
notes?: string;
|
|
155
|
+
|
|
135
156
|
/**
|
|
136
157
|
* The breaks of the shift
|
|
137
158
|
*/
|
|
@@ -204,6 +225,11 @@ export namespace UnassignedshiftListResponse {
|
|
|
204
225
|
*/
|
|
205
226
|
start_time: string;
|
|
206
227
|
|
|
228
|
+
/**
|
|
229
|
+
* Notes for the shift, max length 256 characters
|
|
230
|
+
*/
|
|
231
|
+
notes?: string;
|
|
232
|
+
|
|
207
233
|
/**
|
|
208
234
|
* The breaks of the shift
|
|
209
235
|
*/
|
|
@@ -396,6 +422,11 @@ export interface UnassignedshiftCreateResponse {
|
|
|
396
422
|
*/
|
|
397
423
|
assigned_shift_ids?: Array<string>;
|
|
398
424
|
|
|
425
|
+
/**
|
|
426
|
+
* Custom fields for the unassigned shift
|
|
427
|
+
*/
|
|
428
|
+
custom_fields?: Array<unknown>;
|
|
429
|
+
|
|
399
430
|
/**
|
|
400
431
|
* Configuration for an open shift. If present, this is an open shift (workers can
|
|
401
432
|
* sign up). If absent/None, this is an empty shift (placeholder).
|
|
@@ -430,6 +461,11 @@ export namespace UnassignedshiftCreateResponse {
|
|
|
430
461
|
*/
|
|
431
462
|
start_time: string;
|
|
432
463
|
|
|
464
|
+
/**
|
|
465
|
+
* Notes for the shift, max length 256 characters
|
|
466
|
+
*/
|
|
467
|
+
notes?: string;
|
|
468
|
+
|
|
433
469
|
/**
|
|
434
470
|
* The breaks of the shift
|
|
435
471
|
*/
|
|
@@ -502,6 +538,11 @@ export namespace UnassignedshiftCreateResponse {
|
|
|
502
538
|
*/
|
|
503
539
|
start_time: string;
|
|
504
540
|
|
|
541
|
+
/**
|
|
542
|
+
* Notes for the shift, max length 256 characters
|
|
543
|
+
*/
|
|
544
|
+
notes?: string;
|
|
545
|
+
|
|
505
546
|
/**
|
|
506
547
|
* The breaks of the shift
|
|
507
548
|
*/
|
|
@@ -697,6 +738,11 @@ export interface UnassignedshiftRetrieveResponse extends BusinessPartnersAPI.Met
|
|
|
697
738
|
*/
|
|
698
739
|
assigned_shift_ids?: Array<string>;
|
|
699
740
|
|
|
741
|
+
/**
|
|
742
|
+
* Custom fields for the unassigned shift
|
|
743
|
+
*/
|
|
744
|
+
custom_fields?: Array<unknown>;
|
|
745
|
+
|
|
700
746
|
/**
|
|
701
747
|
* Configuration for an open shift. If present, this is an open shift (workers can
|
|
702
748
|
* sign up). If absent/None, this is an empty shift (placeholder).
|
|
@@ -731,6 +777,324 @@ export namespace UnassignedshiftRetrieveResponse {
|
|
|
731
777
|
*/
|
|
732
778
|
start_time: string;
|
|
733
779
|
|
|
780
|
+
/**
|
|
781
|
+
* Notes for the shift, max length 256 characters
|
|
782
|
+
*/
|
|
783
|
+
notes?: string;
|
|
784
|
+
|
|
785
|
+
/**
|
|
786
|
+
* The breaks of the shift
|
|
787
|
+
*/
|
|
788
|
+
shift_breaks?: Array<ShiftData.ShiftBreak>;
|
|
789
|
+
|
|
790
|
+
/**
|
|
791
|
+
* The segments of the shift
|
|
792
|
+
*/
|
|
793
|
+
shift_segments?: Array<ShiftData.ShiftSegment>;
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
export namespace ShiftData {
|
|
797
|
+
export interface ShiftBreak {
|
|
798
|
+
/**
|
|
799
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
800
|
+
*/
|
|
801
|
+
duration_minutes: number;
|
|
802
|
+
|
|
803
|
+
/**
|
|
804
|
+
* The start time of the shift break
|
|
805
|
+
*/
|
|
806
|
+
start_time: string;
|
|
807
|
+
|
|
808
|
+
/**
|
|
809
|
+
* The type of the shift break
|
|
810
|
+
*/
|
|
811
|
+
type: 'MEAL' | 'REST';
|
|
812
|
+
|
|
813
|
+
/**
|
|
814
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
815
|
+
*/
|
|
816
|
+
end_time?: string;
|
|
817
|
+
}
|
|
818
|
+
|
|
819
|
+
export interface ShiftSegment {
|
|
820
|
+
/**
|
|
821
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
822
|
+
*/
|
|
823
|
+
duration_minutes: number;
|
|
824
|
+
|
|
825
|
+
/**
|
|
826
|
+
* The start time of the shift segment
|
|
827
|
+
*/
|
|
828
|
+
start_time: string;
|
|
829
|
+
|
|
830
|
+
/**
|
|
831
|
+
* The end time of the shift segment (calculated from start_time +
|
|
832
|
+
* duration_minutes)
|
|
833
|
+
*/
|
|
834
|
+
end_time?: string;
|
|
835
|
+
|
|
836
|
+
/**
|
|
837
|
+
* The IDs of the job codes associated with the shift segment
|
|
838
|
+
*/
|
|
839
|
+
job_codes_id?: Array<string>;
|
|
840
|
+
}
|
|
841
|
+
}
|
|
842
|
+
|
|
843
|
+
/**
|
|
844
|
+
* The published version of the shift
|
|
845
|
+
*/
|
|
846
|
+
export interface PublishedVersion {
|
|
847
|
+
/**
|
|
848
|
+
* The end time of the shift
|
|
849
|
+
*/
|
|
850
|
+
end_time: string;
|
|
851
|
+
|
|
852
|
+
/**
|
|
853
|
+
* The start time of the shift
|
|
854
|
+
*/
|
|
855
|
+
start_time: string;
|
|
856
|
+
|
|
857
|
+
/**
|
|
858
|
+
* Notes for the shift, max length 256 characters
|
|
859
|
+
*/
|
|
860
|
+
notes?: string;
|
|
861
|
+
|
|
862
|
+
/**
|
|
863
|
+
* The breaks of the shift
|
|
864
|
+
*/
|
|
865
|
+
shift_breaks?: Array<PublishedVersion.ShiftBreak>;
|
|
866
|
+
|
|
867
|
+
/**
|
|
868
|
+
* The segments of the shift
|
|
869
|
+
*/
|
|
870
|
+
shift_segments?: Array<PublishedVersion.ShiftSegment>;
|
|
871
|
+
}
|
|
872
|
+
|
|
873
|
+
export namespace PublishedVersion {
|
|
874
|
+
export interface ShiftBreak {
|
|
875
|
+
/**
|
|
876
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
877
|
+
*/
|
|
878
|
+
duration_minutes: number;
|
|
879
|
+
|
|
880
|
+
/**
|
|
881
|
+
* The start time of the shift break
|
|
882
|
+
*/
|
|
883
|
+
start_time: string;
|
|
884
|
+
|
|
885
|
+
/**
|
|
886
|
+
* The type of the shift break
|
|
887
|
+
*/
|
|
888
|
+
type: 'MEAL' | 'REST';
|
|
889
|
+
|
|
890
|
+
/**
|
|
891
|
+
* The end time of the shift break (calculated from start_time + duration_minutes)
|
|
892
|
+
*/
|
|
893
|
+
end_time?: string;
|
|
894
|
+
}
|
|
895
|
+
|
|
896
|
+
export interface ShiftSegment {
|
|
897
|
+
/**
|
|
898
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
899
|
+
*/
|
|
900
|
+
duration_minutes: number;
|
|
901
|
+
|
|
902
|
+
/**
|
|
903
|
+
* The start time of the shift segment
|
|
904
|
+
*/
|
|
905
|
+
start_time: string;
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* The end time of the shift segment (calculated from start_time +
|
|
909
|
+
* duration_minutes)
|
|
910
|
+
*/
|
|
911
|
+
end_time?: string;
|
|
912
|
+
|
|
913
|
+
/**
|
|
914
|
+
* The IDs of the job codes associated with the shift segment
|
|
915
|
+
*/
|
|
916
|
+
job_codes_id?: Array<string>;
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
/**
|
|
921
|
+
* The schedule
|
|
922
|
+
*
|
|
923
|
+
* Expandable field
|
|
924
|
+
*/
|
|
925
|
+
export interface Schedule {
|
|
926
|
+
/**
|
|
927
|
+
* Identifier field
|
|
928
|
+
*/
|
|
929
|
+
id: string;
|
|
930
|
+
|
|
931
|
+
/**
|
|
932
|
+
* Record creation date
|
|
933
|
+
*/
|
|
934
|
+
created_at: string;
|
|
935
|
+
|
|
936
|
+
/**
|
|
937
|
+
* Record update date
|
|
938
|
+
*/
|
|
939
|
+
updated_at: string;
|
|
940
|
+
|
|
941
|
+
/**
|
|
942
|
+
* Whether the requesting role can edit the schedule.
|
|
943
|
+
*/
|
|
944
|
+
can_edit?: boolean;
|
|
945
|
+
|
|
946
|
+
/**
|
|
947
|
+
* The managers of the schedule.
|
|
948
|
+
*
|
|
949
|
+
* Expandable field
|
|
950
|
+
*/
|
|
951
|
+
managers?: Array<WorkersAPI.Worker>;
|
|
952
|
+
|
|
953
|
+
/**
|
|
954
|
+
* The IDs of the managers of the schedule.
|
|
955
|
+
*/
|
|
956
|
+
managers_id?: Array<string>;
|
|
957
|
+
|
|
958
|
+
/**
|
|
959
|
+
* The members of the schedule.
|
|
960
|
+
*
|
|
961
|
+
* Expandable field
|
|
962
|
+
*/
|
|
963
|
+
members?: Array<WorkersAPI.Worker>;
|
|
964
|
+
|
|
965
|
+
/**
|
|
966
|
+
* The IDs of the members of the schedule.
|
|
967
|
+
*/
|
|
968
|
+
members_id?: Array<string>;
|
|
969
|
+
|
|
970
|
+
/**
|
|
971
|
+
* The name of the schedule.
|
|
972
|
+
*/
|
|
973
|
+
name?: string;
|
|
974
|
+
|
|
975
|
+
/**
|
|
976
|
+
* The observers of the schedule.
|
|
977
|
+
*
|
|
978
|
+
* Expandable field
|
|
979
|
+
*/
|
|
980
|
+
observers?: Array<WorkersAPI.Worker>;
|
|
981
|
+
|
|
982
|
+
/**
|
|
983
|
+
* The IDs of the observers of the schedule.
|
|
984
|
+
*/
|
|
985
|
+
observers_id?: Array<string>;
|
|
986
|
+
|
|
987
|
+
/**
|
|
988
|
+
* The settings of the schedule.
|
|
989
|
+
*/
|
|
990
|
+
settings?: Schedule.Settings;
|
|
991
|
+
}
|
|
992
|
+
|
|
993
|
+
export namespace Schedule {
|
|
994
|
+
/**
|
|
995
|
+
* The settings of the schedule.
|
|
996
|
+
*/
|
|
997
|
+
export interface Settings {
|
|
998
|
+
/**
|
|
999
|
+
* The IANA timezone identifier for the schedule (e.g., 'America/New_York').
|
|
1000
|
+
* Accepted values are defined by the tz database, listed here:
|
|
1001
|
+
* https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
|
1002
|
+
*/
|
|
1003
|
+
timezone?: string;
|
|
1004
|
+
}
|
|
1005
|
+
}
|
|
1006
|
+
}
|
|
1007
|
+
|
|
1008
|
+
export interface UnassignedshiftUpdateResponse {
|
|
1009
|
+
/**
|
|
1010
|
+
* Identifier field
|
|
1011
|
+
*/
|
|
1012
|
+
id: string;
|
|
1013
|
+
|
|
1014
|
+
/**
|
|
1015
|
+
* Record creation date
|
|
1016
|
+
*/
|
|
1017
|
+
created_at: string;
|
|
1018
|
+
|
|
1019
|
+
/**
|
|
1020
|
+
* Whether the shift is published
|
|
1021
|
+
*/
|
|
1022
|
+
is_published: boolean;
|
|
1023
|
+
|
|
1024
|
+
/**
|
|
1025
|
+
* The ID of the schedule
|
|
1026
|
+
*/
|
|
1027
|
+
schedule_id: string;
|
|
1028
|
+
|
|
1029
|
+
/**
|
|
1030
|
+
* The data of the shift
|
|
1031
|
+
*/
|
|
1032
|
+
shift_data: UnassignedshiftUpdateResponse.ShiftData;
|
|
1033
|
+
|
|
1034
|
+
/**
|
|
1035
|
+
* The target count of the shift
|
|
1036
|
+
*/
|
|
1037
|
+
target_count: number;
|
|
1038
|
+
|
|
1039
|
+
/**
|
|
1040
|
+
* Record update date
|
|
1041
|
+
*/
|
|
1042
|
+
updated_at: string;
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* The number of assigned shifts
|
|
1046
|
+
*/
|
|
1047
|
+
assigned_count?: number;
|
|
1048
|
+
|
|
1049
|
+
/**
|
|
1050
|
+
* The IDs of the assigned shifts that are part of this unassigned shift
|
|
1051
|
+
*/
|
|
1052
|
+
assigned_shift_ids?: Array<string>;
|
|
1053
|
+
|
|
1054
|
+
/**
|
|
1055
|
+
* Custom fields for the unassigned shift
|
|
1056
|
+
*/
|
|
1057
|
+
custom_fields?: Array<unknown>;
|
|
1058
|
+
|
|
1059
|
+
/**
|
|
1060
|
+
* Configuration for an open shift. If present, this is an open shift (workers can
|
|
1061
|
+
* sign up). If absent/None, this is an empty shift (placeholder).
|
|
1062
|
+
*/
|
|
1063
|
+
open_shift_config?: unknown;
|
|
1064
|
+
|
|
1065
|
+
/**
|
|
1066
|
+
* The published version of the shift
|
|
1067
|
+
*/
|
|
1068
|
+
published_version?: UnassignedshiftUpdateResponse.PublishedVersion;
|
|
1069
|
+
|
|
1070
|
+
/**
|
|
1071
|
+
* The schedule
|
|
1072
|
+
*
|
|
1073
|
+
* Expandable field
|
|
1074
|
+
*/
|
|
1075
|
+
schedule?: UnassignedshiftUpdateResponse.Schedule;
|
|
1076
|
+
}
|
|
1077
|
+
|
|
1078
|
+
export namespace UnassignedshiftUpdateResponse {
|
|
1079
|
+
/**
|
|
1080
|
+
* The data of the shift
|
|
1081
|
+
*/
|
|
1082
|
+
export interface ShiftData {
|
|
1083
|
+
/**
|
|
1084
|
+
* The end time of the shift
|
|
1085
|
+
*/
|
|
1086
|
+
end_time: string;
|
|
1087
|
+
|
|
1088
|
+
/**
|
|
1089
|
+
* The start time of the shift
|
|
1090
|
+
*/
|
|
1091
|
+
start_time: string;
|
|
1092
|
+
|
|
1093
|
+
/**
|
|
1094
|
+
* Notes for the shift, max length 256 characters
|
|
1095
|
+
*/
|
|
1096
|
+
notes?: string;
|
|
1097
|
+
|
|
734
1098
|
/**
|
|
735
1099
|
* The breaks of the shift
|
|
736
1100
|
*/
|
|
@@ -803,6 +1167,11 @@ export namespace UnassignedshiftRetrieveResponse {
|
|
|
803
1167
|
*/
|
|
804
1168
|
start_time: string;
|
|
805
1169
|
|
|
1170
|
+
/**
|
|
1171
|
+
* Notes for the shift, max length 256 characters
|
|
1172
|
+
*/
|
|
1173
|
+
notes?: string;
|
|
1174
|
+
|
|
806
1175
|
/**
|
|
807
1176
|
* The breaks of the shift
|
|
808
1177
|
*/
|
|
@@ -1002,6 +1371,11 @@ export namespace UnassignedshiftCreateParams {
|
|
|
1002
1371
|
*/
|
|
1003
1372
|
start_time: string;
|
|
1004
1373
|
|
|
1374
|
+
/**
|
|
1375
|
+
* Notes for the shift, max length 256 characters
|
|
1376
|
+
*/
|
|
1377
|
+
notes?: string;
|
|
1378
|
+
|
|
1005
1379
|
/**
|
|
1006
1380
|
* The breaks of the shift
|
|
1007
1381
|
*/
|
|
@@ -1054,14 +1428,107 @@ export interface UnassignedshiftRetrieveParams {
|
|
|
1054
1428
|
expand?: string;
|
|
1055
1429
|
}
|
|
1056
1430
|
|
|
1431
|
+
export interface UnassignedshiftUpdateParams {
|
|
1432
|
+
/**
|
|
1433
|
+
* Whether the shift is published
|
|
1434
|
+
*/
|
|
1435
|
+
is_published: boolean;
|
|
1436
|
+
|
|
1437
|
+
/**
|
|
1438
|
+
* The data of the shift
|
|
1439
|
+
*/
|
|
1440
|
+
shift_data: UnassignedshiftUpdateParams.ShiftData;
|
|
1441
|
+
|
|
1442
|
+
/**
|
|
1443
|
+
* The target count of the shift
|
|
1444
|
+
*/
|
|
1445
|
+
target_count: number;
|
|
1446
|
+
|
|
1447
|
+
/**
|
|
1448
|
+
* Configuration for an open shift. If present, this is an open shift (workers can
|
|
1449
|
+
* sign up). If absent/None, this is an empty shift (placeholder).
|
|
1450
|
+
*/
|
|
1451
|
+
open_shift_config?: unknown;
|
|
1452
|
+
}
|
|
1453
|
+
|
|
1454
|
+
export namespace UnassignedshiftUpdateParams {
|
|
1455
|
+
/**
|
|
1456
|
+
* The data of the shift
|
|
1457
|
+
*/
|
|
1458
|
+
export interface ShiftData {
|
|
1459
|
+
/**
|
|
1460
|
+
* The end time of the shift
|
|
1461
|
+
*/
|
|
1462
|
+
end_time: string;
|
|
1463
|
+
|
|
1464
|
+
/**
|
|
1465
|
+
* The start time of the shift
|
|
1466
|
+
*/
|
|
1467
|
+
start_time: string;
|
|
1468
|
+
|
|
1469
|
+
/**
|
|
1470
|
+
* Notes for the shift, max length 256 characters
|
|
1471
|
+
*/
|
|
1472
|
+
notes?: string;
|
|
1473
|
+
|
|
1474
|
+
/**
|
|
1475
|
+
* The breaks of the shift
|
|
1476
|
+
*/
|
|
1477
|
+
shift_breaks?: Array<ShiftData.ShiftBreak>;
|
|
1478
|
+
|
|
1479
|
+
/**
|
|
1480
|
+
* The segments of the shift
|
|
1481
|
+
*/
|
|
1482
|
+
shift_segments?: Array<ShiftData.ShiftSegment>;
|
|
1483
|
+
}
|
|
1484
|
+
|
|
1485
|
+
export namespace ShiftData {
|
|
1486
|
+
export interface ShiftBreak {
|
|
1487
|
+
/**
|
|
1488
|
+
* The duration of the shift break in minutes (input only for creation)
|
|
1489
|
+
*/
|
|
1490
|
+
duration_minutes: number;
|
|
1491
|
+
|
|
1492
|
+
/**
|
|
1493
|
+
* The start time of the shift break
|
|
1494
|
+
*/
|
|
1495
|
+
start_time: string;
|
|
1496
|
+
|
|
1497
|
+
/**
|
|
1498
|
+
* The type of the shift break
|
|
1499
|
+
*/
|
|
1500
|
+
type: 'MEAL' | 'REST';
|
|
1501
|
+
}
|
|
1502
|
+
|
|
1503
|
+
export interface ShiftSegment {
|
|
1504
|
+
/**
|
|
1505
|
+
* The duration of the shift segment in minutes (input only for creation)
|
|
1506
|
+
*/
|
|
1507
|
+
duration_minutes: number;
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* The start time of the shift segment
|
|
1511
|
+
*/
|
|
1512
|
+
start_time: string;
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
* The IDs of the job codes associated with the shift segment
|
|
1516
|
+
*/
|
|
1517
|
+
job_codes_id?: Array<string>;
|
|
1518
|
+
}
|
|
1519
|
+
}
|
|
1520
|
+
}
|
|
1521
|
+
|
|
1057
1522
|
export declare namespace Unassignedshifts {
|
|
1058
1523
|
export {
|
|
1059
1524
|
type UnassignedshiftListResponse as UnassignedshiftListResponse,
|
|
1060
1525
|
type UnassignedshiftCreateResponse as UnassignedshiftCreateResponse,
|
|
1061
1526
|
type UnassignedshiftRetrieveResponse as UnassignedshiftRetrieveResponse,
|
|
1527
|
+
type UnassignedshiftUpdateResponse as UnassignedshiftUpdateResponse,
|
|
1062
1528
|
type UnassignedshiftListResponsesPageCursorURL as UnassignedshiftListResponsesPageCursorURL,
|
|
1063
1529
|
type UnassignedshiftListParams as UnassignedshiftListParams,
|
|
1064
1530
|
type UnassignedshiftCreateParams as UnassignedshiftCreateParams,
|
|
1065
1531
|
type UnassignedshiftRetrieveParams as UnassignedshiftRetrieveParams,
|
|
1532
|
+
type UnassignedshiftUpdateParams as UnassignedshiftUpdateParams,
|
|
1066
1533
|
};
|
|
1067
1534
|
}
|
|
@@ -22,12 +22,26 @@ export class WorkLocations extends APIResource {
|
|
|
22
22
|
return this._client.getAPIList('/work-locations', PageCursorURL<WorkLocation>, { query, ...options });
|
|
23
23
|
}
|
|
24
24
|
|
|
25
|
+
/**
|
|
26
|
+
* Create a new work location
|
|
27
|
+
*/
|
|
28
|
+
create(body: WorkLocationCreateParams, options?: RequestOptions): APIPromise<WorkLocation> {
|
|
29
|
+
return this._client.post('/work-locations', { body, ...options });
|
|
30
|
+
}
|
|
31
|
+
|
|
25
32
|
/**
|
|
26
33
|
* Retrieve a specific work location
|
|
27
34
|
*/
|
|
28
35
|
retrieve(id: string, options?: RequestOptions): APIPromise<WorkLocationRetrieveResponse> {
|
|
29
36
|
return this._client.get(path`/work-locations/${id}`, options);
|
|
30
37
|
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Updated a specific work location
|
|
41
|
+
*/
|
|
42
|
+
update(id: string, body: WorkLocationUpdateParams, options?: RequestOptions): APIPromise<WorkLocation> {
|
|
43
|
+
return this._client.patch(path`/work-locations/${id}`, { body, ...options });
|
|
44
|
+
}
|
|
31
45
|
}
|
|
32
46
|
|
|
33
47
|
export type WorkLocationsPageCursorURL = PageCursorURL<WorkLocation>;
|
|
@@ -70,11 +84,115 @@ export interface WorkLocationListParams {
|
|
|
70
84
|
order_by?: string;
|
|
71
85
|
}
|
|
72
86
|
|
|
87
|
+
export interface WorkLocationCreateParams {
|
|
88
|
+
/**
|
|
89
|
+
* The address for the work location.
|
|
90
|
+
*/
|
|
91
|
+
address: WorkLocationCreateParams.Address;
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* The name of the work location.
|
|
95
|
+
*/
|
|
96
|
+
name: string;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export namespace WorkLocationCreateParams {
|
|
100
|
+
/**
|
|
101
|
+
* The address for the work location.
|
|
102
|
+
*/
|
|
103
|
+
export interface Address {
|
|
104
|
+
/**
|
|
105
|
+
* The country component, pursuant to SCIM RFC 7643 4.1.2.
|
|
106
|
+
*/
|
|
107
|
+
country?: Shared.CountryCode;
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* The city or locality component.
|
|
111
|
+
*/
|
|
112
|
+
locality?: string;
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
|
|
116
|
+
*/
|
|
117
|
+
postal_code?: string;
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* The state or region component, pursuant to SCIM RFC 7643 4.1.2.
|
|
121
|
+
*/
|
|
122
|
+
region?: string;
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* The full street address component, which may include house number, street name,
|
|
126
|
+
* P.O. box, and multi-line extended street address information, pursuant to SCIM
|
|
127
|
+
* RFC 7643 4.1.2..
|
|
128
|
+
*/
|
|
129
|
+
street_address?: string;
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* The classification of the address.
|
|
133
|
+
*/
|
|
134
|
+
type?: 'HOME' | 'WORK' | 'OTHER';
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
export interface WorkLocationUpdateParams {
|
|
139
|
+
/**
|
|
140
|
+
* The address for the work location.
|
|
141
|
+
*/
|
|
142
|
+
address: WorkLocationUpdateParams.Address;
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* The name of the work location.
|
|
146
|
+
*/
|
|
147
|
+
name: string;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
export namespace WorkLocationUpdateParams {
|
|
151
|
+
/**
|
|
152
|
+
* The address for the work location.
|
|
153
|
+
*/
|
|
154
|
+
export interface Address {
|
|
155
|
+
/**
|
|
156
|
+
* The country component, pursuant to SCIM RFC 7643 4.1.2.
|
|
157
|
+
*/
|
|
158
|
+
country?: Shared.CountryCode;
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* The city or locality component.
|
|
162
|
+
*/
|
|
163
|
+
locality?: string;
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
|
|
167
|
+
*/
|
|
168
|
+
postal_code?: string;
|
|
169
|
+
|
|
170
|
+
/**
|
|
171
|
+
* The state or region component, pursuant to SCIM RFC 7643 4.1.2.
|
|
172
|
+
*/
|
|
173
|
+
region?: string;
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* The full street address component, which may include house number, street name,
|
|
177
|
+
* P.O. box, and multi-line extended street address information, pursuant to SCIM
|
|
178
|
+
* RFC 7643 4.1.2..
|
|
179
|
+
*/
|
|
180
|
+
street_address?: string;
|
|
181
|
+
|
|
182
|
+
/**
|
|
183
|
+
* The classification of the address.
|
|
184
|
+
*/
|
|
185
|
+
type?: 'HOME' | 'WORK' | 'OTHER';
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
|
|
73
189
|
export declare namespace WorkLocations {
|
|
74
190
|
export {
|
|
75
191
|
type WorkLocation as WorkLocation,
|
|
76
192
|
type WorkLocationRetrieveResponse as WorkLocationRetrieveResponse,
|
|
77
193
|
type WorkLocationsPageCursorURL as WorkLocationsPageCursorURL,
|
|
78
194
|
type WorkLocationListParams as WorkLocationListParams,
|
|
195
|
+
type WorkLocationCreateParams as WorkLocationCreateParams,
|
|
196
|
+
type WorkLocationUpdateParams as WorkLocationUpdateParams,
|
|
79
197
|
};
|
|
80
198
|
}
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.2.0-alpha.
|
|
1
|
+
export const VERSION = '0.2.0-alpha.26'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.2.0-alpha.
|
|
1
|
+
export declare const VERSION = "0.2.0-alpha.26";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.2.0-alpha.
|
|
1
|
+
export declare const VERSION = "0.2.0-alpha.26";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.VERSION = void 0;
|
|
4
|
-
exports.VERSION = '0.2.0-alpha.
|
|
4
|
+
exports.VERSION = '0.2.0-alpha.26'; // x-release-please-version
|
|
5
5
|
//# sourceMappingURL=version.js.map
|
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '0.2.0-alpha.
|
|
1
|
+
export const VERSION = '0.2.0-alpha.26'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|