@dsptch-work/api-client 0.37.0 → 0.38.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.
- package/CHANGELOG.md +98 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +81 -10
- package/dist/gen/sdk.gen.js +108 -9
- package/dist/gen/types.gen.d.ts +232 -53
- package/dist/gen/zod.gen.d.ts +129 -36
- package/dist/gen/zod.gen.js +77 -17
- package/package.json +1 -1
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -287,7 +287,7 @@ export type Problem = {
|
|
|
287
287
|
*
|
|
288
288
|
* **Unparseable Date Value**
|
|
289
289
|
*
|
|
290
|
-
* A date-time value cannot be parsed,
|
|
290
|
+
* A date-time value cannot be parsed, falls outside the storable range, or has no UTC offset where one is required. Format values as ISO 8601 (for example `2026-08-05` or `2026-08-05T14:30`); a time entry's `start_time` and `end_time`, a timestamp filter bound, and an `as_of[]` coordinate need an offset (for example `2026-08-05T14:30:00-04:00` or `2026-08-05T18:30:00Z`).
|
|
291
291
|
*
|
|
292
292
|
* ### invalid_filter_value
|
|
293
293
|
*
|
|
@@ -2540,7 +2540,7 @@ export type TimecodeHistoryVersionObject = {
|
|
|
2540
2540
|
*/
|
|
2541
2541
|
export type TimecodeParameters = {
|
|
2542
2542
|
/**
|
|
2543
|
-
*
|
|
2543
|
+
* The day the new timecode becomes effective, as a calendar date (`YYYY-MM-DD`). It applies from 00:00 UTC on that day, the same as the web. A value with a time of day is refused with `422`. Defaults to the time of the request. Accepted on create only.
|
|
2544
2544
|
*/
|
|
2545
2545
|
effective_date?: string;
|
|
2546
2546
|
/**
|
|
@@ -2609,11 +2609,11 @@ export type TimecodeParameters = {
|
|
|
2609
2609
|
*/
|
|
2610
2610
|
export type TimecodeCorrectionParameters = {
|
|
2611
2611
|
/**
|
|
2612
|
-
* Where the correction starts applying. Defaults to the addressed version's own start.
|
|
2612
|
+
* Where the correction starts applying, as a date-time with a UTC offset (`Z` or `-04:00`). Defaults to the addressed version's own start. A time without an offset answers 422 invalid_date at its pointer, showing the time fixed in UTC. Null or a non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date.
|
|
2613
2613
|
*/
|
|
2614
2614
|
effective_from?: string;
|
|
2615
2615
|
/**
|
|
2616
|
-
* Where the correction stops applying; it must be later than `effective_from`. Omit to correct through the end of the segment containing `effective_from`, preserving later scheduled changes.
|
|
2616
|
+
* Where the correction stops applying, as a date-time with a UTC offset (`Z` or `-04:00`); it must be later than `effective_from`. Omit to correct through the end of the segment containing `effective_from`, preserving later scheduled changes. A time without an offset answers 422 invalid_date at its pointer, showing the time fixed in UTC. Null or a non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date.
|
|
2617
2617
|
*/
|
|
2618
2618
|
effective_to?: string;
|
|
2619
2619
|
/**
|
|
@@ -2682,7 +2682,7 @@ export type TimecodeCorrectionParameters = {
|
|
|
2682
2682
|
*/
|
|
2683
2683
|
export type TimecodeGenesisParameters = {
|
|
2684
2684
|
/**
|
|
2685
|
-
* The new
|
|
2685
|
+
* The new first day of the timecode's valid-time timeline, as a calendar date (`YYYY-MM-DD`). The timeline begins at 00:00 UTC on that day, the same as the web. A value with a time of day is refused with `422`. Required; the shift is refused if it would orphan recorded time or leave no coverage.
|
|
2686
2686
|
*/
|
|
2687
2687
|
effective_date: string;
|
|
2688
2688
|
};
|
|
@@ -2700,7 +2700,7 @@ export type TimecodeScheduledTerminationParameters = {
|
|
|
2700
2700
|
*/
|
|
2701
2701
|
export type TimecodeScheduledChangeParameters = {
|
|
2702
2702
|
/**
|
|
2703
|
-
*
|
|
2703
|
+
* The day the change takes effect, as a calendar date (`YYYY-MM-DD`). It applies from 00:00 UTC on that day, the same as the web; on the day the timecode began, it applies from that beginning instead. A value with a time of day is refused with `422`. Must be on or after the day the timecode began.
|
|
2704
2704
|
*/
|
|
2705
2705
|
effective_date: string;
|
|
2706
2706
|
/**
|
|
@@ -5443,15 +5443,15 @@ export type UserResponseObject = {
|
|
|
5443
5443
|
*/
|
|
5444
5444
|
export type UserUpdateParameters = {
|
|
5445
5445
|
/**
|
|
5446
|
-
* Work email address.
|
|
5446
|
+
* Work email address. Once verified, changes only through the user's confirmation; sending the current value is accepted.
|
|
5447
5447
|
*/
|
|
5448
5448
|
email?: string | null;
|
|
5449
5449
|
/**
|
|
5450
|
-
* Personal (non-work) email address.
|
|
5450
|
+
* Personal (non-work) email address. Once verified, changes only through the user's confirmation; sending the current value is accepted.
|
|
5451
5451
|
*/
|
|
5452
5452
|
personal_email?: string | null;
|
|
5453
5453
|
/**
|
|
5454
|
-
* Contact phone number.
|
|
5454
|
+
* Contact phone number. Once verified, changes only through the user's confirmation; sending the current value is accepted.
|
|
5455
5455
|
*/
|
|
5456
5456
|
phone_number?: string | null;
|
|
5457
5457
|
/**
|
|
@@ -5919,11 +5919,11 @@ export type TimeEntryCreateParameters = {
|
|
|
5919
5919
|
*/
|
|
5920
5920
|
timekeeping_time_card_id: string;
|
|
5921
5921
|
/**
|
|
5922
|
-
* Start of the work as a
|
|
5922
|
+
* Start of the work as a date-time with a UTC offset (`Z` or `-04:00`), rounded to the nearest second. The offset decides the instant, daylight saving included, so either occurrence of a time the clocks repeat when they fall back can be sent (`01:30:00-04:00` or `01:30:00-05:00`). A time without an offset answers 422 invalid_date at its pointer, showing the time fixed with the offset of the time card's pay schedule zone (`tz_name`) and in UTC. Null or a non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date.
|
|
5923
5923
|
*/
|
|
5924
5924
|
start_time: string;
|
|
5925
5925
|
/**
|
|
5926
|
-
* End of the work as a
|
|
5926
|
+
* End of the work as a date-time with a UTC offset (`Z` or `-04:00`), rounded to the nearest second. The offset decides the instant, daylight saving included, so either occurrence of a time the clocks repeat when they fall back can be sent (`01:30:00-04:00` or `01:30:00-05:00`). A time without an offset answers 422 invalid_date at its pointer, showing the time fixed with the offset of the time card's pay schedule zone (`tz_name`) and in UTC. Null or a non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date.
|
|
5927
5927
|
*/
|
|
5928
5928
|
end_time: string;
|
|
5929
5929
|
/**
|
|
@@ -5960,11 +5960,11 @@ export type TimeEntryCreateParameters = {
|
|
|
5960
5960
|
*/
|
|
5961
5961
|
export type TimeEntryUpdateParameters = {
|
|
5962
5962
|
/**
|
|
5963
|
-
* Start of the work as a
|
|
5963
|
+
* Start of the work as a date-time with a UTC offset (`Z` or `-04:00`), rounded to the nearest second. The offset decides the instant, daylight saving included, so either occurrence of a time the clocks repeat when they fall back can be sent (`01:30:00-04:00` or `01:30:00-05:00`). A time without an offset answers 422 invalid_date at its pointer, showing the time fixed with the offset of the time card's pay schedule zone (`tz_name`) and in UTC. Null or a non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date.
|
|
5964
5964
|
*/
|
|
5965
5965
|
start_time?: string;
|
|
5966
5966
|
/**
|
|
5967
|
-
* End of the work as a
|
|
5967
|
+
* End of the work as a date-time with a UTC offset (`Z` or `-04:00`), rounded to the nearest second. The offset decides the instant, daylight saving included, so either occurrence of a time the clocks repeat when they fall back can be sent (`01:30:00-04:00` or `01:30:00-05:00`). A time without an offset answers 422 invalid_date at its pointer, showing the time fixed with the offset of the time card's pay schedule zone (`tz_name`) and in UTC. Null or a non-string answers 422 at its pointer; a string that does not parse as a date and time answers 422 invalid_date.
|
|
5968
5968
|
*/
|
|
5969
5969
|
end_time?: string;
|
|
5970
5970
|
/**
|
|
@@ -6058,6 +6058,12 @@ export type FormDefinitionObject = {
|
|
|
6058
6058
|
json: {
|
|
6059
6059
|
[key: string]: unknown;
|
|
6060
6060
|
};
|
|
6061
|
+
/**
|
|
6062
|
+
* OpenAPI 3.0 schema for the submission json. Object properties name the answers, and array items describe each row or value. Descriptions document choice values. Unanswered fields may be omitted or set to null.
|
|
6063
|
+
*/
|
|
6064
|
+
submission_shape: {
|
|
6065
|
+
[key: string]: unknown;
|
|
6066
|
+
};
|
|
6061
6067
|
/**
|
|
6062
6068
|
* When the record was created (ISO 8601).
|
|
6063
6069
|
*/
|
|
@@ -6110,6 +6116,10 @@ export type FormSubmissionIndexObject = {
|
|
|
6110
6116
|
* A single form submission — a user's completed SurveyJS form with the resolved answers (the fuller show representation). Read-only; submissions are created in the app.
|
|
6111
6117
|
*/
|
|
6112
6118
|
export type FormSubmissionResponseObject = {
|
|
6119
|
+
/**
|
|
6120
|
+
* Unique identifier.
|
|
6121
|
+
*/
|
|
6122
|
+
id: string;
|
|
6113
6123
|
/**
|
|
6114
6124
|
* The submitting user.
|
|
6115
6125
|
*/
|
|
@@ -8500,6 +8510,40 @@ export type ProjectSiteUpdateParameters = {
|
|
|
8500
8510
|
*/
|
|
8501
8511
|
feature_ids?: Array<string>;
|
|
8502
8512
|
};
|
|
8513
|
+
/**
|
|
8514
|
+
* A project–user visibility join: names one person on one project. Path `{id}` is this join's id. Not included on project GET.
|
|
8515
|
+
*/
|
|
8516
|
+
export type ProjectUserVisibilityResponseObject = {
|
|
8517
|
+
/**
|
|
8518
|
+
* Unique identifier.
|
|
8519
|
+
*/
|
|
8520
|
+
id: string;
|
|
8521
|
+
/**
|
|
8522
|
+
* ID of the project this row names a person on. Taken from the path.
|
|
8523
|
+
*/
|
|
8524
|
+
project_id: string;
|
|
8525
|
+
/**
|
|
8526
|
+
* ID of the named user. Must hold a manager, safety manager, or field lead role at the project's owner.
|
|
8527
|
+
*/
|
|
8528
|
+
user_id: string;
|
|
8529
|
+
/**
|
|
8530
|
+
* When the record was created (ISO 8601).
|
|
8531
|
+
*/
|
|
8532
|
+
created_at: string;
|
|
8533
|
+
/**
|
|
8534
|
+
* When the record was last updated (ISO 8601).
|
|
8535
|
+
*/
|
|
8536
|
+
updated_at: string;
|
|
8537
|
+
};
|
|
8538
|
+
/**
|
|
8539
|
+
* Request body for naming a person on a project. `user_id` is required. The project is taken from the path and is not part of the body. There is no update body — `user_id` and `project_id` are readonly after create.
|
|
8540
|
+
*/
|
|
8541
|
+
export type ProjectUserVisibilityParameters = {
|
|
8542
|
+
/**
|
|
8543
|
+
* ID of a user visible to the API key who holds a manager, safety manager, or field lead role at the project's owner. Duplicate (project, user) pairs are rejected. Omission answers 400; supplied null, a blank ID, or a wrong type answers 422. A user the key cannot see answers 404.
|
|
8544
|
+
*/
|
|
8545
|
+
user_id: string;
|
|
8546
|
+
};
|
|
8503
8547
|
/**
|
|
8504
8548
|
* A file attached to a project. Uploaded through the direct-upload flow. `name` is always "document" and is not client-writable.
|
|
8505
8549
|
*/
|
|
@@ -9078,7 +9122,7 @@ export type ComplianceCheckParameters = {
|
|
|
9078
9122
|
*/
|
|
9079
9123
|
status?: 'dismissed' | 'pending';
|
|
9080
9124
|
/**
|
|
9081
|
-
*
|
|
9125
|
+
* The day the check is due, as a calendar date (`YYYY-MM-DD`). It is stored as 00:00 UTC on that day, the same as the web. A value with a time of day is refused with `422`. Send null to clear it, or omit to leave it unchanged.
|
|
9082
9126
|
*/
|
|
9083
9127
|
time_due?: string | null;
|
|
9084
9128
|
/**
|
|
@@ -10902,7 +10946,7 @@ export type PositionParameters = {
|
|
|
10902
10946
|
};
|
|
10903
10947
|
};
|
|
10904
10948
|
/**
|
|
10905
|
-
* Parameters for creating a per-unit scope price on a job. `scope_kind` and `
|
|
10949
|
+
* Parameters for creating a per-unit scope price on a job. `scope_kind` and `unit_price_cents` are required; omitting either answers 400, and a null or wrong-typed value answers 422.
|
|
10906
10950
|
*/
|
|
10907
10951
|
export type ProductionJobScopePriceParameters = {
|
|
10908
10952
|
/**
|
|
@@ -10910,9 +10954,9 @@ export type ProductionJobScopePriceParameters = {
|
|
|
10910
10954
|
*/
|
|
10911
10955
|
scope_kind: string;
|
|
10912
10956
|
/**
|
|
10913
|
-
* Billing rate per unit, as a decimal string
|
|
10957
|
+
* Billing rate per unit in cents, as a decimal string (e.g. "120000" or the read form "120000.0" for $1,200.00, or "3.5" for $0.035); a fraction of a cent is kept exactly and bills exactly. A negative value or a JSON number answers 422.
|
|
10914
10958
|
*/
|
|
10915
|
-
|
|
10959
|
+
unit_price_cents: string;
|
|
10916
10960
|
/**
|
|
10917
10961
|
* Contracted number of units expected for this scope on the job, as an integer; null when no target is set.
|
|
10918
10962
|
*/
|
|
@@ -10931,9 +10975,9 @@ export type ProductionJobScopePriceUpdateParameters = {
|
|
|
10931
10975
|
*/
|
|
10932
10976
|
scope_kind?: string;
|
|
10933
10977
|
/**
|
|
10934
|
-
* Billing rate per unit, as a decimal string
|
|
10978
|
+
* Billing rate per unit in cents, as a decimal string (e.g. "120000" or the read form "120000.0" for $1,200.00, or "3.5" for $0.035); a fraction of a cent is kept exactly and bills exactly. A negative value or a JSON number answers 422.
|
|
10935
10979
|
*/
|
|
10936
|
-
|
|
10980
|
+
unit_price_cents?: string;
|
|
10937
10981
|
/**
|
|
10938
10982
|
* Contracted number of units expected for this scope on the job, as an integer; null when no target is set.
|
|
10939
10983
|
*/
|
|
@@ -10964,9 +11008,9 @@ export type ProductionJobScopePriceResponseObject = {
|
|
|
10964
11008
|
*/
|
|
10965
11009
|
unit_of_measure: string;
|
|
10966
11010
|
/**
|
|
10967
|
-
* Billing rate per unit, as a decimal string
|
|
11011
|
+
* Billing rate per unit in cents, as a decimal string (e.g. "120000.0" is $1,200.00 and "3.5" is $0.035); a fraction of a cent is kept exactly. Present for company keys and for administrators, managers, safety managers, and field leads of the company that owns the job; omitted for other user keys.
|
|
10968
11012
|
*/
|
|
10969
|
-
|
|
11013
|
+
unit_price_cents?: string;
|
|
10970
11014
|
/**
|
|
10971
11015
|
* Contracted number of units expected for this scope on the job; null when no target is set. Present for company keys and for administrators, managers, safety managers, and field leads of the company that owns the job; omitted for other user keys.
|
|
10972
11016
|
*/
|
|
@@ -13827,7 +13871,7 @@ export type AssetsItemResponseObject = {
|
|
|
13827
13871
|
*/
|
|
13828
13872
|
status: 'available' | 'assigned' | null;
|
|
13829
13873
|
/**
|
|
13830
|
-
* When the item was purchased
|
|
13874
|
+
* When the item was purchased (ISO 8601); null when not recorded.
|
|
13831
13875
|
*/
|
|
13832
13876
|
purchase_date: string | null;
|
|
13833
13877
|
/**
|
|
@@ -13919,7 +13963,7 @@ export type AssetsItemParameters = {
|
|
|
13919
13963
|
*/
|
|
13920
13964
|
status?: 'available' | 'assigned';
|
|
13921
13965
|
/**
|
|
13922
|
-
*
|
|
13966
|
+
* The day the item was purchased, as a calendar date (`YYYY-MM-DD`). It is stored as 00:00 UTC on that day, the same as the web. A value with a time of day is refused with `422`. Send null to clear it.
|
|
13923
13967
|
*/
|
|
13924
13968
|
purchase_date?: string | null;
|
|
13925
13969
|
/**
|
|
@@ -14014,7 +14058,7 @@ export type AssetsItemUpdateParameters = {
|
|
|
14014
14058
|
*/
|
|
14015
14059
|
status?: 'available' | 'assigned';
|
|
14016
14060
|
/**
|
|
14017
|
-
*
|
|
14061
|
+
* The day the item was purchased, as a calendar date (`YYYY-MM-DD`). It is stored as 00:00 UTC on that day, the same as the web. A value with a time of day is refused with `422`. Send null to clear it.
|
|
14018
14062
|
*/
|
|
14019
14063
|
purchase_date?: string | null;
|
|
14020
14064
|
/**
|
|
@@ -14247,7 +14291,7 @@ export type AssetsFormAssignmentTriggerResponseObject = {
|
|
|
14247
14291
|
*/
|
|
14248
14292
|
time_of_day_due: string;
|
|
14249
14293
|
/**
|
|
14250
|
-
* IDs of the users the generated form is assigned to. Used only when assign_to is custom;
|
|
14294
|
+
* IDs of the users the generated form is assigned to. Used only when assign_to is custom; any other mode stores none.
|
|
14251
14295
|
*/
|
|
14252
14296
|
assigned_user_ids: Array<string>;
|
|
14253
14297
|
/**
|
|
@@ -14308,7 +14352,7 @@ export type AssetsFormAssignmentTriggerParameters = {
|
|
|
14308
14352
|
*/
|
|
14309
14353
|
time_of_day_due: string;
|
|
14310
14354
|
/**
|
|
14311
|
-
* IDs of the users the generated form is assigned to. Used only when assign_to is custom;
|
|
14355
|
+
* IDs of the users the generated form is assigned to. Used only when assign_to is custom; any other mode stores none.
|
|
14312
14356
|
*/
|
|
14313
14357
|
assigned_user_ids?: Array<string>;
|
|
14314
14358
|
/**
|
|
@@ -14361,7 +14405,7 @@ export type AssetsFormAssignmentTriggerUpdateParameters = {
|
|
|
14361
14405
|
*/
|
|
14362
14406
|
time_of_day_due?: string;
|
|
14363
14407
|
/**
|
|
14364
|
-
* IDs of the users the generated form is assigned to. Used only when assign_to is custom;
|
|
14408
|
+
* IDs of the users the generated form is assigned to. Used only when assign_to is custom; any other mode stores none.
|
|
14365
14409
|
*/
|
|
14366
14410
|
assigned_user_ids?: Array<string>;
|
|
14367
14411
|
/**
|
|
@@ -23601,7 +23645,7 @@ export type ListRateRulesData = {
|
|
|
23601
23645
|
};
|
|
23602
23646
|
query?: {
|
|
23603
23647
|
/**
|
|
23604
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
23648
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
23605
23649
|
*/
|
|
23606
23650
|
'as_of[valid]'?: string;
|
|
23607
23651
|
as_of?: string;
|
|
@@ -23681,7 +23725,7 @@ export type GetRateRuleData = {
|
|
|
23681
23725
|
};
|
|
23682
23726
|
query?: {
|
|
23683
23727
|
/**
|
|
23684
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
23728
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
23685
23729
|
*/
|
|
23686
23730
|
'as_of[valid]'?: string;
|
|
23687
23731
|
};
|
|
@@ -24194,7 +24238,7 @@ export type ListJobWageDeterminationsData = {
|
|
|
24194
24238
|
};
|
|
24195
24239
|
query?: {
|
|
24196
24240
|
/**
|
|
24197
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
24241
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
24198
24242
|
*/
|
|
24199
24243
|
'as_of[valid]'?: string;
|
|
24200
24244
|
as_of?: string;
|
|
@@ -24317,7 +24361,7 @@ export type GetJobWageDeterminationData = {
|
|
|
24317
24361
|
};
|
|
24318
24362
|
query?: {
|
|
24319
24363
|
/**
|
|
24320
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
24364
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
24321
24365
|
*/
|
|
24322
24366
|
'as_of[valid]'?: string;
|
|
24323
24367
|
};
|
|
@@ -25319,7 +25363,7 @@ export type ListOvertimeRulesData = {
|
|
|
25319
25363
|
};
|
|
25320
25364
|
query?: {
|
|
25321
25365
|
/**
|
|
25322
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
25366
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
25323
25367
|
*/
|
|
25324
25368
|
'as_of[valid]'?: string;
|
|
25325
25369
|
as_of?: string;
|
|
@@ -25450,7 +25494,7 @@ export type GetOvertimeRuleData = {
|
|
|
25450
25494
|
};
|
|
25451
25495
|
query?: {
|
|
25452
25496
|
/**
|
|
25453
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
25497
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
25454
25498
|
*/
|
|
25455
25499
|
'as_of[valid]'?: string;
|
|
25456
25500
|
};
|
|
@@ -25888,7 +25932,7 @@ export type ListPayRateRulesData = {
|
|
|
25888
25932
|
};
|
|
25889
25933
|
query?: {
|
|
25890
25934
|
/**
|
|
25891
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
25935
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
25892
25936
|
*/
|
|
25893
25937
|
'as_of[valid]'?: string;
|
|
25894
25938
|
as_of?: string;
|
|
@@ -26025,7 +26069,7 @@ export type GetPayRateRuleData = {
|
|
|
26025
26069
|
};
|
|
26026
26070
|
query?: {
|
|
26027
26071
|
/**
|
|
26028
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
26072
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
26029
26073
|
*/
|
|
26030
26074
|
'as_of[valid]'?: string;
|
|
26031
26075
|
};
|
|
@@ -26819,7 +26863,7 @@ export type ListExternalMapHistoryData = {
|
|
|
26819
26863
|
};
|
|
26820
26864
|
query?: {
|
|
26821
26865
|
/**
|
|
26822
|
-
* 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.
|
|
26866
|
+
* 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. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
26823
26867
|
*/
|
|
26824
26868
|
'as_of[transaction]'?: string;
|
|
26825
26869
|
'as_of[valid]'?: string;
|
|
@@ -26881,11 +26925,11 @@ export type ListExternalMapsData = {
|
|
|
26881
26925
|
'page[limit]'?: number;
|
|
26882
26926
|
page?: string;
|
|
26883
26927
|
/**
|
|
26884
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
26928
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
26885
26929
|
*/
|
|
26886
26930
|
'as_of[valid]'?: string;
|
|
26887
26931
|
/**
|
|
26888
|
-
* 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.
|
|
26932
|
+
* 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. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
26889
26933
|
*/
|
|
26890
26934
|
'as_of[transaction]'?: string;
|
|
26891
26935
|
as_of?: string;
|
|
@@ -26927,11 +26971,11 @@ export type GetExternalMapData = {
|
|
|
26927
26971
|
};
|
|
26928
26972
|
query?: {
|
|
26929
26973
|
/**
|
|
26930
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
26974
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
26931
26975
|
*/
|
|
26932
26976
|
'as_of[valid]'?: string;
|
|
26933
26977
|
/**
|
|
26934
|
-
* 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.
|
|
26978
|
+
* 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. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
26935
26979
|
*/
|
|
26936
26980
|
'as_of[transaction]'?: string;
|
|
26937
26981
|
};
|
|
@@ -28416,7 +28460,7 @@ export type ListEmploymentsData = {
|
|
|
28416
28460
|
filter?: string;
|
|
28417
28461
|
'filter[unexpected]'?: string;
|
|
28418
28462
|
/**
|
|
28419
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
28463
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
28420
28464
|
*/
|
|
28421
28465
|
'as_of[valid]'?: string;
|
|
28422
28466
|
as_of?: string;
|
|
@@ -28551,7 +28595,7 @@ export type GetEmploymentData = {
|
|
|
28551
28595
|
};
|
|
28552
28596
|
query?: {
|
|
28553
28597
|
/**
|
|
28554
|
-
* Read the version valid at this point.
|
|
28598
|
+
* Read the version valid at this point. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
28555
28599
|
*/
|
|
28556
28600
|
'as_of[valid]'?: string;
|
|
28557
28601
|
};
|
|
@@ -29467,7 +29511,7 @@ export type ListProjectWageDeterminationRateRulesData = {
|
|
|
29467
29511
|
};
|
|
29468
29512
|
query?: {
|
|
29469
29513
|
/**
|
|
29470
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
29514
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
29471
29515
|
*/
|
|
29472
29516
|
'as_of[valid]'?: string;
|
|
29473
29517
|
as_of?: string;
|
|
@@ -29543,7 +29587,7 @@ export type GetProjectWageDeterminationRateRuleData = {
|
|
|
29543
29587
|
};
|
|
29544
29588
|
query?: {
|
|
29545
29589
|
/**
|
|
29546
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
29590
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
29547
29591
|
*/
|
|
29548
29592
|
'as_of[valid]'?: string;
|
|
29549
29593
|
};
|
|
@@ -29735,6 +29779,141 @@ export type UpdateProjectSiteResponses = {
|
|
|
29735
29779
|
200: ProjectSiteResponseObject;
|
|
29736
29780
|
};
|
|
29737
29781
|
export type UpdateProjectSiteResponse = UpdateProjectSiteResponses[keyof UpdateProjectSiteResponses];
|
|
29782
|
+
export type ListUserVisibilitiesData = {
|
|
29783
|
+
body?: never;
|
|
29784
|
+
path: {
|
|
29785
|
+
project_id: string;
|
|
29786
|
+
};
|
|
29787
|
+
query?: {
|
|
29788
|
+
/**
|
|
29789
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
29790
|
+
* `meta.page.next_cursor`.
|
|
29791
|
+
*/
|
|
29792
|
+
'page[cursor]'?: string;
|
|
29793
|
+
/**
|
|
29794
|
+
* 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`.
|
|
29795
|
+
*/
|
|
29796
|
+
'page[limit]'?: number;
|
|
29797
|
+
page?: string;
|
|
29798
|
+
filter?: string;
|
|
29799
|
+
'filter[unexpected]'?: string;
|
|
29800
|
+
};
|
|
29801
|
+
url: '/api/v1/projects/{project_id}/user_visibilities';
|
|
29802
|
+
};
|
|
29803
|
+
export type ListUserVisibilitiesErrors = {
|
|
29804
|
+
/**
|
|
29805
|
+
* Bad Request
|
|
29806
|
+
*/
|
|
29807
|
+
400: Problem;
|
|
29808
|
+
/**
|
|
29809
|
+
* Forbidden
|
|
29810
|
+
*/
|
|
29811
|
+
403: Problem;
|
|
29812
|
+
/**
|
|
29813
|
+
* Not Found
|
|
29814
|
+
*/
|
|
29815
|
+
404: Problem;
|
|
29816
|
+
};
|
|
29817
|
+
export type ListUserVisibilitiesError = ListUserVisibilitiesErrors[keyof ListUserVisibilitiesErrors];
|
|
29818
|
+
export type ListUserVisibilitiesResponses = {
|
|
29819
|
+
/**
|
|
29820
|
+
* Success
|
|
29821
|
+
*/
|
|
29822
|
+
200: {
|
|
29823
|
+
meta: Meta;
|
|
29824
|
+
links: Links;
|
|
29825
|
+
data: Array<ProjectUserVisibilityResponseObject>;
|
|
29826
|
+
};
|
|
29827
|
+
};
|
|
29828
|
+
export type ListUserVisibilitiesResponse = ListUserVisibilitiesResponses[keyof ListUserVisibilitiesResponses];
|
|
29829
|
+
export type CreateUserVisibilityData = {
|
|
29830
|
+
body: ProjectUserVisibilityParameters;
|
|
29831
|
+
path: {
|
|
29832
|
+
project_id: string;
|
|
29833
|
+
};
|
|
29834
|
+
query?: never;
|
|
29835
|
+
url: '/api/v1/projects/{project_id}/user_visibilities';
|
|
29836
|
+
};
|
|
29837
|
+
export type CreateUserVisibilityErrors = {
|
|
29838
|
+
/**
|
|
29839
|
+
* Bad Request
|
|
29840
|
+
*/
|
|
29841
|
+
400: Problem;
|
|
29842
|
+
/**
|
|
29843
|
+
* Forbidden
|
|
29844
|
+
*/
|
|
29845
|
+
403: Problem;
|
|
29846
|
+
/**
|
|
29847
|
+
* Not Found
|
|
29848
|
+
*/
|
|
29849
|
+
404: Problem;
|
|
29850
|
+
/**
|
|
29851
|
+
* Unprocessable Content
|
|
29852
|
+
*/
|
|
29853
|
+
422: Problem;
|
|
29854
|
+
};
|
|
29855
|
+
export type CreateUserVisibilityError = CreateUserVisibilityErrors[keyof CreateUserVisibilityErrors];
|
|
29856
|
+
export type CreateUserVisibilityResponses = {
|
|
29857
|
+
/**
|
|
29858
|
+
* Created
|
|
29859
|
+
*/
|
|
29860
|
+
201: ProjectUserVisibilityResponseObject;
|
|
29861
|
+
};
|
|
29862
|
+
export type CreateUserVisibilityResponse = CreateUserVisibilityResponses[keyof CreateUserVisibilityResponses];
|
|
29863
|
+
export type DeleteUserVisibilityData = {
|
|
29864
|
+
body?: never;
|
|
29865
|
+
path: {
|
|
29866
|
+
project_id: string;
|
|
29867
|
+
id: string;
|
|
29868
|
+
};
|
|
29869
|
+
query?: never;
|
|
29870
|
+
url: '/api/v1/projects/{project_id}/user_visibilities/{id}';
|
|
29871
|
+
};
|
|
29872
|
+
export type DeleteUserVisibilityErrors = {
|
|
29873
|
+
/**
|
|
29874
|
+
* Forbidden
|
|
29875
|
+
*/
|
|
29876
|
+
403: Problem;
|
|
29877
|
+
/**
|
|
29878
|
+
* Not Found
|
|
29879
|
+
*/
|
|
29880
|
+
404: Problem;
|
|
29881
|
+
};
|
|
29882
|
+
export type DeleteUserVisibilityError = DeleteUserVisibilityErrors[keyof DeleteUserVisibilityErrors];
|
|
29883
|
+
export type DeleteUserVisibilityResponses = {
|
|
29884
|
+
/**
|
|
29885
|
+
* No Content
|
|
29886
|
+
*/
|
|
29887
|
+
204: void;
|
|
29888
|
+
};
|
|
29889
|
+
export type DeleteUserVisibilityResponse = DeleteUserVisibilityResponses[keyof DeleteUserVisibilityResponses];
|
|
29890
|
+
export type GetUserVisibilityData = {
|
|
29891
|
+
body?: never;
|
|
29892
|
+
path: {
|
|
29893
|
+
project_id: string;
|
|
29894
|
+
id: string;
|
|
29895
|
+
};
|
|
29896
|
+
query?: never;
|
|
29897
|
+
url: '/api/v1/projects/{project_id}/user_visibilities/{id}';
|
|
29898
|
+
};
|
|
29899
|
+
export type GetUserVisibilityErrors = {
|
|
29900
|
+
/**
|
|
29901
|
+
* Forbidden
|
|
29902
|
+
*/
|
|
29903
|
+
403: Problem;
|
|
29904
|
+
/**
|
|
29905
|
+
* Not Found
|
|
29906
|
+
*/
|
|
29907
|
+
404: Problem;
|
|
29908
|
+
};
|
|
29909
|
+
export type GetUserVisibilityError = GetUserVisibilityErrors[keyof GetUserVisibilityErrors];
|
|
29910
|
+
export type GetUserVisibilityResponses = {
|
|
29911
|
+
/**
|
|
29912
|
+
* Success
|
|
29913
|
+
*/
|
|
29914
|
+
200: ProjectUserVisibilityResponseObject;
|
|
29915
|
+
};
|
|
29916
|
+
export type GetUserVisibilityResponse = GetUserVisibilityResponses[keyof GetUserVisibilityResponses];
|
|
29738
29917
|
export type ShiftProjectWageDeterminationGenesisData = {
|
|
29739
29918
|
body: ProjectWageDeterminationGenesisParameters;
|
|
29740
29919
|
headers: {
|
|
@@ -30058,7 +30237,7 @@ export type ListProjectWageDeterminationsData = {
|
|
|
30058
30237
|
};
|
|
30059
30238
|
query?: {
|
|
30060
30239
|
/**
|
|
30061
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
30240
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
30062
30241
|
*/
|
|
30063
30242
|
'as_of[valid]'?: string;
|
|
30064
30243
|
as_of?: string;
|
|
@@ -30181,7 +30360,7 @@ export type GetProjectWageDeterminationData = {
|
|
|
30181
30360
|
};
|
|
30182
30361
|
query?: {
|
|
30183
30362
|
/**
|
|
30184
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
30363
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
30185
30364
|
*/
|
|
30186
30365
|
'as_of[valid]'?: string;
|
|
30187
30366
|
};
|
|
@@ -32081,7 +32260,7 @@ export type ListTimecodeHistoryData = {
|
|
|
32081
32260
|
};
|
|
32082
32261
|
query?: {
|
|
32083
32262
|
/**
|
|
32084
|
-
* 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.
|
|
32263
|
+
* 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. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
32085
32264
|
*/
|
|
32086
32265
|
'as_of[transaction]'?: string;
|
|
32087
32266
|
'as_of[valid]'?: string;
|
|
@@ -32353,11 +32532,11 @@ export type ListTimecodesData = {
|
|
|
32353
32532
|
'page[limit]'?: number;
|
|
32354
32533
|
page?: string;
|
|
32355
32534
|
/**
|
|
32356
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
32535
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
32357
32536
|
*/
|
|
32358
32537
|
'as_of[valid]'?: string;
|
|
32359
32538
|
/**
|
|
32360
|
-
* 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.
|
|
32539
|
+
* 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. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
32361
32540
|
*/
|
|
32362
32541
|
'as_of[transaction]'?: string;
|
|
32363
32542
|
as_of?: string;
|
|
@@ -32430,11 +32609,11 @@ export type GetTimecodeData = {
|
|
|
32430
32609
|
};
|
|
32431
32610
|
query?: {
|
|
32432
32611
|
/**
|
|
32433
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
32612
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
32434
32613
|
*/
|
|
32435
32614
|
'as_of[valid]'?: string;
|
|
32436
32615
|
/**
|
|
32437
|
-
* 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.
|
|
32616
|
+
* 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. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
32438
32617
|
*/
|
|
32439
32618
|
'as_of[transaction]'?: string;
|
|
32440
32619
|
};
|
|
@@ -32958,7 +33137,7 @@ export type ListPayPeriodConfigsData = {
|
|
|
32958
33137
|
'page[limit]'?: number;
|
|
32959
33138
|
page?: string;
|
|
32960
33139
|
/**
|
|
32961
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
33140
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
32962
33141
|
*/
|
|
32963
33142
|
'as_of[valid]'?: string;
|
|
32964
33143
|
as_of?: string;
|
|
@@ -33033,7 +33212,7 @@ export type GetPayPeriodConfigData = {
|
|
|
33033
33212
|
};
|
|
33034
33213
|
query?: {
|
|
33035
33214
|
/**
|
|
33036
|
-
* Read the version valid at this point in time. Defaults to now.
|
|
33215
|
+
* Read the version valid at this point in time. Defaults to now. Needs a UTC offset (`2026-03-01T00:00:00Z`); a value without one is a `422`.
|
|
33037
33216
|
*/
|
|
33038
33217
|
'as_of[valid]'?: string;
|
|
33039
33218
|
};
|