@dsptch-work/api-client 0.10.0 → 0.11.0

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.
@@ -1223,6 +1223,9 @@ export type TimecodeGenesisParameters = {
1223
1223
  */
1224
1224
  effective_date: string;
1225
1225
  };
1226
+ /**
1227
+ * Request body for scheduling a timecode's termination: the date from which it stops being valid. The body is required — the endpoint reads effective_date with `params.expect`, so a request omitting it is refused with `400`.
1228
+ */
1226
1229
  export type TimecodeScheduledTerminationParameters = {
1227
1230
  /**
1228
1231
  * When the timecode stops being valid. Must fall strictly after the version family's `valid_from`; an end at or before it would leave no coverage at all and is refused with `422`.
@@ -1355,6 +1358,10 @@ export type AssetsProductResponseObject = {
1355
1358
  * Images attached to the product; each carries a download url for its file.
1356
1359
  */
1357
1360
  images: Array<AssetsAttachmentResponseObject>;
1361
+ /**
1362
+ * When the product was archived (ISO 8601); null while active. Archiving a product also archives all of its items; both are hidden from listings by default (see filter[state]) and read-only until unarchived.
1363
+ */
1364
+ archived_at: string | null;
1358
1365
  /**
1359
1366
  * When the record was created (ISO 8601).
1360
1367
  */
@@ -1572,7 +1579,7 @@ export type PerDiemParameters = {
1572
1579
  /**
1573
1580
  * Allowance amount in cents, as a string (e.g. "7500" is $75.00).
1574
1581
  */
1575
- rate_cents: string | null;
1582
+ rate_cents: string;
1576
1583
  /**
1577
1584
  * ISO 4217 currency code, e.g. "USD".
1578
1585
  */
@@ -2861,6 +2868,19 @@ export type JobParameters = {
2861
2868
  */
2862
2869
  label?: string | null;
2863
2870
  } | null;
2871
+ /**
2872
+ * Custom field values to add to the job, addressed by custom field config id; null when none. Each row creates a value, so a config that already carries one on this job is refused with a 422 — to overwrite, send the value under a top-level key named after the custom field instead. Supplying this key turns that by-name form off for the request.
2873
+ */
2874
+ custom_fields_attributes?: Array<{
2875
+ /**
2876
+ * ID of the custom field config the value belongs to; the config must belong to the company that owns the job.
2877
+ */
2878
+ custom_field_config_id: string;
2879
+ /**
2880
+ * Value to store for the custom field; null when unset.
2881
+ */
2882
+ value?: string | null;
2883
+ }> | null;
2864
2884
  /**
2865
2885
  * Prevailing-wage / apprenticeship (PWA) compliance details to set on the job; which fields apply depends on region. Null when the job tracks no PWA compliance.
2866
2886
  */
@@ -3703,21 +3723,21 @@ export type ManagerTimeEntryApprovalParameters = {
3703
3723
  approver_user_id: string;
3704
3724
  };
3705
3725
  /**
3706
- * Request body for creating or updating a time entry; on create, timekeeping_time_card_id, start_time, and end_time are required.
3726
+ * The time-entry body fields shared by the create and update bodies; each of those declares its own requiredness.
3707
3727
  */
3708
3728
  export type TimeEntryParameters = {
3709
3729
  /**
3710
3730
  * Id of the time card to attach the entry to; user_id is derived server-side from it. Required on create.
3711
3731
  */
3712
- timekeeping_time_card_id: string;
3732
+ timekeeping_time_card_id?: string;
3713
3733
  /**
3714
3734
  * these will be rounded to the nearest second
3715
3735
  */
3716
- start_time: string;
3736
+ start_time?: string;
3717
3737
  /**
3718
3738
  * these will be rounded to the nearest second
3719
3739
  */
3720
- end_time: string;
3740
+ end_time?: string;
3721
3741
  /**
3722
3742
  * Id of the job to work against; the worker must have a Position covering that job at start_time. Send null (or omit) for no job.
3723
3743
  */
@@ -3742,11 +3762,25 @@ export type TimeEntryParameters = {
3742
3762
  * Feature ids to allocate to this time entry. Only features your company can view are accepted.
3743
3763
  */
3744
3764
  feature_ids?: Array<string> | null;
3765
+ };
3766
+ /**
3767
+ * Request body for creating a time entry — the time_entry_parameters fields, of which timekeeping_time_card_id, start_time, and end_time are required, plus the explicit "no feature" acknowledgement.
3768
+ */
3769
+ export type TimeEntryCreateParameters = TimeEntryParameters & {
3745
3770
  /**
3746
3771
  * Set true to record an explicit "no feature" answer when the job requires a feature allocation and you're not supplying one.
3747
3772
  */
3748
3773
  feature_allocation_acknowledged?: boolean | null;
3749
3774
  };
3775
+ /**
3776
+ * Request body for updating a time entry — the time_entry_parameters fields, every one optional, plus the acknowledgement that clears an apprenticeship allocation conflict.
3777
+ */
3778
+ export type TimeEntryUpdateParameters = TimeEntryParameters & {
3779
+ /**
3780
+ * Set true to accept dropping the time card's apprenticeship hour allocations when the new times invalidate them; without it such an update returns 422.
3781
+ */
3782
+ confirm_allocation_conflict?: boolean | null;
3783
+ };
3750
3784
  /**
3751
3785
  * A page of form definitions. A form definition is a SurveyJS form template built and versioned in the web app's form builder, so this API is read-only.
3752
3786
  */
@@ -3948,7 +3982,7 @@ export type UserCompanyCreateParameters = {
3948
3982
  /**
3949
3983
  * How the worker is paid: hourly or salary.
3950
3984
  */
3951
- compensation_type?: string | null;
3985
+ compensation_type?: 'hourly' | 'salary';
3952
3986
  /**
3953
3987
  * Whether to enroll the worker in Time and Attendance (time tracking).
3954
3988
  */
@@ -4024,7 +4058,7 @@ export type UserCompanyScheduledChangesParameters = {
4024
4058
  /**
4025
4059
  * How the worker is paid: hourly or salary.
4026
4060
  */
4027
- compensation_type?: string;
4061
+ compensation_type?: 'hourly' | 'salary';
4028
4062
  /**
4029
4063
  * Whether the worker is eligible for overtime pay.
4030
4064
  */
@@ -6811,7 +6845,7 @@ export type CertificationParameters = {
6811
6845
  /**
6812
6846
  * Whether this is a recognized, vetted credential type. This is a property of the certification definition, distinct from the verified flag on a certification a worker holds.
6813
6847
  */
6814
- verified?: boolean | null;
6848
+ verified?: boolean;
6815
6849
  /**
6816
6850
  * How long the certification stays valid, as an ISO 8601 duration (for example "P1Y" for one year or "P6M" for six months). Drives expiry reminders on held certifications; null when the certification does not expire.
6817
6851
  */
@@ -6959,7 +6993,7 @@ export type UserCertificationParameters = {
6959
6993
  /**
6960
6994
  * Whether DSPTCH has verified this held certification. Distinct from the verified flag on the certification definition itself.
6961
6995
  */
6962
- verified?: boolean | null;
6996
+ verified?: boolean;
6963
6997
  /**
6964
6998
  * When the held certification expires (YYYY-MM-DD). Must be after received_at; null when it does not expire.
6965
6999
  */
@@ -7882,9 +7916,9 @@ export type AssetsItemResponseObject = {
7882
7916
  */
7883
7917
  serial_number: string | null;
7884
7918
  /**
7885
- * Lifecycle status of the item: one of available, assigned, or retired.
7919
+ * Placement status of the item: available, or assigned when held by a user.
7886
7920
  */
7887
- status: 'available' | 'assigned' | 'retired' | null;
7921
+ status: 'available' | 'assigned' | null;
7888
7922
  /**
7889
7923
  * When the item was purchased (ISO 8601).
7890
7924
  */
@@ -7939,6 +7973,10 @@ export type AssetsItemResponseObject = {
7939
7973
  * Images attached to the item; each carries a download url for its file.
7940
7974
  */
7941
7975
  images: Array<AssetsAttachmentResponseObject>;
7976
+ /**
7977
+ * When the item was archived (ISO 8601); null while active. An archived item is hidden from listings by default (see filter[state]) and read-only, with its location and history preserved; unarchiving restores it as it was.
7978
+ */
7979
+ archived_at: string | null;
7942
7980
  /**
7943
7981
  * When the record was created (ISO 8601).
7944
7982
  */
@@ -7969,9 +8007,9 @@ export type AssetsItemParameters = {
7969
8007
  */
7970
8008
  serial_number: string;
7971
8009
  /**
7972
- * Lifecycle status of the item: one of available, assigned, or retired.
8010
+ * Placement status of the item: available, or assigned when held by a user.
7973
8011
  */
7974
- status?: 'available' | 'assigned' | 'retired';
8012
+ status?: 'available' | 'assigned';
7975
8013
  /**
7976
8014
  * When the item was purchased (ISO 8601).
7977
8015
  */
@@ -9105,15 +9143,6 @@ export type AssetsAdjustmentParameters = {
9105
9143
  */
9106
9144
  performed_by_user_id: string;
9107
9145
  };
9108
- /**
9109
- * Retire an item, taking it out of service. A serial item is removed from its site or user (recording the removal) and marked retired; a bulk item is flagged retired without changing its stock. Delete this resource to un-retire.
9110
- */
9111
- export type AssetsRetirementParameters = {
9112
- /**
9113
- * ID of the user this retirement is performed on behalf of, recorded on any resulting transaction. Required; must belong to your company.
9114
- */
9115
- performed_by_user_id: string;
9116
- };
9117
9146
  export type ListApiKeyScopesData = {
9118
9147
  body?: never;
9119
9148
  path?: never;
@@ -9125,7 +9154,7 @@ export type ListApiKeyScopesResponses = {
9125
9154
  * Success
9126
9155
  */
9127
9156
  200: {
9128
- data?: Array<ApiKeyScopeResponseObject>;
9157
+ data: Array<ApiKeyScopeResponseObject>;
9129
9158
  };
9130
9159
  };
9131
9160
  export type ListApiKeyScopesResponse = ListApiKeyScopesResponses[keyof ListApiKeyScopesResponses];
@@ -9195,9 +9224,9 @@ export type ListApprenticesResponses = {
9195
9224
  * Success
9196
9225
  */
9197
9226
  200: {
9198
- meta?: Meta;
9199
- links?: Links;
9200
- data?: Array<ApprenticeshipApprenticeResponseObject>;
9227
+ meta: Meta;
9228
+ links: Links;
9229
+ data: Array<ApprenticeshipApprenticeResponseObject>;
9201
9230
  };
9202
9231
  };
9203
9232
  export type ListApprenticesResponse = ListApprenticesResponses[keyof ListApprenticesResponses];
@@ -9280,9 +9309,9 @@ export type ListOccupationsResponses = {
9280
9309
  * Success
9281
9310
  */
9282
9311
  200: {
9283
- meta?: Meta;
9284
- links?: Links;
9285
- data?: Array<ApprenticeshipOccupationResponseObject>;
9312
+ meta: Meta;
9313
+ links: Links;
9314
+ data: Array<ApprenticeshipOccupationResponseObject>;
9286
9315
  };
9287
9316
  };
9288
9317
  export type ListOccupationsResponse = ListOccupationsResponses[keyof ListOccupationsResponses];
@@ -9388,9 +9417,9 @@ export type ListEmployersResponses = {
9388
9417
  * Success
9389
9418
  */
9390
9419
  200: {
9391
- meta?: Meta;
9392
- links?: Links;
9393
- data?: Array<ApprenticeshipProgramEmployerResponseObject>;
9420
+ meta: Meta;
9421
+ links: Links;
9422
+ data: Array<ApprenticeshipProgramEmployerResponseObject>;
9394
9423
  };
9395
9424
  };
9396
9425
  export type ListEmployersResponse = ListEmployersResponses[keyof ListEmployersResponses];
@@ -9517,9 +9546,9 @@ export type ListProgramsResponses = {
9517
9546
  * Success
9518
9547
  */
9519
9548
  200: {
9520
- meta?: Meta;
9521
- links?: Links;
9522
- data?: Array<ApprenticeshipProgramResponseObject>;
9549
+ meta: Meta;
9550
+ links: Links;
9551
+ data: Array<ApprenticeshipProgramResponseObject>;
9523
9552
  };
9524
9553
  };
9525
9554
  export type ListProgramsResponse = ListProgramsResponses[keyof ListProgramsResponses];
@@ -9622,9 +9651,9 @@ export type ListPeriodsResponses = {
9622
9651
  * Success
9623
9652
  */
9624
9653
  200: {
9625
- meta?: Meta;
9626
- links?: Links;
9627
- data?: Array<ApprenticeshipWageSchedulePeriodResponseObject>;
9654
+ meta: Meta;
9655
+ links: Links;
9656
+ data: Array<ApprenticeshipWageSchedulePeriodResponseObject>;
9628
9657
  };
9629
9658
  };
9630
9659
  export type ListPeriodsResponse = ListPeriodsResponses[keyof ListPeriodsResponses];
@@ -9730,9 +9759,9 @@ export type ListWageSchedulesResponses = {
9730
9759
  * Success
9731
9760
  */
9732
9761
  200: {
9733
- meta?: Meta;
9734
- links?: Links;
9735
- data?: Array<ApprenticeshipWageScheduleResponseObject>;
9762
+ meta: Meta;
9763
+ links: Links;
9764
+ data: Array<ApprenticeshipWageScheduleResponseObject>;
9736
9765
  };
9737
9766
  };
9738
9767
  export type ListWageSchedulesResponse = ListWageSchedulesResponses[keyof ListWageSchedulesResponses];
@@ -9842,9 +9871,9 @@ export type ListAttributesResponses = {
9842
9871
  * Success
9843
9872
  */
9844
9873
  200: {
9845
- meta?: Meta;
9846
- links?: Links;
9847
- data?: Array<AssetsAttributeResponseObject>;
9874
+ meta: Meta;
9875
+ links: Links;
9876
+ data: Array<AssetsAttributeResponseObject>;
9848
9877
  };
9849
9878
  };
9850
9879
  export type ListAttributesResponse = ListAttributesResponses[keyof ListAttributesResponses];
@@ -10001,9 +10030,9 @@ export type ListCategoriesResponses = {
10001
10030
  * Success
10002
10031
  */
10003
10032
  200: {
10004
- meta?: Meta;
10005
- links?: Links;
10006
- data?: Array<AssetsCategoryResponseObject>;
10033
+ meta: Meta;
10034
+ links: Links;
10035
+ data: Array<AssetsCategoryResponseObject>;
10007
10036
  };
10008
10037
  };
10009
10038
  export type ListCategoriesResponse = ListCategoriesResponses[keyof ListCategoriesResponses];
@@ -10144,9 +10173,9 @@ export type ListCustodiesResponses = {
10144
10173
  * Success
10145
10174
  */
10146
10175
  200: {
10147
- meta?: Meta;
10148
- links?: Links;
10149
- data?: Array<AssetsCustodyResponseObject>;
10176
+ meta: Meta;
10177
+ links: Links;
10178
+ data: Array<AssetsCustodyResponseObject>;
10150
10179
  };
10151
10180
  };
10152
10181
  export type ListCustodiesResponse = ListCustodiesResponses[keyof ListCustodiesResponses];
@@ -10199,9 +10228,9 @@ export type ListEventsResponses = {
10199
10228
  * Success
10200
10229
  */
10201
10230
  200: {
10202
- meta?: Meta;
10203
- links?: Links;
10204
- data?: Array<AssetsItemEventResponseObject>;
10231
+ meta: Meta;
10232
+ links: Links;
10233
+ data: Array<AssetsItemEventResponseObject>;
10205
10234
  };
10206
10235
  };
10207
10236
  export type ListEventsResponse = ListEventsResponses[keyof ListEventsResponses];
@@ -10273,9 +10302,9 @@ export type ListFormAssignmentTriggersResponses = {
10273
10302
  * Success
10274
10303
  */
10275
10304
  200: {
10276
- meta?: Meta;
10277
- links?: Links;
10278
- data?: Array<AssetsFormAssignmentTriggerResponseObject>;
10305
+ meta: Meta;
10306
+ links: Links;
10307
+ data: Array<AssetsFormAssignmentTriggerResponseObject>;
10279
10308
  };
10280
10309
  };
10281
10310
  export type ListFormAssignmentTriggersResponse = ListFormAssignmentTriggersResponses[keyof ListFormAssignmentTriggersResponses];
@@ -10400,9 +10429,9 @@ export type ListInventoriesResponses = {
10400
10429
  * Success
10401
10430
  */
10402
10431
  200: {
10403
- meta?: Meta;
10404
- links?: Links;
10405
- data?: Array<AssetsInventoryResponseObject>;
10432
+ meta: Meta;
10433
+ links: Links;
10434
+ data: Array<AssetsInventoryResponseObject>;
10406
10435
  };
10407
10436
  };
10408
10437
  export type ListInventoriesResponse = ListInventoriesResponses[keyof ListInventoriesResponses];
@@ -10464,6 +10493,10 @@ export type ListItemsData = {
10464
10493
  * Filter by service state
10465
10494
  */
10466
10495
  'filter[service]'?: string;
10496
+ /**
10497
+ * Filter by lifecycle state (defaults to 'active', hiding archived items)
10498
+ */
10499
+ 'filter[state]'?: string;
10467
10500
  filter?: string;
10468
10501
  'filter[unexpected]'?: string;
10469
10502
  };
@@ -10489,9 +10522,9 @@ export type ListItemsResponses = {
10489
10522
  * Success
10490
10523
  */
10491
10524
  200: {
10492
- meta?: Meta;
10493
- links?: Links;
10494
- data?: Array<AssetsItemResponseObject>;
10525
+ meta: Meta;
10526
+ links: Links;
10527
+ data: Array<AssetsItemResponseObject>;
10495
10528
  };
10496
10529
  };
10497
10530
  export type ListItemsResponse = ListItemsResponses[keyof ListItemsResponses];
@@ -10585,50 +10618,6 @@ export type UpdateItemResponses = {
10585
10618
  200: AssetsItemResponseObject;
10586
10619
  };
10587
10620
  export type UpdateItemResponse = UpdateItemResponses[keyof UpdateItemResponses];
10588
- export type UnretireItemData = {
10589
- body?: never;
10590
- path: {
10591
- item_id: string;
10592
- };
10593
- query?: never;
10594
- url: '/api/v1/assets/items/{item_id}/retirement';
10595
- };
10596
- export type UnretireItemErrors = {
10597
- /**
10598
- * Forbidden
10599
- */
10600
- 403: Problem;
10601
- };
10602
- export type UnretireItemError = UnretireItemErrors[keyof UnretireItemErrors];
10603
- export type UnretireItemResponses = {
10604
- /**
10605
- * Success
10606
- */
10607
- 200: AssetsItemResponseObject;
10608
- };
10609
- export type UnretireItemResponse = UnretireItemResponses[keyof UnretireItemResponses];
10610
- export type RetireItemData = {
10611
- body: AssetsRetirementParameters;
10612
- path: {
10613
- item_id: string;
10614
- };
10615
- query?: never;
10616
- url: '/api/v1/assets/items/{item_id}/retirement';
10617
- };
10618
- export type RetireItemErrors = {
10619
- /**
10620
- * Forbidden
10621
- */
10622
- 403: Problem;
10623
- };
10624
- export type RetireItemError = RetireItemErrors[keyof RetireItemErrors];
10625
- export type RetireItemResponses = {
10626
- /**
10627
- * Created
10628
- */
10629
- 201: AssetsItemResponseObject;
10630
- };
10631
- export type RetireItemResponse = RetireItemResponses[keyof RetireItemResponses];
10632
10621
  export type ListServiceSchedulesData = {
10633
10622
  body?: never;
10634
10623
  path: {
@@ -10675,9 +10664,9 @@ export type ListServiceSchedulesResponses = {
10675
10664
  * Success
10676
10665
  */
10677
10666
  200: {
10678
- meta?: Meta;
10679
- links?: Links;
10680
- data?: Array<AssetsServiceScheduleResponseObject>;
10667
+ meta: Meta;
10668
+ links: Links;
10669
+ data: Array<AssetsServiceScheduleResponseObject>;
10681
10670
  };
10682
10671
  };
10683
10672
  export type ListServiceSchedulesResponse = ListServiceSchedulesResponses[keyof ListServiceSchedulesResponses];
@@ -10833,9 +10822,9 @@ export type ListServiceEventsResponses = {
10833
10822
  * Success
10834
10823
  */
10835
10824
  200: {
10836
- meta?: Meta;
10837
- links?: Links;
10838
- data?: Array<AssetsServiceEventFullResponseObject>;
10825
+ meta: Meta;
10826
+ links: Links;
10827
+ data: Array<AssetsServiceEventFullResponseObject>;
10839
10828
  };
10840
10829
  };
10841
10830
  export type ListServiceEventsResponse = ListServiceEventsResponses[keyof ListServiceEventsResponses];
@@ -10973,9 +10962,9 @@ export type ListFormAssignmentTasksResponses = {
10973
10962
  * Success
10974
10963
  */
10975
10964
  200: {
10976
- meta?: Meta;
10977
- links?: Links;
10978
- data?: Array<AssetsItemFormAssignmentResponseObject>;
10965
+ meta: Meta;
10966
+ links: Links;
10967
+ data: Array<AssetsItemFormAssignmentResponseObject>;
10979
10968
  };
10980
10969
  };
10981
10970
  export type ListFormAssignmentTasksResponse = ListFormAssignmentTasksResponses[keyof ListFormAssignmentTasksResponses];
@@ -11096,9 +11085,9 @@ export type ListDocumentsResponses = {
11096
11085
  * Success
11097
11086
  */
11098
11087
  200: {
11099
- meta?: Meta;
11100
- links?: Links;
11101
- data?: Array<AssetsDocumentResponseObject>;
11088
+ meta: Meta;
11089
+ links: Links;
11090
+ data: Array<AssetsDocumentResponseObject>;
11102
11091
  };
11103
11092
  };
11104
11093
  export type ListDocumentsResponse = ListDocumentsResponses[keyof ListDocumentsResponses];
@@ -11226,9 +11215,9 @@ export type ListVersionsResponses = {
11226
11215
  * Success
11227
11216
  */
11228
11217
  200: {
11229
- meta?: Meta;
11230
- links?: Links;
11231
- data?: Array<AssetsDocumentVersionResponseObject>;
11218
+ meta: Meta;
11219
+ links: Links;
11220
+ data: Array<AssetsDocumentVersionResponseObject>;
11232
11221
  };
11233
11222
  };
11234
11223
  export type ListVersionsResponse = ListVersionsResponses[keyof ListVersionsResponses];
@@ -11240,6 +11229,14 @@ export type ListProductsData = {
11240
11229
  * Filter by asset category
11241
11230
  */
11242
11231
  'filter[assets_category_id]'?: string;
11232
+ /**
11233
+ * Filter by lifecycle state (defaults to 'active', hiding archived products):
11234
+ * * `active`
11235
+ * * `archived`
11236
+ * * `all`
11237
+ *
11238
+ */
11239
+ 'filter[state]'?: string;
11243
11240
  'filter[created_at][gte]'?: string;
11244
11241
  'filter[created_at][lte]'?: string;
11245
11242
  'filter[updated_at][gte]'?: string;
@@ -11279,9 +11276,9 @@ export type ListProductsResponses = {
11279
11276
  * Success
11280
11277
  */
11281
11278
  200: {
11282
- meta?: Meta;
11283
- links?: Links;
11284
- data?: Array<AssetsProductResponseObject>;
11279
+ meta: Meta;
11280
+ links: Links;
11281
+ data: Array<AssetsProductResponseObject>;
11285
11282
  };
11286
11283
  };
11287
11284
  export type ListProductsResponse = ListProductsResponses[keyof ListProductsResponses];
@@ -11473,9 +11470,9 @@ export type ListServiceScheduleTemplatesResponses = {
11473
11470
  * Success
11474
11471
  */
11475
11472
  200: {
11476
- meta?: Meta;
11477
- links?: Links;
11478
- data?: Array<AssetsServiceScheduleTemplateResponseObject>;
11473
+ meta: Meta;
11474
+ links: Links;
11475
+ data: Array<AssetsServiceScheduleTemplateResponseObject>;
11479
11476
  };
11480
11477
  };
11481
11478
  export type ListServiceScheduleTemplatesResponse = ListServiceScheduleTemplatesResponses[keyof ListServiceScheduleTemplatesResponses];
@@ -11691,9 +11688,9 @@ export type ListAssetsSitesResponses = {
11691
11688
  * Success
11692
11689
  */
11693
11690
  200: {
11694
- meta?: Meta;
11695
- links?: Links;
11696
- data?: Array<AssetsSiteResponseObject>;
11691
+ meta: Meta;
11692
+ links: Links;
11693
+ data: Array<AssetsSiteResponseObject>;
11697
11694
  };
11698
11695
  };
11699
11696
  export type ListAssetsSitesResponse = ListAssetsSitesResponses[keyof ListAssetsSitesResponses];
@@ -11833,9 +11830,9 @@ export type ListTransfersResponses = {
11833
11830
  * Success
11834
11831
  */
11835
11832
  200: {
11836
- meta?: Meta;
11837
- links?: Links;
11838
- data?: Array<AssetsTransferResponseObject>;
11833
+ meta: Meta;
11834
+ links: Links;
11835
+ data: Array<AssetsTransferResponseObject>;
11839
11836
  };
11840
11837
  };
11841
11838
  export type ListTransfersResponse = ListTransfersResponses[keyof ListTransfersResponses];
@@ -11932,9 +11929,9 @@ export type ListVendorsResponses = {
11932
11929
  * Success
11933
11930
  */
11934
11931
  200: {
11935
- meta?: Meta;
11936
- links?: Links;
11937
- data?: Array<AssetsVendorResponseObject>;
11932
+ meta: Meta;
11933
+ links: Links;
11934
+ data: Array<AssetsVendorResponseObject>;
11938
11935
  };
11939
11936
  };
11940
11937
  export type ListVendorsResponse = ListVendorsResponses[keyof ListVendorsResponses];
@@ -12083,9 +12080,9 @@ export type ListFeaturesResponses = {
12083
12080
  * Success
12084
12081
  */
12085
12082
  200: {
12086
- meta?: Meta;
12087
- links?: Links;
12088
- data?: Array<FeatureResponseObject>;
12083
+ meta: Meta;
12084
+ links: Links;
12085
+ data: Array<FeatureResponseObject>;
12089
12086
  };
12090
12087
  };
12091
12088
  export type ListFeaturesResponse = ListFeaturesResponses[keyof ListFeaturesResponses];
@@ -12162,9 +12159,9 @@ export type ListAtlasSitesResponses = {
12162
12159
  * Success
12163
12160
  */
12164
12161
  200: {
12165
- meta?: Meta;
12166
- links?: Links;
12167
- data?: Array<SiteResponseObject>;
12162
+ meta: Meta;
12163
+ links: Links;
12164
+ data: Array<SiteResponseObject>;
12168
12165
  };
12169
12166
  };
12170
12167
  export type ListAtlasSitesResponse = ListAtlasSitesResponses[keyof ListAtlasSitesResponses];
@@ -12269,9 +12266,9 @@ export type ListPackagesResponses = {
12269
12266
  * Success
12270
12267
  */
12271
12268
  200: {
12272
- meta?: Meta;
12273
- links?: Links;
12274
- data?: Array<CertificationPackageResponseObject>;
12269
+ meta: Meta;
12270
+ links: Links;
12271
+ data: Array<CertificationPackageResponseObject>;
12275
12272
  };
12276
12273
  };
12277
12274
  export type ListPackagesResponse = ListPackagesResponses[keyof ListPackagesResponses];
@@ -12720,9 +12717,9 @@ export type ListDepartmentsResponses = {
12720
12717
  * Success
12721
12718
  */
12722
12719
  200: {
12723
- meta?: Meta;
12724
- links?: Links;
12725
- data?: Array<DepartmentResponseObject>;
12720
+ meta: Meta;
12721
+ links: Links;
12722
+ data: Array<DepartmentResponseObject>;
12726
12723
  };
12727
12724
  };
12728
12725
  export type ListDepartmentsResponse = ListDepartmentsResponses[keyof ListDepartmentsResponses];
@@ -12819,9 +12816,9 @@ export type ListCompaniesResponses = {
12819
12816
  * Success
12820
12817
  */
12821
12818
  200: {
12822
- meta?: Meta;
12823
- links?: Links;
12824
- data?: Array<CompanyResponseObject>;
12819
+ meta: Meta;
12820
+ links: Links;
12821
+ data: Array<CompanyResponseObject>;
12825
12822
  };
12826
12823
  };
12827
12824
  export type ListCompaniesResponse = ListCompaniesResponses[keyof ListCompaniesResponses];
@@ -12937,9 +12934,9 @@ export type ListChecksResponses = {
12937
12934
  * Success
12938
12935
  */
12939
12936
  200: {
12940
- meta?: Meta;
12941
- links?: Links;
12942
- data?: Array<ComplianceCheckResponseObject>;
12937
+ meta: Meta;
12938
+ links: Links;
12939
+ data: Array<ComplianceCheckResponseObject>;
12943
12940
  };
12944
12941
  };
12945
12942
  export type ListChecksResponse = ListChecksResponses[keyof ListChecksResponses];
@@ -13032,9 +13029,9 @@ export type ListCustomFieldConfigsResponses = {
13032
13029
  * Success
13033
13030
  */
13034
13031
  200: {
13035
- meta?: Meta;
13036
- links?: Links;
13037
- data?: Array<CustomFieldConfigsResponseObject>;
13032
+ meta: Meta;
13033
+ links: Links;
13034
+ data: Array<CustomFieldConfigsResponseObject>;
13038
13035
  };
13039
13036
  };
13040
13037
  export type ListCustomFieldConfigsResponse = ListCustomFieldConfigsResponses[keyof ListCustomFieldConfigsResponses];
@@ -13372,9 +13369,9 @@ export type ListGroupUsersResponses = {
13372
13369
  * Success
13373
13370
  */
13374
13371
  200: {
13375
- meta?: Meta;
13376
- links?: Links;
13377
- data?: Array<UserGroupResponse>;
13372
+ meta: Meta;
13373
+ links: Links;
13374
+ data: Array<UserGroupResponse>;
13378
13375
  };
13379
13376
  };
13380
13377
  export type ListGroupUsersResponse = ListGroupUsersResponses[keyof ListGroupUsersResponses];
@@ -13464,9 +13461,9 @@ export type ListGroupsResponses = {
13464
13461
  * Success
13465
13462
  */
13466
13463
  200: {
13467
- meta?: Meta;
13468
- links?: Links;
13469
- data?: Array<GroupResponseObject>;
13464
+ meta: Meta;
13465
+ links: Links;
13466
+ data: Array<GroupResponseObject>;
13470
13467
  };
13471
13468
  };
13472
13469
  export type ListGroupsResponse = ListGroupsResponses[keyof ListGroupsResponses];
@@ -13630,9 +13627,9 @@ export type ListJobScopePricesResponses = {
13630
13627
  * Success
13631
13628
  */
13632
13629
  200: {
13633
- meta?: Meta;
13634
- links?: Links;
13635
- data?: Array<ProductionJobScopePriceResponseObject>;
13630
+ meta: Meta;
13631
+ links: Links;
13632
+ data: Array<ProductionJobScopePriceResponseObject>;
13636
13633
  };
13637
13634
  };
13638
13635
  export type ListJobScopePricesResponse = ListJobScopePricesResponses[keyof ListJobScopePricesResponses];
@@ -13820,9 +13817,9 @@ export type ListRateRuleHistoryResponses = {
13820
13817
  * Success
13821
13818
  */
13822
13819
  200: {
13823
- meta?: Meta;
13824
- links?: Links;
13825
- data?: Array<RateRuleHistoryVersionObject>;
13820
+ meta: Meta;
13821
+ links: Links;
13822
+ data: Array<RateRuleHistoryVersionObject>;
13826
13823
  };
13827
13824
  };
13828
13825
  export type ListRateRuleHistoryResponse = ListRateRuleHistoryResponses[keyof ListRateRuleHistoryResponses];
@@ -13864,9 +13861,9 @@ export type ListRateRulesResponses = {
13864
13861
  * Success
13865
13862
  */
13866
13863
  200: {
13867
- meta?: Meta;
13868
- links?: Links;
13869
- data?: Array<RateRuleResponseObject>;
13864
+ meta: Meta;
13865
+ links: Links;
13866
+ data: Array<RateRuleResponseObject>;
13870
13867
  };
13871
13868
  };
13872
13869
  export type ListRateRulesResponse = ListRateRulesResponses[keyof ListRateRulesResponses];
@@ -13964,9 +13961,9 @@ export type ListJobWageDeterminationHistoryResponses = {
13964
13961
  * Success
13965
13962
  */
13966
13963
  200: {
13967
- meta?: Meta;
13968
- links?: Links;
13969
- data?: Array<JobWageDeterminationHistoryVersionObject>;
13964
+ meta: Meta;
13965
+ links: Links;
13966
+ data: Array<JobWageDeterminationHistoryVersionObject>;
13970
13967
  };
13971
13968
  };
13972
13969
  export type ListJobWageDeterminationHistoryResponse = ListJobWageDeterminationHistoryResponses[keyof ListJobWageDeterminationHistoryResponses];
@@ -14007,9 +14004,9 @@ export type ListJobWageDeterminationsResponses = {
14007
14004
  * Success
14008
14005
  */
14009
14006
  200: {
14010
- meta?: Meta;
14011
- links?: Links;
14012
- data?: Array<JobWageDeterminationResponseObject>;
14007
+ meta: Meta;
14008
+ links: Links;
14009
+ data: Array<JobWageDeterminationResponseObject>;
14013
14010
  };
14014
14011
  };
14015
14012
  export type ListJobWageDeterminationsResponse = ListJobWageDeterminationsResponses[keyof ListJobWageDeterminationsResponses];
@@ -14171,9 +14168,9 @@ export type ListJobsResponses = {
14171
14168
  * Success
14172
14169
  */
14173
14170
  200: {
14174
- meta?: Meta;
14175
- links?: Links;
14176
- data?: Array<JobResponseObject>;
14171
+ meta: Meta;
14172
+ links: Links;
14173
+ data: Array<JobResponseObject>;
14177
14174
  };
14178
14175
  };
14179
14176
  export type ListJobsResponse = ListJobsResponses[keyof ListJobsResponses];
@@ -14405,9 +14402,9 @@ export type ListCompensationElementsResponses = {
14405
14402
  * Success
14406
14403
  */
14407
14404
  200: {
14408
- meta?: Meta;
14409
- links?: Links;
14410
- data?: Array<CompensationElementResponseObject>;
14405
+ meta: Meta;
14406
+ links: Links;
14407
+ data: Array<CompensationElementResponseObject>;
14411
14408
  };
14412
14409
  };
14413
14410
  export type ListCompensationElementsResponse = ListCompensationElementsResponses[keyof ListCompensationElementsResponses];
@@ -14474,9 +14471,9 @@ export type ListExternalMapHistoryResponses = {
14474
14471
  * Success
14475
14472
  */
14476
14473
  200: {
14477
- meta?: Meta;
14478
- links?: Links;
14479
- data?: Array<PayrollExternalMapHistoryVersionObject>;
14474
+ meta: Meta;
14475
+ links: Links;
14476
+ data: Array<PayrollExternalMapHistoryVersionObject>;
14480
14477
  };
14481
14478
  };
14482
14479
  export type ListExternalMapHistoryResponse = ListExternalMapHistoryResponses[keyof ListExternalMapHistoryResponses];
@@ -14542,9 +14539,9 @@ export type ListExternalMapsResponses = {
14542
14539
  * Success
14543
14540
  */
14544
14541
  200: {
14545
- meta?: Meta;
14546
- links?: Links;
14547
- data?: Array<PayrollExternalMapResponseObject>;
14542
+ meta: Meta;
14543
+ links: Links;
14544
+ data: Array<PayrollExternalMapResponseObject>;
14548
14545
  };
14549
14546
  };
14550
14547
  export type ListExternalMapsResponse = ListExternalMapsResponses[keyof ListExternalMapsResponses];
@@ -14626,9 +14623,9 @@ export type ListFringeBenefitPlansResponses = {
14626
14623
  * Success
14627
14624
  */
14628
14625
  200: {
14629
- meta?: Meta;
14630
- links?: Links;
14631
- data?: Array<PayrollFringeBenefitPlanResponseObject>;
14626
+ meta: Meta;
14627
+ links: Links;
14628
+ data: Array<PayrollFringeBenefitPlanResponseObject>;
14632
14629
  };
14633
14630
  };
14634
14631
  export type ListFringeBenefitPlansResponse = ListFringeBenefitPlansResponses[keyof ListFringeBenefitPlansResponses];
@@ -15278,9 +15275,9 @@ export type ListPerDiemsResponses = {
15278
15275
  * Success
15279
15276
  */
15280
15277
  200: {
15281
- meta?: Meta;
15282
- links?: Links;
15283
- data?: Array<PerDiemResponseObject>;
15278
+ meta: Meta;
15279
+ links: Links;
15280
+ data: Array<PerDiemResponseObject>;
15284
15281
  };
15285
15282
  };
15286
15283
  export type ListPerDiemsResponse = ListPerDiemsResponses[keyof ListPerDiemsResponses];
@@ -15440,9 +15437,9 @@ export type ListPositionFunctionsResponses = {
15440
15437
  * Success
15441
15438
  */
15442
15439
  200: {
15443
- meta?: Meta;
15444
- links?: Links;
15445
- data?: Array<PositionFunctionResponseObject>;
15440
+ meta: Meta;
15441
+ links: Links;
15442
+ data: Array<PositionFunctionResponseObject>;
15446
15443
  };
15447
15444
  };
15448
15445
  export type ListPositionFunctionsResponse = ListPositionFunctionsResponses[keyof ListPositionFunctionsResponses];
@@ -15609,9 +15606,9 @@ export type ListCompletionsResponses = {
15609
15606
  * Success
15610
15607
  */
15611
15608
  200: {
15612
- meta?: Meta;
15613
- links?: Links;
15614
- data?: Array<ProductionCompletionResponseObject>;
15609
+ meta: Meta;
15610
+ links: Links;
15611
+ data: Array<ProductionCompletionResponseObject>;
15615
15612
  };
15616
15613
  };
15617
15614
  export type ListCompletionsResponse = ListCompletionsResponses[keyof ListCompletionsResponses];
@@ -15814,9 +15811,9 @@ export type ListProjectsResponses = {
15814
15811
  * Success
15815
15812
  */
15816
15813
  200: {
15817
- meta?: Meta;
15818
- links?: Links;
15819
- data?: Array<ProjectResponseObject>;
15814
+ meta: Meta;
15815
+ links: Links;
15816
+ data: Array<ProjectResponseObject>;
15820
15817
  };
15821
15818
  };
15822
15819
  export type ListProjectsResponse = ListProjectsResponses[keyof ListProjectsResponses];
@@ -16011,9 +16008,9 @@ export type ListTradesResponses = {
16011
16008
  * Success
16012
16009
  */
16013
16010
  200: {
16014
- meta?: Meta;
16015
- links?: Links;
16016
- data?: Array<PwaTradeResponseObject>;
16011
+ meta: Meta;
16012
+ links: Links;
16013
+ data: Array<PwaTradeResponseObject>;
16017
16014
  };
16018
16015
  };
16019
16016
  export type ListTradesResponse = ListTradesResponses[keyof ListTradesResponses];
@@ -16233,9 +16230,9 @@ export type ListTemplatesResponses = {
16233
16230
  * Success
16234
16231
  */
16235
16232
  200: {
16236
- meta?: Meta;
16237
- links?: Links;
16238
- data?: Array<JobTemplateResponseObject>;
16233
+ meta: Meta;
16234
+ links: Links;
16235
+ data: Array<JobTemplateResponseObject>;
16239
16236
  };
16240
16237
  };
16241
16238
  export type ListTemplatesResponse = ListTemplatesResponses[keyof ListTemplatesResponses];
@@ -16338,9 +16335,9 @@ export type ListTimeCardPerDiemsResponses = {
16338
16335
  * Success
16339
16336
  */
16340
16337
  200: {
16341
- meta?: Meta;
16342
- links?: Links;
16343
- data?: Array<TimeCardPerDiemResponseObject>;
16338
+ meta: Meta;
16339
+ links: Links;
16340
+ data: Array<TimeCardPerDiemResponseObject>;
16344
16341
  };
16345
16342
  };
16346
16343
  export type ListTimeCardPerDiemsResponse = ListTimeCardPerDiemsResponses[keyof ListTimeCardPerDiemsResponses];
@@ -16478,9 +16475,9 @@ export type ListPriorPeriodAdjustmentsResponses = {
16478
16475
  * Success
16479
16476
  */
16480
16477
  200: {
16481
- meta?: Meta;
16482
- links?: Links;
16483
- data?: Array<PriorPeriodAdjustmentResponseObject>;
16478
+ meta: Meta;
16479
+ links: Links;
16480
+ data: Array<PriorPeriodAdjustmentResponseObject>;
16484
16481
  };
16485
16482
  };
16486
16483
  export type ListPriorPeriodAdjustmentsResponse = ListPriorPeriodAdjustmentsResponses[keyof ListPriorPeriodAdjustmentsResponses];
@@ -16726,7 +16723,7 @@ export type ListTimeEntriesResponses = {
16726
16723
  };
16727
16724
  export type ListTimeEntriesResponse = ListTimeEntriesResponses[keyof ListTimeEntriesResponses];
16728
16725
  export type CreateTimeEntryData = {
16729
- body: TimeEntryParameters;
16726
+ body: TimeEntryCreateParameters;
16730
16727
  path?: never;
16731
16728
  query?: never;
16732
16729
  url: '/api/v1/time_entries';
@@ -16783,7 +16780,7 @@ export type DeleteTimeEntryResponses = {
16783
16780
  };
16784
16781
  export type DeleteTimeEntryResponse = DeleteTimeEntryResponses[keyof DeleteTimeEntryResponses];
16785
16782
  export type UpdateTimeEntryData = {
16786
- body: TimeEntryParameters;
16783
+ body: TimeEntryUpdateParameters;
16787
16784
  path: {
16788
16785
  /**
16789
16786
  * Unique identifier of the time entry.
@@ -16900,9 +16897,9 @@ export type ListTimecodeHistoryResponses = {
16900
16897
  * Success
16901
16898
  */
16902
16899
  200: {
16903
- meta?: Meta;
16904
- links?: Links;
16905
- data?: Array<TimecodeHistoryVersionObject>;
16900
+ meta: Meta;
16901
+ links: Links;
16902
+ data: Array<TimecodeHistoryVersionObject>;
16906
16903
  };
16907
16904
  };
16908
16905
  export type ListTimecodeHistoryResponse = ListTimecodeHistoryResponses[keyof ListTimecodeHistoryResponses];
@@ -17178,9 +17175,9 @@ export type ListTimecodesResponses = {
17178
17175
  * Success
17179
17176
  */
17180
17177
  200: {
17181
- meta?: Meta;
17182
- links?: Links;
17183
- data?: Array<TimecodeResponseObject>;
17178
+ meta: Meta;
17179
+ links: Links;
17180
+ data: Array<TimecodeResponseObject>;
17184
17181
  };
17185
17182
  };
17186
17183
  export type ListTimecodesResponse = ListTimecodesResponses[keyof ListTimecodesResponses];
@@ -17427,9 +17424,9 @@ export type ListAttestationConfigsResponses = {
17427
17424
  * Success
17428
17425
  */
17429
17426
  200: {
17430
- meta?: Meta;
17431
- links?: Links;
17432
- data?: Array<AttestationConfigResponseObject>;
17427
+ meta: Meta;
17428
+ links: Links;
17429
+ data: Array<AttestationConfigResponseObject>;
17433
17430
  };
17434
17431
  };
17435
17432
  export type ListAttestationConfigsResponse = ListAttestationConfigsResponses[keyof ListAttestationConfigsResponses];
@@ -17550,9 +17547,9 @@ export type ListPayPeriodConfigHistoryResponses = {
17550
17547
  * Success
17551
17548
  */
17552
17549
  200: {
17553
- meta?: Meta;
17554
- links?: Links;
17555
- data?: Array<PayPeriodConfigHistoryVersionObject>;
17550
+ meta: Meta;
17551
+ links: Links;
17552
+ data: Array<PayPeriodConfigHistoryVersionObject>;
17556
17553
  };
17557
17554
  };
17558
17555
  export type ListPayPeriodConfigHistoryResponse = ListPayPeriodConfigHistoryResponses[keyof ListPayPeriodConfigHistoryResponses];
@@ -17616,9 +17613,9 @@ export type ListHolidaysResponses = {
17616
17613
  * Success
17617
17614
  */
17618
17615
  200: {
17619
- meta?: Meta;
17620
- links?: Links;
17621
- data?: Array<HolidayResponseObject>;
17616
+ meta: Meta;
17617
+ links: Links;
17618
+ data: Array<HolidayResponseObject>;
17622
17619
  };
17623
17620
  };
17624
17621
  export type ListHolidaysResponse = ListHolidaysResponses[keyof ListHolidaysResponses];
@@ -17764,9 +17761,9 @@ export type ListPayPeriodConfigsResponses = {
17764
17761
  * Success
17765
17762
  */
17766
17763
  200: {
17767
- meta?: Meta;
17768
- links?: Links;
17769
- data?: Array<PayPeriodConfigResponseObject>;
17764
+ meta: Meta;
17765
+ links: Links;
17766
+ data: Array<PayPeriodConfigResponseObject>;
17770
17767
  };
17771
17768
  };
17772
17769
  export type ListPayPeriodConfigsResponse = ListPayPeriodConfigsResponses[keyof ListPayPeriodConfigsResponses];
@@ -17848,9 +17845,9 @@ export type ListTimeCardActualsResponses = {
17848
17845
  * Success
17849
17846
  */
17850
17847
  200: {
17851
- meta?: Meta;
17852
- links?: Links;
17853
- data?: Array<TimeCardActualsResponseObject>;
17848
+ meta: Meta;
17849
+ links: Links;
17850
+ data: Array<TimeCardActualsResponseObject>;
17854
17851
  };
17855
17852
  };
17856
17853
  export type ListTimeCardActualsResponse = ListTimeCardActualsResponses[keyof ListTimeCardActualsResponses];
@@ -17930,9 +17927,9 @@ export type ListUserRolesResponses = {
17930
17927
  * Success
17931
17928
  */
17932
17929
  200: {
17933
- meta?: Meta;
17934
- links?: Links;
17935
- data?: Array<UserRoleResponse>;
17930
+ meta: Meta;
17931
+ links: Links;
17932
+ data: Array<UserRoleResponse>;
17936
17933
  };
17937
17934
  };
17938
17935
  export type ListUserRolesResponse = ListUserRolesResponses[keyof ListUserRolesResponses];
@@ -18313,9 +18310,9 @@ export type ListUsersResponses = {
18313
18310
  * Success
18314
18311
  */
18315
18312
  200: {
18316
- meta?: Meta;
18317
- links?: Links;
18318
- data?: Array<UserResponseObject>;
18313
+ meta: Meta;
18314
+ links: Links;
18315
+ data: Array<UserResponseObject>;
18319
18316
  };
18320
18317
  };
18321
18318
  export type ListUsersResponse = ListUsersResponses[keyof ListUsersResponses];
@@ -18557,9 +18554,9 @@ export type ListWorkTypesResponses = {
18557
18554
  * Success
18558
18555
  */
18559
18556
  200: {
18560
- meta?: Meta;
18561
- links?: Links;
18562
- data?: Array<WorkTypeResponseObject>;
18557
+ meta: Meta;
18558
+ links: Links;
18559
+ data: Array<WorkTypeResponseObject>;
18563
18560
  };
18564
18561
  };
18565
18562
  export type ListWorkTypesResponse = ListWorkTypesResponses[keyof ListWorkTypesResponses];