@dsptch-work/api-client 0.32.0 → 0.34.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.
@@ -201,6 +201,12 @@ export type Problem = {
201
201
  *
202
202
  * The resource's timeline already ends at a scheduled termination, and scheduling a second one would silently move it. Moving an end is two steps on purpose: cancel the standing termination, then schedule the one you want.
203
203
  *
204
+ * ### authorization_revoked
205
+ *
206
+ * **Authorization Revoked**
207
+ *
208
+ * The assessor grant is revoked. A revoked grant keeps its row as history and cannot be changed or revoked again. To make the user an assessor again, grant them anew.
209
+ *
204
210
  * ### import_in_progress
205
211
  *
206
212
  * **Import In Progress**
@@ -235,7 +241,7 @@ export type Problem = {
235
241
  *
236
242
  * **Version Overlap**
237
243
  *
238
- * The write conflicts with what is already recorded for the resource — another version occupies the same span, or the write contradicts the resource's recorded identity. Re-read the current state and retry on top of it.
244
+ * The write collides with another version of the same resource — another version occupies the same span, or the write contradicts the identity the resource's versions record. Re-read the current state and retry on top of it.
239
245
  *
240
246
  * ## 412
241
247
  *
@@ -381,14 +387,20 @@ export type Problem = {
381
387
  *
382
388
  * ## 503
383
389
  *
390
+ * ### database_timeout
391
+ *
392
+ * **Database Timeout**
393
+ *
394
+ * A database statement behind the request ran past the server's time limit and was stopped before it finished. The request may be fine as sent — resend it after the `Retry-After` window, and if it keeps timing out, ask for less at once, such as a narrower filter or a smaller page.
395
+ *
384
396
  * ### write_contended
385
397
  *
386
398
  * **Write Contended**
387
399
  *
388
- * Another write to the same resource held it for longer than this request was willing to wait, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
400
+ * Another write to the same resource held it for longer than this request was willing to wait, or collided with it, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
389
401
  *
390
402
  */
391
- export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'malformed_body' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'forbidden_key' | 'insufficient_api_key_scope' | 'user_scoped_key_required' | 'not_found' | 'already_subscribed' | 'already_terminated' | 'import_in_progress' | 'pay_schedule_already_exists' | 'product_archived' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'interval_too_wide' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error' | 'write_contended';
403
+ export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'malformed_body' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'forbidden_key' | 'insufficient_api_key_scope' | 'user_scoped_key_required' | 'not_found' | 'already_subscribed' | 'already_terminated' | 'authorization_revoked' | 'import_in_progress' | 'pay_schedule_already_exists' | 'product_archived' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'interval_too_wide' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error' | 'database_timeout' | 'write_contended';
392
404
  export type ApiKeyScopeResponseObject = {
393
405
  resource: string;
394
406
  action: 'read' | 'create' | 'update' | 'delete';
@@ -496,6 +508,390 @@ export type DirectUploadResponseObject = {
496
508
  };
497
509
  };
498
510
  };
511
+ /**
512
+ * A competence standard owned by your company. Content lives on named revisions, not a valid-time history. current_version_id is the active revision and draft_version_id is the in-progress revision; either is null when absent.
513
+ */
514
+ export type CompetencyStandardResponseObject = {
515
+ /**
516
+ * ID of the standard.
517
+ */
518
+ id: string;
519
+ /**
520
+ * Name of the standard, unique within the company.
521
+ */
522
+ name: string;
523
+ /**
524
+ * ID of the department this standard is filed under; null when it is company-wide.
525
+ */
526
+ companies_department_id: string | null;
527
+ /**
528
+ * When the standard was archived; null while it is in the working catalog.
529
+ */
530
+ archived_at: string | null;
531
+ /**
532
+ * ID of the active revision; null when no revision has been promoted.
533
+ */
534
+ current_version_id: string | null;
535
+ /**
536
+ * ID of the draft revision; null when no draft is open.
537
+ */
538
+ draft_version_id: string | null;
539
+ /**
540
+ * When the standard was created.
541
+ */
542
+ created_at: string;
543
+ /**
544
+ * When the standard was last updated.
545
+ */
546
+ updated_at: string;
547
+ };
548
+ /**
549
+ * Archive a competence standard. The body takes no fields; send an empty object or no body. Archiving an archived standard returns it unchanged.
550
+ */
551
+ export type CompetencyStandardArchiveParameters = {
552
+ [key: string]: never;
553
+ };
554
+ /**
555
+ * Create a competence standard. Revision 1 is opened as a draft. sort_order and revision are server-assigned and are not accepted.
556
+ */
557
+ export type CompetencyStandardParameters = {
558
+ /**
559
+ * Name of the standard, unique within the company. Required.
560
+ */
561
+ name: string;
562
+ /**
563
+ * ID of the department this standard is filed under; optional, null to leave it company-wide.
564
+ */
565
+ companies_department_id?: string | null;
566
+ };
567
+ /**
568
+ * Update a competence standard's name or department. Send only the fields to change. Revisions are not edited here.
569
+ */
570
+ export type CompetencyStandardUpdateParameters = {
571
+ /**
572
+ * Name of the standard, unique within the company. Omit to leave it unchanged.
573
+ */
574
+ name?: string;
575
+ /**
576
+ * ID of the department this standard is filed under; omit to leave it unchanged, or send null to clear it.
577
+ */
578
+ companies_department_id?: string | null;
579
+ };
580
+ /**
581
+ * One named revision of a competence standard. revision is a positive integer and status is draft, active, or superseded. This is not a temporal history entry.
582
+ */
583
+ export type CompetencyStandardVersionResponseObject = {
584
+ /**
585
+ * ID of the revision.
586
+ */
587
+ id: string;
588
+ /**
589
+ * ID of the standard this revision belongs to.
590
+ */
591
+ competencies_standard_id: string;
592
+ /**
593
+ * Positive integer revision number, assigned when the revision is cut. Revision 1 is created with the standard.
594
+ */
595
+ revision: number;
596
+ /**
597
+ * Lifecycle of this revision: draft, active, or superseded. At most one draft and one active revision exist per standard.
598
+ */
599
+ status: 'draft' | 'active' | 'superseded';
600
+ /**
601
+ * Notes recorded when this revision was cut; null when unset.
602
+ */
603
+ change_notes: string | null;
604
+ /**
605
+ * ID of the admin or safety manager who promoted this revision; null while it is a draft.
606
+ */
607
+ approved_by_user_id: string | null;
608
+ /**
609
+ * When this revision was promoted; null while it is a draft.
610
+ */
611
+ approved_at: string | null;
612
+ /**
613
+ * Whether this revision has a controlled PDF attached. The file is not copied when a new revision is cut, and the bytes are not served by this API.
614
+ */
615
+ controlled_pdf_attached: boolean;
616
+ /**
617
+ * When the revision was created.
618
+ */
619
+ created_at: string;
620
+ /**
621
+ * When the revision was last updated.
622
+ */
623
+ updated_at: string;
624
+ };
625
+ /**
626
+ * Notes for a new draft revision, or a replacement of the notes on an existing draft. Cutting a revision copies the active level, key-activity, and criterion tree and does not copy the controlled PDF.
627
+ */
628
+ export type CompetencyStandardVersionParameters = {
629
+ /**
630
+ * Notes for this draft; optional, null to clear.
631
+ */
632
+ change_notes?: string | null;
633
+ };
634
+ /**
635
+ * Promote a draft revision to active. A user key promotes as its user and must omit approved_by_user_id. A company key must name an admin or safety manager.
636
+ */
637
+ export type CompetencyStandardVersionPromotionParameters = {
638
+ /**
639
+ * ID of the admin or safety manager who approves the promotion. Required for a company key. A user key that sends it is refused.
640
+ */
641
+ approved_by_user_id?: string;
642
+ };
643
+ /**
644
+ * A proficiency tier on one standard revision. sort_order is the durable tier qualifications record, and it is server-assigned.
645
+ */
646
+ export type CompetencyLevelResponseObject = {
647
+ /**
648
+ * ID of the level.
649
+ */
650
+ id: string;
651
+ /**
652
+ * ID of the revision this level belongs to.
653
+ */
654
+ competencies_standard_version_id: string;
655
+ /**
656
+ * Zero-based position of this level among its siblings. The first level is 0. Qualifications store this number, not the level id.
657
+ */
658
+ sort_order: number;
659
+ /**
660
+ * Name of the tier; null when unset.
661
+ */
662
+ name: string | null;
663
+ /**
664
+ * Description of the tier; null when unset.
665
+ */
666
+ description: string | null;
667
+ /**
668
+ * When the level was created.
669
+ */
670
+ created_at: string;
671
+ /**
672
+ * When the level was last updated.
673
+ */
674
+ updated_at: string;
675
+ };
676
+ /**
677
+ * Create or update a level on a draft revision. sort_order is server-assigned and is rejected if sent.
678
+ */
679
+ export type CompetencyLevelParameters = {
680
+ /**
681
+ * Name of the tier; optional, null to clear.
682
+ */
683
+ name?: string | null;
684
+ /**
685
+ * Description of the tier; optional, null to clear.
686
+ */
687
+ description?: string | null;
688
+ };
689
+ /**
690
+ * A task on a level. Catalog text is editable only while the parent revision is a draft. sort_order is server-assigned.
691
+ */
692
+ export type CompetencyKeyActivityResponseObject = {
693
+ /**
694
+ * ID of the key activity.
695
+ */
696
+ id: string;
697
+ /**
698
+ * ID of the level this key activity belongs to.
699
+ */
700
+ competencies_level_id: string;
701
+ /**
702
+ * Zero-based position among sibling key activities. Server-assigned.
703
+ */
704
+ sort_order: number;
705
+ /**
706
+ * Display number of the task; null when unset.
707
+ */
708
+ number: string | null;
709
+ /**
710
+ * Title of the task; null when unset.
711
+ */
712
+ title: string | null;
713
+ /**
714
+ * Notes for assessors; null when unset.
715
+ */
716
+ notes: string | null;
717
+ /**
718
+ * When the key activity was created.
719
+ */
720
+ created_at: string;
721
+ /**
722
+ * When the key activity was last updated.
723
+ */
724
+ updated_at: string;
725
+ };
726
+ /**
727
+ * Create or update a key activity on a draft revision. sort_order is server-assigned and is rejected if sent.
728
+ */
729
+ export type CompetencyKeyActivityParameters = {
730
+ /**
731
+ * Display number of the task; optional, null to clear.
732
+ */
733
+ number?: string | null;
734
+ /**
735
+ * Title of the task; optional, null to clear.
736
+ */
737
+ title?: string | null;
738
+ /**
739
+ * Notes for assessors; optional, null to clear.
740
+ */
741
+ notes?: string | null;
742
+ };
743
+ /**
744
+ * One evidence criterion on a key activity. Editable only while the parent revision is a draft. sort_order is server-assigned.
745
+ */
746
+ export type CompetencyCriterionResponseObject = {
747
+ /**
748
+ * ID of the criterion.
749
+ */
750
+ id: string;
751
+ /**
752
+ * ID of the key activity this criterion belongs to.
753
+ */
754
+ competencies_key_activity_id: string;
755
+ /**
756
+ * Zero-based position among sibling criteria. Server-assigned.
757
+ */
758
+ sort_order: number;
759
+ /**
760
+ * Display number of the criterion; null when unset.
761
+ */
762
+ number: string | null;
763
+ /**
764
+ * Criterion text; null when unset.
765
+ */
766
+ body: string | null;
767
+ /**
768
+ * Guidance on what evidence satisfies the criterion; null when unset.
769
+ */
770
+ evidence_note: string | null;
771
+ /**
772
+ * When the criterion was created.
773
+ */
774
+ created_at: string;
775
+ /**
776
+ * When the criterion was last updated.
777
+ */
778
+ updated_at: string;
779
+ };
780
+ /**
781
+ * Create or update a criterion on a draft revision. sort_order is server-assigned and is rejected if sent.
782
+ */
783
+ export type CompetencyCriterionParameters = {
784
+ /**
785
+ * Display number of the criterion; optional, null to clear.
786
+ */
787
+ number?: string | null;
788
+ /**
789
+ * Criterion text; optional, null to clear.
790
+ */
791
+ body?: string | null;
792
+ /**
793
+ * Guidance on what evidence satisfies the criterion; optional, null to clear.
794
+ */
795
+ evidence_note?: string | null;
796
+ };
797
+ /**
798
+ * Swap a draft catalog row with its neighbor. The row cannot move past either end of the list.
799
+ */
800
+ export type CompetencySortOrderMoveParameters = {
801
+ /**
802
+ * Which neighbor to swap with: up or down. Required.
803
+ */
804
+ direction: 'up' | 'down';
805
+ };
806
+ /**
807
+ * One assessor-registry grant for one standard. Department scope is informational. revoked_at is null while the grant is active.
808
+ */
809
+ export type CompetencyAssessorAuthorizationResponseObject = {
810
+ /**
811
+ * ID of the authorization.
812
+ */
813
+ id: string;
814
+ /**
815
+ * ID of the user who holds the grant.
816
+ */
817
+ user_id: string;
818
+ /**
819
+ * ID of the standard this grant covers.
820
+ */
821
+ competencies_standard_id: string;
822
+ /**
823
+ * ID of the department the grant is noted against; null when it is company-wide. Department does not restrict which assessments the user may touch.
824
+ */
825
+ companies_department_id: string | null;
826
+ /**
827
+ * Role of the grant: authorized_assessor collects field evidence, qualified_assessor decides assessments.
828
+ */
829
+ kind: 'authorized_assessor' | 'qualified_assessor';
830
+ /**
831
+ * ID of the user who recorded the grant.
832
+ */
833
+ granted_by_user_id: string;
834
+ /**
835
+ * When the grant was recorded.
836
+ */
837
+ granted_at: string;
838
+ /**
839
+ * When the grant was revoked; null while it is active.
840
+ */
841
+ revoked_at: string | null;
842
+ /**
843
+ * active until the grant is revoked, then revoked. The same words are filter[state] values on the list endpoint, which also accepts all.
844
+ */
845
+ state: 'active' | 'revoked';
846
+ /**
847
+ * When the authorization row was created.
848
+ */
849
+ created_at: string;
850
+ /**
851
+ * When the authorization row was last updated.
852
+ */
853
+ updated_at: string;
854
+ };
855
+ /**
856
+ * Grant an assessor role for one standard. A user key grants as its user. A company key names the grantor. An active grant of the same kind for the same user and standard is unique.
857
+ */
858
+ export type CompetencyAssessorAuthorizationParameters = {
859
+ /**
860
+ * ID of the user who receives the grant. Required.
861
+ */
862
+ user_id: string;
863
+ /**
864
+ * Role to grant: authorized_assessor or qualified_assessor. Required.
865
+ */
866
+ kind: 'authorized_assessor' | 'qualified_assessor';
867
+ /**
868
+ * ID of the standard this grant covers. Required. Changing it means revoke and regrant.
869
+ */
870
+ competencies_standard_id: string;
871
+ /**
872
+ * ID of the department the grant is noted against; optional, null to leave it company-wide. A blank ID answers 422.
873
+ */
874
+ companies_department_id?: string | null;
875
+ /**
876
+ * ID of the admin or safety manager recording the grant. Required for a company key. A user key grants as itself and must omit it.
877
+ */
878
+ granted_by_user_id?: string;
879
+ };
880
+ /**
881
+ * Update the department note on an active grant. Kind, user, standard, and grantor are fixed. A revoked grant answers 409 authorization_revoked.
882
+ */
883
+ export type CompetencyAssessorAuthorizationUpdateParameters = {
884
+ /**
885
+ * ID of the department the grant is noted against; omit to leave it unchanged, or send null to clear it. A blank ID answers 422.
886
+ */
887
+ companies_department_id?: string | null;
888
+ };
889
+ /**
890
+ * Revoke an active grant. The body takes no fields; send an empty object or no body. Revocation sets revoked_at and keeps the row; revoking it again answers 409 authorization_revoked.
891
+ */
892
+ export type CompetencyAssessorAuthorizationRevocationParameters = {
893
+ [key: string]: never;
894
+ };
499
895
  /**
500
896
  * A durable standing. The candidate passed the standard at level_sort_order. There is no level id, so the standing survives the next revision. This API does not create or update qualifications.
501
897
  */
@@ -2619,7 +3015,7 @@ export type PerDiemResponseObject = {
2619
3015
  /**
2620
3016
  * Whether the per diem is currently active and available to use.
2621
3017
  */
2622
- active: boolean | null;
3018
+ active: boolean;
2623
3019
  /**
2624
3020
  * IDs of the work types this per diem applies to.
2625
3021
  */
@@ -2664,11 +3060,11 @@ export type PerDiemParameters = {
2664
3060
  /**
2665
3061
  * Whether this should become the company default per diem. Non-boolean values other than null answer 422.
2666
3062
  */
2667
- default?: boolean | null;
3063
+ default?: boolean;
2668
3064
  /**
2669
- * Whether the per diem is active and available to use. Non-boolean values other than null answer 422.
3065
+ * Whether the per diem is active and available to use. Null or a non-boolean answers 422.
2670
3066
  */
2671
- active?: boolean | null;
3067
+ active?: boolean;
2672
3068
  /**
2673
3069
  * Unique nonblank IDs of the work types this per diem applies to; each must be shared or the company's own. Providing this replaces the entire set; an empty array clears it. Omit to attach none or leave the set unchanged on update. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422. An unavailable work type answers 404.
2674
3070
  */
@@ -2705,11 +3101,11 @@ export type PerDiemUpdateParameters = {
2705
3101
  /**
2706
3102
  * Whether this should become the company default per diem; omit to leave it unchanged. Non-boolean values other than null answer 422.
2707
3103
  */
2708
- default?: boolean | null;
3104
+ default?: boolean;
2709
3105
  /**
2710
- * Whether the per diem is active and available to use; omit to leave it unchanged. Non-boolean values other than null answer 422.
3106
+ * Whether the per diem is active and available to use; omit to leave it unchanged. Null or a non-boolean answers 422.
2711
3107
  */
2712
- active?: boolean | null;
3108
+ active?: boolean;
2713
3109
  /**
2714
3110
  * Unique nonblank IDs of the work types this per diem applies to; each must be shared or the company's own. Providing this replaces the entire set; an empty array clears it. Omit to attach none or leave the set unchanged on update. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422. An unavailable work type answers 404.
2715
3111
  */
@@ -3663,7 +4059,7 @@ export type PwaCompanyUserDetailsParameters = {
3663
4059
  */
3664
4060
  city?: string | null;
3665
4061
  /**
3666
- * Home address two-letter US state code; required together with address1 when any home-address field is set.
4062
+ * Home address two-letter US state code; any other value is rejected. Required together with address1 when any home-address field is set.
3667
4063
  */
3668
4064
  state?: string | null;
3669
4065
  /**
@@ -3673,7 +4069,7 @@ export type PwaCompanyUserDetailsParameters = {
3673
4069
  /**
3674
4070
  * Worker race for demographic reporting, as an array of codes (e.g. CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, NOT_SPECIFIED).
3675
4071
  */
3676
- race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'> | null;
4072
+ race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'>;
3677
4073
  /**
3678
4074
  * Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
3679
4075
  */
@@ -3721,11 +4117,11 @@ export type PwaCompanyUserDetailsParameters = {
3721
4117
  /**
3722
4118
  * Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes (e.g. eep_program_completed, foster_care, formerly_incarcerated). See the schema enum for the full set.
3723
4119
  */
3724
- il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'> | null;
4120
+ il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'>;
3725
4121
  /**
3726
4122
  * Illinois SHINES workforce-program participation, as an array of program codes (e.g. solar_training_pipeline_program, craft_apprenticeship_program). See the schema enum for the full set.
3727
4123
  */
3728
- il_shines_other_programs?: Array<'solar_training_pipeline_program' | 'craft_apprenticeship_program' | 'multi_cultural_jobs_program' | 'clean_jobs_workforce_network_program' | 'illinois_climate_works_prep_apprenticeship_program' | 'returning_residents_clean_jobs_training_program' | 'other'> | null;
4124
+ il_shines_other_programs?: Array<'solar_training_pipeline_program' | 'craft_apprenticeship_program' | 'multi_cultural_jobs_program' | 'clean_jobs_workforce_network_program' | 'illinois_climate_works_prep_apprenticeship_program' | 'returning_residents_clean_jobs_training_program' | 'other'>;
3729
4125
  /**
3730
4126
  * Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
3731
4127
  */
@@ -3733,7 +4129,7 @@ export type PwaCompanyUserDetailsParameters = {
3733
4129
  /**
3734
4130
  * Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american).
3735
4131
  */
3736
- or_boli_race?: Array<'american_indian_or_alaska_native' | 'asian' | 'hispanic_or_latino' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'white' | 'portuguese_or_brazilian'> | null;
4132
+ or_boli_race?: Array<'american_indian_or_alaska_native' | 'asian' | 'hispanic_or_latino' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'white' | 'portuguese_or_brazilian'>;
3737
4133
  };
3738
4134
  /**
3739
4135
  * Update a worker's PWA compliance details. The company is taken from the API key. Every field is optional — send only what changes, and omitted fields are left unchanged. The company/user pair is fixed at creation.
@@ -3752,7 +4148,7 @@ export type PwaCompanyUserDetailsUpdateParameters = {
3752
4148
  */
3753
4149
  city?: string | null;
3754
4150
  /**
3755
- * Home address two-letter US state code; required together with address1 when any home-address field is set.
4151
+ * Home address two-letter US state code; any other value is rejected. Required together with address1 when any home-address field is set.
3756
4152
  */
3757
4153
  state?: string | null;
3758
4154
  /**
@@ -3762,7 +4158,7 @@ export type PwaCompanyUserDetailsUpdateParameters = {
3762
4158
  /**
3763
4159
  * Worker race for demographic reporting, as an array of codes (e.g. CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, NOT_SPECIFIED).
3764
4160
  */
3765
- race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'> | null;
4161
+ race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'>;
3766
4162
  /**
3767
4163
  * Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
3768
4164
  */
@@ -3810,11 +4206,11 @@ export type PwaCompanyUserDetailsUpdateParameters = {
3810
4206
  /**
3811
4207
  * Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes (e.g. eep_program_completed, foster_care, formerly_incarcerated). See the schema enum for the full set.
3812
4208
  */
3813
- il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'> | null;
4209
+ il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'>;
3814
4210
  /**
3815
4211
  * Illinois SHINES workforce-program participation, as an array of program codes (e.g. solar_training_pipeline_program, craft_apprenticeship_program). See the schema enum for the full set.
3816
4212
  */
3817
- il_shines_other_programs?: Array<'solar_training_pipeline_program' | 'craft_apprenticeship_program' | 'multi_cultural_jobs_program' | 'clean_jobs_workforce_network_program' | 'illinois_climate_works_prep_apprenticeship_program' | 'returning_residents_clean_jobs_training_program' | 'other'> | null;
4213
+ il_shines_other_programs?: Array<'solar_training_pipeline_program' | 'craft_apprenticeship_program' | 'multi_cultural_jobs_program' | 'clean_jobs_workforce_network_program' | 'illinois_climate_works_prep_apprenticeship_program' | 'returning_residents_clean_jobs_training_program' | 'other'>;
3818
4214
  /**
3819
4215
  * Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
3820
4216
  */
@@ -3822,7 +4218,7 @@ export type PwaCompanyUserDetailsUpdateParameters = {
3822
4218
  /**
3823
4219
  * Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american).
3824
4220
  */
3825
- or_boli_race?: Array<'american_indian_or_alaska_native' | 'asian' | 'hispanic_or_latino' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'white' | 'portuguese_or_brazilian'> | null;
4221
+ or_boli_race?: Array<'american_indian_or_alaska_native' | 'asian' | 'hispanic_or_latino' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'white' | 'portuguese_or_brazilian'>;
3826
4222
  };
3827
4223
  /**
3828
4224
  * A craft grouping used for prevailing-wage / apprenticeship (PWA) compliance — the unit an apprenticeship ratio is measured against. Owned by either a project (pooling the craft across the project's jobs) or a standalone job, never both.
@@ -3862,7 +4258,7 @@ export type PwaTradeResponseObject = {
3862
4258
  */
3863
4259
  export type PwaTradeParameters = {
3864
4260
  /**
3865
- * Display name of the craft to create, e.g. "Electrician".
4261
+ * Display name of the craft to create, e.g. "Electrician". Omission answers 400; supplied null or a wrong type answers 422, and a blank name fails model validation with 422.
3866
4262
  */
3867
4263
  name: string;
3868
4264
  };
@@ -4225,9 +4621,9 @@ export type JobParameters = {
4225
4621
  */
4226
4622
  requested_by_company_id?: string;
4227
4623
  /**
4228
- * Complete desired set of manager user ID strings. Omit or send null to preserve the set; send an empty array to clear it. Other non-array values or non-string members return 422 before any job or relationship is saved.
4624
+ * Complete desired set of unique nonblank manager user IDs. Omit to preserve the set; send an empty array to clear it. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422 before any job or relationship is saved.
4229
4625
  */
4230
- manager_user_ids?: Array<string> | null;
4626
+ manager_user_ids?: Array<string>;
4231
4627
  /**
4232
4628
  * Purchase order number for the job; null when unset.
4233
4629
  */
@@ -4278,9 +4674,9 @@ export type JobParameters = {
4278
4674
  */
4279
4675
  allow_customer_access?: boolean;
4280
4676
  /**
4281
- * Complete desired set of timecode ID strings. Omit or send null to preserve the set; send an empty array to clear it. Other non-array values or non-string members return 422 before any job or relationship is saved.
4677
+ * Complete desired set of unique nonblank timecode IDs. Omit to preserve the set; send an empty array to clear it. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422 before any job or relationship is saved.
4282
4678
  */
4283
- timekeeping_timecode_ids?: Array<string> | null;
4679
+ timekeeping_timecode_ids?: Array<string>;
4284
4680
  /**
4285
4681
  * Whether the feature-allocation selector is shown for this job; null when unset.
4286
4682
  */
@@ -4641,7 +5037,7 @@ export type UserResponseObject = {
4641
5037
  /**
4642
5038
  * How the worker is paid: hourly or salary.
4643
5039
  */
4644
- compensation_type: string | null;
5040
+ compensation_type: 'hourly' | 'salary' | null;
4645
5041
  /**
4646
5042
  * Base pay rate, formatted as a currency string in the company's currency. Present for company keys, company administrators, and the employed person, and omitted otherwise; null when authorized but unset.
4647
5043
  */
@@ -4931,11 +5327,11 @@ export type UserParameters = ({
4931
5327
  */
4932
5328
  avatar_signed_id?: string | null;
4933
5329
  /**
4934
- * Id of the internal user recorded as the creator of the worker's invite, and named to the recipient as the person inviting them; must be a member of your company. Ignored when skip_invite is set.
5330
+ * Id of the internal user recorded as the creator of the worker's invite, and named to the recipient as the person inviting them. A user key always records its own user and answers 403 if the body names one; a company key must name a user your company can see, or the request answers 404. Ignored when skip_invite is set.
4935
5331
  */
4936
5332
  created_by_user_id?: string;
4937
5333
  /**
4938
- * Id of the internal user recorded as having last sent the worker's invite, and named as the sender on that person's in-app notification; must be a member of your company. Null, and ignored, when skip_invite is set.
5334
+ * Id of the internal user recorded as having last sent the worker's invite, and named as the sender on that person's in-app notification. Read like created_by_user_id. Null, and ignored, when skip_invite is set.
4939
5335
  */
4940
5336
  last_sent_by_user_id?: string | null;
4941
5337
  /**
@@ -5041,7 +5437,7 @@ export type UserParameters = ({
5041
5437
  */
5042
5438
  city?: string | null;
5043
5439
  /**
5044
- * Home address two-letter US state code.
5440
+ * Home address two-letter US state code; any other value is rejected.
5045
5441
  */
5046
5442
  state?: string | null;
5047
5443
  /**
@@ -5051,11 +5447,11 @@ export type UserParameters = ({
5051
5447
  /**
5052
5448
  * Worker race for demographic reporting, as an array of codes such as CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, and NOT_SPECIFIED.
5053
5449
  */
5054
- race?: Array<string> | null;
5450
+ race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'>;
5055
5451
  /**
5056
5452
  * Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
5057
5453
  */
5058
- sex?: string | null;
5454
+ sex?: 'female' | 'male' | 'non_binary' | 'not_specified' | null;
5059
5455
  /**
5060
5456
  * Local business license number, when a jurisdiction requires it on certified payroll.
5061
5457
  */
@@ -5068,26 +5464,26 @@ export type UserParameters = ({
5068
5464
  * Worker's driver's license number (stored encrypted).
5069
5465
  */
5070
5466
  drivers_license_number?: string | null;
5467
+ /**
5468
+ * Worker Social Security Number (nine digits, stored encrypted), required on certified payroll in some jurisdictions.
5469
+ */
5470
+ ssn?: string | null;
5071
5471
  /**
5072
5472
  * Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified.
5073
5473
  */
5074
- veteran_status?: string | null;
5474
+ veteran_status?: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified' | null;
5075
5475
  /**
5076
5476
  * Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified.
5077
5477
  */
5078
- hispanic_origin?: string | null;
5478
+ hispanic_origin?: 'yes' | 'no' | 'not_specified' | null;
5079
5479
  /**
5080
- * Worker Social Security Number (nine digits, stored encrypted), required on certified payroll in some jurisdictions.
5480
+ * Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR); an integer from 0 to 99.
5081
5481
  */
5082
- ssn?: string | null;
5482
+ ca_dir_withholding_exemptions?: number | null;
5083
5483
  /**
5084
5484
  * Whether the worker has a disability, for demographic reporting.
5085
5485
  */
5086
- disabled?: boolean | null;
5087
- /**
5088
- * Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR); an integer from 0 to 99.
5089
- */
5090
- ca_dir_withholding_exemptions?: number | null;
5486
+ disabled?: boolean;
5091
5487
  /**
5092
5488
  * Illinois DOL race classification for Illinois prevailing-wage reporting, as a single code such as white, black, or hispanic_or_latino. See the schema enum for the full set.
5093
5489
  */
@@ -5099,11 +5495,11 @@ export type UserParameters = ({
5099
5495
  /**
5100
5496
  * Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes such as eep_program_completed, foster_care, and formerly_incarcerated.
5101
5497
  */
5102
- il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'> | null;
5498
+ il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'>;
5103
5499
  /**
5104
5500
  * Illinois SHINES workforce-program participation for the worker, as an array of program codes such as solar_training_pipeline_program and craft_apprenticeship_program.
5105
5501
  */
5106
- il_shines_other_programs?: Array<'solar_training_pipeline_program' | 'craft_apprenticeship_program' | 'multi_cultural_jobs_program' | 'clean_jobs_workforce_network_program' | 'illinois_climate_works_prep_apprenticeship_program' | 'returning_residents_clean_jobs_training_program' | 'other'> | null;
5502
+ il_shines_other_programs?: Array<'solar_training_pipeline_program' | 'craft_apprenticeship_program' | 'multi_cultural_jobs_program' | 'clean_jobs_workforce_network_program' | 'illinois_climate_works_prep_apprenticeship_program' | 'returning_residents_clean_jobs_training_program' | 'other'>;
5107
5503
  /**
5108
5504
  * Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
5109
5505
  */
@@ -5111,7 +5507,7 @@ export type UserParameters = ({
5111
5507
  /**
5112
5508
  * Oregon BOLI race classification, as an array of codes such as white, asian, hispanic_or_latino, and black_or_african_american.
5113
5509
  */
5114
- or_boli_race?: Array<'american_indian_or_alaska_native' | 'asian' | 'hispanic_or_latino' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'white' | 'portuguese_or_brazilian'> | null;
5510
+ or_boli_race?: Array<'american_indian_or_alaska_native' | 'asian' | 'hispanic_or_latino' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'white' | 'portuguese_or_brazilian'>;
5115
5511
  } | null;
5116
5512
  };
5117
5513
  /**
@@ -5903,7 +6299,7 @@ export type CustomFieldConfigsResponseObject = {
5903
6299
  /**
5904
6300
  * The kind of record the field attaches to: one of apprenticeship_apprentice, company, job, or user_company.
5905
6301
  */
5906
- model_type: string;
6302
+ model_type: 'apprenticeship_apprentice' | 'company' | 'job' | 'user_company';
5907
6303
  /**
5908
6304
  * Whether the field is shown.
5909
6305
  */
@@ -5934,7 +6330,7 @@ export type CustomFieldConfigParameters = {
5934
6330
  */
5935
6331
  description?: string | null;
5936
6332
  /**
5937
- * The kind of record the field attaches to: one of apprenticeship_apprentice, company, job, or user_company. Any other value, or null, answers 422.
6333
+ * The kind of record the field attaches to: one of apprenticeship_apprentice, company, job, or user_company. It cannot change after creation. Any other value, or null, answers 422.
5938
6334
  */
5939
6335
  model_type: 'apprenticeship_apprentice' | 'company' | 'job' | 'user_company';
5940
6336
  /**
@@ -5943,7 +6339,7 @@ export type CustomFieldConfigParameters = {
5943
6339
  visible?: boolean;
5944
6340
  };
5945
6341
  /**
5946
- * Request body for updating a custom field definition. Every field is optional; omit a field to preserve its current value. The resulting definition's name must remain unique for its company and model type.
6342
+ * Request body for updating a custom field definition. Every field is optional; omit a field to preserve its current value. `model_type` is fixed at creation, so sending it answers 400. The resulting definition's name must remain unique for its company and model type.
5947
6343
  */
5948
6344
  export type CustomFieldConfigUpdateParameters = {
5949
6345
  /**
@@ -5954,10 +6350,6 @@ export type CustomFieldConfigUpdateParameters = {
5954
6350
  * Optional description of the custom field; omit to preserve it, or send null to clear it. A nonstring value other than null answers 422.
5955
6351
  */
5956
6352
  description?: string | null;
5957
- /**
5958
- * The kind of record the field attaches to: one of apprenticeship_apprentice, company, job, or user_company. Omit to preserve the current value; any other value, or null, answers 422.
5959
- */
5960
- model_type?: 'apprenticeship_apprentice' | 'company' | 'job' | 'user_company';
5961
6353
  /**
5962
6354
  * Whether the field is shown, as a JSON boolean; omit to preserve the current value. Null or a nonboolean value answers 422.
5963
6355
  */
@@ -6056,7 +6448,7 @@ export type UserCompanyScheduledChange = {
6056
6448
  /**
6057
6449
  * How the worker is paid: hourly or salary.
6058
6450
  */
6059
- compensation_type: string;
6451
+ compensation_type: 'hourly' | 'salary';
6060
6452
  /**
6061
6453
  * Whether the worker is eligible for overtime pay in this version.
6062
6454
  */
@@ -7651,7 +8043,7 @@ export type ProjectParameters = {
7651
8043
  */
7652
8044
  parent_id?: string | null;
7653
8045
  /**
7654
- * Complete desired set of participating company ID strings. Omit to preserve the set; send an empty array to clear it. Null, non-array values, or non-string members return 422 before any project or relationship is saved. Remove a participant's jobs before removing it from this set.
8046
+ * Complete desired set of unique nonblank participating company IDs. Omit to preserve the set; send an empty array to clear it. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422 before any project or relationship is saved. Remove a participant's jobs before removing it from this set.
7655
8047
  */
7656
8048
  participating_company_ids?: Array<string>;
7657
8049
  /**
@@ -7736,7 +8128,7 @@ export type ProjectUpdateParameters = {
7736
8128
  */
7737
8129
  parent_id?: string | null;
7738
8130
  /**
7739
- * Complete desired set of participating company ID strings. Omit to preserve the set; send an empty array to clear it. Null, non-array values, or non-string members return 422 before any project or relationship is saved. Remove a participant's jobs before removing it from this set.
8131
+ * Complete desired set of unique nonblank participating company IDs. Omit to preserve the set; send an empty array to clear it. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422 before any project or relationship is saved. Remove a participant's jobs before removing it from this set.
7740
8132
  */
7741
8133
  participating_company_ids?: Array<string>;
7742
8134
  /**
@@ -8024,7 +8416,7 @@ export type FeatureResponseObject = {
8024
8416
  updated_at: string;
8025
8417
  };
8026
8418
  /**
8027
- * A billing metric — the count of distinct prevailing-wage/apprenticeship (PWA) tracked workers on a project in a given month, aggregated for the billed company. One row per project per month.
8419
+ * A billing metric — the count of distinct prevailing-wage/apprenticeship (PWA) tracked workers on one billable unit in a given month, aggregated for the billed company. A billable unit is a project (one row per project per month, counting workers once across every job in the project tree) or a job outside any project (one row per job per month). Exactly one of `project_id` and `job_id` is set.
8028
8420
  */
8029
8421
  export type BillingPwaUserCountByProjectByMonthResponseObject = {
8030
8422
  /**
@@ -8040,15 +8432,23 @@ export type BillingPwaUserCountByProjectByMonthResponseObject = {
8040
8432
  */
8041
8433
  month: number;
8042
8434
  /**
8043
- * ID of the project the count is for.
8435
+ * ID of the project the count is for. `null` when the row is for a job outside any project.
8044
8436
  */
8045
- project_id: string;
8437
+ project_id: string | null;
8438
+ /**
8439
+ * Name of the project the count is for. `null` when the row is for a job outside any project.
8440
+ */
8441
+ project_name: string | null;
8442
+ /**
8443
+ * ID of the job the count is for. `null` when the row is for a project.
8444
+ */
8445
+ job_id: string | null;
8046
8446
  /**
8047
- * Name of the project the count is for.
8447
+ * Name of the job the count is for. `null` when the row is for a project.
8048
8448
  */
8049
- project_name: string;
8449
+ job_name: string | null;
8050
8450
  /**
8051
- * Distinct workers with PWA-tracked time on the project that month.
8451
+ * Distinct workers with PWA-tracked time on the project or job that month.
8052
8452
  */
8053
8453
  user_count: number;
8054
8454
  };
@@ -9822,11 +10222,11 @@ export type PositionResponseObject = {
9822
10222
  skill_level: string | null;
9823
10223
  };
9824
10224
  /**
9825
- * Start of the position's scheduled window (ISO 8601); null when unscheduled.
10225
+ * The position's first day, as a calendar date (`YYYY-MM-DD`) in the job's tz_name; null when unscheduled.
9826
10226
  */
9827
10227
  start_time: string | null;
9828
10228
  /**
9829
- * End of the position's scheduled window (ISO 8601); null when unscheduled.
10229
+ * The position's last day, as a calendar date (`YYYY-MM-DD`) in the job's tz_name; null when unscheduled.
9830
10230
  */
9831
10231
  end_time: string | null;
9832
10232
  /**
@@ -9921,11 +10321,11 @@ export type PositionParameters = {
9921
10321
  */
9922
10322
  fulfilled_by_user_id?: string | null;
9923
10323
  /**
9924
- * Start of the position's scheduled window (ISO 8601); must fall within the job's schedule.
10324
+ * The position's first day, as a calendar date (`YYYY-MM-DD`) in the job's tz_name. Required when the job has a schedule, and must fall within it. A time is refused with `422`. On update, null leaves the stored date unchanged.
9925
10325
  */
9926
10326
  start_time?: string | null;
9927
10327
  /**
9928
- * End of the position's scheduled window (ISO 8601); must be on or after start_time and within the job's schedule.
10328
+ * The position's last day, as a calendar date (`YYYY-MM-DD`) in the job's tz_name. Required when the job has a schedule, and must be on or after start_time and within it. A time is refused with `422`. On update, null leaves the stored date unchanged.
9929
10329
  */
9930
10330
  end_time?: string | null;
9931
10331
  /**
@@ -9961,7 +10361,7 @@ export type PositionParameters = {
9961
10361
  */
9962
10362
  wage_adder_rate_cents?: number | null;
9963
10363
  /**
9964
- * The complete desired set of job wage determination IDs. On PATCH, this replaces the current set; omit the field to leave assignments unchanged. Required federal and regional assignments cannot be removed from a PWA position. Must be an array of ID strings; malformed submitted lists are rejected before any changes are written.
10364
+ * The complete desired set of unique nonblank job wage determination IDs. On PATCH, this replaces the current set; omit the field to leave assignments unchanged. Required federal and regional assignments cannot be removed from a PWA position. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422 before any changes are written.
9965
10365
  */
9966
10366
  job_wage_determination_ids?: Array<string>;
9967
10367
  /**
@@ -10070,7 +10470,7 @@ export type ProductionCompletionUpdateParameters = {
10070
10470
  */
10071
10471
  work_date?: string;
10072
10472
  /**
10073
- * Job positions that performed the work. Omit to preserve the crew; a supplied list replaces it and must retain at least one position.
10473
+ * Unique nonblank IDs of the job positions that performed the work. Omit to preserve the crew; a supplied list replaces it and must retain at least one position. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422.
10074
10474
  */
10075
10475
  position_ids?: Array<string>;
10076
10476
  completable_attributes?: {
@@ -10085,9 +10485,9 @@ export type ProductionCompletionUpdateParameters = {
10085
10485
  */
10086
10486
  export type ProductionCompletionBaseParameters = {
10087
10487
  /**
10088
- * Scope price the work bills against; set on create only, and it determines the job.
10488
+ * Scope price the work bills against; set on create only, and it determines the job. Omission answers 400; a scope price the API key cannot see answers 404.
10089
10489
  */
10090
- production_job_scope_price_id?: string;
10490
+ production_job_scope_price_id: string;
10091
10491
  /**
10092
10492
  * ID of the company member filing the completion. Omission answers 400; supplied null, a blank ID, or a wrong type answers 422. A user outside the company that owns the API key answers 422.
10093
10493
  */
@@ -10101,7 +10501,7 @@ export type ProductionCompletionBaseParameters = {
10101
10501
  */
10102
10502
  work_date?: string;
10103
10503
  /**
10104
- * Job positions that performed the work (the crew). At least one is required; on update the list replaces the crew.
10504
+ * Unique nonblank IDs of the job positions that performed the work (the crew). At least one is required; on update the list replaces the crew. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422.
10105
10505
  */
10106
10506
  position_ids?: Array<string>;
10107
10507
  };
@@ -11481,10 +11881,6 @@ export type FederalJobWageDeterminationParameters = {
11481
11881
  * The DOL general wage determination the rates are drawn from — the general decision number plus its revision (e.g. "CA20230001/5"); null when not recorded.
11482
11882
  */
11483
11883
  general_wage_determination?: string | null;
11484
- /**
11485
- * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
11486
- */
11487
- pay_rates_rule_package_id?: string | null;
11488
11884
  };
11489
11885
  /**
11490
11886
  * Parameters for creating a Regional (state prevailing-wage) wage determination on a job.
@@ -11518,10 +11914,6 @@ export type RegionalJobWageDeterminationParameters = {
11518
11914
  * Overtime package whose rules govern overtime on work under this determination. This is not a versioned attribute: setting it points every version at that package, not only the one this request writes, and `effective_from` does not date it. Send null to detach, leaving the determination with no overtime package of its own. Omit the key to leave the current attachment alone. A package belonging to another company is refused, and a Federal determination refuses one outright — only a Regional determination carries overtime rules.
11519
11915
  */
11520
11916
  overtime_package_id?: string | null;
11521
- /**
11522
- * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
11523
- */
11524
- pay_rates_rule_package_id?: string | null;
11525
11917
  regional_fields?: RegionalWageDeterminationFields;
11526
11918
  };
11527
11919
  /**
@@ -11536,10 +11928,6 @@ export type JobWageDeterminationUpdateParameters = {
11536
11928
  * Overtime package whose rules govern overtime on work under this determination. This is not a versioned attribute: setting it points every version at that package, not only the one this request writes, and `effective_from` does not date it. Send null to detach, leaving the determination with no overtime package of its own. Omit the key to leave the current attachment alone. A package belonging to another company is refused, and a Federal determination refuses one outright — only a Regional determination carries overtime rules.
11537
11929
  */
11538
11930
  overtime_package_id?: string | null;
11539
- /**
11540
- * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
11541
- */
11542
- pay_rates_rule_package_id?: string | null;
11543
11931
  /**
11544
11932
  * Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
11545
11933
  */
@@ -11901,10 +12289,6 @@ export type FederalProjectWageDeterminationParameters = {
11901
12289
  * The DOL general wage determination the rates are drawn from — the general decision number plus its revision (e.g. "CA20230001/5"); null when not recorded.
11902
12290
  */
11903
12291
  general_wage_determination?: string | null;
11904
- /**
11905
- * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. A package belonging to another company is refused.
11906
- */
11907
- pay_rates_rule_package_id?: string | null;
11908
12292
  };
11909
12293
  /**
11910
12294
  * Parameters for creating a Regional (state prevailing-wage) wage determination on a project.
@@ -11938,10 +12322,6 @@ export type RegionalProjectWageDeterminationParameters = {
11938
12322
  * Overtime package whose rules govern overtime on work under this determination. This is not a versioned attribute: setting it points every version at that package, not only the one this request writes, and `effective_from` does not date it. Send null to detach, leaving the determination with no overtime package of its own. Omit the key to leave the current attachment alone. A package belonging to another company is refused, and a Federal determination refuses one outright — only a Regional determination carries overtime rules.
11939
12323
  */
11940
12324
  overtime_package_id?: string | null;
11941
- /**
11942
- * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. A package belonging to another company is refused.
11943
- */
11944
- pay_rates_rule_package_id?: string | null;
11945
12325
  regional_fields?: RegionalWageDeterminationFields;
11946
12326
  };
11947
12327
  /**
@@ -11956,10 +12336,6 @@ export type ProjectWageDeterminationUpdateParameters = {
11956
12336
  * Overtime package whose rules govern overtime on work under this determination. This is not a versioned attribute: setting it points every version at that package, not only the one this request writes, and `effective_from` does not date it. Send null to detach, leaving the determination with no overtime package of its own. Omit the key to leave the current attachment alone. A package belonging to another company is refused, and a Federal determination refuses one outright — only a Regional determination carries overtime rules.
11957
12337
  */
11958
12338
  overtime_package_id?: string | null;
11959
- /**
11960
- * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
11961
- */
11962
- pay_rates_rule_package_id?: string | null;
11963
12339
  /**
11964
12340
  * Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
11965
12341
  */
@@ -12341,7 +12717,7 @@ export type PayRatesRuleParameters = {
12341
12717
  */
12342
12718
  conditions?: Array<RateRuleCondition>;
12343
12719
  /**
12344
- * Calendar date when the rule begins in the package company's timezone; defaults to today there.
12720
+ * Calendar date when the rule begins in the package's timezone, which is that of the project or job holding the package, else its company's; defaults to today there.
12345
12721
  */
12346
12722
  effective_date?: string;
12347
12723
  };
@@ -12378,7 +12754,7 @@ export type PayRatesRuleScheduledTerminationParameters = {
12378
12754
  effective_date: string;
12379
12755
  };
12380
12756
  /**
12381
- * Schedule a rule recipe change from a company-local effective date.
12757
+ * Schedule a rule recipe change from an effective date in the package's timezone, which is that of the project or job holding the package, else its company's.
12382
12758
  */
12383
12759
  export type PayRatesRuleScheduledChangeParameters = {
12384
12760
  /**
@@ -13064,7 +13440,7 @@ export type AssetsFormAssignmentTriggerResponseObject = {
13064
13440
  */
13065
13441
  day_of_month_due: number | null;
13066
13442
  /**
13067
- * IANA time zone (e.g. "America/New_York") in which time_of_day_due is interpreted.
13443
+ * IANA time zone name (e.g. "US/Central") in which time_of_day_due is interpreted.
13068
13444
  */
13069
13445
  tz_name: string;
13070
13446
  /**
@@ -13096,6 +13472,10 @@ export type AssetsFormAssignmentTriggerParameters = {
13096
13472
  * ID of the form definition (a SurveyJS form template) this assignment is for.
13097
13473
  */
13098
13474
  form_definition_id: string;
13475
+ /**
13476
+ * Optional label for this trigger rule; null when unset.
13477
+ */
13478
+ name?: string | null;
13099
13479
  /**
13100
13480
  * The custody event that fires the rule: assignment (an item is assigned to a user) or unassignment (an item is removed from a user).
13101
13481
  */
@@ -13108,18 +13488,6 @@ export type AssetsFormAssignmentTriggerParameters = {
13108
13488
  * How the first due date is set: day_of_event (the day the rule fires), day_of_week (the next day_of_week_due), or day_of_month (day_of_month_due of the current or next month).
13109
13489
  */
13110
13490
  first_due_by: 'day_of_event' | 'day_of_week' | 'day_of_month';
13111
- /**
13112
- * IANA time zone (e.g. "America/New_York") in which time_of_day_due is interpreted.
13113
- */
13114
- tz_name: string;
13115
- /**
13116
- * Wall-clock time of day the form is due (HH:MM), interpreted in tz_name.
13117
- */
13118
- time_of_day_due: string;
13119
- /**
13120
- * Optional label for this trigger rule; null when unset.
13121
- */
13122
- name?: string | null;
13123
13491
  /**
13124
13492
  * How often the generated form recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment.
13125
13493
  */
@@ -13132,6 +13500,14 @@ export type AssetsFormAssignmentTriggerParameters = {
13132
13500
  * Day of month the form is first due, 1 to 31 (clamped to the month's last day). Required when first_due_by is day_of_month; null otherwise.
13133
13501
  */
13134
13502
  day_of_month_due?: number | null;
13503
+ /**
13504
+ * IANA time zone name (e.g. "US/Central") in which time_of_day_due is interpreted.
13505
+ */
13506
+ tz_name: string;
13507
+ /**
13508
+ * Wall-clock time of day the form is due (HH:MM), interpreted in tz_name.
13509
+ */
13510
+ time_of_day_due: string;
13135
13511
  /**
13136
13512
  * IDs of the users the generated form is assigned to. Used only when assign_to is custom; cleared for the other modes.
13137
13513
  */
@@ -13149,6 +13525,10 @@ export type AssetsFormAssignmentTriggerUpdateParameters = {
13149
13525
  * ID of the form definition (a SurveyJS form template) this assignment is for.
13150
13526
  */
13151
13527
  form_definition_id?: string;
13528
+ /**
13529
+ * Optional label for this trigger rule; null when unset.
13530
+ */
13531
+ name?: string | null;
13152
13532
  /**
13153
13533
  * The custody event that fires the rule: assignment (an item is assigned to a user) or unassignment (an item is removed from a user).
13154
13534
  */
@@ -13161,18 +13541,6 @@ export type AssetsFormAssignmentTriggerUpdateParameters = {
13161
13541
  * How the first due date is set: day_of_event (the day the rule fires), day_of_week (the next day_of_week_due), or day_of_month (day_of_month_due of the current or next month).
13162
13542
  */
13163
13543
  first_due_by?: 'day_of_event' | 'day_of_week' | 'day_of_month';
13164
- /**
13165
- * IANA time zone (e.g. "America/New_York") in which time_of_day_due is interpreted.
13166
- */
13167
- tz_name?: string;
13168
- /**
13169
- * Wall-clock time of day the form is due (HH:MM), interpreted in tz_name.
13170
- */
13171
- time_of_day_due?: string;
13172
- /**
13173
- * Optional label for this trigger rule; null when unset.
13174
- */
13175
- name?: string | null;
13176
13544
  /**
13177
13545
  * How often the generated form recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment.
13178
13546
  */
@@ -13185,6 +13553,14 @@ export type AssetsFormAssignmentTriggerUpdateParameters = {
13185
13553
  * Day of month the form is first due, 1 to 31 (clamped to the month's last day). Required when first_due_by is day_of_month; null otherwise.
13186
13554
  */
13187
13555
  day_of_month_due?: number | null;
13556
+ /**
13557
+ * IANA time zone name (e.g. "US/Central") in which time_of_day_due is interpreted.
13558
+ */
13559
+ tz_name?: string;
13560
+ /**
13561
+ * Wall-clock time of day the form is due (HH:MM), interpreted in tz_name.
13562
+ */
13563
+ time_of_day_due?: string;
13188
13564
  /**
13189
13565
  * IDs of the users the generated form is assigned to. Used only when assign_to is custom; cleared for the other modes.
13190
13566
  */
@@ -14360,7 +14736,7 @@ export type AssetsArchiveParameters = {
14360
14736
  */
14361
14737
  export type AssetsServiceScheduleSeedParameters = {
14362
14738
  /**
14363
- * Optional. Serial item IDs to seed; IDs outside the seedable items are skipped. Omit to seed every seedable item. An empty list, null, or a value that is not an array of strings answers 422.
14739
+ * Optional. Serial item IDs to seed. An ID the API key cannot see answers 404; a visible item the template cannot seed, or a blank member, answers 422 at that member. Omit to seed every seedable item. An empty list, null, or a value that is not an array of strings answers 422.
14364
14740
  */
14365
14741
  assets_item_ids?: Array<string>;
14366
14742
  /**
@@ -14373,7 +14749,7 @@ export type AssetsServiceScheduleSeedParameters = {
14373
14749
  */
14374
14750
  export type AssetsServiceScheduleSyncParameters = {
14375
14751
  /**
14376
- * Optional. Blocked schedule IDs to sync; IDs outside the blocked schedules are skipped. Omit to sync every blocked schedule. An empty list, null, or a value that is not an array of strings answers 422.
14752
+ * Optional. Blocked schedule IDs to sync. An ID the API key cannot see answers 404; a visible schedule the template cannot sync, or a blank member, answers 422 at that member. Omit to sync every blocked schedule. An empty list, null, or a value that is not an array of strings answers 422.
14377
14753
  */
14378
14754
  schedule_ids?: Array<string>;
14379
14755
  /**
@@ -14381,6 +14757,18 @@ export type AssetsServiceScheduleSyncParameters = {
14381
14757
  */
14382
14758
  performed_by_user_id: string;
14383
14759
  };
14760
+ /**
14761
+ * Archive a competence standard. The body takes no fields; send an empty object or no body. Archiving an archived standard returns it unchanged.
14762
+ */
14763
+ export type CompetencyStandardArchiveParametersWritable = {
14764
+ [key: string]: never;
14765
+ };
14766
+ /**
14767
+ * Revoke an active grant. The body takes no fields; send an empty object or no body. Revocation sets revoked_at and keeps the row; revoking it again answers 409 authorization_revoked.
14768
+ */
14769
+ export type CompetencyAssessorAuthorizationRevocationParametersWritable = {
14770
+ [key: string]: never;
14771
+ };
14384
14772
  /**
14385
14773
  * A page of certifications held by your company's workers.
14386
14774
  */
@@ -18629,6 +19017,10 @@ export type ListPwaUserCountsByProjectByMonthsData = {
18629
19017
  */
18630
19018
  'filter[year_month]'?: string;
18631
19019
  'filter[project_id]'?: string;
19020
+ /**
19021
+ * Filter to one job outside any project
19022
+ */
19023
+ 'filter[job_id]'?: string;
18632
19024
  filter?: string;
18633
19025
  'filter[unexpected]'?: string;
18634
19026
  };
@@ -19397,27 +19789,1175 @@ export type ListCompaniesErrors = {
19397
19789
  */
19398
19790
  403: Problem;
19399
19791
  };
19400
- export type ListCompaniesError = ListCompaniesErrors[keyof ListCompaniesErrors];
19401
- export type ListCompaniesResponses = {
19792
+ export type ListCompaniesError = ListCompaniesErrors[keyof ListCompaniesErrors];
19793
+ export type ListCompaniesResponses = {
19794
+ /**
19795
+ * Success
19796
+ */
19797
+ 200: {
19798
+ meta: Meta;
19799
+ links: Links;
19800
+ data: Array<CompanyResponseObject>;
19801
+ };
19802
+ };
19803
+ export type ListCompaniesResponse = ListCompaniesResponses[keyof ListCompaniesResponses];
19804
+ export type GetCompanyData = {
19805
+ body?: never;
19806
+ path: {
19807
+ id: string;
19808
+ };
19809
+ query?: never;
19810
+ url: '/api/v1/companies/{id}';
19811
+ };
19812
+ export type GetCompanyErrors = {
19813
+ /**
19814
+ * Forbidden
19815
+ */
19816
+ 403: Problem;
19817
+ /**
19818
+ * Not Found
19819
+ */
19820
+ 404: Problem;
19821
+ };
19822
+ export type GetCompanyError = GetCompanyErrors[keyof GetCompanyErrors];
19823
+ export type GetCompanyResponses = {
19824
+ /**
19825
+ * Success
19826
+ */
19827
+ 200: CompanyResponseObject;
19828
+ };
19829
+ export type GetCompanyResponse = GetCompanyResponses[keyof GetCompanyResponses];
19830
+ export type UpdateCompanyProfileData = {
19831
+ body: CompanyParameters;
19832
+ path: {
19833
+ id: string;
19834
+ };
19835
+ query?: never;
19836
+ url: '/api/v1/companies/{id}';
19837
+ };
19838
+ export type UpdateCompanyProfileErrors = {
19839
+ /**
19840
+ * Bad Request
19841
+ */
19842
+ 400: Problem;
19843
+ /**
19844
+ * Forbidden
19845
+ */
19846
+ 403: Problem;
19847
+ /**
19848
+ * Not Found
19849
+ */
19850
+ 404: Problem;
19851
+ /**
19852
+ * Unprocessable Content
19853
+ */
19854
+ 422: Problem;
19855
+ };
19856
+ export type UpdateCompanyProfileError = UpdateCompanyProfileErrors[keyof UpdateCompanyProfileErrors];
19857
+ export type UpdateCompanyProfileResponses = {
19858
+ /**
19859
+ * Success
19860
+ */
19861
+ 200: CompanyResponseObject;
19862
+ };
19863
+ export type UpdateCompanyProfileResponse = UpdateCompanyProfileResponses[keyof UpdateCompanyProfileResponses];
19864
+ export type ListAssessmentsData = {
19865
+ body?: never;
19866
+ path?: never;
19867
+ query?: {
19868
+ /**
19869
+ * Assessments of this candidate.
19870
+ */
19871
+ 'filter[candidate_user_id]'?: string;
19872
+ /**
19873
+ * Assessments pinned to this level.
19874
+ */
19875
+ 'filter[competencies_level_id]'?: string;
19876
+ /**
19877
+ * evidence_collection, submitted, in_review, or decided.
19878
+ */
19879
+ 'filter[status]'?: 'evidence_collection' | 'submitted' | 'in_review' | 'decided';
19880
+ /**
19881
+ * competent or not_yet_competent. Null until the assessment is decided.
19882
+ */
19883
+ 'filter[outcome]'?: 'competent' | 'not_yet_competent' | null;
19884
+ filter?: string;
19885
+ 'filter[unexpected]'?: string;
19886
+ };
19887
+ url: '/api/v1/competencies/assessments';
19888
+ };
19889
+ export type ListAssessmentsErrors = {
19890
+ /**
19891
+ * Bad Request
19892
+ */
19893
+ 400: Problem;
19894
+ /**
19895
+ * Forbidden
19896
+ */
19897
+ 403: Problem;
19898
+ };
19899
+ export type ListAssessmentsError = ListAssessmentsErrors[keyof ListAssessmentsErrors];
19900
+ export type ListAssessmentsResponses = {
19901
+ /**
19902
+ * Success
19903
+ */
19904
+ 200: {
19905
+ meta: Meta;
19906
+ links: Links;
19907
+ data: Array<CompetencyAssessmentResponseObject>;
19908
+ };
19909
+ };
19910
+ export type ListAssessmentsResponse = ListAssessmentsResponses[keyof ListAssessmentsResponses];
19911
+ export type GetAssessmentData = {
19912
+ body?: never;
19913
+ path: {
19914
+ id: string;
19915
+ };
19916
+ query?: never;
19917
+ url: '/api/v1/competencies/assessments/{id}';
19918
+ };
19919
+ export type GetAssessmentErrors = {
19920
+ /**
19921
+ * Forbidden
19922
+ */
19923
+ 403: Problem;
19924
+ /**
19925
+ * Not Found
19926
+ */
19927
+ 404: Problem;
19928
+ };
19929
+ export type GetAssessmentError = GetAssessmentErrors[keyof GetAssessmentErrors];
19930
+ export type GetAssessmentResponses = {
19931
+ /**
19932
+ * Success
19933
+ */
19934
+ 200: CompetencyAssessmentResponseObject;
19935
+ };
19936
+ export type GetAssessmentResponse = GetAssessmentResponses[keyof GetAssessmentResponses];
19937
+ export type ListAssessmentKeyActivitiesData = {
19938
+ body?: never;
19939
+ path: {
19940
+ assessment_id: string;
19941
+ };
19942
+ query?: {
19943
+ filter?: string;
19944
+ 'filter[unexpected]'?: string;
19945
+ };
19946
+ url: '/api/v1/competencies/assessments/{assessment_id}/key_activities';
19947
+ };
19948
+ export type ListAssessmentKeyActivitiesErrors = {
19949
+ /**
19950
+ * Bad Request
19951
+ */
19952
+ 400: Problem;
19953
+ /**
19954
+ * Forbidden
19955
+ */
19956
+ 403: Problem;
19957
+ };
19958
+ export type ListAssessmentKeyActivitiesError = ListAssessmentKeyActivitiesErrors[keyof ListAssessmentKeyActivitiesErrors];
19959
+ export type ListAssessmentKeyActivitiesResponses = {
19960
+ /**
19961
+ * Candidate sees a decided review
19962
+ */
19963
+ 200: {
19964
+ meta: Meta;
19965
+ links: Links;
19966
+ data: Array<CompetencyAssessmentKeyActivityResponseObject>;
19967
+ };
19968
+ };
19969
+ export type ListAssessmentKeyActivitiesResponse = ListAssessmentKeyActivitiesResponses[keyof ListAssessmentKeyActivitiesResponses];
19970
+ export type GetAssessmentKeyActivityData = {
19971
+ body?: never;
19972
+ path: {
19973
+ assessment_id: string;
19974
+ id: string;
19975
+ };
19976
+ query?: never;
19977
+ url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{id}';
19978
+ };
19979
+ export type GetAssessmentKeyActivityErrors = {
19980
+ /**
19981
+ * Forbidden
19982
+ */
19983
+ 403: Problem;
19984
+ };
19985
+ export type GetAssessmentKeyActivityError = GetAssessmentKeyActivityErrors[keyof GetAssessmentKeyActivityErrors];
19986
+ export type GetAssessmentKeyActivityResponses = {
19987
+ /**
19988
+ * Candidate sees a decided review
19989
+ */
19990
+ 200: CompetencyAssessmentKeyActivityResponseObject;
19991
+ };
19992
+ export type GetAssessmentKeyActivityResponse = GetAssessmentKeyActivityResponses[keyof GetAssessmentKeyActivityResponses];
19993
+ export type ListEvidenceItemsData = {
19994
+ body?: never;
19995
+ path: {
19996
+ assessment_id: string;
19997
+ key_activity_id: string;
19998
+ };
19999
+ query?: {
20000
+ /**
20001
+ * upload, form_submission, or certification.
20002
+ */
20003
+ 'filter[kind]'?: 'upload' | 'form_submission' | 'certification';
20004
+ filter?: string;
20005
+ 'filter[unexpected]'?: string;
20006
+ };
20007
+ url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{key_activity_id}/evidence_items';
20008
+ };
20009
+ export type ListEvidenceItemsErrors = {
20010
+ /**
20011
+ * Bad Request
20012
+ */
20013
+ 400: Problem;
20014
+ /**
20015
+ * Forbidden
20016
+ */
20017
+ 403: Problem;
20018
+ };
20019
+ export type ListEvidenceItemsError = ListEvidenceItemsErrors[keyof ListEvidenceItemsErrors];
20020
+ export type ListEvidenceItemsResponses = {
20021
+ /**
20022
+ * Success
20023
+ */
20024
+ 200: {
20025
+ meta: Meta;
20026
+ links: Links;
20027
+ data: Array<CompetencyEvidenceItemResponseObject>;
20028
+ };
20029
+ };
20030
+ export type ListEvidenceItemsResponse = ListEvidenceItemsResponses[keyof ListEvidenceItemsResponses];
20031
+ export type GetEvidenceItemData = {
20032
+ body?: never;
20033
+ path: {
20034
+ assessment_id: string;
20035
+ key_activity_id: string;
20036
+ id: string;
20037
+ };
20038
+ query?: never;
20039
+ url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{key_activity_id}/evidence_items/{id}';
20040
+ };
20041
+ export type GetEvidenceItemErrors = {
20042
+ /**
20043
+ * Forbidden
20044
+ */
20045
+ 403: Problem;
20046
+ };
20047
+ export type GetEvidenceItemError = GetEvidenceItemErrors[keyof GetEvidenceItemErrors];
20048
+ export type GetEvidenceItemResponses = {
20049
+ /**
20050
+ * Success
20051
+ */
20052
+ 200: CompetencyEvidenceItemResponseObject;
20053
+ };
20054
+ export type GetEvidenceItemResponse = GetEvidenceItemResponses[keyof GetEvidenceItemResponses];
20055
+ export type ListAssessorAuthorizationsData = {
20056
+ body?: never;
20057
+ path?: never;
20058
+ query?: {
20059
+ /**
20060
+ * Authorizations held by this user.
20061
+ */
20062
+ 'filter[user_id]'?: string;
20063
+ /**
20064
+ * Authorizations noted against this department.
20065
+ */
20066
+ 'filter[companies_department_id]'?: string;
20067
+ /**
20068
+ * Authorizations for this standard.
20069
+ */
20070
+ 'filter[competencies_standard_id]'?: string;
20071
+ /**
20072
+ * Authorizations of any of the given kinds. Comma-separate to match both (`authorized_assessor,qualified_assessor`).
20073
+ */
20074
+ 'filter[kind]'?: Array<'authorized_assessor' | 'qualified_assessor'>;
20075
+ /**
20076
+ * Filter by lifecycle state. Defaults to `active` (non-active records are hidden); `revoked` returns only non-active records; `all` returns both.
20077
+ */
20078
+ 'filter[state]'?: 'active' | 'revoked' | 'all';
20079
+ 'filter[created_at][gte]'?: string;
20080
+ 'filter[created_at][lte]'?: string;
20081
+ 'filter[updated_at][gte]'?: string;
20082
+ 'filter[updated_at][lte]'?: string;
20083
+ 'filter[granted_at][gte]'?: string;
20084
+ 'filter[granted_at][lte]'?: string;
20085
+ 'filter[revoked_at][gte]'?: string;
20086
+ 'filter[revoked_at][lte]'?: string;
20087
+ filter?: string;
20088
+ 'filter[unexpected]'?: string;
20089
+ /**
20090
+ * This pagination cursor corresponds to the cursor value found in the response in
20091
+ * `meta.page.next_cursor`.
20092
+ */
20093
+ 'page[cursor]'?: string;
20094
+ /**
20095
+ * 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`.
20096
+ */
20097
+ 'page[limit]'?: number;
20098
+ page?: string;
20099
+ };
20100
+ url: '/api/v1/competencies/assessor_authorizations';
20101
+ };
20102
+ export type ListAssessorAuthorizationsErrors = {
20103
+ /**
20104
+ * Bad Request
20105
+ */
20106
+ 400: Problem;
20107
+ /**
20108
+ * Forbidden
20109
+ */
20110
+ 403: Problem;
20111
+ /**
20112
+ * Unprocessable Content
20113
+ */
20114
+ 422: Problem;
20115
+ };
20116
+ export type ListAssessorAuthorizationsError = ListAssessorAuthorizationsErrors[keyof ListAssessorAuthorizationsErrors];
20117
+ export type ListAssessorAuthorizationsResponses = {
20118
+ /**
20119
+ * Success
20120
+ */
20121
+ 200: {
20122
+ meta: Meta;
20123
+ links: Links;
20124
+ data: Array<CompetencyAssessorAuthorizationResponseObject>;
20125
+ };
20126
+ };
20127
+ export type ListAssessorAuthorizationsResponse = ListAssessorAuthorizationsResponses[keyof ListAssessorAuthorizationsResponses];
20128
+ export type CreateAssessorAuthorizationData = {
20129
+ body: CompetencyAssessorAuthorizationParameters;
20130
+ path?: never;
20131
+ query?: never;
20132
+ url: '/api/v1/competencies/assessor_authorizations';
20133
+ };
20134
+ export type CreateAssessorAuthorizationErrors = {
20135
+ /**
20136
+ * Bad Request
20137
+ */
20138
+ 400: Problem;
20139
+ /**
20140
+ * Forbidden
20141
+ */
20142
+ 403: Problem;
20143
+ /**
20144
+ * Not Found
20145
+ */
20146
+ 404: Problem;
20147
+ /**
20148
+ * Unprocessable Content
20149
+ */
20150
+ 422: Problem;
20151
+ };
20152
+ export type CreateAssessorAuthorizationError = CreateAssessorAuthorizationErrors[keyof CreateAssessorAuthorizationErrors];
20153
+ export type CreateAssessorAuthorizationResponses = {
20154
+ /**
20155
+ * Created
20156
+ */
20157
+ 201: CompetencyAssessorAuthorizationResponseObject;
20158
+ };
20159
+ export type CreateAssessorAuthorizationResponse = CreateAssessorAuthorizationResponses[keyof CreateAssessorAuthorizationResponses];
20160
+ export type GetAssessorAuthorizationData = {
20161
+ body?: never;
20162
+ path: {
20163
+ id: string;
20164
+ };
20165
+ query?: never;
20166
+ url: '/api/v1/competencies/assessor_authorizations/{id}';
20167
+ };
20168
+ export type GetAssessorAuthorizationErrors = {
20169
+ /**
20170
+ * Forbidden
20171
+ */
20172
+ 403: Problem;
20173
+ /**
20174
+ * Not Found
20175
+ */
20176
+ 404: Problem;
20177
+ };
20178
+ export type GetAssessorAuthorizationError = GetAssessorAuthorizationErrors[keyof GetAssessorAuthorizationErrors];
20179
+ export type GetAssessorAuthorizationResponses = {
20180
+ /**
20181
+ * Success
20182
+ */
20183
+ 200: CompetencyAssessorAuthorizationResponseObject;
20184
+ };
20185
+ export type GetAssessorAuthorizationResponse = GetAssessorAuthorizationResponses[keyof GetAssessorAuthorizationResponses];
20186
+ export type UpdateAssessorAuthorizationData = {
20187
+ body?: CompetencyAssessorAuthorizationUpdateParameters;
20188
+ path: {
20189
+ id: string;
20190
+ };
20191
+ query?: never;
20192
+ url: '/api/v1/competencies/assessor_authorizations/{id}';
20193
+ };
20194
+ export type UpdateAssessorAuthorizationErrors = {
20195
+ /**
20196
+ * Bad Request
20197
+ */
20198
+ 400: Problem;
20199
+ /**
20200
+ * Forbidden
20201
+ */
20202
+ 403: Problem;
20203
+ /**
20204
+ * Not Found
20205
+ */
20206
+ 404: Problem;
20207
+ /**
20208
+ * Conflict
20209
+ */
20210
+ 409: Problem;
20211
+ };
20212
+ export type UpdateAssessorAuthorizationError = UpdateAssessorAuthorizationErrors[keyof UpdateAssessorAuthorizationErrors];
20213
+ export type UpdateAssessorAuthorizationResponses = {
20214
+ /**
20215
+ * Success
20216
+ */
20217
+ 200: CompetencyAssessorAuthorizationResponseObject;
20218
+ };
20219
+ export type UpdateAssessorAuthorizationResponse = UpdateAssessorAuthorizationResponses[keyof UpdateAssessorAuthorizationResponses];
20220
+ export type RevokeAssessorAuthorizationData = {
20221
+ body?: CompetencyAssessorAuthorizationRevocationParametersWritable;
20222
+ path: {
20223
+ assessor_authorization_id: string;
20224
+ };
20225
+ query?: never;
20226
+ url: '/api/v1/competencies/assessor_authorizations/{assessor_authorization_id}/revocation';
20227
+ };
20228
+ export type RevokeAssessorAuthorizationErrors = {
20229
+ /**
20230
+ * Bad Request
20231
+ */
20232
+ 400: Problem;
20233
+ /**
20234
+ * Forbidden
20235
+ */
20236
+ 403: Problem;
20237
+ /**
20238
+ * Not Found
20239
+ */
20240
+ 404: Problem;
20241
+ /**
20242
+ * Conflict
20243
+ */
20244
+ 409: Problem;
20245
+ };
20246
+ export type RevokeAssessorAuthorizationError = RevokeAssessorAuthorizationErrors[keyof RevokeAssessorAuthorizationErrors];
20247
+ export type RevokeAssessorAuthorizationResponses = {
20248
+ /**
20249
+ * Created
20250
+ */
20251
+ 201: CompetencyAssessorAuthorizationResponseObject;
20252
+ };
20253
+ export type RevokeAssessorAuthorizationResponse = RevokeAssessorAuthorizationResponses[keyof RevokeAssessorAuthorizationResponses];
20254
+ export type ListLevelsData = {
20255
+ body?: never;
20256
+ path: {
20257
+ standard_id: string;
20258
+ version_id: string;
20259
+ };
20260
+ query?: {
20261
+ filter?: string;
20262
+ 'filter[unexpected]'?: string;
20263
+ };
20264
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels';
20265
+ };
20266
+ export type ListLevelsErrors = {
20267
+ /**
20268
+ * Bad Request
20269
+ */
20270
+ 400: Problem;
20271
+ /**
20272
+ * Forbidden
20273
+ */
20274
+ 403: Problem;
20275
+ };
20276
+ export type ListLevelsError = ListLevelsErrors[keyof ListLevelsErrors];
20277
+ export type ListLevelsResponses = {
20278
+ /**
20279
+ * Success
20280
+ */
20281
+ 200: {
20282
+ meta: Meta;
20283
+ links: Links;
20284
+ data: Array<CompetencyLevelResponseObject>;
20285
+ };
20286
+ };
20287
+ export type ListLevelsResponse = ListLevelsResponses[keyof ListLevelsResponses];
20288
+ export type CreateLevelData = {
20289
+ body?: CompetencyLevelParameters;
20290
+ path: {
20291
+ standard_id: string;
20292
+ version_id: string;
20293
+ };
20294
+ query?: never;
20295
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels';
20296
+ };
20297
+ export type CreateLevelErrors = {
20298
+ /**
20299
+ * Bad Request
20300
+ */
20301
+ 400: Problem;
20302
+ /**
20303
+ * Forbidden
20304
+ */
20305
+ 403: Problem;
20306
+ };
20307
+ export type CreateLevelError = CreateLevelErrors[keyof CreateLevelErrors];
20308
+ export type CreateLevelResponses = {
20309
+ /**
20310
+ * Created
20311
+ */
20312
+ 201: CompetencyLevelResponseObject;
20313
+ };
20314
+ export type CreateLevelResponse = CreateLevelResponses[keyof CreateLevelResponses];
20315
+ export type DeleteLevelData = {
20316
+ body?: never;
20317
+ path: {
20318
+ standard_id: string;
20319
+ version_id: string;
20320
+ id: string;
20321
+ };
20322
+ query?: never;
20323
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}';
20324
+ };
20325
+ export type DeleteLevelErrors = {
20326
+ /**
20327
+ * Forbidden
20328
+ */
20329
+ 403: unknown;
20330
+ };
20331
+ export type DeleteLevelResponses = {
20332
+ /**
20333
+ * No Content
20334
+ */
20335
+ 204: void;
20336
+ };
20337
+ export type DeleteLevelResponse = DeleteLevelResponses[keyof DeleteLevelResponses];
20338
+ export type GetLevelData = {
20339
+ body?: never;
20340
+ path: {
20341
+ standard_id: string;
20342
+ version_id: string;
20343
+ id: string;
20344
+ };
20345
+ query?: never;
20346
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}';
20347
+ };
20348
+ export type GetLevelErrors = {
20349
+ /**
20350
+ * Forbidden
20351
+ */
20352
+ 403: Problem;
20353
+ /**
20354
+ * Not Found
20355
+ */
20356
+ 404: Problem;
20357
+ };
20358
+ export type GetLevelError = GetLevelErrors[keyof GetLevelErrors];
20359
+ export type GetLevelResponses = {
20360
+ /**
20361
+ * Success
20362
+ */
20363
+ 200: CompetencyLevelResponseObject;
20364
+ };
20365
+ export type GetLevelResponse = GetLevelResponses[keyof GetLevelResponses];
20366
+ export type UpdateLevelData = {
20367
+ body?: CompetencyLevelParameters;
20368
+ path: {
20369
+ standard_id: string;
20370
+ version_id: string;
20371
+ id: string;
20372
+ };
20373
+ query?: never;
20374
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}';
20375
+ };
20376
+ export type UpdateLevelErrors = {
20377
+ /**
20378
+ * Bad Request
20379
+ */
20380
+ 400: Problem;
20381
+ /**
20382
+ * Forbidden
20383
+ */
20384
+ 403: Problem;
20385
+ };
20386
+ export type UpdateLevelError = UpdateLevelErrors[keyof UpdateLevelErrors];
20387
+ export type UpdateLevelResponses = {
20388
+ /**
20389
+ * Success
20390
+ */
20391
+ 200: CompetencyLevelResponseObject;
20392
+ };
20393
+ export type UpdateLevelResponse = UpdateLevelResponses[keyof UpdateLevelResponses];
20394
+ export type MoveCompetencyLevelData = {
20395
+ body?: CompetencySortOrderMoveParameters;
20396
+ path: {
20397
+ standard_id: string;
20398
+ version_id: string;
20399
+ level_id: string;
20400
+ };
20401
+ query?: never;
20402
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/move';
20403
+ };
20404
+ export type MoveCompetencyLevelErrors = {
20405
+ /**
20406
+ * Bad Request
20407
+ */
20408
+ 400: Problem;
20409
+ /**
20410
+ * Forbidden
20411
+ */
20412
+ 403: Problem;
20413
+ /**
20414
+ * Unmovable
20415
+ */
20416
+ 422: Problem;
20417
+ };
20418
+ export type MoveCompetencyLevelError = MoveCompetencyLevelErrors[keyof MoveCompetencyLevelErrors];
20419
+ export type MoveCompetencyLevelResponses = {
20420
+ /**
20421
+ * Success
20422
+ */
20423
+ 200: CompetencyLevelResponseObject;
20424
+ };
20425
+ export type MoveCompetencyLevelResponse = MoveCompetencyLevelResponses[keyof MoveCompetencyLevelResponses];
20426
+ export type ListKeyActivitiesData = {
20427
+ body?: never;
20428
+ path: {
20429
+ standard_id: string;
20430
+ version_id: string;
20431
+ level_id: string;
20432
+ };
20433
+ query?: {
20434
+ filter?: string;
20435
+ 'filter[unexpected]'?: string;
20436
+ };
20437
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities';
20438
+ };
20439
+ export type ListKeyActivitiesErrors = {
20440
+ /**
20441
+ * Bad Request
20442
+ */
20443
+ 400: Problem;
20444
+ /**
20445
+ * Forbidden
20446
+ */
20447
+ 403: Problem;
20448
+ };
20449
+ export type ListKeyActivitiesError = ListKeyActivitiesErrors[keyof ListKeyActivitiesErrors];
20450
+ export type ListKeyActivitiesResponses = {
20451
+ /**
20452
+ * Success
20453
+ */
20454
+ 200: {
20455
+ meta: Meta;
20456
+ links: Links;
20457
+ data: Array<CompetencyKeyActivityResponseObject>;
20458
+ };
20459
+ };
20460
+ export type ListKeyActivitiesResponse = ListKeyActivitiesResponses[keyof ListKeyActivitiesResponses];
20461
+ export type CreateKeyActivityData = {
20462
+ body?: CompetencyKeyActivityParameters;
20463
+ path: {
20464
+ standard_id: string;
20465
+ version_id: string;
20466
+ level_id: string;
20467
+ };
20468
+ query?: never;
20469
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities';
20470
+ };
20471
+ export type CreateKeyActivityErrors = {
20472
+ /**
20473
+ * Bad Request
20474
+ */
20475
+ 400: Problem;
20476
+ /**
20477
+ * Forbidden
20478
+ */
20479
+ 403: Problem;
20480
+ };
20481
+ export type CreateKeyActivityError = CreateKeyActivityErrors[keyof CreateKeyActivityErrors];
20482
+ export type CreateKeyActivityResponses = {
20483
+ /**
20484
+ * Created
20485
+ */
20486
+ 201: CompetencyKeyActivityResponseObject;
20487
+ };
20488
+ export type CreateKeyActivityResponse = CreateKeyActivityResponses[keyof CreateKeyActivityResponses];
20489
+ export type DeleteKeyActivityData = {
20490
+ body?: never;
20491
+ path: {
20492
+ standard_id: string;
20493
+ version_id: string;
20494
+ level_id: string;
20495
+ id: string;
20496
+ };
20497
+ query?: never;
20498
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}';
20499
+ };
20500
+ export type DeleteKeyActivityErrors = {
20501
+ /**
20502
+ * Forbidden
20503
+ */
20504
+ 403: unknown;
20505
+ };
20506
+ export type DeleteKeyActivityResponses = {
20507
+ /**
20508
+ * No Content
20509
+ */
20510
+ 204: void;
20511
+ };
20512
+ export type DeleteKeyActivityResponse = DeleteKeyActivityResponses[keyof DeleteKeyActivityResponses];
20513
+ export type GetKeyActivityData = {
20514
+ body?: never;
20515
+ path: {
20516
+ standard_id: string;
20517
+ version_id: string;
20518
+ level_id: string;
20519
+ id: string;
20520
+ };
20521
+ query?: never;
20522
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}';
20523
+ };
20524
+ export type GetKeyActivityErrors = {
20525
+ /**
20526
+ * Forbidden
20527
+ */
20528
+ 403: Problem;
20529
+ };
20530
+ export type GetKeyActivityError = GetKeyActivityErrors[keyof GetKeyActivityErrors];
20531
+ export type GetKeyActivityResponses = {
20532
+ /**
20533
+ * Success
20534
+ */
20535
+ 200: CompetencyKeyActivityResponseObject;
20536
+ };
20537
+ export type GetKeyActivityResponse = GetKeyActivityResponses[keyof GetKeyActivityResponses];
20538
+ export type UpdateKeyActivityData = {
20539
+ body?: CompetencyKeyActivityParameters;
20540
+ path: {
20541
+ standard_id: string;
20542
+ version_id: string;
20543
+ level_id: string;
20544
+ id: string;
20545
+ };
20546
+ query?: never;
20547
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}';
20548
+ };
20549
+ export type UpdateKeyActivityErrors = {
20550
+ /**
20551
+ * Bad Request
20552
+ */
20553
+ 400: Problem;
20554
+ /**
20555
+ * Forbidden
20556
+ */
20557
+ 403: Problem;
20558
+ };
20559
+ export type UpdateKeyActivityError = UpdateKeyActivityErrors[keyof UpdateKeyActivityErrors];
20560
+ export type UpdateKeyActivityResponses = {
20561
+ /**
20562
+ * Success
20563
+ */
20564
+ 200: CompetencyKeyActivityResponseObject;
20565
+ };
20566
+ export type UpdateKeyActivityResponse = UpdateKeyActivityResponses[keyof UpdateKeyActivityResponses];
20567
+ export type MoveCompetencyKeyActivityData = {
20568
+ body?: CompetencySortOrderMoveParameters;
20569
+ path: {
20570
+ standard_id: string;
20571
+ version_id: string;
20572
+ level_id: string;
20573
+ key_activity_id: string;
20574
+ };
20575
+ query?: never;
20576
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/move';
20577
+ };
20578
+ export type MoveCompetencyKeyActivityErrors = {
20579
+ /**
20580
+ * Bad Request
20581
+ */
20582
+ 400: Problem;
20583
+ /**
20584
+ * Forbidden
20585
+ */
20586
+ 403: Problem;
20587
+ /**
20588
+ * Unmovable
20589
+ */
20590
+ 422: Problem;
20591
+ };
20592
+ export type MoveCompetencyKeyActivityError = MoveCompetencyKeyActivityErrors[keyof MoveCompetencyKeyActivityErrors];
20593
+ export type MoveCompetencyKeyActivityResponses = {
20594
+ /**
20595
+ * Success
20596
+ */
20597
+ 200: CompetencyKeyActivityResponseObject;
20598
+ };
20599
+ export type MoveCompetencyKeyActivityResponse = MoveCompetencyKeyActivityResponses[keyof MoveCompetencyKeyActivityResponses];
20600
+ export type ListCriteriaData = {
20601
+ body?: never;
20602
+ path: {
20603
+ standard_id: string;
20604
+ version_id: string;
20605
+ level_id: string;
20606
+ key_activity_id: string;
20607
+ };
20608
+ query?: {
20609
+ filter?: string;
20610
+ 'filter[unexpected]'?: string;
20611
+ };
20612
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria';
20613
+ };
20614
+ export type ListCriteriaErrors = {
20615
+ /**
20616
+ * Bad Request
20617
+ */
20618
+ 400: Problem;
20619
+ /**
20620
+ * Forbidden
20621
+ */
20622
+ 403: Problem;
20623
+ };
20624
+ export type ListCriteriaError = ListCriteriaErrors[keyof ListCriteriaErrors];
20625
+ export type ListCriteriaResponses = {
20626
+ /**
20627
+ * Success
20628
+ */
20629
+ 200: {
20630
+ meta: Meta;
20631
+ links: Links;
20632
+ data: Array<CompetencyCriterionResponseObject>;
20633
+ };
20634
+ };
20635
+ export type ListCriteriaResponse = ListCriteriaResponses[keyof ListCriteriaResponses];
20636
+ export type CreateCriterionData = {
20637
+ body?: CompetencyCriterionParameters;
20638
+ path: {
20639
+ standard_id: string;
20640
+ version_id: string;
20641
+ level_id: string;
20642
+ key_activity_id: string;
20643
+ };
20644
+ query?: never;
20645
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria';
20646
+ };
20647
+ export type CreateCriterionErrors = {
20648
+ /**
20649
+ * Bad Request
20650
+ */
20651
+ 400: Problem;
20652
+ /**
20653
+ * Forbidden
20654
+ */
20655
+ 403: Problem;
20656
+ };
20657
+ export type CreateCriterionError = CreateCriterionErrors[keyof CreateCriterionErrors];
20658
+ export type CreateCriterionResponses = {
20659
+ /**
20660
+ * Created
20661
+ */
20662
+ 201: CompetencyCriterionResponseObject;
20663
+ };
20664
+ export type CreateCriterionResponse = CreateCriterionResponses[keyof CreateCriterionResponses];
20665
+ export type DeleteCriterionData = {
20666
+ body?: never;
20667
+ path: {
20668
+ standard_id: string;
20669
+ version_id: string;
20670
+ level_id: string;
20671
+ key_activity_id: string;
20672
+ id: string;
20673
+ };
20674
+ query?: never;
20675
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}';
20676
+ };
20677
+ export type DeleteCriterionErrors = {
20678
+ /**
20679
+ * Forbidden
20680
+ */
20681
+ 403: unknown;
20682
+ };
20683
+ export type DeleteCriterionResponses = {
20684
+ /**
20685
+ * No Content
20686
+ */
20687
+ 204: void;
20688
+ };
20689
+ export type DeleteCriterionResponse = DeleteCriterionResponses[keyof DeleteCriterionResponses];
20690
+ export type GetCriterionData = {
20691
+ body?: never;
20692
+ path: {
20693
+ standard_id: string;
20694
+ version_id: string;
20695
+ level_id: string;
20696
+ key_activity_id: string;
20697
+ id: string;
20698
+ };
20699
+ query?: never;
20700
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}';
20701
+ };
20702
+ export type GetCriterionErrors = {
20703
+ /**
20704
+ * Forbidden
20705
+ */
20706
+ 403: Problem;
20707
+ };
20708
+ export type GetCriterionError = GetCriterionErrors[keyof GetCriterionErrors];
20709
+ export type GetCriterionResponses = {
20710
+ /**
20711
+ * Success
20712
+ */
20713
+ 200: CompetencyCriterionResponseObject;
20714
+ };
20715
+ export type GetCriterionResponse = GetCriterionResponses[keyof GetCriterionResponses];
20716
+ export type UpdateCriterionData = {
20717
+ body?: CompetencyCriterionParameters;
20718
+ path: {
20719
+ standard_id: string;
20720
+ version_id: string;
20721
+ level_id: string;
20722
+ key_activity_id: string;
20723
+ id: string;
20724
+ };
20725
+ query?: never;
20726
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}';
20727
+ };
20728
+ export type UpdateCriterionErrors = {
20729
+ /**
20730
+ * Bad Request
20731
+ */
20732
+ 400: Problem;
20733
+ /**
20734
+ * Forbidden
20735
+ */
20736
+ 403: Problem;
20737
+ };
20738
+ export type UpdateCriterionError = UpdateCriterionErrors[keyof UpdateCriterionErrors];
20739
+ export type UpdateCriterionResponses = {
20740
+ /**
20741
+ * Success
20742
+ */
20743
+ 200: CompetencyCriterionResponseObject;
20744
+ };
20745
+ export type UpdateCriterionResponse = UpdateCriterionResponses[keyof UpdateCriterionResponses];
20746
+ export type MoveCompetencyCriterionData = {
20747
+ body?: CompetencySortOrderMoveParameters;
20748
+ path: {
20749
+ standard_id: string;
20750
+ version_id: string;
20751
+ level_id: string;
20752
+ key_activity_id: string;
20753
+ criterion_id: string;
20754
+ };
20755
+ query?: never;
20756
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{criterion_id}/move';
20757
+ };
20758
+ export type MoveCompetencyCriterionErrors = {
20759
+ /**
20760
+ * Bad Request
20761
+ */
20762
+ 400: Problem;
20763
+ /**
20764
+ * Forbidden
20765
+ */
20766
+ 403: Problem;
20767
+ /**
20768
+ * Unmovable
20769
+ */
20770
+ 422: Problem;
20771
+ };
20772
+ export type MoveCompetencyCriterionError = MoveCompetencyCriterionErrors[keyof MoveCompetencyCriterionErrors];
20773
+ export type MoveCompetencyCriterionResponses = {
20774
+ /**
20775
+ * Success
20776
+ */
20777
+ 200: CompetencyCriterionResponseObject;
20778
+ };
20779
+ export type MoveCompetencyCriterionResponse = MoveCompetencyCriterionResponses[keyof MoveCompetencyCriterionResponses];
20780
+ export type ListQualificationsData = {
20781
+ body?: never;
20782
+ path?: never;
20783
+ query?: {
20784
+ /**
20785
+ * Standings held by this candidate.
20786
+ */
20787
+ 'filter[candidate_user_id]'?: string;
20788
+ /**
20789
+ * Standings against this standard.
20790
+ */
20791
+ 'filter[competencies_standard_id]'?: string;
20792
+ /**
20793
+ * Standings at this tier.
20794
+ */
20795
+ 'filter[level_sort_order]'?: number;
20796
+ filter?: string;
20797
+ 'filter[unexpected]'?: string;
20798
+ /**
20799
+ * This pagination cursor corresponds to the cursor value found in the response in
20800
+ * `meta.page.next_cursor`.
20801
+ */
20802
+ 'page[cursor]'?: string;
20803
+ /**
20804
+ * 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`.
20805
+ */
20806
+ 'page[limit]'?: number;
20807
+ page?: string;
20808
+ };
20809
+ url: '/api/v1/competencies/qualifications';
20810
+ };
20811
+ export type ListQualificationsErrors = {
20812
+ /**
20813
+ * Bad Request
20814
+ */
20815
+ 400: Problem;
20816
+ /**
20817
+ * Forbidden
20818
+ */
20819
+ 403: Problem;
20820
+ };
20821
+ export type ListQualificationsError = ListQualificationsErrors[keyof ListQualificationsErrors];
20822
+ export type ListQualificationsResponses = {
20823
+ /**
20824
+ * Success
20825
+ */
20826
+ 200: {
20827
+ meta: Meta;
20828
+ links: Links;
20829
+ data: Array<CompetencyQualificationResponseObject>;
20830
+ };
20831
+ };
20832
+ export type ListQualificationsResponse = ListQualificationsResponses[keyof ListQualificationsResponses];
20833
+ export type GetQualificationData = {
20834
+ body?: never;
20835
+ path: {
20836
+ id: string;
20837
+ };
20838
+ query?: never;
20839
+ url: '/api/v1/competencies/qualifications/{id}';
20840
+ };
20841
+ export type GetQualificationErrors = {
20842
+ /**
20843
+ * Forbidden
20844
+ */
20845
+ 403: Problem;
20846
+ /**
20847
+ * Not Found
20848
+ */
20849
+ 404: Problem;
20850
+ };
20851
+ export type GetQualificationError = GetQualificationErrors[keyof GetQualificationErrors];
20852
+ export type GetQualificationResponses = {
20853
+ /**
20854
+ * Success
20855
+ */
20856
+ 200: CompetencyQualificationResponseObject;
20857
+ };
20858
+ export type GetQualificationResponse = GetQualificationResponses[keyof GetQualificationResponses];
20859
+ export type ListStandardsData = {
20860
+ body?: never;
20861
+ path?: never;
20862
+ query?: {
20863
+ /**
20864
+ * Case-insensitive substring match on the standard name.
20865
+ */
20866
+ 'filter[name]'?: string;
20867
+ /**
20868
+ * Standards filed under this department.
20869
+ */
20870
+ 'filter[companies_department_id]'?: string;
20871
+ /**
20872
+ * `active` has a promoted revision and is not archived. `draft` has a draft and no active revision. `archived` is archived.
20873
+ */
20874
+ 'filter[catalog_status]'?: 'active' | 'draft' | 'archived';
20875
+ 'filter[created_at][gte]'?: string;
20876
+ 'filter[created_at][lte]'?: string;
20877
+ 'filter[updated_at][gte]'?: string;
20878
+ 'filter[updated_at][lte]'?: string;
20879
+ filter?: string;
20880
+ 'filter[unexpected]'?: string;
20881
+ /**
20882
+ * This pagination cursor corresponds to the cursor value found in the response in
20883
+ * `meta.page.next_cursor`.
20884
+ */
20885
+ 'page[cursor]'?: string;
20886
+ /**
20887
+ * 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`.
20888
+ */
20889
+ 'page[limit]'?: number;
20890
+ page?: string;
20891
+ };
20892
+ url: '/api/v1/competencies/standards';
20893
+ };
20894
+ export type ListStandardsErrors = {
20895
+ /**
20896
+ * Bad Request
20897
+ */
20898
+ 400: Problem;
20899
+ /**
20900
+ * Forbidden
20901
+ */
20902
+ 403: Problem;
20903
+ /**
20904
+ * Unprocessable Content
20905
+ */
20906
+ 422: Problem;
20907
+ };
20908
+ export type ListStandardsError = ListStandardsErrors[keyof ListStandardsErrors];
20909
+ export type ListStandardsResponses = {
20910
+ /**
20911
+ * Success
20912
+ */
20913
+ 200: {
20914
+ meta: Meta;
20915
+ links: Links;
20916
+ data: Array<CompetencyStandardResponseObject>;
20917
+ };
20918
+ };
20919
+ export type ListStandardsResponse = ListStandardsResponses[keyof ListStandardsResponses];
20920
+ export type CreateStandardData = {
20921
+ body?: CompetencyStandardParameters;
20922
+ path?: never;
20923
+ query?: never;
20924
+ url: '/api/v1/competencies/standards';
20925
+ };
20926
+ export type CreateStandardErrors = {
20927
+ /**
20928
+ * Bad Request
20929
+ */
20930
+ 400: Problem;
20931
+ /**
20932
+ * Forbidden
20933
+ */
20934
+ 403: Problem;
20935
+ /**
20936
+ * Not Found
20937
+ */
20938
+ 404: Problem;
20939
+ /**
20940
+ * Unprocessable Content
20941
+ */
20942
+ 422: Problem;
20943
+ };
20944
+ export type CreateStandardError = CreateStandardErrors[keyof CreateStandardErrors];
20945
+ export type CreateStandardResponses = {
19402
20946
  /**
19403
- * Success
20947
+ * Created
19404
20948
  */
19405
- 200: {
19406
- meta: Meta;
19407
- links: Links;
19408
- data: Array<CompanyResponseObject>;
19409
- };
20949
+ 201: CompetencyStandardResponseObject;
19410
20950
  };
19411
- export type ListCompaniesResponse = ListCompaniesResponses[keyof ListCompaniesResponses];
19412
- export type GetCompanyData = {
20951
+ export type CreateStandardResponse = CreateStandardResponses[keyof CreateStandardResponses];
20952
+ export type GetStandardData = {
19413
20953
  body?: never;
19414
20954
  path: {
19415
20955
  id: string;
19416
20956
  };
19417
20957
  query?: never;
19418
- url: '/api/v1/companies/{id}';
20958
+ url: '/api/v1/competencies/standards/{id}';
19419
20959
  };
19420
- export type GetCompanyErrors = {
20960
+ export type GetStandardErrors = {
19421
20961
  /**
19422
20962
  * Forbidden
19423
20963
  */
@@ -19427,23 +20967,23 @@ export type GetCompanyErrors = {
19427
20967
  */
19428
20968
  404: Problem;
19429
20969
  };
19430
- export type GetCompanyError = GetCompanyErrors[keyof GetCompanyErrors];
19431
- export type GetCompanyResponses = {
20970
+ export type GetStandardError = GetStandardErrors[keyof GetStandardErrors];
20971
+ export type GetStandardResponses = {
19432
20972
  /**
19433
20973
  * Success
19434
20974
  */
19435
- 200: CompanyResponseObject;
20975
+ 200: CompetencyStandardResponseObject;
19436
20976
  };
19437
- export type GetCompanyResponse = GetCompanyResponses[keyof GetCompanyResponses];
19438
- export type UpdateCompanyProfileData = {
19439
- body: CompanyParameters;
20977
+ export type GetStandardResponse = GetStandardResponses[keyof GetStandardResponses];
20978
+ export type UpdateStandardData = {
20979
+ body?: CompetencyStandardUpdateParameters;
19440
20980
  path: {
19441
20981
  id: string;
19442
20982
  };
19443
20983
  query?: never;
19444
- url: '/api/v1/companies/{id}';
20984
+ url: '/api/v1/competencies/standards/{id}';
19445
20985
  };
19446
- export type UpdateCompanyProfileErrors = {
20986
+ export type UpdateStandardErrors = {
19447
20987
  /**
19448
20988
  * Bad Request
19449
20989
  */
@@ -19456,75 +20996,54 @@ export type UpdateCompanyProfileErrors = {
19456
20996
  * Not Found
19457
20997
  */
19458
20998
  404: Problem;
19459
- /**
19460
- * Unprocessable Content
19461
- */
19462
- 422: Problem;
19463
20999
  };
19464
- export type UpdateCompanyProfileError = UpdateCompanyProfileErrors[keyof UpdateCompanyProfileErrors];
19465
- export type UpdateCompanyProfileResponses = {
21000
+ export type UpdateStandardError = UpdateStandardErrors[keyof UpdateStandardErrors];
21001
+ export type UpdateStandardResponses = {
19466
21002
  /**
19467
21003
  * Success
19468
21004
  */
19469
- 200: CompanyResponseObject;
21005
+ 200: CompetencyStandardResponseObject;
19470
21006
  };
19471
- export type UpdateCompanyProfileResponse = UpdateCompanyProfileResponses[keyof UpdateCompanyProfileResponses];
19472
- export type ListAssessmentsData = {
21007
+ export type UpdateStandardResponse = UpdateStandardResponses[keyof UpdateStandardResponses];
21008
+ export type UnarchiveCompetencyStandardData = {
19473
21009
  body?: never;
19474
- path?: never;
19475
- query?: {
19476
- /**
19477
- * Assessments of this candidate.
19478
- */
19479
- 'filter[candidate_user_id]'?: string;
19480
- /**
19481
- * Assessments pinned to this level.
19482
- */
19483
- 'filter[competencies_level_id]'?: string;
19484
- /**
19485
- * evidence_collection, submitted, in_review, or decided.
19486
- */
19487
- 'filter[status]'?: 'evidence_collection' | 'submitted' | 'in_review' | 'decided';
19488
- /**
19489
- * competent or not_yet_competent. Null until the assessment is decided.
19490
- */
19491
- 'filter[outcome]'?: 'competent' | 'not_yet_competent' | null;
19492
- filter?: string;
19493
- 'filter[unexpected]'?: string;
21010
+ path: {
21011
+ standard_id: string;
19494
21012
  };
19495
- url: '/api/v1/competencies/assessments';
21013
+ query?: never;
21014
+ url: '/api/v1/competencies/standards/{standard_id}/archive';
19496
21015
  };
19497
- export type ListAssessmentsErrors = {
19498
- /**
19499
- * Bad Request
19500
- */
19501
- 400: Problem;
21016
+ export type UnarchiveCompetencyStandardErrors = {
19502
21017
  /**
19503
21018
  * Forbidden
19504
21019
  */
19505
21020
  403: Problem;
21021
+ /**
21022
+ * Not Found
21023
+ */
21024
+ 404: Problem;
19506
21025
  };
19507
- export type ListAssessmentsError = ListAssessmentsErrors[keyof ListAssessmentsErrors];
19508
- export type ListAssessmentsResponses = {
21026
+ export type UnarchiveCompetencyStandardError = UnarchiveCompetencyStandardErrors[keyof UnarchiveCompetencyStandardErrors];
21027
+ export type UnarchiveCompetencyStandardResponses = {
19509
21028
  /**
19510
21029
  * Success
19511
21030
  */
19512
- 200: {
19513
- meta: Meta;
19514
- links: Links;
19515
- data: Array<CompetencyAssessmentResponseObject>;
19516
- };
21031
+ 200: CompetencyStandardResponseObject;
19517
21032
  };
19518
- export type ListAssessmentsResponse = ListAssessmentsResponses[keyof ListAssessmentsResponses];
19519
- export type GetAssessmentData = {
19520
- body?: never;
21033
+ export type UnarchiveCompetencyStandardResponse = UnarchiveCompetencyStandardResponses[keyof UnarchiveCompetencyStandardResponses];
21034
+ export type ArchiveCompetencyStandardData = {
21035
+ body?: CompetencyStandardArchiveParametersWritable;
19521
21036
  path: {
19522
- id: string;
21037
+ standard_id: string;
19523
21038
  };
19524
21039
  query?: never;
19525
- url: '/api/v1/competencies/assessments/{id}';
21040
+ url: '/api/v1/competencies/standards/{standard_id}/archive';
19526
21041
  };
19527
- export type GetAssessmentErrors = {
21042
+ export type ArchiveCompetencyStandardErrors = {
21043
+ /**
21044
+ * Bad Request
21045
+ */
21046
+ 400: Problem;
19528
21047
  /**
19529
21048
  * Forbidden
19530
21049
  */
@@ -19534,26 +21053,44 @@ export type GetAssessmentErrors = {
19534
21053
  */
19535
21054
  404: Problem;
19536
21055
  };
19537
- export type GetAssessmentError = GetAssessmentErrors[keyof GetAssessmentErrors];
19538
- export type GetAssessmentResponses = {
21056
+ export type ArchiveCompetencyStandardError = ArchiveCompetencyStandardErrors[keyof ArchiveCompetencyStandardErrors];
21057
+ export type ArchiveCompetencyStandardResponses = {
19539
21058
  /**
19540
- * Success
21059
+ * Created
19541
21060
  */
19542
- 200: CompetencyAssessmentResponseObject;
21061
+ 201: CompetencyStandardResponseObject;
19543
21062
  };
19544
- export type GetAssessmentResponse = GetAssessmentResponses[keyof GetAssessmentResponses];
19545
- export type ListAssessmentKeyActivitiesData = {
21063
+ export type ArchiveCompetencyStandardResponse = ArchiveCompetencyStandardResponses[keyof ArchiveCompetencyStandardResponses];
21064
+ export type ListCompetencyStandardVersionsData = {
19546
21065
  body?: never;
19547
21066
  path: {
19548
- assessment_id: string;
21067
+ standard_id: string;
19549
21068
  };
19550
21069
  query?: {
21070
+ /**
21071
+ * Revision status: draft, active, or superseded.
21072
+ */
21073
+ 'filter[status]'?: 'draft' | 'active' | 'superseded';
21074
+ 'filter[created_at][gte]'?: string;
21075
+ 'filter[created_at][lte]'?: string;
21076
+ 'filter[updated_at][gte]'?: string;
21077
+ 'filter[updated_at][lte]'?: string;
19551
21078
  filter?: string;
19552
21079
  'filter[unexpected]'?: string;
21080
+ /**
21081
+ * This pagination cursor corresponds to the cursor value found in the response in
21082
+ * `meta.page.next_cursor`.
21083
+ */
21084
+ 'page[cursor]'?: string;
21085
+ /**
21086
+ * 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`.
21087
+ */
21088
+ 'page[limit]'?: number;
21089
+ page?: string;
19553
21090
  };
19554
- url: '/api/v1/competencies/assessments/{assessment_id}/key_activities';
21091
+ url: '/api/v1/competencies/standards/{standard_id}/versions';
19555
21092
  };
19556
- export type ListAssessmentKeyActivitiesErrors = {
21093
+ export type ListCompetencyStandardVersionsErrors = {
19557
21094
  /**
19558
21095
  * Bad Request
19559
21096
  */
@@ -19562,136 +21099,112 @@ export type ListAssessmentKeyActivitiesErrors = {
19562
21099
  * Forbidden
19563
21100
  */
19564
21101
  403: Problem;
21102
+ /**
21103
+ * Unprocessable Content
21104
+ */
21105
+ 422: Problem;
19565
21106
  };
19566
- export type ListAssessmentKeyActivitiesError = ListAssessmentKeyActivitiesErrors[keyof ListAssessmentKeyActivitiesErrors];
19567
- export type ListAssessmentKeyActivitiesResponses = {
21107
+ export type ListCompetencyStandardVersionsError = ListCompetencyStandardVersionsErrors[keyof ListCompetencyStandardVersionsErrors];
21108
+ export type ListCompetencyStandardVersionsResponses = {
19568
21109
  /**
19569
- * Candidate sees a decided review
21110
+ * Success
19570
21111
  */
19571
21112
  200: {
19572
21113
  meta: Meta;
19573
21114
  links: Links;
19574
- data: Array<CompetencyAssessmentKeyActivityResponseObject>;
21115
+ data: Array<CompetencyStandardVersionResponseObject>;
19575
21116
  };
19576
21117
  };
19577
- export type ListAssessmentKeyActivitiesResponse = ListAssessmentKeyActivitiesResponses[keyof ListAssessmentKeyActivitiesResponses];
19578
- export type GetAssessmentKeyActivityData = {
19579
- body?: never;
21118
+ export type ListCompetencyStandardVersionsResponse = ListCompetencyStandardVersionsResponses[keyof ListCompetencyStandardVersionsResponses];
21119
+ export type CreateCompetencyStandardVersionData = {
21120
+ body?: CompetencyStandardVersionParameters;
19580
21121
  path: {
19581
- assessment_id: string;
19582
- id: string;
21122
+ standard_id: string;
19583
21123
  };
19584
21124
  query?: never;
19585
- url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{id}';
21125
+ url: '/api/v1/competencies/standards/{standard_id}/versions';
19586
21126
  };
19587
- export type GetAssessmentKeyActivityErrors = {
21127
+ export type CreateCompetencyStandardVersionErrors = {
21128
+ /**
21129
+ * Bad Request
21130
+ */
21131
+ 400: Problem;
19588
21132
  /**
19589
21133
  * Forbidden
19590
21134
  */
19591
21135
  403: Problem;
21136
+ /**
21137
+ * Unprocessable Content
21138
+ */
21139
+ 422: Problem;
19592
21140
  };
19593
- export type GetAssessmentKeyActivityError = GetAssessmentKeyActivityErrors[keyof GetAssessmentKeyActivityErrors];
19594
- export type GetAssessmentKeyActivityResponses = {
21141
+ export type CreateCompetencyStandardVersionError = CreateCompetencyStandardVersionErrors[keyof CreateCompetencyStandardVersionErrors];
21142
+ export type CreateCompetencyStandardVersionResponses = {
19595
21143
  /**
19596
- * Candidate sees a decided review
21144
+ * Created
19597
21145
  */
19598
- 200: CompetencyAssessmentKeyActivityResponseObject;
21146
+ 201: CompetencyStandardVersionResponseObject;
19599
21147
  };
19600
- export type GetAssessmentKeyActivityResponse = GetAssessmentKeyActivityResponses[keyof GetAssessmentKeyActivityResponses];
19601
- export type ListEvidenceItemsData = {
21148
+ export type CreateCompetencyStandardVersionResponse = CreateCompetencyStandardVersionResponses[keyof CreateCompetencyStandardVersionResponses];
21149
+ export type DeleteCompetencyStandardVersionData = {
19602
21150
  body?: never;
19603
21151
  path: {
19604
- assessment_id: string;
19605
- key_activity_id: string;
19606
- };
19607
- query?: {
19608
- /**
19609
- * upload, form_submission, or certification.
19610
- */
19611
- 'filter[kind]'?: 'upload' | 'form_submission' | 'certification';
19612
- filter?: string;
19613
- 'filter[unexpected]'?: string;
21152
+ standard_id: string;
21153
+ id: string;
19614
21154
  };
19615
- url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{key_activity_id}/evidence_items';
21155
+ query?: never;
21156
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{id}';
19616
21157
  };
19617
- export type ListEvidenceItemsErrors = {
19618
- /**
19619
- * Bad Request
19620
- */
19621
- 400: Problem;
21158
+ export type DeleteCompetencyStandardVersionErrors = {
19622
21159
  /**
19623
21160
  * Forbidden
19624
21161
  */
19625
- 403: Problem;
21162
+ 403: unknown;
19626
21163
  };
19627
- export type ListEvidenceItemsError = ListEvidenceItemsErrors[keyof ListEvidenceItemsErrors];
19628
- export type ListEvidenceItemsResponses = {
21164
+ export type DeleteCompetencyStandardVersionResponses = {
19629
21165
  /**
19630
- * Success
21166
+ * No Content
19631
21167
  */
19632
- 200: {
19633
- meta: Meta;
19634
- links: Links;
19635
- data: Array<CompetencyEvidenceItemResponseObject>;
19636
- };
21168
+ 204: void;
19637
21169
  };
19638
- export type ListEvidenceItemsResponse = ListEvidenceItemsResponses[keyof ListEvidenceItemsResponses];
19639
- export type GetEvidenceItemData = {
21170
+ export type DeleteCompetencyStandardVersionResponse = DeleteCompetencyStandardVersionResponses[keyof DeleteCompetencyStandardVersionResponses];
21171
+ export type GetCompetencyStandardVersionData = {
19640
21172
  body?: never;
19641
21173
  path: {
19642
- assessment_id: string;
19643
- key_activity_id: string;
21174
+ standard_id: string;
19644
21175
  id: string;
19645
21176
  };
19646
21177
  query?: never;
19647
- url: '/api/v1/competencies/assessments/{assessment_id}/key_activities/{key_activity_id}/evidence_items/{id}';
21178
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{id}';
19648
21179
  };
19649
- export type GetEvidenceItemErrors = {
21180
+ export type GetCompetencyStandardVersionErrors = {
19650
21181
  /**
19651
21182
  * Forbidden
19652
21183
  */
19653
21184
  403: Problem;
21185
+ /**
21186
+ * Not Found
21187
+ */
21188
+ 404: Problem;
19654
21189
  };
19655
- export type GetEvidenceItemError = GetEvidenceItemErrors[keyof GetEvidenceItemErrors];
19656
- export type GetEvidenceItemResponses = {
21190
+ export type GetCompetencyStandardVersionError = GetCompetencyStandardVersionErrors[keyof GetCompetencyStandardVersionErrors];
21191
+ export type GetCompetencyStandardVersionResponses = {
19657
21192
  /**
19658
21193
  * Success
19659
21194
  */
19660
- 200: CompetencyEvidenceItemResponseObject;
21195
+ 200: CompetencyStandardVersionResponseObject;
19661
21196
  };
19662
- export type GetEvidenceItemResponse = GetEvidenceItemResponses[keyof GetEvidenceItemResponses];
19663
- export type ListQualificationsData = {
19664
- body?: never;
19665
- path?: never;
19666
- query?: {
19667
- /**
19668
- * Standings held by this candidate.
19669
- */
19670
- 'filter[candidate_user_id]'?: string;
19671
- /**
19672
- * Standings against this standard.
19673
- */
19674
- 'filter[competencies_standard_id]'?: string;
19675
- /**
19676
- * Standings at this tier.
19677
- */
19678
- 'filter[level_sort_order]'?: number;
19679
- filter?: string;
19680
- 'filter[unexpected]'?: string;
19681
- /**
19682
- * This pagination cursor corresponds to the cursor value found in the response in
19683
- * `meta.page.next_cursor`.
19684
- */
19685
- 'page[cursor]'?: string;
19686
- /**
19687
- * 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`.
19688
- */
19689
- 'page[limit]'?: number;
19690
- page?: string;
21197
+ export type GetCompetencyStandardVersionResponse = GetCompetencyStandardVersionResponses[keyof GetCompetencyStandardVersionResponses];
21198
+ export type UpdateCompetencyStandardVersionData = {
21199
+ body?: CompetencyStandardVersionParameters;
21200
+ path: {
21201
+ standard_id: string;
21202
+ id: string;
19691
21203
  };
19692
- url: '/api/v1/competencies/qualifications';
21204
+ query?: never;
21205
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{id}';
19693
21206
  };
19694
- export type ListQualificationsErrors = {
21207
+ export type UpdateCompetencyStandardVersionErrors = {
19695
21208
  /**
19696
21209
  * Bad Request
19697
21210
  */
@@ -19701,44 +21214,41 @@ export type ListQualificationsErrors = {
19701
21214
  */
19702
21215
  403: Problem;
19703
21216
  };
19704
- export type ListQualificationsError = ListQualificationsErrors[keyof ListQualificationsErrors];
19705
- export type ListQualificationsResponses = {
21217
+ export type UpdateCompetencyStandardVersionError = UpdateCompetencyStandardVersionErrors[keyof UpdateCompetencyStandardVersionErrors];
21218
+ export type UpdateCompetencyStandardVersionResponses = {
19706
21219
  /**
19707
21220
  * Success
19708
21221
  */
19709
- 200: {
19710
- meta: Meta;
19711
- links: Links;
19712
- data: Array<CompetencyQualificationResponseObject>;
19713
- };
21222
+ 200: CompetencyStandardVersionResponseObject;
19714
21223
  };
19715
- export type ListQualificationsResponse = ListQualificationsResponses[keyof ListQualificationsResponses];
19716
- export type GetQualificationData = {
19717
- body?: never;
21224
+ export type UpdateCompetencyStandardVersionResponse = UpdateCompetencyStandardVersionResponses[keyof UpdateCompetencyStandardVersionResponses];
21225
+ export type PromoteCompetencyStandardVersionData = {
21226
+ body?: CompetencyStandardVersionPromotionParameters;
19718
21227
  path: {
19719
- id: string;
21228
+ standard_id: string;
21229
+ version_id: string;
19720
21230
  };
19721
21231
  query?: never;
19722
- url: '/api/v1/competencies/qualifications/{id}';
21232
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/promotion';
19723
21233
  };
19724
- export type GetQualificationErrors = {
21234
+ export type PromoteCompetencyStandardVersionErrors = {
19725
21235
  /**
19726
- * Forbidden
21236
+ * Bad Request
19727
21237
  */
19728
- 403: Problem;
21238
+ 400: Problem;
19729
21239
  /**
19730
- * Not Found
21240
+ * Forbidden
19731
21241
  */
19732
- 404: Problem;
21242
+ 403: Problem;
19733
21243
  };
19734
- export type GetQualificationError = GetQualificationErrors[keyof GetQualificationErrors];
19735
- export type GetQualificationResponses = {
21244
+ export type PromoteCompetencyStandardVersionError = PromoteCompetencyStandardVersionErrors[keyof PromoteCompetencyStandardVersionErrors];
21245
+ export type PromoteCompetencyStandardVersionResponses = {
19736
21246
  /**
19737
- * Success
21247
+ * Created
19738
21248
  */
19739
- 200: CompetencyQualificationResponseObject;
21249
+ 201: CompetencyStandardVersionResponseObject;
19740
21250
  };
19741
- export type GetQualificationResponse = GetQualificationResponses[keyof GetQualificationResponses];
21251
+ export type PromoteCompetencyStandardVersionResponse = PromoteCompetencyStandardVersionResponses[keyof PromoteCompetencyStandardVersionResponses];
19742
21252
  export type ListChecksData = {
19743
21253
  body?: never;
19744
21254
  path?: never;
@@ -21199,6 +22709,10 @@ export type CreateRateRuleErrors = {
21199
22709
  * Unprocessable Content
21200
22710
  */
21201
22711
  422: Problem;
22712
+ /**
22713
+ * Service Unavailable
22714
+ */
22715
+ 503: Problem;
21202
22716
  };
21203
22717
  export type CreateRateRuleError = CreateRateRuleErrors[keyof CreateRateRuleErrors];
21204
22718
  export type CreateRateRuleResponses = {
@@ -21642,7 +23156,7 @@ export type CancelJobWageDeterminationScheduledTerminationData = {
21642
23156
  };
21643
23157
  export type CancelJobWageDeterminationScheduledTerminationErrors = {
21644
23158
  /**
21645
- * Forbidden
23159
+ * Forbidden (user-scoped key required)
21646
23160
  */
21647
23161
  403: Problem;
21648
23162
  /**
@@ -21691,7 +23205,7 @@ export type ScheduleJobWageDeterminationTerminationErrors = {
21691
23205
  */
21692
23206
  400: Problem;
21693
23207
  /**
21694
- * Forbidden
23208
+ * Forbidden (user-scoped key required)
21695
23209
  */
21696
23210
  403: Problem;
21697
23211
  /**
@@ -22042,7 +23556,7 @@ export type CreateJobErrors = {
22042
23556
  */
22043
23557
  403: Problem;
22044
23558
  /**
22045
- * Template not found
23559
+ * Not Found
22046
23560
  */
22047
23561
  404: Problem;
22048
23562
  /**
@@ -30922,6 +32436,10 @@ export type CreateCompanyErrors = {
30922
32436
  * Forbidden
30923
32437
  */
30924
32438
  403: Problem;
32439
+ /**
32440
+ * Not Found
32441
+ */
32442
+ 404: Problem;
30925
32443
  /**
30926
32444
  * Unprocessable Content
30927
32445
  */