@dsptch-work/api-client 0.2.0 → 0.3.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.
@@ -965,7 +965,7 @@ export type AssetsProductResponseObject = {
965
965
  /**
966
966
  * ID of the category classifying this product; null when uncategorized.
967
967
  */
968
- category_id: string | null;
968
+ assets_category_id: string | null;
969
969
  attributes: AssetsAttributeValueObjects;
970
970
  /**
971
971
  * Images attached to the product; each carries a download url for its file.
@@ -999,7 +999,7 @@ export type AssetsProductParameters = {
999
999
  /**
1000
1000
  * ID of the category classifying this product; null when uncategorized.
1001
1001
  */
1002
- category_id?: string | null;
1002
+ assets_category_id?: string | null;
1003
1003
  /**
1004
1004
  * Universal Product Code; unique within the company. Null when not set.
1005
1005
  */
@@ -1025,13 +1025,13 @@ export type AssetsProductParameters = {
1025
1025
  */
1026
1026
  counted_by?: 'each' | 'pair' | 'pack';
1027
1027
  /**
1028
- * Upserts the values of this product's category attributes, one entry per attribute. Send a blank value and null attribute_option_id to clear one.
1028
+ * Upserts the values of this product's category attributes, one entry per attribute. Send a blank value and null assets_attribute_option_id to clear one.
1029
1029
  */
1030
1030
  attribute_values?: Array<{
1031
1031
  /**
1032
1032
  * ID of the attribute definition.
1033
1033
  */
1034
- attribute_id: string;
1034
+ assets_attribute_id: string;
1035
1035
  /**
1036
1036
  * The entered value for a non-select attribute (text, number, date, or boolean as a string); null for a select attribute or when unfilled.
1037
1037
  */
@@ -1039,7 +1039,7 @@ export type AssetsProductParameters = {
1039
1039
  /**
1040
1040
  * ID of the chosen option for a select attribute; null otherwise.
1041
1041
  */
1042
- attribute_option_id?: string | null;
1042
+ assets_attribute_option_id?: string | null;
1043
1043
  }>;
1044
1044
  /**
1045
1045
  * Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
@@ -1065,7 +1065,7 @@ export type AssetsProductUpdateParameters = {
1065
1065
  /**
1066
1066
  * ID of the category classifying this product; null when uncategorized.
1067
1067
  */
1068
- category_id?: string | null;
1068
+ assets_category_id?: string | null;
1069
1069
  /**
1070
1070
  * Universal Product Code; unique within the company. Null when not set.
1071
1071
  */
@@ -1091,13 +1091,13 @@ export type AssetsProductUpdateParameters = {
1091
1091
  */
1092
1092
  counted_by?: 'each' | 'pair' | 'pack';
1093
1093
  /**
1094
- * Upserts the values of this product's category attributes, one entry per attribute. Send a blank value and null attribute_option_id to clear one.
1094
+ * Upserts the values of this product's category attributes, one entry per attribute. Send a blank value and null assets_attribute_option_id to clear one.
1095
1095
  */
1096
1096
  attribute_values?: Array<{
1097
1097
  /**
1098
1098
  * ID of the attribute definition.
1099
1099
  */
1100
- attribute_id: string;
1100
+ assets_attribute_id: string;
1101
1101
  /**
1102
1102
  * The entered value for a non-select attribute (text, number, date, or boolean as a string); null for a select attribute or when unfilled.
1103
1103
  */
@@ -1105,7 +1105,7 @@ export type AssetsProductUpdateParameters = {
1105
1105
  /**
1106
1106
  * ID of the chosen option for a select attribute; null otherwise.
1107
1107
  */
1108
- attribute_option_id?: string | null;
1108
+ assets_attribute_option_id?: string | null;
1109
1109
  }>;
1110
1110
  /**
1111
1111
  * Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
@@ -1143,11 +1143,11 @@ export type PerDiemResponseObject = {
1143
1143
  /**
1144
1144
  * Whether this is the company default per diem.
1145
1145
  */
1146
- is_default: boolean | null;
1146
+ default: boolean | null;
1147
1147
  /**
1148
1148
  * Whether the per diem is currently active and available to use.
1149
1149
  */
1150
- is_active: boolean | null;
1150
+ active: boolean | null;
1151
1151
  /**
1152
1152
  * IDs of the work types this per diem applies to.
1153
1153
  */
@@ -1192,11 +1192,11 @@ export type PerDiemParameters = {
1192
1192
  /**
1193
1193
  * Whether this should become the company default per diem.
1194
1194
  */
1195
- is_default?: boolean | null;
1195
+ default?: boolean | null;
1196
1196
  /**
1197
1197
  * Whether the per diem is active and available to use.
1198
1198
  */
1199
- is_active?: boolean | null;
1199
+ active?: boolean | null;
1200
1200
  /**
1201
1201
  * IDs of the work types this per diem applies to.
1202
1202
  */
@@ -1213,7 +1213,7 @@ export type AssetsAttributeValueObjects = Array<{
1213
1213
  /**
1214
1214
  * ID of the attribute definition.
1215
1215
  */
1216
- attribute_id: string;
1216
+ assets_attribute_id: string;
1217
1217
  /**
1218
1218
  * The entered value for a non-select attribute (text, number, date, or boolean as a string); null for a select attribute or when unfilled.
1219
1219
  */
@@ -1221,7 +1221,7 @@ export type AssetsAttributeValueObjects = Array<{
1221
1221
  /**
1222
1222
  * ID of the chosen option for a select attribute; null otherwise.
1223
1223
  */
1224
- attribute_option_id: string | null;
1224
+ assets_attribute_option_id: string | null;
1225
1225
  }>;
1226
1226
  /**
1227
1227
  * A reusable custom-field definition (for example "Color" or "Voltage") that categories assign and products or items fill in.
@@ -1338,7 +1338,7 @@ export type AssetsCategoryResponseObject = {
1338
1338
  /**
1339
1339
  * ID of the attribute definition.
1340
1340
  */
1341
- attribute_id: string;
1341
+ assets_attribute_id: string;
1342
1342
  /**
1343
1343
  * Where this attribute is filled in for the category: product (on the catalog product) or item (on each individual item).
1344
1344
  */
@@ -1384,7 +1384,7 @@ export type AssetsCategoryParameters = {
1384
1384
  /**
1385
1385
  * ID of the attribute definition.
1386
1386
  */
1387
- attribute_id: string;
1387
+ assets_attribute_id: string;
1388
1388
  /**
1389
1389
  * Where this attribute is filled in for the category: product (on the catalog product) or item (on each individual item).
1390
1390
  */
@@ -1693,11 +1693,11 @@ export type PayPeriodConfigResponseObject = {
1693
1693
  /**
1694
1694
  * Whether a pay date that falls on a holiday shifts to after the holiday.
1695
1695
  */
1696
- is_paid_after_holiday: boolean;
1696
+ paid_after_holiday: boolean;
1697
1697
  /**
1698
1698
  * Whether this is a demo schedule holding non-production data. Null when unset.
1699
1699
  */
1700
- is_demo: boolean | null;
1700
+ demo: boolean | null;
1701
1701
  /**
1702
1702
  * Start of this schedule version's validity window (ISO 8601).
1703
1703
  */
@@ -1725,8 +1725,8 @@ export type PayPeriodConfigHistoryVersionObject = {
1725
1725
  payroll_system: 'rippling' | 'quickbooks_online' | 'paychex' | 'gusto';
1726
1726
  actuals_enabled: boolean | null;
1727
1727
  requires_external_map_contributor: boolean;
1728
- is_paid_after_holiday: boolean;
1729
- is_demo: boolean | null;
1728
+ paid_after_holiday: boolean;
1729
+ demo: boolean | null;
1730
1730
  valid_from: string;
1731
1731
  valid_to: string | null;
1732
1732
  created_at: string;
@@ -2431,7 +2431,7 @@ export type JobParameters = {
2431
2431
  /**
2432
2432
  * Whether this is the job's primary work type.
2433
2433
  */
2434
- is_primary?: boolean;
2434
+ primary?: boolean;
2435
2435
  /**
2436
2436
  * ID of the work type to associate with the job.
2437
2437
  */
@@ -3728,7 +3728,7 @@ export type WorkTypeResponseObject = {
3728
3728
  /**
3729
3729
  * Whether the company internally created this work type. Defaults to false, and is always true for shared global work types (those with no owning company).
3730
3730
  */
3731
- is_verified: boolean;
3731
+ verified: boolean;
3732
3732
  /**
3733
3733
  * Owning company's id (UUID) when the work type is company-specific; null for shared global work types.
3734
3734
  */
@@ -3803,9 +3803,9 @@ export type CompanyResponseObject = {
3803
3803
  color_hex: string;
3804
3804
  tagline: string | null;
3805
3805
  founding_year: number | null;
3806
- corporate_structure: 'corporation' | 'llc' | 'partnership' | 'sole_proprietorship' | 's_corporation';
3807
- employee_count_range: 'one_to_ten' | 'eleven_to_fifty' | 'fifty_one_to_two_hundred' | 'two_hundred_one_to_five_hundred' | 'five_hundred_one_to_one_thousand' | 'one_thousand_one_to_five_thousand' | 'five_thousand_one_to_ten_thousand' | 'ten_thousand_one_plus';
3808
- revenue_range: 'zero_to_one_million' | 'one_to_ten_million' | 'ten_to_twenty_five_million' | 'twenty_five_to_fifty_million' | 'fifty_to_one_hundred_million' | 'one_hundred_to_two_fifty_million' | 'two_fifty_to_five_hundred_million' | 'five_hundred_to_one_billion' | 'one_billion_to_ten_billion' | 'ten_billion_plus';
3806
+ corporate_structure: 'corporation' | 'llc' | 'partnership' | 'sole_proprietorship' | 's_corporation' | null;
3807
+ employee_count_range: 'one_to_ten' | 'eleven_to_fifty' | 'fifty_one_to_two_hundred' | 'two_hundred_one_to_five_hundred' | 'five_hundred_one_to_one_thousand' | 'one_thousand_one_to_five_thousand' | 'five_thousand_one_to_ten_thousand' | 'ten_thousand_one_plus' | null;
3808
+ revenue_range: 'zero_to_one_million' | 'one_to_ten_million' | 'ten_to_twenty_five_million' | 'twenty_five_to_fifty_million' | 'fifty_to_one_hundred_million' | 'one_hundred_to_two_fifty_million' | 'two_fifty_to_five_hundred_million' | 'five_hundred_to_one_billion' | 'one_billion_to_ten_billion' | 'ten_billion_plus' | null;
3809
3809
  /**
3810
3810
  * North American Industry Classification System code.
3811
3811
  */
@@ -3814,6 +3814,65 @@ export type CompanyResponseObject = {
3814
3814
  created_at: string;
3815
3815
  updated_at: string;
3816
3816
  };
3817
+ export type CompanyParameters = ({
3818
+ name: string;
3819
+ } | {
3820
+ legal_name: string | null;
3821
+ } | {
3822
+ description: string | null;
3823
+ } | {
3824
+ address: string | null;
3825
+ } | {
3826
+ website: string | null;
3827
+ } | {
3828
+ phone_number: string | null;
3829
+ } | {
3830
+ email: string | null;
3831
+ } | {
3832
+ /**
3833
+ * Brand color as a hex string (e.g. "#312e81").
3834
+ */
3835
+ color_hex: string;
3836
+ } | {
3837
+ tagline: string | null;
3838
+ } | {
3839
+ founding_year: number | null;
3840
+ } | {
3841
+ corporate_structure: 'corporation' | 'llc' | 'partnership' | 'sole_proprietorship' | 's_corporation' | null;
3842
+ } | {
3843
+ employee_count_range: 'one_to_ten' | 'eleven_to_fifty' | 'fifty_one_to_two_hundred' | 'two_hundred_one_to_five_hundred' | 'five_hundred_one_to_one_thousand' | 'one_thousand_one_to_five_thousand' | 'five_thousand_one_to_ten_thousand' | 'ten_thousand_one_plus' | null;
3844
+ } | {
3845
+ revenue_range: 'zero_to_one_million' | 'one_to_ten_million' | 'ten_to_twenty_five_million' | 'twenty_five_to_fifty_million' | 'fifty_to_one_hundred_million' | 'one_hundred_to_two_fifty_million' | 'two_fifty_to_five_hundred_million' | 'five_hundred_to_one_billion' | 'one_billion_to_ten_billion' | 'ten_billion_plus' | null;
3846
+ } | {
3847
+ /**
3848
+ * North American Industry Classification System code.
3849
+ */
3850
+ naics_code: string | null;
3851
+ } | {
3852
+ linkedin_url: string | null;
3853
+ }) & {
3854
+ name?: string;
3855
+ legal_name?: string | null;
3856
+ description?: string | null;
3857
+ address?: string | null;
3858
+ website?: string | null;
3859
+ phone_number?: string | null;
3860
+ email?: string | null;
3861
+ /**
3862
+ * Brand color as a hex string (e.g. "#312e81").
3863
+ */
3864
+ color_hex?: string;
3865
+ tagline?: string | null;
3866
+ founding_year?: number | null;
3867
+ corporate_structure?: 'corporation' | 'llc' | 'partnership' | 'sole_proprietorship' | 's_corporation' | null;
3868
+ employee_count_range?: 'one_to_ten' | 'eleven_to_fifty' | 'fifty_one_to_two_hundred' | 'two_hundred_one_to_five_hundred' | 'five_hundred_one_to_one_thousand' | 'one_thousand_one_to_five_thousand' | 'five_thousand_one_to_ten_thousand' | 'ten_thousand_one_plus' | null;
3869
+ revenue_range?: 'zero_to_one_million' | 'one_to_ten_million' | 'ten_to_twenty_five_million' | 'twenty_five_to_fifty_million' | 'fifty_to_one_hundred_million' | 'one_hundred_to_two_fifty_million' | 'two_fifty_to_five_hundred_million' | 'five_hundred_to_one_billion' | 'one_billion_to_ten_billion' | 'ten_billion_plus' | null;
3870
+ /**
3871
+ * North American Industry Classification System code.
3872
+ */
3873
+ naics_code?: string | null;
3874
+ linkedin_url?: string | null;
3875
+ };
3817
3876
  /**
3818
3877
  * A custom field definition — a company-defined attribute attached to one kind of record (jobs, workers, apprentices, or the company itself). Deleting one is blocked while any record still holds a value for it.
3819
3878
  */
@@ -3837,7 +3896,7 @@ export type CustomFieldConfigsResponseObject = {
3837
3896
  /**
3838
3897
  * Whether the field is shown.
3839
3898
  */
3840
- is_visible: boolean;
3899
+ visible: boolean;
3841
3900
  /**
3842
3901
  * ID of the company that owns this record.
3843
3902
  */
@@ -3870,7 +3929,7 @@ export type CustomFieldConfigParameters = {
3870
3929
  /**
3871
3930
  * Whether the field is shown.
3872
3931
  */
3873
- is_visible?: boolean;
3932
+ visible?: boolean;
3874
3933
  };
3875
3934
  /**
3876
3935
  * A user's membership in a group.
@@ -5117,6 +5176,36 @@ export type ProjectParameters = {
5117
5176
  */
5118
5177
  placed_in_service_date?: string | null;
5119
5178
  };
5179
+ export type SiteCheckInResponseObject = {
5180
+ id: string;
5181
+ site_id: string;
5182
+ /**
5183
+ * The checked-in DSPTCH user; null when the person was recorded by name instead.
5184
+ */
5185
+ user_id: string | null;
5186
+ first_name: string | null;
5187
+ last_name: string | null;
5188
+ site_contact_id: string | null;
5189
+ site_contact_first_name: string | null;
5190
+ site_contact_last_name: string | null;
5191
+ employer_name: string | null;
5192
+ description: string | null;
5193
+ rationale: string | null;
5194
+ /**
5195
+ * How the check-in was captured.
5196
+ */
5197
+ source: 'manual' | 'auto';
5198
+ nerc_check_in: boolean;
5199
+ cip_exceptional: boolean;
5200
+ created_by_user_id: string | null;
5201
+ latitude: number | null;
5202
+ longitude: number | null;
5203
+ start_time: string;
5204
+ end_time: string | null;
5205
+ verified_at: string | null;
5206
+ created_at: string;
5207
+ updated_at: string;
5208
+ };
5120
5209
  /**
5121
5210
  * A geographic location where work is performed — a site on the Atlas map. Read-only through the API; sites are drawn on the map or imported from external sources, not created here.
5122
5211
  */
@@ -5235,7 +5324,7 @@ export type FeatureResponseObject = {
5235
5324
  /**
5236
5325
  * True when the feature is a private draft scoped to its creating user rather than shared with the company.
5237
5326
  */
5238
- is_scoped_to_user: boolean;
5327
+ scoped_to_user: boolean;
5239
5328
  /**
5240
5329
  * ID of the feature's address; null when none is set.
5241
5330
  */
@@ -5896,7 +5985,7 @@ export type PositionResponseObject = {
5896
5985
  /**
5897
5986
  * Whether this position tracks Prevailing Wage / Apprenticeship (PWA) compliance; when true, the PWA rate fields and wage-determination associations apply.
5898
5987
  */
5899
- is_pwa: boolean;
5988
+ pwa: boolean;
5900
5989
  /**
5901
5990
  * UIDs of the federal (Davis-Bacon) wage determinations applied to this position; empty when none.
5902
5991
  */
@@ -5977,7 +6066,7 @@ export type PositionParameters = {
5977
6066
  /**
5978
6067
  * Whether the position tracks PWA compliance; must be true to attach wage determinations or set the PWA rate fields.
5979
6068
  */
5980
- is_pwa?: boolean;
6069
+ pwa?: boolean;
5981
6070
  /**
5982
6071
  * Desired hourly cash-fringe rate in cents.
5983
6072
  */
@@ -6327,7 +6416,7 @@ export type CertificationParameters = {
6327
6416
  */
6328
6417
  description?: string | null;
6329
6418
  /**
6330
- * Whether this is a recognized, vetted credential type. This is a property of the certification definition, distinct from a held certification's is_verified.
6419
+ * 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.
6331
6420
  */
6332
6421
  verified?: boolean | null;
6333
6422
  /**
@@ -6460,7 +6549,7 @@ export type UserCertificationParameters = {
6460
6549
  /**
6461
6550
  * When the worker earned the certification (ISO 8601). Required.
6462
6551
  */
6463
- date_received: string;
6552
+ received_at: string;
6464
6553
  /**
6465
6554
  * Optional proof document to attach (for example a certificate scan). Write-only — it is not returned in responses.
6466
6555
  */
@@ -6475,11 +6564,11 @@ export type UserCertificationParameters = {
6475
6564
  content?: string;
6476
6565
  } | null;
6477
6566
  /**
6478
- * Whether DSPTCH has verified this held certification. Distinct from the certification's own verified flag.
6567
+ * Whether DSPTCH has verified this held certification. Distinct from the verified flag on the certification definition itself.
6479
6568
  */
6480
- is_verified?: boolean | null;
6569
+ verified?: boolean | null;
6481
6570
  /**
6482
- * When the held certification expires (YYYY-MM-DD). Must be after date_received; null when it does not expire.
6571
+ * When the held certification expires (YYYY-MM-DD). Must be after received_at; null when it does not expire.
6483
6572
  */
6484
6573
  expiration_date?: string | null;
6485
6574
  /**
@@ -6529,11 +6618,11 @@ export type UserCertificationResponseObject = {
6529
6618
  /**
6530
6619
  * When the worker earned the certification (ISO 8601).
6531
6620
  */
6532
- date_received: string;
6621
+ received_at: string;
6533
6622
  /**
6534
6623
  * Whether DSPTCH has verified this held certification.
6535
6624
  */
6536
- is_verified: boolean;
6625
+ verified: boolean;
6537
6626
  /**
6538
6627
  * Id of the company or organization that granted the certification to the worker. Set to your company for records created through the API; null when unknown.
6539
6628
  */
@@ -7289,9 +7378,9 @@ export type AssetsItemResponseObject = {
7289
7378
  */
7290
7379
  serial_number: string | null;
7291
7380
  /**
7292
- * Lifecycle status of the item: one of available, assigned, transit, maintenance, or retired.
7381
+ * Lifecycle status of the item: one of available, assigned, or retired.
7293
7382
  */
7294
- status: 'available' | 'assigned' | 'transit' | 'maintenance' | 'retired';
7383
+ status: 'available' | 'assigned' | 'retired';
7295
7384
  /**
7296
7385
  * When the item was purchased (ISO 8601).
7297
7386
  */
@@ -7346,9 +7435,9 @@ export type AssetsItemParameters = {
7346
7435
  */
7347
7436
  serial_number: string;
7348
7437
  /**
7349
- * Lifecycle status of the item: one of available, assigned, transit, maintenance, or retired.
7438
+ * Lifecycle status of the item: one of available, assigned, or retired.
7350
7439
  */
7351
- status?: 'available' | 'assigned' | 'transit' | 'maintenance' | 'retired';
7440
+ status?: 'available' | 'assigned' | 'retired';
7352
7441
  /**
7353
7442
  * When the item was purchased (ISO 8601).
7354
7443
  */
@@ -7681,7 +7770,7 @@ export type AssetsDocumentResponseObject = {
7681
7770
  /**
7682
7771
  * ID of the asset item this document belongs to.
7683
7772
  */
7684
- item_id: string;
7773
+ assets_item_id: string;
7685
7774
  /**
7686
7775
  * Read-only document label; this API does not set it, so it is always "document".
7687
7776
  */
@@ -7785,7 +7874,7 @@ export type AssetsItemFormAssignmentResponseObject = {
7785
7874
  /**
7786
7875
  * ID of the asset item this form task belongs to.
7787
7876
  */
7788
- item_id: string;
7877
+ assets_item_id: string;
7789
7878
  /**
7790
7879
  * ID of the form definition (a SurveyJS form template) this assignment is for.
7791
7880
  */
@@ -7807,7 +7896,7 @@ export type AssetsItemFormAssignmentResponseObject = {
7807
7896
  */
7808
7897
  time_due: string | null;
7809
7898
  /**
7810
- * How often this form task recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment; on write, applied only when is_recurring is true.
7899
+ * How often this form task recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment; on write, applied only when recurring is true.
7811
7900
  */
7812
7901
  frequency: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY';
7813
7902
  /**
@@ -7833,7 +7922,7 @@ export type AssetsItemFormAssignmentResponseObject = {
7833
7922
  }>;
7834
7923
  };
7835
7924
  /**
7836
- * Create or update an item form assignment. form_definition_id and task_attributes are required, and task_attributes.created_by_user_id is required (a missing value returns 400). is_recurring gates the recurrence fields.
7925
+ * Create or update an item form assignment. form_definition_id and task_attributes are required, and task_attributes.created_by_user_id is required (a missing value returns 400). recurring gates the recurrence fields.
7837
7926
  */
7838
7927
  export type AssetsItemFormAssignmentParameters = {
7839
7928
  /**
@@ -7843,7 +7932,7 @@ export type AssetsItemFormAssignmentParameters = {
7843
7932
  /**
7844
7933
  * When true, frequency and recurrence_end_time apply; when false or omitted, the task is one-time and those fields are cleared.
7845
7934
  */
7846
- is_recurring?: boolean;
7935
+ recurring?: boolean;
7847
7936
  /**
7848
7937
  * The underlying task's name, schedule, assignees, and reminders.
7849
7938
  */
@@ -7873,7 +7962,7 @@ export type AssetsItemFormAssignmentParameters = {
7873
7962
  */
7874
7963
  tz_name?: string | null;
7875
7964
  /**
7876
- * How often this form task recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment; on write, applied only when is_recurring is true.
7965
+ * How often this form task recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment; on write, applied only when recurring is true.
7877
7966
  */
7878
7967
  frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY';
7879
7968
  /**
@@ -7906,7 +7995,7 @@ export type AssetsInventoryResponseObject = {
7906
7995
  /**
7907
7996
  * ID of the asset item stocked here.
7908
7997
  */
7909
- item_id: string;
7998
+ assets_item_id: string;
7910
7999
  /**
7911
8000
  * ID of the site holding the stock.
7912
8001
  */
@@ -7939,7 +8028,7 @@ export type AssetsCustodyResponseObject = {
7939
8028
  /**
7940
8029
  * ID of the asset item held.
7941
8030
  */
7942
- item_id: string;
8031
+ assets_item_id: string;
7943
8032
  /**
7944
8033
  * ID of the user who holds the item.
7945
8034
  */
@@ -7980,7 +8069,7 @@ export type AssetsTransactionEventResponseObject = {
7980
8069
  /**
7981
8070
  * ID of the asset item this event concerns.
7982
8071
  */
7983
- item_id: string;
8072
+ assets_item_id: string;
7984
8073
  /**
7985
8074
  * ID of the company that owns this record.
7986
8075
  */
@@ -8050,7 +8139,7 @@ export type AssetsServiceEventResponseObject = {
8050
8139
  /**
8051
8140
  * ID of the asset item this event concerns.
8052
8141
  */
8053
- item_id: string;
8142
+ assets_item_id: string;
8054
8143
  /**
8055
8144
  * ID of the company that owns this record.
8056
8145
  */
@@ -8108,7 +8197,7 @@ export type AssetsServiceScheduleResponseObject = {
8108
8197
  /**
8109
8198
  * ID of the asset item this schedule applies to.
8110
8199
  */
8111
- item_id: string;
8200
+ assets_item_id: string;
8112
8201
  /**
8113
8202
  * ID of the company that owns this record.
8114
8203
  */
@@ -8190,7 +8279,7 @@ export type AssetsServiceEventFullResponseObject = {
8190
8279
  /**
8191
8280
  * ID of the asset item that was serviced.
8192
8281
  */
8193
- item_id: string;
8282
+ assets_item_id: string;
8194
8283
  /**
8195
8284
  * ID of the company that owns this record.
8196
8285
  */
@@ -8374,7 +8463,7 @@ export type AssetsTransferResponseObject = {
8374
8463
  /**
8375
8464
  * ID of the asset item to move.
8376
8465
  */
8377
- item_id: string;
8466
+ assets_item_id: string;
8378
8467
  /**
8379
8468
  * Number of units of the item to move; greater than 0.
8380
8469
  */
@@ -8420,7 +8509,7 @@ export type AssetsTransferParameters = {
8420
8509
  /**
8421
8510
  * ID of the asset item to move.
8422
8511
  */
8423
- item_id: string;
8512
+ assets_item_id: string;
8424
8513
  /**
8425
8514
  * Number of units of the item to move; greater than 0.
8426
8515
  */
@@ -9477,7 +9566,7 @@ export type ListCustodiesData = {
9477
9566
  body?: never;
9478
9567
  path?: never;
9479
9568
  query?: {
9480
- 'filter[item_id]'?: string;
9569
+ 'filter[assets_item_id]'?: string;
9481
9570
  'filter[user_id]'?: string;
9482
9571
  filter?: string;
9483
9572
  'filter[unexpected]'?: string;
@@ -9532,7 +9621,7 @@ export type ListEventsData = {
9532
9621
  body?: never;
9533
9622
  path?: never;
9534
9623
  query?: {
9535
- 'filter[item_id]'?: string;
9624
+ 'filter[assets_item_id]'?: string;
9536
9625
  'filter[eventable_type]'?: string;
9537
9626
  filter?: string;
9538
9627
  'filter[unexpected]'?: string;
@@ -9733,7 +9822,7 @@ export type ListInventoriesData = {
9733
9822
  body?: never;
9734
9823
  path?: never;
9735
9824
  query?: {
9736
- 'filter[item_id]'?: string;
9825
+ 'filter[assets_item_id]'?: string;
9737
9826
  'filter[assets_site_id]'?: string;
9738
9827
  filter?: string;
9739
9828
  'filter[unexpected]'?: string;
@@ -10567,7 +10656,7 @@ export type ListProductsData = {
10567
10656
  /**
10568
10657
  * Filter by asset category
10569
10658
  */
10570
- 'filter[category_id]'?: string;
10659
+ 'filter[assets_category_id]'?: string;
10571
10660
  'filter[created_at][gte]'?: string;
10572
10661
  'filter[created_at][lte]'?: string;
10573
10662
  'filter[updated_at][gte]'?: string;
@@ -10907,7 +10996,7 @@ export type SeedServiceScheduleTemplateData = {
10907
10996
  /**
10908
10997
  * Serial item ids to seed; omit to seed every cleanly-seedable item
10909
10998
  */
10910
- item_ids?: Array<string>;
10999
+ assets_item_ids?: Array<string>;
10911
11000
  /**
10912
11001
  * Required
10913
11002
  */
@@ -12167,6 +12256,36 @@ export type GetCompanyResponses = {
12167
12256
  200: CompanyResponseObject;
12168
12257
  };
12169
12258
  export type GetCompanyResponse = GetCompanyResponses[keyof GetCompanyResponses];
12259
+ export type UpdateCompanyProfileData = {
12260
+ body: CompanyParameters;
12261
+ path: {
12262
+ id: string;
12263
+ };
12264
+ query?: never;
12265
+ url: '/api/v1/companies/{id}';
12266
+ };
12267
+ export type UpdateCompanyProfileErrors = {
12268
+ /**
12269
+ * Forbidden
12270
+ */
12271
+ 403: ErrorsObject;
12272
+ /**
12273
+ * Not Found
12274
+ */
12275
+ 404: ErrorsObject;
12276
+ /**
12277
+ * Unprocessable Content
12278
+ */
12279
+ 422: ErrorsObject;
12280
+ };
12281
+ export type UpdateCompanyProfileError = UpdateCompanyProfileErrors[keyof UpdateCompanyProfileErrors];
12282
+ export type UpdateCompanyProfileResponses = {
12283
+ /**
12284
+ * Success
12285
+ */
12286
+ 200: CompanyResponseObject;
12287
+ };
12288
+ export type UpdateCompanyProfileResponse = UpdateCompanyProfileResponses[keyof UpdateCompanyProfileResponses];
12170
12289
  export type ListChecksData = {
12171
12290
  body?: never;
12172
12291
  path?: never;
@@ -13480,6 +13599,90 @@ export type UpdateJobResponses = {
13480
13599
  200: JobResponseObject;
13481
13600
  };
13482
13601
  export type UpdateJobResponse = UpdateJobResponses[keyof UpdateJobResponses];
13602
+ export type ListSiteCheckInsData = {
13603
+ body?: never;
13604
+ path: {
13605
+ site_id: string;
13606
+ };
13607
+ query?: {
13608
+ /**
13609
+ * Narrow to one checked-in user
13610
+ */
13611
+ 'filter[user_id]'?: string;
13612
+ 'filter[created_at][gte]'?: string;
13613
+ 'filter[created_at][lte]'?: string;
13614
+ 'filter[updated_at][gte]'?: string;
13615
+ 'filter[updated_at][lte]'?: string;
13616
+ 'filter[start_time][gte]'?: string;
13617
+ 'filter[start_time][lte]'?: string;
13618
+ filter?: string;
13619
+ 'filter[unexpected]'?: string;
13620
+ /**
13621
+ * This pagination cursor corresponds to the cursor value found in the response in
13622
+ * `meta.page.next_cursor`.
13623
+ */
13624
+ 'page[cursor]'?: string;
13625
+ /**
13626
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
13627
+ */
13628
+ 'page[limit]'?: number;
13629
+ page?: string;
13630
+ };
13631
+ url: '/api/v1/oversite/sites/{site_id}/check_ins';
13632
+ };
13633
+ export type ListSiteCheckInsErrors = {
13634
+ /**
13635
+ * Bad Request
13636
+ */
13637
+ 400: ErrorsObject;
13638
+ /**
13639
+ * Forbidden
13640
+ */
13641
+ 403: ErrorsObject;
13642
+ /**
13643
+ * Unprocessable Content
13644
+ */
13645
+ 422: ErrorsObject;
13646
+ };
13647
+ export type ListSiteCheckInsError = ListSiteCheckInsErrors[keyof ListSiteCheckInsErrors];
13648
+ export type ListSiteCheckInsResponses = {
13649
+ /**
13650
+ * Success
13651
+ */
13652
+ 200: {
13653
+ meta: Meta;
13654
+ links: Links;
13655
+ data: Array<SiteCheckInResponseObject>;
13656
+ };
13657
+ };
13658
+ export type ListSiteCheckInsResponse = ListSiteCheckInsResponses[keyof ListSiteCheckInsResponses];
13659
+ export type GetSiteCheckInData = {
13660
+ body?: never;
13661
+ path: {
13662
+ site_id: string;
13663
+ id: string;
13664
+ };
13665
+ query?: never;
13666
+ url: '/api/v1/oversite/sites/{site_id}/check_ins/{id}';
13667
+ };
13668
+ export type GetSiteCheckInErrors = {
13669
+ /**
13670
+ * Forbidden
13671
+ */
13672
+ 403: ErrorsObject;
13673
+ /**
13674
+ * Not Found
13675
+ */
13676
+ 404: ErrorsObject;
13677
+ };
13678
+ export type GetSiteCheckInError = GetSiteCheckInErrors[keyof GetSiteCheckInErrors];
13679
+ export type GetSiteCheckInResponses = {
13680
+ /**
13681
+ * Success
13682
+ */
13683
+ 200: SiteCheckInResponseObject;
13684
+ };
13685
+ export type GetSiteCheckInResponse = GetSiteCheckInResponses[keyof GetSiteCheckInResponses];
13483
13686
  export type ListPayPeriodsData = {
13484
13687
  body?: never;
13485
13688
  path?: never;
@@ -13583,7 +13786,7 @@ export type ListExternalMapHistoryData = {
13583
13786
  };
13584
13787
  query?: {
13585
13788
  /**
13586
- * Read the timeline as it was recorded at this moment. Defaults to now.
13789
+ * Read the timeline as it was recorded at this moment — the corrections nested under each version stop at the same point, and each version publishes the `transaction_to` it had then, so one corrected since still reads as open. `version_status` is always relative to now. Defaults to now.
13587
13790
  */
13588
13791
  'as_of[transaction]'?: string;
13589
13792
  'as_of[valid]'?: string;
@@ -13649,7 +13852,7 @@ export type ListExternalMapsData = {
13649
13852
  */
13650
13853
  'as_of[valid]'?: string;
13651
13854
  /**
13652
- * Read the version as it was recorded at this point in transaction time. Defaults to now.
13855
+ * Read the version as it was recorded at this point in transaction time. Its `transaction_to` is published as of that point, so a version corrected since still reads as open. Defaults to now.
13653
13856
  */
13654
13857
  'as_of[transaction]'?: string;
13655
13858
  as_of?: string;
@@ -13695,7 +13898,7 @@ export type GetExternalMapData = {
13695
13898
  */
13696
13899
  'as_of[valid]'?: string;
13697
13900
  /**
13698
- * Read the version as it was recorded at this point in transaction time. Defaults to now.
13901
+ * Read the version as it was recorded at this point in transaction time. Its `transaction_to` is published as of that point, so a version corrected since still reads as open. Defaults to now.
13699
13902
  */
13700
13903
  'as_of[transaction]'?: string;
13701
13904
  };
@@ -14362,7 +14565,7 @@ export type ListPerDiemsData = {
14362
14565
  /**
14363
14566
  * Filter by default status
14364
14567
  */
14365
- 'filter[is_default]'?: boolean;
14568
+ 'filter[default]'?: boolean;
14366
14569
  /**
14367
14570
  * Filter by taxable status
14368
14571
  */
@@ -15155,7 +15358,7 @@ export type CreateFormAssignmentTaskData = {
15155
15358
  body?: {
15156
15359
  form_definition_id: string;
15157
15360
  spread_assignees?: boolean;
15158
- is_recurring?: boolean;
15361
+ recurring?: boolean;
15159
15362
  task_attributes: {
15160
15363
  name: string;
15161
15364
  description?: string;
@@ -15917,7 +16120,7 @@ export type ListTimecodeHistoryData = {
15917
16120
  };
15918
16121
  query?: {
15919
16122
  /**
15920
- * Read the timeline as it was recorded at this moment. Defaults to now.
16123
+ * Read the timeline as it was recorded at this moment — the corrections nested under each version stop at the same point, and each version publishes the `transaction_to` it had then, so one corrected since still reads as open. `version_status` is always relative to now. Defaults to now.
15921
16124
  */
15922
16125
  'as_of[transaction]'?: string;
15923
16126
  'as_of[valid]'?: string;
@@ -16053,6 +16256,10 @@ export type CancelTimecodeScheduledTerminationErrors = {
16053
16256
  * Not Found
16054
16257
  */
16055
16258
  404: ErrorsObject;
16259
+ /**
16260
+ * Conflict
16261
+ */
16262
+ 409: ErrorsObject;
16056
16263
  /**
16057
16264
  * Unprocessable Content
16058
16265
  */
@@ -16091,7 +16298,7 @@ export type ListTimecodesData = {
16091
16298
  */
16092
16299
  'as_of[valid]'?: string;
16093
16300
  /**
16094
- * Read the version as it was recorded at this point in transaction time. Defaults to now.
16301
+ * Read the version as it was recorded at this point in transaction time. Its `transaction_to` is published as of that point, so a version corrected since still reads as open. Defaults to now.
16095
16302
  */
16096
16303
  'as_of[transaction]'?: string;
16097
16304
  as_of?: string;
@@ -16193,7 +16400,7 @@ export type GetTimecodeData = {
16193
16400
  */
16194
16401
  'as_of[valid]'?: string;
16195
16402
  /**
16196
- * Read the version as it was recorded at this point in transaction time. Defaults to now.
16403
+ * Read the version as it was recorded at this point in transaction time. Its `transaction_to` is published as of that point, so a version corrected since still reads as open. Defaults to now.
16197
16404
  */
16198
16405
  'as_of[transaction]'?: string;
16199
16406
  };