@dsptch-work/api-client 0.33.0 → 0.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +185 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +320 -7
- package/dist/gen/sdk.gen.js +559 -6
- package/dist/gen/types.gen.d.ts +1553 -250
- package/dist/gen/zod.gen.d.ts +1442 -456
- package/dist/gen/zod.gen.js +766 -223
- package/package.json +1 -1
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -26,11 +26,11 @@ export type Problem = {
|
|
|
26
26
|
*/
|
|
27
27
|
instance: string;
|
|
28
28
|
/**
|
|
29
|
-
* Optional nonempty validation
|
|
29
|
+
* Optional nonempty entries, one per refused field or value: validation failures, and other request-body refusals such as `subtype_foreign_keys`. Each item gives a readable detail and, when the server can prove a public body location, a pointer to it. Clients must accept entries without a pointer.
|
|
30
30
|
*/
|
|
31
31
|
errors?: Array<{
|
|
32
32
|
/**
|
|
33
|
-
* The
|
|
33
|
+
* The message for this entry.
|
|
34
34
|
*/
|
|
35
35
|
detail: string;
|
|
36
36
|
/**
|
|
@@ -241,7 +241,7 @@ export type Problem = {
|
|
|
241
241
|
*
|
|
242
242
|
* **Version Overlap**
|
|
243
243
|
*
|
|
244
|
-
* The write
|
|
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.
|
|
245
245
|
*
|
|
246
246
|
* ## 412
|
|
247
247
|
*
|
|
@@ -335,7 +335,7 @@ export type Problem = {
|
|
|
335
335
|
*
|
|
336
336
|
* **Foreign Subtype Attributes**
|
|
337
337
|
*
|
|
338
|
-
* A
|
|
338
|
+
* A write carries keys the record's resolved subtype does not accept, whether nested or beside the record's own fields (a serial item's fields sent for a bulk item). Send only the keys valid for that subtype; the message names the offending ones, and each one's entry in `errors` points at it. Nothing is written.
|
|
339
339
|
*
|
|
340
340
|
* ### synced_determination
|
|
341
341
|
*
|
|
@@ -508,6 +508,309 @@ export type DirectUploadResponseObject = {
|
|
|
508
508
|
};
|
|
509
509
|
};
|
|
510
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
|
+
* Suggested assessment method for this criterion; null when unset. An assessment does not have to use it.
|
|
773
|
+
*/
|
|
774
|
+
assessment_method: 'direct_observation' | 'simulation' | 'oral_questioning' | 'written_questioning' | 'products_of_work' | 'recognized_prior_learning' | 'witness_testimony' | 'other' | null;
|
|
775
|
+
/**
|
|
776
|
+
* When the criterion was created.
|
|
777
|
+
*/
|
|
778
|
+
created_at: string;
|
|
779
|
+
/**
|
|
780
|
+
* When the criterion was last updated.
|
|
781
|
+
*/
|
|
782
|
+
updated_at: string;
|
|
783
|
+
};
|
|
784
|
+
/**
|
|
785
|
+
* Create or update a criterion on a draft revision. sort_order is server-assigned and is rejected if sent.
|
|
786
|
+
*/
|
|
787
|
+
export type CompetencyCriterionParameters = {
|
|
788
|
+
/**
|
|
789
|
+
* Display number of the criterion; optional, null to clear.
|
|
790
|
+
*/
|
|
791
|
+
number?: string | null;
|
|
792
|
+
/**
|
|
793
|
+
* Criterion text; optional, null to clear.
|
|
794
|
+
*/
|
|
795
|
+
body?: string | null;
|
|
796
|
+
/**
|
|
797
|
+
* Guidance on what evidence satisfies the criterion; optional, null to clear.
|
|
798
|
+
*/
|
|
799
|
+
evidence_note?: string | null;
|
|
800
|
+
/**
|
|
801
|
+
* Suggested assessment method; optional, null to clear.
|
|
802
|
+
*/
|
|
803
|
+
assessment_method?: 'direct_observation' | 'simulation' | 'oral_questioning' | 'written_questioning' | 'products_of_work' | 'recognized_prior_learning' | 'witness_testimony' | 'other' | null;
|
|
804
|
+
};
|
|
805
|
+
/**
|
|
806
|
+
* Swap a draft catalog row with its neighbor. The row cannot move past either end of the list.
|
|
807
|
+
*/
|
|
808
|
+
export type CompetencySortOrderMoveParameters = {
|
|
809
|
+
/**
|
|
810
|
+
* Which neighbor to swap with: up or down. Required.
|
|
811
|
+
*/
|
|
812
|
+
direction: 'up' | 'down';
|
|
813
|
+
};
|
|
511
814
|
/**
|
|
512
815
|
* One assessor-registry grant for one standard. Department scope is informational. revoked_at is null while the grant is active.
|
|
513
816
|
*/
|
|
@@ -2549,10 +2852,6 @@ export type AssetsProductResponseObject = {
|
|
|
2549
2852
|
* Create a catalog product. `type` (serial or bulk) is required and immutable. `attribute_values` upserts the product's category-attribute values.
|
|
2550
2853
|
*/
|
|
2551
2854
|
export type AssetsProductParameters = {
|
|
2552
|
-
/**
|
|
2553
|
-
* Product kind, set on create and immutable: serial (individually tracked) or bulk (quantity-counted).
|
|
2554
|
-
*/
|
|
2555
|
-
type: 'serial' | 'bulk';
|
|
2556
2855
|
/**
|
|
2557
2856
|
* Human-readable product name.
|
|
2558
2857
|
*/
|
|
@@ -2562,9 +2861,13 @@ export type AssetsProductParameters = {
|
|
|
2562
2861
|
*/
|
|
2563
2862
|
description?: string | null;
|
|
2564
2863
|
/**
|
|
2565
|
-
*
|
|
2864
|
+
* Manufacturer or brand; required when model is given. Null when not set.
|
|
2566
2865
|
*/
|
|
2567
|
-
|
|
2866
|
+
make?: string | null;
|
|
2867
|
+
/**
|
|
2868
|
+
* Model name or number; unique per manufacturer within the company. Null when not set.
|
|
2869
|
+
*/
|
|
2870
|
+
model?: string | null;
|
|
2568
2871
|
/**
|
|
2569
2872
|
* Universal Product Code; unique within the company. Null when not set.
|
|
2570
2873
|
*/
|
|
@@ -2577,24 +2880,20 @@ export type AssetsProductParameters = {
|
|
|
2577
2880
|
* Default low-stock reorder threshold for this product's items, applied across sites unless a site overrides it. Null when not set.
|
|
2578
2881
|
*/
|
|
2579
2882
|
default_minimum_quantity?: number | null;
|
|
2580
|
-
/**
|
|
2581
|
-
* Manufacturer or brand; required when model is given. Null when not set.
|
|
2582
|
-
*/
|
|
2583
|
-
make?: string | null;
|
|
2584
|
-
/**
|
|
2585
|
-
* Model name or number; unique per manufacturer within the company. Null when not set.
|
|
2586
|
-
*/
|
|
2587
|
-
model?: string | null;
|
|
2588
2883
|
/**
|
|
2589
2884
|
* Unit of measure for counting a bulk product's inventory: one of each, pair, or pack. A serial product is always counted each.
|
|
2590
2885
|
*/
|
|
2591
2886
|
counted_by?: 'each' | 'pair' | 'pack';
|
|
2887
|
+
/**
|
|
2888
|
+
* ID of the category classifying this product; null when uncategorized.
|
|
2889
|
+
*/
|
|
2890
|
+
assets_category_id?: string | null;
|
|
2592
2891
|
/**
|
|
2593
2892
|
* Optional. Flag the product as a container whose items can hold other items (a toolbox or gang box). Only serialized products may be containers.
|
|
2594
2893
|
*/
|
|
2595
2894
|
container?: boolean;
|
|
2596
2895
|
/**
|
|
2597
|
-
* Upserts the values of this product's category attributes, one
|
|
2896
|
+
* Upserts the values of this product's category attributes, as a list of row objects, one per attribute. Each row requires its assets_attribute_id; a row without one answers 400, and a blank one 422. Send a blank value and null assets_attribute_option_id to clear one. A value is a string or null; any other JSON type, or an unknown row field, answers 422 at that row.
|
|
2598
2897
|
*/
|
|
2599
2898
|
attribute_values?: Array<{
|
|
2600
2899
|
/**
|
|
@@ -2611,9 +2910,26 @@ export type AssetsProductParameters = {
|
|
|
2611
2910
|
assets_attribute_option_id?: string | null;
|
|
2612
2911
|
}>;
|
|
2613
2912
|
/**
|
|
2614
|
-
* Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
|
|
2913
|
+
* Image attachments, as a list of row objects. Send file with a signed_id to add one; include id with _destroy to remove an existing one. An unknown or wrongly typed row field answers 422 at that row.
|
|
2914
|
+
*/
|
|
2915
|
+
images_attributes?: Array<{
|
|
2916
|
+
/**
|
|
2917
|
+
* ID of an existing attachment to remove; omit to add a new one.
|
|
2918
|
+
*/
|
|
2919
|
+
id?: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* A signed_id from POST /api/v1/direct_uploads registered for `assets.products`; a signed_id issued for any other resource answers 422.
|
|
2922
|
+
*/
|
|
2923
|
+
file?: string;
|
|
2924
|
+
/**
|
|
2925
|
+
* Set true to remove the attachment named by id.
|
|
2926
|
+
*/
|
|
2927
|
+
_destroy?: boolean;
|
|
2928
|
+
}>;
|
|
2929
|
+
/**
|
|
2930
|
+
* Product kind, set on create and immutable: serial (individually tracked) or bulk (quantity-counted).
|
|
2615
2931
|
*/
|
|
2616
|
-
|
|
2932
|
+
type: 'serial' | 'bulk';
|
|
2617
2933
|
/**
|
|
2618
2934
|
* ID of the user this write is performed on behalf of, recorded for auditing. 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.
|
|
2619
2935
|
*/
|
|
@@ -2632,9 +2948,13 @@ export type AssetsProductUpdateParameters = {
|
|
|
2632
2948
|
*/
|
|
2633
2949
|
description?: string | null;
|
|
2634
2950
|
/**
|
|
2635
|
-
*
|
|
2951
|
+
* Manufacturer or brand; required when model is given. Null when not set.
|
|
2636
2952
|
*/
|
|
2637
|
-
|
|
2953
|
+
make?: string | null;
|
|
2954
|
+
/**
|
|
2955
|
+
* Model name or number; unique per manufacturer within the company. Null when not set.
|
|
2956
|
+
*/
|
|
2957
|
+
model?: string | null;
|
|
2638
2958
|
/**
|
|
2639
2959
|
* Universal Product Code; unique within the company. Null when not set.
|
|
2640
2960
|
*/
|
|
@@ -2647,24 +2967,20 @@ export type AssetsProductUpdateParameters = {
|
|
|
2647
2967
|
* Default low-stock reorder threshold for this product's items, applied across sites unless a site overrides it. Null when not set.
|
|
2648
2968
|
*/
|
|
2649
2969
|
default_minimum_quantity?: number | null;
|
|
2650
|
-
/**
|
|
2651
|
-
* Manufacturer or brand; required when model is given. Null when not set.
|
|
2652
|
-
*/
|
|
2653
|
-
make?: string | null;
|
|
2654
|
-
/**
|
|
2655
|
-
* Model name or number; unique per manufacturer within the company. Null when not set.
|
|
2656
|
-
*/
|
|
2657
|
-
model?: string | null;
|
|
2658
2970
|
/**
|
|
2659
2971
|
* Unit of measure for counting a bulk product's inventory: one of each, pair, or pack. A serial product is always counted each.
|
|
2660
2972
|
*/
|
|
2661
2973
|
counted_by?: 'each' | 'pair' | 'pack';
|
|
2974
|
+
/**
|
|
2975
|
+
* ID of the category classifying this product; null when uncategorized.
|
|
2976
|
+
*/
|
|
2977
|
+
assets_category_id?: string | null;
|
|
2662
2978
|
/**
|
|
2663
2979
|
* Optional. Flag the product as a container whose items can hold other items (a toolbox or gang box). Only serialized products may be containers.
|
|
2664
2980
|
*/
|
|
2665
2981
|
container?: boolean;
|
|
2666
2982
|
/**
|
|
2667
|
-
* Upserts the values of this product's category attributes, one
|
|
2983
|
+
* Upserts the values of this product's category attributes, as a list of row objects, one per attribute. Each row requires its assets_attribute_id; a row without one answers 400, and a blank one 422. Send a blank value and null assets_attribute_option_id to clear one. A value is a string or null; any other JSON type, or an unknown row field, answers 422 at that row.
|
|
2668
2984
|
*/
|
|
2669
2985
|
attribute_values?: Array<{
|
|
2670
2986
|
/**
|
|
@@ -2681,9 +2997,22 @@ export type AssetsProductUpdateParameters = {
|
|
|
2681
2997
|
assets_attribute_option_id?: string | null;
|
|
2682
2998
|
}>;
|
|
2683
2999
|
/**
|
|
2684
|
-
* Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
|
|
3000
|
+
* Image attachments, as a list of row objects. Send file with a signed_id to add one; include id with _destroy to remove an existing one. An unknown or wrongly typed row field answers 422 at that row.
|
|
2685
3001
|
*/
|
|
2686
|
-
images_attributes?: Array<
|
|
3002
|
+
images_attributes?: Array<{
|
|
3003
|
+
/**
|
|
3004
|
+
* ID of an existing attachment to remove; omit to add a new one.
|
|
3005
|
+
*/
|
|
3006
|
+
id?: string;
|
|
3007
|
+
/**
|
|
3008
|
+
* A signed_id from POST /api/v1/direct_uploads registered for `assets.products`; a signed_id issued for any other resource answers 422.
|
|
3009
|
+
*/
|
|
3010
|
+
file?: string;
|
|
3011
|
+
/**
|
|
3012
|
+
* Set true to remove the attachment named by id.
|
|
3013
|
+
*/
|
|
3014
|
+
_destroy?: boolean;
|
|
3015
|
+
}>;
|
|
2687
3016
|
};
|
|
2688
3017
|
/**
|
|
2689
3018
|
* A named daily allowance (meals, lodging, travel, and the like) that a company can attach to time.
|
|
@@ -3010,7 +3339,7 @@ export type AssetsCategoryResponseObject = {
|
|
|
3010
3339
|
updated_at: string;
|
|
3011
3340
|
};
|
|
3012
3341
|
/**
|
|
3013
|
-
* Create
|
|
3342
|
+
* Create a category. Only name is required; omitting it answers 400, and a blank or null name or any wrong-typed value answers 422. A null or blank parent_id files the category at the root. `category_attributes` sets this category's direct attribute assignments.
|
|
3014
3343
|
*/
|
|
3015
3344
|
export type AssetsCategoryParameters = {
|
|
3016
3345
|
/**
|
|
@@ -3022,7 +3351,7 @@ export type AssetsCategoryParameters = {
|
|
|
3022
3351
|
*/
|
|
3023
3352
|
parent_id?: string | null;
|
|
3024
3353
|
/**
|
|
3025
|
-
* Attribute assignments for this category. Include id to update an existing assignment, omit id to add one, or set _destroy to remove one.
|
|
3354
|
+
* Attribute assignments for this category, as a list of row objects. Include id to update an existing assignment, omit id to add one, or set _destroy to remove one. An unknown or wrongly typed row field answers 422 at that row.
|
|
3026
3355
|
*/
|
|
3027
3356
|
category_attributes?: Array<{
|
|
3028
3357
|
/**
|
|
@@ -3032,11 +3361,11 @@ export type AssetsCategoryParameters = {
|
|
|
3032
3361
|
/**
|
|
3033
3362
|
* ID of the attribute definition.
|
|
3034
3363
|
*/
|
|
3035
|
-
assets_attribute_id
|
|
3364
|
+
assets_attribute_id?: string;
|
|
3036
3365
|
/**
|
|
3037
3366
|
* Where this attribute is filled in for the category: product (on the catalog product) or item (on each individual item).
|
|
3038
3367
|
*/
|
|
3039
|
-
fillable_on
|
|
3368
|
+
fillable_on?: 'product' | 'item';
|
|
3040
3369
|
/**
|
|
3041
3370
|
* Whether a value for this attribute must be provided.
|
|
3042
3371
|
*/
|
|
@@ -3052,7 +3381,7 @@ export type AssetsCategoryParameters = {
|
|
|
3052
3381
|
}>;
|
|
3053
3382
|
};
|
|
3054
3383
|
/**
|
|
3055
|
-
* Update a category. All fields are optional — send only what changes. `category_attributes` sets this category's direct attribute assignments.
|
|
3384
|
+
* Update a category. All fields are optional — send only what changes. A blank or null name or any wrong-typed value answers 422, and a null or blank parent_id moves the category to the root. `category_attributes` sets this category's direct attribute assignments.
|
|
3056
3385
|
*/
|
|
3057
3386
|
export type AssetsCategoryUpdateParameters = {
|
|
3058
3387
|
/**
|
|
@@ -3064,7 +3393,7 @@ export type AssetsCategoryUpdateParameters = {
|
|
|
3064
3393
|
*/
|
|
3065
3394
|
parent_id?: string | null;
|
|
3066
3395
|
/**
|
|
3067
|
-
* Attribute assignments for this category. Include id to update an existing assignment, omit id to add one, or set _destroy to remove one.
|
|
3396
|
+
* Attribute assignments for this category, as a list of row objects. Include id to update an existing assignment, omit id to add one, or set _destroy to remove one. An unknown or wrongly typed row field answers 422 at that row.
|
|
3068
3397
|
*/
|
|
3069
3398
|
category_attributes?: Array<{
|
|
3070
3399
|
/**
|
|
@@ -3074,11 +3403,11 @@ export type AssetsCategoryUpdateParameters = {
|
|
|
3074
3403
|
/**
|
|
3075
3404
|
* ID of the attribute definition.
|
|
3076
3405
|
*/
|
|
3077
|
-
assets_attribute_id
|
|
3406
|
+
assets_attribute_id?: string;
|
|
3078
3407
|
/**
|
|
3079
3408
|
* Where this attribute is filled in for the category: product (on the catalog product) or item (on each individual item).
|
|
3080
3409
|
*/
|
|
3081
|
-
fillable_on
|
|
3410
|
+
fillable_on?: 'product' | 'item';
|
|
3082
3411
|
/**
|
|
3083
3412
|
* Whether a value for this attribute must be provided.
|
|
3084
3413
|
*/
|
|
@@ -3774,7 +4103,7 @@ export type PwaCompanyUserDetailsParameters = {
|
|
|
3774
4103
|
/**
|
|
3775
4104
|
* Worker race for demographic reporting, as an array of codes (e.g. CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, NOT_SPECIFIED).
|
|
3776
4105
|
*/
|
|
3777
|
-
race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'
|
|
4106
|
+
race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'>;
|
|
3778
4107
|
/**
|
|
3779
4108
|
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
|
|
3780
4109
|
*/
|
|
@@ -3822,11 +4151,11 @@ export type PwaCompanyUserDetailsParameters = {
|
|
|
3822
4151
|
/**
|
|
3823
4152
|
* 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.
|
|
3824
4153
|
*/
|
|
3825
|
-
il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'
|
|
4154
|
+
il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'>;
|
|
3826
4155
|
/**
|
|
3827
4156
|
* 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.
|
|
3828
4157
|
*/
|
|
3829
|
-
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'
|
|
4158
|
+
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'>;
|
|
3830
4159
|
/**
|
|
3831
4160
|
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
|
|
3832
4161
|
*/
|
|
@@ -3834,7 +4163,7 @@ export type PwaCompanyUserDetailsParameters = {
|
|
|
3834
4163
|
/**
|
|
3835
4164
|
* Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american).
|
|
3836
4165
|
*/
|
|
3837
|
-
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'
|
|
4166
|
+
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'>;
|
|
3838
4167
|
};
|
|
3839
4168
|
/**
|
|
3840
4169
|
* 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.
|
|
@@ -3863,7 +4192,7 @@ export type PwaCompanyUserDetailsUpdateParameters = {
|
|
|
3863
4192
|
/**
|
|
3864
4193
|
* Worker race for demographic reporting, as an array of codes (e.g. CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, NOT_SPECIFIED).
|
|
3865
4194
|
*/
|
|
3866
|
-
race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'
|
|
4195
|
+
race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'>;
|
|
3867
4196
|
/**
|
|
3868
4197
|
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
|
|
3869
4198
|
*/
|
|
@@ -3911,11 +4240,11 @@ export type PwaCompanyUserDetailsUpdateParameters = {
|
|
|
3911
4240
|
/**
|
|
3912
4241
|
* 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.
|
|
3913
4242
|
*/
|
|
3914
|
-
il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'
|
|
4243
|
+
il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'>;
|
|
3915
4244
|
/**
|
|
3916
4245
|
* 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.
|
|
3917
4246
|
*/
|
|
3918
|
-
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'
|
|
4247
|
+
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'>;
|
|
3919
4248
|
/**
|
|
3920
4249
|
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
|
|
3921
4250
|
*/
|
|
@@ -3923,7 +4252,7 @@ export type PwaCompanyUserDetailsUpdateParameters = {
|
|
|
3923
4252
|
/**
|
|
3924
4253
|
* Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american).
|
|
3925
4254
|
*/
|
|
3926
|
-
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'
|
|
4255
|
+
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'>;
|
|
3927
4256
|
};
|
|
3928
4257
|
/**
|
|
3929
4258
|
* 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.
|
|
@@ -4326,9 +4655,9 @@ export type JobParameters = {
|
|
|
4326
4655
|
*/
|
|
4327
4656
|
requested_by_company_id?: string;
|
|
4328
4657
|
/**
|
|
4329
|
-
* Complete desired set of manager user
|
|
4658
|
+
* 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.
|
|
4330
4659
|
*/
|
|
4331
|
-
manager_user_ids?: Array<string
|
|
4660
|
+
manager_user_ids?: Array<string>;
|
|
4332
4661
|
/**
|
|
4333
4662
|
* Purchase order number for the job; null when unset.
|
|
4334
4663
|
*/
|
|
@@ -4379,9 +4708,9 @@ export type JobParameters = {
|
|
|
4379
4708
|
*/
|
|
4380
4709
|
allow_customer_access?: boolean;
|
|
4381
4710
|
/**
|
|
4382
|
-
* Complete desired set of timecode
|
|
4711
|
+
* 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.
|
|
4383
4712
|
*/
|
|
4384
|
-
timekeeping_timecode_ids?: Array<string
|
|
4713
|
+
timekeeping_timecode_ids?: Array<string>;
|
|
4385
4714
|
/**
|
|
4386
4715
|
* Whether the feature-allocation selector is shown for this job; null when unset.
|
|
4387
4716
|
*/
|
|
@@ -5152,11 +5481,11 @@ export type UserParameters = ({
|
|
|
5152
5481
|
/**
|
|
5153
5482
|
* Worker race for demographic reporting, as an array of codes such as CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, and NOT_SPECIFIED.
|
|
5154
5483
|
*/
|
|
5155
|
-
race?: Array<
|
|
5484
|
+
race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'>;
|
|
5156
5485
|
/**
|
|
5157
5486
|
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
|
|
5158
5487
|
*/
|
|
5159
|
-
sex?:
|
|
5488
|
+
sex?: 'female' | 'male' | 'non_binary' | 'not_specified' | null;
|
|
5160
5489
|
/**
|
|
5161
5490
|
* Local business license number, when a jurisdiction requires it on certified payroll.
|
|
5162
5491
|
*/
|
|
@@ -5169,26 +5498,26 @@ export type UserParameters = ({
|
|
|
5169
5498
|
* Worker's driver's license number (stored encrypted).
|
|
5170
5499
|
*/
|
|
5171
5500
|
drivers_license_number?: string | null;
|
|
5501
|
+
/**
|
|
5502
|
+
* Worker Social Security Number (nine digits, stored encrypted), required on certified payroll in some jurisdictions.
|
|
5503
|
+
*/
|
|
5504
|
+
ssn?: string | null;
|
|
5172
5505
|
/**
|
|
5173
5506
|
* Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified.
|
|
5174
5507
|
*/
|
|
5175
|
-
veteran_status?:
|
|
5508
|
+
veteran_status?: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified' | null;
|
|
5176
5509
|
/**
|
|
5177
5510
|
* Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified.
|
|
5178
5511
|
*/
|
|
5179
|
-
hispanic_origin?:
|
|
5512
|
+
hispanic_origin?: 'yes' | 'no' | 'not_specified' | null;
|
|
5180
5513
|
/**
|
|
5181
|
-
*
|
|
5514
|
+
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR); an integer from 0 to 99.
|
|
5182
5515
|
*/
|
|
5183
|
-
|
|
5516
|
+
ca_dir_withholding_exemptions?: number | null;
|
|
5184
5517
|
/**
|
|
5185
5518
|
* Whether the worker has a disability, for demographic reporting.
|
|
5186
5519
|
*/
|
|
5187
|
-
disabled?: boolean
|
|
5188
|
-
/**
|
|
5189
|
-
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR); an integer from 0 to 99.
|
|
5190
|
-
*/
|
|
5191
|
-
ca_dir_withholding_exemptions?: number | null;
|
|
5520
|
+
disabled?: boolean;
|
|
5192
5521
|
/**
|
|
5193
5522
|
* 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.
|
|
5194
5523
|
*/
|
|
@@ -5200,11 +5529,11 @@ export type UserParameters = ({
|
|
|
5200
5529
|
/**
|
|
5201
5530
|
* 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.
|
|
5202
5531
|
*/
|
|
5203
|
-
il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'
|
|
5532
|
+
il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'>;
|
|
5204
5533
|
/**
|
|
5205
5534
|
* Illinois SHINES workforce-program participation for the worker, as an array of program codes such as solar_training_pipeline_program and craft_apprenticeship_program.
|
|
5206
5535
|
*/
|
|
5207
|
-
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'
|
|
5536
|
+
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'>;
|
|
5208
5537
|
/**
|
|
5209
5538
|
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
|
|
5210
5539
|
*/
|
|
@@ -5212,7 +5541,7 @@ export type UserParameters = ({
|
|
|
5212
5541
|
/**
|
|
5213
5542
|
* Oregon BOLI race classification, as an array of codes such as white, asian, hispanic_or_latino, and black_or_african_american.
|
|
5214
5543
|
*/
|
|
5215
|
-
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'
|
|
5544
|
+
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'>;
|
|
5216
5545
|
} | null;
|
|
5217
5546
|
};
|
|
5218
5547
|
/**
|
|
@@ -7748,7 +8077,7 @@ export type ProjectParameters = {
|
|
|
7748
8077
|
*/
|
|
7749
8078
|
parent_id?: string | null;
|
|
7750
8079
|
/**
|
|
7751
|
-
* Complete desired set of participating company
|
|
8080
|
+
* 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.
|
|
7752
8081
|
*/
|
|
7753
8082
|
participating_company_ids?: Array<string>;
|
|
7754
8083
|
/**
|
|
@@ -7833,7 +8162,7 @@ export type ProjectUpdateParameters = {
|
|
|
7833
8162
|
*/
|
|
7834
8163
|
parent_id?: string | null;
|
|
7835
8164
|
/**
|
|
7836
|
-
* Complete desired set of participating company
|
|
8165
|
+
* 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.
|
|
7837
8166
|
*/
|
|
7838
8167
|
participating_company_ids?: Array<string>;
|
|
7839
8168
|
/**
|
|
@@ -9927,11 +10256,11 @@ export type PositionResponseObject = {
|
|
|
9927
10256
|
skill_level: string | null;
|
|
9928
10257
|
};
|
|
9929
10258
|
/**
|
|
9930
|
-
*
|
|
10259
|
+
* The position's first day, as a calendar date (`YYYY-MM-DD`) in the job's tz_name; null when unscheduled.
|
|
9931
10260
|
*/
|
|
9932
10261
|
start_time: string | null;
|
|
9933
10262
|
/**
|
|
9934
|
-
*
|
|
10263
|
+
* The position's last day, as a calendar date (`YYYY-MM-DD`) in the job's tz_name; null when unscheduled.
|
|
9935
10264
|
*/
|
|
9936
10265
|
end_time: string | null;
|
|
9937
10266
|
/**
|
|
@@ -10026,11 +10355,11 @@ export type PositionParameters = {
|
|
|
10026
10355
|
*/
|
|
10027
10356
|
fulfilled_by_user_id?: string | null;
|
|
10028
10357
|
/**
|
|
10029
|
-
*
|
|
10358
|
+
* 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.
|
|
10030
10359
|
*/
|
|
10031
10360
|
start_time?: string | null;
|
|
10032
10361
|
/**
|
|
10033
|
-
*
|
|
10362
|
+
* 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.
|
|
10034
10363
|
*/
|
|
10035
10364
|
end_time?: string | null;
|
|
10036
10365
|
/**
|
|
@@ -10066,7 +10395,7 @@ export type PositionParameters = {
|
|
|
10066
10395
|
*/
|
|
10067
10396
|
wage_adder_rate_cents?: number | null;
|
|
10068
10397
|
/**
|
|
10069
|
-
* 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.
|
|
10398
|
+
* 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.
|
|
10070
10399
|
*/
|
|
10071
10400
|
job_wage_determination_ids?: Array<string>;
|
|
10072
10401
|
/**
|
|
@@ -10159,75 +10488,65 @@ export type ProductionJobScopePriceResponseObject = {
|
|
|
10159
10488
|
updated_at: string;
|
|
10160
10489
|
};
|
|
10161
10490
|
/**
|
|
10162
|
-
*
|
|
10163
|
-
*/
|
|
10164
|
-
export type ProductionCompletionParameters = ProductionFeatureCompletionParameters | ProductionQuantityCompletionParameters;
|
|
10165
|
-
/**
|
|
10166
|
-
* Update a completion. Send only the fields to change. The scope price, filer, and feature reference are fixed at creation. Sending production_job_scope_price_id or performed_by_user_id on update returns 400 unknown_key. Feature completions accept no completable changes; quantity completions accept quantity_completed. A key for the other subtype returns 422.
|
|
10491
|
+
* Record a completion against a scope price. The server takes the completable subtype from the production tracking kind of the scope price's job, never from the request: a feature-tracked job records which feature was completed, and a quantity-tracked job how many units were completed. completable_attributes declares both kinds' keys; sending the other kind's key answers 422 subtype_foreign_keys with an entry pointing at it, and nothing is written.
|
|
10167
10492
|
*/
|
|
10168
|
-
export type
|
|
10493
|
+
export type ProductionCompletionParameters = {
|
|
10169
10494
|
/**
|
|
10170
|
-
*
|
|
10495
|
+
* Scope price the work bills against; set on create only, and it determines the job. Omission answers 400; null, a blank ID, or a wrong type answers 422; a scope price the API key cannot see answers 404.
|
|
10496
|
+
*/
|
|
10497
|
+
production_job_scope_price_id: string;
|
|
10498
|
+
/**
|
|
10499
|
+
* 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.
|
|
10500
|
+
*/
|
|
10501
|
+
performed_by_user_id: string;
|
|
10502
|
+
/**
|
|
10503
|
+
* Free-text notes on the completion; null when none.
|
|
10171
10504
|
*/
|
|
10172
10505
|
notes?: string | null;
|
|
10173
10506
|
/**
|
|
10174
|
-
* Date the work was performed (YYYY-MM-DD)
|
|
10507
|
+
* Date the work was performed (YYYY-MM-DD). Omit it to file the completion on today's date in the job's time zone; null or a value that is not a calendar date answers 422.
|
|
10175
10508
|
*/
|
|
10176
10509
|
work_date?: string;
|
|
10177
10510
|
/**
|
|
10178
|
-
*
|
|
10511
|
+
* Unique nonblank IDs of the job positions that performed the work (the crew). At least one is required. Null, null members, wrong types, blank IDs, and duplicate IDs answer 422.
|
|
10179
10512
|
*/
|
|
10180
10513
|
position_ids?: Array<string>;
|
|
10514
|
+
/**
|
|
10515
|
+
* The completion's subtype fields, whose kind follows the job's production tracking kind. A string, array, or null answers 422; an unknown key inside answers 422 at its pointer.
|
|
10516
|
+
*/
|
|
10181
10517
|
completable_attributes?: {
|
|
10182
10518
|
/**
|
|
10183
|
-
*
|
|
10519
|
+
* Feature the work completed, for a feature-tracked job; required there, and immutable after create.
|
|
10520
|
+
*/
|
|
10521
|
+
feature_id?: string;
|
|
10522
|
+
/**
|
|
10523
|
+
* Number of units completed, a positive integer, for a quantity-tracked job; required there.
|
|
10184
10524
|
*/
|
|
10185
10525
|
quantity_completed?: number;
|
|
10186
10526
|
};
|
|
10187
10527
|
};
|
|
10188
10528
|
/**
|
|
10189
|
-
*
|
|
10529
|
+
* Update a completion. Send only the fields to change. The scope price, filer, and feature reference are fixed at creation. Sending production_job_scope_price_id or performed_by_user_id on update returns 400 unknown_key. Feature completions accept no completable changes, so quantity_completed on one answers 422 subtype_foreign_keys with an entry pointing at it; quantity completions accept quantity_completed.
|
|
10190
10530
|
*/
|
|
10191
|
-
export type
|
|
10192
|
-
/**
|
|
10193
|
-
* 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.
|
|
10194
|
-
*/
|
|
10195
|
-
production_job_scope_price_id: string;
|
|
10196
|
-
/**
|
|
10197
|
-
* 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.
|
|
10198
|
-
*/
|
|
10199
|
-
performed_by_user_id: string;
|
|
10531
|
+
export type ProductionCompletionUpdateParameters = {
|
|
10200
10532
|
/**
|
|
10201
|
-
* Free-text notes
|
|
10533
|
+
* Free-text notes; omit to preserve them, or send null to clear them.
|
|
10202
10534
|
*/
|
|
10203
10535
|
notes?: string | null;
|
|
10204
10536
|
/**
|
|
10205
|
-
* Date the work was performed (YYYY-MM-DD);
|
|
10537
|
+
* Date the work was performed (YYYY-MM-DD); omit to preserve it. Null or a value that is not a calendar date answers 422.
|
|
10206
10538
|
*/
|
|
10207
10539
|
work_date?: string;
|
|
10208
10540
|
/**
|
|
10209
|
-
*
|
|
10541
|
+
* 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.
|
|
10210
10542
|
*/
|
|
10211
10543
|
position_ids?: Array<string>;
|
|
10212
|
-
|
|
10213
|
-
|
|
10214
|
-
|
|
10215
|
-
*/
|
|
10216
|
-
export type ProductionFeatureCompletionParameters = ProductionCompletionBaseParameters & {
|
|
10217
|
-
completable_attributes?: {
|
|
10218
|
-
/**
|
|
10219
|
-
* Feature the work completed; required on create, immutable after.
|
|
10220
|
-
*/
|
|
10221
|
-
feature_id?: string;
|
|
10222
|
-
};
|
|
10223
|
-
};
|
|
10224
|
-
/**
|
|
10225
|
-
* Payload for completions on quantity-tracked jobs (the scope price's job tracks production by quantity). feature_id is not accepted.
|
|
10226
|
-
*/
|
|
10227
|
-
export type ProductionQuantityCompletionParameters = ProductionCompletionBaseParameters & {
|
|
10544
|
+
/**
|
|
10545
|
+
* The completion's subtype fields. A string, array, or null answers 422; any key but quantity_completed, feature_id included, answers 422 at its pointer.
|
|
10546
|
+
*/
|
|
10228
10547
|
completable_attributes?: {
|
|
10229
10548
|
/**
|
|
10230
|
-
* Number of units completed.
|
|
10549
|
+
* Number of units completed, a positive integer, for quantity completions only. Omit to preserve it.
|
|
10231
10550
|
*/
|
|
10232
10551
|
quantity_completed?: number;
|
|
10233
10552
|
};
|
|
@@ -11586,10 +11905,6 @@ export type FederalJobWageDeterminationParameters = {
|
|
|
11586
11905
|
* 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.
|
|
11587
11906
|
*/
|
|
11588
11907
|
general_wage_determination?: string | null;
|
|
11589
|
-
/**
|
|
11590
|
-
* 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.
|
|
11591
|
-
*/
|
|
11592
|
-
pay_rates_rule_package_id?: string | null;
|
|
11593
11908
|
};
|
|
11594
11909
|
/**
|
|
11595
11910
|
* Parameters for creating a Regional (state prevailing-wage) wage determination on a job.
|
|
@@ -11623,10 +11938,6 @@ export type RegionalJobWageDeterminationParameters = {
|
|
|
11623
11938
|
* 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.
|
|
11624
11939
|
*/
|
|
11625
11940
|
overtime_package_id?: string | null;
|
|
11626
|
-
/**
|
|
11627
|
-
* 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.
|
|
11628
|
-
*/
|
|
11629
|
-
pay_rates_rule_package_id?: string | null;
|
|
11630
11941
|
regional_fields?: RegionalWageDeterminationFields;
|
|
11631
11942
|
};
|
|
11632
11943
|
/**
|
|
@@ -11641,10 +11952,6 @@ export type JobWageDeterminationUpdateParameters = {
|
|
|
11641
11952
|
* 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.
|
|
11642
11953
|
*/
|
|
11643
11954
|
overtime_package_id?: string | null;
|
|
11644
|
-
/**
|
|
11645
|
-
* 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.
|
|
11646
|
-
*/
|
|
11647
|
-
pay_rates_rule_package_id?: string | null;
|
|
11648
11955
|
/**
|
|
11649
11956
|
* Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
|
|
11650
11957
|
*/
|
|
@@ -12006,10 +12313,6 @@ export type FederalProjectWageDeterminationParameters = {
|
|
|
12006
12313
|
* 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.
|
|
12007
12314
|
*/
|
|
12008
12315
|
general_wage_determination?: string | null;
|
|
12009
|
-
/**
|
|
12010
|
-
* 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.
|
|
12011
|
-
*/
|
|
12012
|
-
pay_rates_rule_package_id?: string | null;
|
|
12013
12316
|
};
|
|
12014
12317
|
/**
|
|
12015
12318
|
* Parameters for creating a Regional (state prevailing-wage) wage determination on a project.
|
|
@@ -12043,10 +12346,6 @@ export type RegionalProjectWageDeterminationParameters = {
|
|
|
12043
12346
|
* 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.
|
|
12044
12347
|
*/
|
|
12045
12348
|
overtime_package_id?: string | null;
|
|
12046
|
-
/**
|
|
12047
|
-
* 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.
|
|
12048
|
-
*/
|
|
12049
|
-
pay_rates_rule_package_id?: string | null;
|
|
12050
12349
|
regional_fields?: RegionalWageDeterminationFields;
|
|
12051
12350
|
};
|
|
12052
12351
|
/**
|
|
@@ -12061,10 +12360,6 @@ export type ProjectWageDeterminationUpdateParameters = {
|
|
|
12061
12360
|
* 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.
|
|
12062
12361
|
*/
|
|
12063
12362
|
overtime_package_id?: string | null;
|
|
12064
|
-
/**
|
|
12065
|
-
* 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.
|
|
12066
|
-
*/
|
|
12067
|
-
pay_rates_rule_package_id?: string | null;
|
|
12068
12363
|
/**
|
|
12069
12364
|
* Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
|
|
12070
12365
|
*/
|
|
@@ -12440,29 +12735,53 @@ export type PayRatesRuleResponseObject = {
|
|
|
12440
12735
|
* Parameters for creating a conditional wage or fringe adjustment in a pay-rate rule package.
|
|
12441
12736
|
*/
|
|
12442
12737
|
export type PayRatesRuleParameters = {
|
|
12443
|
-
effect: RateRuleEffect;
|
|
12444
12738
|
/**
|
|
12445
|
-
*
|
|
12739
|
+
* 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.
|
|
12446
12740
|
*/
|
|
12447
|
-
|
|
12741
|
+
effective_date?: string;
|
|
12448
12742
|
/**
|
|
12449
|
-
*
|
|
12743
|
+
* The adjustment applied when a rule matches — an addition to the wage or fringe rate.
|
|
12450
12744
|
*/
|
|
12451
|
-
|
|
12745
|
+
effect: {
|
|
12746
|
+
/**
|
|
12747
|
+
* Which base rate the effect adds to: `wage_increment` the hourly wage rate, `fringe_increment` the fringe rate.
|
|
12748
|
+
*/
|
|
12749
|
+
type: 'wage_increment' | 'fringe_increment';
|
|
12750
|
+
/**
|
|
12751
|
+
* Amount added to the base rate, in whole cents as a decimal string (e.g. "300" is $3.00). Zero or positive; fractional input is truncated.
|
|
12752
|
+
*/
|
|
12753
|
+
amount_cents: string;
|
|
12754
|
+
};
|
|
12755
|
+
/**
|
|
12756
|
+
* Match conditions for the rule. Omit or send an empty list for an unconditional rule.
|
|
12757
|
+
*/
|
|
12758
|
+
conditions?: Array<RateRuleTimeRangeCondition | RateRuleDaysCondition | RateRuleSpecificDateCondition | RateRuleApprenticePeriodCondition | RateRuleApprenticeHoursCondition | RateRuleOvertimeMultiplierCondition>;
|
|
12452
12759
|
};
|
|
12453
12760
|
/**
|
|
12454
12761
|
* Change a rule from an effective date forward. Omitted effect or conditions keep that part of the targeted version. When the targeted recipe changes, the resulting complete recipe applies from that coordinate across later scheduled versions; an unchanged recipe does not alter later scheduled versions. An empty conditions list makes the rule unconditional. Omit effective_from to correct the selected version from its exact existing start. A rule with an unbounded lower limit requires effective_from.
|
|
12455
12762
|
*/
|
|
12456
12763
|
export type PayRatesRuleUpdateParameters = {
|
|
12457
|
-
effect?: RateRuleEffect;
|
|
12458
|
-
/**
|
|
12459
|
-
* Replacement match conditions. Omit this field to keep the targeted version's conditions; send an empty list to make the rule unconditional.
|
|
12460
|
-
*/
|
|
12461
|
-
conditions?: Array<RateRuleCondition>;
|
|
12462
12764
|
/**
|
|
12463
12765
|
* Date the change begins, YYYY-MM-DD. Omit it to correct the selected version from its exact existing start. Required when that version has no lower bound.
|
|
12464
12766
|
*/
|
|
12465
12767
|
effective_from?: string;
|
|
12768
|
+
/**
|
|
12769
|
+
* The adjustment applied when a rule matches — an addition to the wage or fringe rate.
|
|
12770
|
+
*/
|
|
12771
|
+
effect?: {
|
|
12772
|
+
/**
|
|
12773
|
+
* Which base rate the effect adds to: `wage_increment` the hourly wage rate, `fringe_increment` the fringe rate.
|
|
12774
|
+
*/
|
|
12775
|
+
type: 'wage_increment' | 'fringe_increment';
|
|
12776
|
+
/**
|
|
12777
|
+
* Amount added to the base rate, in whole cents as a decimal string (e.g. "300" is $3.00). Zero or positive; fractional input is truncated.
|
|
12778
|
+
*/
|
|
12779
|
+
amount_cents: string;
|
|
12780
|
+
};
|
|
12781
|
+
/**
|
|
12782
|
+
* Replacement match conditions. Omit this field to keep the targeted version's conditions; send an empty list to make the rule unconditional.
|
|
12783
|
+
*/
|
|
12784
|
+
conditions?: Array<RateRuleTimeRangeCondition | RateRuleDaysCondition | RateRuleSpecificDateCondition | RateRuleApprenticePeriodCondition | RateRuleApprenticeHoursCondition | RateRuleOvertimeMultiplierCondition>;
|
|
12466
12785
|
};
|
|
12467
12786
|
/**
|
|
12468
12787
|
* Parameters for moving where a pay-rate rule family's valid-time timeline begins.
|
|
@@ -12483,18 +12802,30 @@ export type PayRatesRuleScheduledTerminationParameters = {
|
|
|
12483
12802
|
effective_date: string;
|
|
12484
12803
|
};
|
|
12485
12804
|
/**
|
|
12486
|
-
* Schedule a rule recipe change from
|
|
12805
|
+
* 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.
|
|
12487
12806
|
*/
|
|
12488
12807
|
export type PayRatesRuleScheduledChangeParameters = {
|
|
12489
12808
|
/**
|
|
12490
12809
|
* Date the change begins, YYYY-MM-DD.
|
|
12491
12810
|
*/
|
|
12492
12811
|
effective_date: string;
|
|
12493
|
-
|
|
12812
|
+
/**
|
|
12813
|
+
* The adjustment applied when a rule matches — an addition to the wage or fringe rate.
|
|
12814
|
+
*/
|
|
12815
|
+
effect?: {
|
|
12816
|
+
/**
|
|
12817
|
+
* Which base rate the effect adds to: `wage_increment` the hourly wage rate, `fringe_increment` the fringe rate.
|
|
12818
|
+
*/
|
|
12819
|
+
type: 'wage_increment' | 'fringe_increment';
|
|
12820
|
+
/**
|
|
12821
|
+
* Amount added to the base rate, in whole cents as a decimal string (e.g. "300" is $3.00). Zero or positive; fractional input is truncated.
|
|
12822
|
+
*/
|
|
12823
|
+
amount_cents: string;
|
|
12824
|
+
};
|
|
12494
12825
|
/**
|
|
12495
12826
|
* Replacement match conditions. Omit this field to keep the targeted version's conditions; send an empty list to make the rule unconditional.
|
|
12496
12827
|
*/
|
|
12497
|
-
conditions?: Array<
|
|
12828
|
+
conditions?: Array<RateRuleTimeRangeCondition | RateRuleDaysCondition | RateRuleSpecificDateCondition | RateRuleApprenticePeriodCondition | RateRuleApprenticeHoursCondition | RateRuleOvertimeMultiplierCondition>;
|
|
12498
12829
|
};
|
|
12499
12830
|
export type PayRatesRuleHistoryCorrectionObject = {
|
|
12500
12831
|
/**
|
|
@@ -12740,11 +13071,23 @@ export type RateRuleParameters = {
|
|
|
12740
13071
|
* Date the rule takes effect, YYYY-MM-DD. Defaults to today. Cannot predate the earliest wage determination the rule's package applies to.
|
|
12741
13072
|
*/
|
|
12742
13073
|
effective_date?: string | null;
|
|
12743
|
-
|
|
13074
|
+
/**
|
|
13075
|
+
* The adjustment applied when a rule matches — an addition to the wage or fringe rate.
|
|
13076
|
+
*/
|
|
13077
|
+
effect: {
|
|
13078
|
+
/**
|
|
13079
|
+
* Which base rate the effect adds to: `wage_increment` the hourly wage rate, `fringe_increment` the fringe rate.
|
|
13080
|
+
*/
|
|
13081
|
+
type: 'wage_increment' | 'fringe_increment';
|
|
13082
|
+
/**
|
|
13083
|
+
* Amount added to the base rate, in whole cents as a decimal string (e.g. "300" is $3.00). Zero or positive; fractional input is truncated.
|
|
13084
|
+
*/
|
|
13085
|
+
amount_cents: string;
|
|
13086
|
+
};
|
|
12744
13087
|
/**
|
|
12745
13088
|
* Match conditions for the rule; optional. Omit or send an empty list for a rule that always applies. At most one condition per category (time, day-selection, apprentice, overtime).
|
|
12746
13089
|
*/
|
|
12747
|
-
conditions?: Array<
|
|
13090
|
+
conditions?: Array<RateRuleTimeRangeCondition | RateRuleDaysCondition | RateRuleSpecificDateCondition | RateRuleApprenticePeriodCondition | RateRuleApprenticeHoursCondition | RateRuleOvertimeMultiplierCondition>;
|
|
12748
13091
|
};
|
|
12749
13092
|
/**
|
|
12750
13093
|
* A tracked physical asset owned by a company and typed by a product — either an individually-tracked serial unit or a quantity-tracked bulk stock record. The serial-only fields (serial_number, status, purchase_date, purchase_price_cents, currency, external_id, external_system_url) are null on a bulk item.
|
|
@@ -12861,7 +13204,7 @@ export type AssetsItemParameters = {
|
|
|
12861
13204
|
/**
|
|
12862
13205
|
* Free-text description of the item.
|
|
12863
13206
|
*/
|
|
12864
|
-
description?: string;
|
|
13207
|
+
description?: string | null;
|
|
12865
13208
|
/**
|
|
12866
13209
|
* ID of the product this item is an instance of.
|
|
12867
13210
|
*/
|
|
@@ -12869,7 +13212,7 @@ export type AssetsItemParameters = {
|
|
|
12869
13212
|
/**
|
|
12870
13213
|
* Serial number identifying the individual physical unit; unique within its product.
|
|
12871
13214
|
*/
|
|
12872
|
-
serial_number
|
|
13215
|
+
serial_number?: string | null;
|
|
12873
13216
|
/**
|
|
12874
13217
|
* Placement status of the item: available, or assigned when held by a user.
|
|
12875
13218
|
*/
|
|
@@ -12877,21 +13220,21 @@ export type AssetsItemParameters = {
|
|
|
12877
13220
|
/**
|
|
12878
13221
|
* When the item was purchased (ISO 8601).
|
|
12879
13222
|
*/
|
|
12880
|
-
purchase_date?: string;
|
|
13223
|
+
purchase_date?: string | null;
|
|
12881
13224
|
/**
|
|
12882
13225
|
* Purchase price in cents, in the item's currency.
|
|
12883
13226
|
*/
|
|
12884
|
-
purchase_price_cents?: number;
|
|
13227
|
+
purchase_price_cents?: number | null;
|
|
12885
13228
|
/**
|
|
12886
13229
|
* Identifier for this item in an external system.
|
|
12887
13230
|
*/
|
|
12888
|
-
external_id?: string;
|
|
13231
|
+
external_id?: string | null;
|
|
12889
13232
|
/**
|
|
12890
13233
|
* URL to this item in an external system.
|
|
12891
13234
|
*/
|
|
12892
|
-
external_system_url?: string;
|
|
13235
|
+
external_system_url?: string | null;
|
|
12893
13236
|
/**
|
|
12894
|
-
* Upserts the values of the item-level attributes of the product's category, one
|
|
13237
|
+
* Upserts the values of the item-level attributes of the product's category, as a list of row objects, one per attribute. Each row requires its assets_attribute_id; a row without one answers 400, and a blank one 422. Send a blank value and null assets_attribute_option_id to clear one. A value is a string or null; any other JSON type, or an unknown row field, answers 422 at that row.
|
|
12895
13238
|
*/
|
|
12896
13239
|
attribute_values?: Array<{
|
|
12897
13240
|
/**
|
|
@@ -12908,32 +13251,45 @@ export type AssetsItemParameters = {
|
|
|
12908
13251
|
assets_attribute_option_id?: string | null;
|
|
12909
13252
|
}>;
|
|
12910
13253
|
/**
|
|
12911
|
-
* Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
|
|
13254
|
+
* Image attachments, as a list of row objects. Send file with a signed_id to add one; include id with _destroy to remove an existing one. An unknown or wrongly typed row field answers 422 at that row.
|
|
13255
|
+
*/
|
|
13256
|
+
images_attributes?: Array<{
|
|
13257
|
+
/**
|
|
13258
|
+
* ID of an existing attachment to remove; omit to add a new one.
|
|
13259
|
+
*/
|
|
13260
|
+
id?: string;
|
|
13261
|
+
/**
|
|
13262
|
+
* A signed_id from POST /api/v1/direct_uploads registered for `assets.items`; a signed_id issued for any other resource answers 422.
|
|
13263
|
+
*/
|
|
13264
|
+
file?: string;
|
|
13265
|
+
/**
|
|
13266
|
+
* Set true to remove the attachment named by id.
|
|
13267
|
+
*/
|
|
13268
|
+
_destroy?: boolean;
|
|
13269
|
+
}>;
|
|
13270
|
+
/**
|
|
13271
|
+
* ID of the user this write is performed on behalf of — recorded as the item's creator or updater and attributed to any placement. 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.
|
|
12912
13272
|
*/
|
|
12913
|
-
|
|
13273
|
+
performed_by_user_id: string;
|
|
12914
13274
|
/**
|
|
12915
13275
|
* Optional, create only. Stock the new item at this site, recording a receive transaction. Mutually exclusive with user_id and container_item_id.
|
|
12916
13276
|
*/
|
|
12917
|
-
assets_site_id?: string;
|
|
13277
|
+
assets_site_id?: string | null;
|
|
12918
13278
|
/**
|
|
12919
13279
|
* Optional, create only. Assign the new item to this user. Mutually exclusive with assets_site_id and container_item_id.
|
|
12920
13280
|
*/
|
|
12921
|
-
user_id?: string;
|
|
13281
|
+
user_id?: string | null;
|
|
12922
13282
|
/**
|
|
12923
13283
|
* Optional, create only. Place the new item inside this container item. Mutually exclusive with assets_site_id and user_id.
|
|
12924
13284
|
*/
|
|
12925
|
-
container_item_id?: string;
|
|
13285
|
+
container_item_id?: string | null;
|
|
12926
13286
|
/**
|
|
12927
13287
|
* Optional, create only. The storage location within the placement site or container the item lands in; must belong to that holder. Omit for an unbinned placement. Ignored for a user assignment.
|
|
12928
13288
|
*/
|
|
12929
|
-
assets_sub_location_id?: string;
|
|
12930
|
-
/**
|
|
12931
|
-
* ID of the user this write is performed on behalf of — recorded as the item's creator or updater and attributed to any placement. 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.
|
|
12932
|
-
*/
|
|
12933
|
-
performed_by_user_id: string;
|
|
13289
|
+
assets_sub_location_id?: string | null;
|
|
12934
13290
|
};
|
|
12935
13291
|
/**
|
|
12936
|
-
* Update an asset item. All item fields are optional — send only what changes — but performed_by_user_id is required to record the updater. Omitted attributes retain their existing values. `attribute_values` upserts the item-level attributes of the product's category.
|
|
13292
|
+
* Update an asset item. All item fields are optional — send only what changes — but performed_by_user_id is required to record the updater. Omitted attributes retain their existing values. `attribute_values` upserts the item-level attributes of the product's category. The serial-only fields (serial_number, status, purchase_date, purchase_price_cents, external_id, external_system_url) apply to a serial item; sending one for a bulk item answers 422 subtype_foreign_keys with an entry pointing at each such field, and nothing is written.
|
|
12937
13293
|
*/
|
|
12938
13294
|
export type AssetsItemUpdateParameters = {
|
|
12939
13295
|
/**
|
|
@@ -12943,7 +13299,7 @@ export type AssetsItemUpdateParameters = {
|
|
|
12943
13299
|
/**
|
|
12944
13300
|
* Free-text description of the item.
|
|
12945
13301
|
*/
|
|
12946
|
-
description?: string;
|
|
13302
|
+
description?: string | null;
|
|
12947
13303
|
/**
|
|
12948
13304
|
* ID of the product this item is an instance of.
|
|
12949
13305
|
*/
|
|
@@ -12951,7 +13307,7 @@ export type AssetsItemUpdateParameters = {
|
|
|
12951
13307
|
/**
|
|
12952
13308
|
* Serial number identifying the individual physical unit; unique within its product.
|
|
12953
13309
|
*/
|
|
12954
|
-
serial_number?: string;
|
|
13310
|
+
serial_number?: string | null;
|
|
12955
13311
|
/**
|
|
12956
13312
|
* Placement status of the item: available, or assigned when held by a user.
|
|
12957
13313
|
*/
|
|
@@ -12959,21 +13315,21 @@ export type AssetsItemUpdateParameters = {
|
|
|
12959
13315
|
/**
|
|
12960
13316
|
* When the item was purchased (ISO 8601).
|
|
12961
13317
|
*/
|
|
12962
|
-
purchase_date?: string;
|
|
13318
|
+
purchase_date?: string | null;
|
|
12963
13319
|
/**
|
|
12964
13320
|
* Purchase price in cents, in the item's currency.
|
|
12965
13321
|
*/
|
|
12966
|
-
purchase_price_cents?: number;
|
|
13322
|
+
purchase_price_cents?: number | null;
|
|
12967
13323
|
/**
|
|
12968
13324
|
* Identifier for this item in an external system.
|
|
12969
13325
|
*/
|
|
12970
|
-
external_id?: string;
|
|
13326
|
+
external_id?: string | null;
|
|
12971
13327
|
/**
|
|
12972
13328
|
* URL to this item in an external system.
|
|
12973
13329
|
*/
|
|
12974
|
-
external_system_url?: string;
|
|
13330
|
+
external_system_url?: string | null;
|
|
12975
13331
|
/**
|
|
12976
|
-
* Upserts the values of the item-level attributes of the product's category, one
|
|
13332
|
+
* Upserts the values of the item-level attributes of the product's category, as a list of row objects, one per attribute. Each row requires its assets_attribute_id; a row without one answers 400, and a blank one 422. Send a blank value and null assets_attribute_option_id to clear one. A value is a string or null; any other JSON type, or an unknown row field, answers 422 at that row.
|
|
12977
13333
|
*/
|
|
12978
13334
|
attribute_values?: Array<{
|
|
12979
13335
|
/**
|
|
@@ -12990,9 +13346,22 @@ export type AssetsItemUpdateParameters = {
|
|
|
12990
13346
|
assets_attribute_option_id?: string | null;
|
|
12991
13347
|
}>;
|
|
12992
13348
|
/**
|
|
12993
|
-
* Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
|
|
13349
|
+
* Image attachments, as a list of row objects. Send file with a signed_id to add one; include id with _destroy to remove an existing one. An unknown or wrongly typed row field answers 422 at that row.
|
|
12994
13350
|
*/
|
|
12995
|
-
images_attributes?: Array<
|
|
13351
|
+
images_attributes?: Array<{
|
|
13352
|
+
/**
|
|
13353
|
+
* ID of an existing attachment to remove; omit to add a new one.
|
|
13354
|
+
*/
|
|
13355
|
+
id?: string;
|
|
13356
|
+
/**
|
|
13357
|
+
* A signed_id from POST /api/v1/direct_uploads registered for `assets.items`; a signed_id issued for any other resource answers 422.
|
|
13358
|
+
*/
|
|
13359
|
+
file?: string;
|
|
13360
|
+
/**
|
|
13361
|
+
* Set true to remove the attachment named by id.
|
|
13362
|
+
*/
|
|
13363
|
+
_destroy?: boolean;
|
|
13364
|
+
}>;
|
|
12996
13365
|
/**
|
|
12997
13366
|
* ID of the user this update is performed on behalf of, recorded as updater. 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.
|
|
12998
13367
|
*/
|
|
@@ -13337,23 +13706,6 @@ export type AssetsAttachmentResponseObject = {
|
|
|
13337
13706
|
*/
|
|
13338
13707
|
updated_at: string;
|
|
13339
13708
|
};
|
|
13340
|
-
/**
|
|
13341
|
-
* One attachment in a nested collection. Send file with a signed_id to add one; send id (with _destroy) to remove an existing one.
|
|
13342
|
-
*/
|
|
13343
|
-
export type AssetsAttachmentParameters = {
|
|
13344
|
-
/**
|
|
13345
|
-
* ID of an existing attachment to remove; omit to add a new one.
|
|
13346
|
-
*/
|
|
13347
|
-
id?: string;
|
|
13348
|
-
/**
|
|
13349
|
-
* A signed_id from POST /api/v1/direct_uploads identifying the uploaded blob to attach. Register the upload naming the resource of the endpoint you are calling — `assets.items` for item images, `assets.products` for product images, `assets.items.service_events` for service event attachments — because a signed_id issued for any other resource will not resolve here.
|
|
13350
|
-
*/
|
|
13351
|
-
file?: string;
|
|
13352
|
-
/**
|
|
13353
|
-
* Set true to remove the attachment named by id.
|
|
13354
|
-
*/
|
|
13355
|
-
_destroy?: boolean;
|
|
13356
|
-
};
|
|
13357
13709
|
/**
|
|
13358
13710
|
* A file attached to an asset item — a document such as a manual, warranty, or certificate. Uploaded through the direct-upload flow and optionally marked as a certified copy.
|
|
13359
13711
|
*/
|
|
@@ -14046,13 +14398,26 @@ export type AssetsServiceEventParameters = {
|
|
|
14046
14398
|
*/
|
|
14047
14399
|
assets_service_schedule_id?: string | null;
|
|
14048
14400
|
/**
|
|
14049
|
-
*
|
|
14401
|
+
* Document attachments for the service, as a list of row objects. Send file with a signed_id to add one. An unknown or wrongly typed row field answers 422 at that row.
|
|
14050
14402
|
*/
|
|
14051
|
-
|
|
14403
|
+
attachments_attributes?: Array<{
|
|
14404
|
+
/**
|
|
14405
|
+
* ID of an existing attachment to remove; omit to add a new one.
|
|
14406
|
+
*/
|
|
14407
|
+
id?: string;
|
|
14408
|
+
/**
|
|
14409
|
+
* A signed_id from POST /api/v1/direct_uploads registered for `assets.items.service_events`; a signed_id issued for any other resource answers 422.
|
|
14410
|
+
*/
|
|
14411
|
+
file?: string;
|
|
14412
|
+
/**
|
|
14413
|
+
* Set true to remove the attachment named by id.
|
|
14414
|
+
*/
|
|
14415
|
+
_destroy?: boolean;
|
|
14416
|
+
}>;
|
|
14052
14417
|
/**
|
|
14053
|
-
*
|
|
14418
|
+
* ID of the user who performed the service. 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.
|
|
14054
14419
|
*/
|
|
14055
|
-
|
|
14420
|
+
performed_by_user_id: string;
|
|
14056
14421
|
};
|
|
14057
14422
|
/**
|
|
14058
14423
|
* Update a service event. Event fields are optional — send only what changes — but performed_by_user_id is required to record the updater. A linked schedule dictates kind, and changing or removing the link recomputes affected due dates.
|
|
@@ -14075,13 +14440,26 @@ export type AssetsServiceEventUpdateParameters = {
|
|
|
14075
14440
|
*/
|
|
14076
14441
|
assets_service_schedule_id?: string | null;
|
|
14077
14442
|
/**
|
|
14078
|
-
*
|
|
14443
|
+
* Document attachments for the service, as a list of row objects. Set _destroy with an id to remove an existing one; omit id to add a new one. An unknown or wrongly typed row field answers 422 at that row.
|
|
14079
14444
|
*/
|
|
14080
|
-
|
|
14445
|
+
attachments_attributes?: Array<{
|
|
14446
|
+
/**
|
|
14447
|
+
* ID of an existing attachment to remove; omit to add a new one.
|
|
14448
|
+
*/
|
|
14449
|
+
id?: string;
|
|
14450
|
+
/**
|
|
14451
|
+
* A signed_id from POST /api/v1/direct_uploads registered for `assets.items.service_events`; a signed_id issued for any other resource answers 422.
|
|
14452
|
+
*/
|
|
14453
|
+
file?: string;
|
|
14454
|
+
/**
|
|
14455
|
+
* Set true to remove the attachment named by id.
|
|
14456
|
+
*/
|
|
14457
|
+
_destroy?: boolean;
|
|
14458
|
+
}>;
|
|
14081
14459
|
/**
|
|
14082
|
-
*
|
|
14460
|
+
* ID of the user this update is performed on behalf of. 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.
|
|
14083
14461
|
*/
|
|
14084
|
-
|
|
14462
|
+
performed_by_user_id: string;
|
|
14085
14463
|
};
|
|
14086
14464
|
/**
|
|
14087
14465
|
* A product-level service cadence that seeds and syncs the matching schedules on that product's items. Changing its defining fields (name, kind, interval) reconciles linked item schedules in the background.
|
|
@@ -14486,6 +14864,12 @@ export type AssetsServiceScheduleSyncParameters = {
|
|
|
14486
14864
|
*/
|
|
14487
14865
|
performed_by_user_id: string;
|
|
14488
14866
|
};
|
|
14867
|
+
/**
|
|
14868
|
+
* Archive a competence standard. The body takes no fields; send an empty object or no body. Archiving an archived standard returns it unchanged.
|
|
14869
|
+
*/
|
|
14870
|
+
export type CompetencyStandardArchiveParametersWritable = {
|
|
14871
|
+
[key: string]: never;
|
|
14872
|
+
};
|
|
14489
14873
|
/**
|
|
14490
14874
|
* 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.
|
|
14491
14875
|
*/
|
|
@@ -16596,7 +16980,7 @@ export type UpdateItemErrors = {
|
|
|
16596
16980
|
*/
|
|
16597
16981
|
404: Problem;
|
|
16598
16982
|
/**
|
|
16599
|
-
* Unprocessable Content
|
|
16983
|
+
* Unprocessable Content (malformed row)
|
|
16600
16984
|
*/
|
|
16601
16985
|
422: Problem;
|
|
16602
16986
|
};
|
|
@@ -17550,7 +17934,7 @@ export type UpdateProductErrors = {
|
|
|
17550
17934
|
*/
|
|
17551
17935
|
404: Problem;
|
|
17552
17936
|
/**
|
|
17553
|
-
* Unprocessable Content
|
|
17937
|
+
* Unprocessable Content (malformed row)
|
|
17554
17938
|
*/
|
|
17555
17939
|
422: Problem;
|
|
17556
17940
|
};
|
|
@@ -19974,38 +20358,19 @@ export type RevokeAssessorAuthorizationResponses = {
|
|
|
19974
20358
|
201: CompetencyAssessorAuthorizationResponseObject;
|
|
19975
20359
|
};
|
|
19976
20360
|
export type RevokeAssessorAuthorizationResponse = RevokeAssessorAuthorizationResponses[keyof RevokeAssessorAuthorizationResponses];
|
|
19977
|
-
export type
|
|
20361
|
+
export type ListLevelsData = {
|
|
19978
20362
|
body?: never;
|
|
19979
|
-
path
|
|
20363
|
+
path: {
|
|
20364
|
+
standard_id: string;
|
|
20365
|
+
version_id: string;
|
|
20366
|
+
};
|
|
19980
20367
|
query?: {
|
|
19981
|
-
/**
|
|
19982
|
-
* Standings held by this candidate.
|
|
19983
|
-
*/
|
|
19984
|
-
'filter[candidate_user_id]'?: string;
|
|
19985
|
-
/**
|
|
19986
|
-
* Standings against this standard.
|
|
19987
|
-
*/
|
|
19988
|
-
'filter[competencies_standard_id]'?: string;
|
|
19989
|
-
/**
|
|
19990
|
-
* Standings at this tier.
|
|
19991
|
-
*/
|
|
19992
|
-
'filter[level_sort_order]'?: number;
|
|
19993
20368
|
filter?: string;
|
|
19994
20369
|
'filter[unexpected]'?: string;
|
|
19995
|
-
/**
|
|
19996
|
-
* This pagination cursor corresponds to the cursor value found in the response in
|
|
19997
|
-
* `meta.page.next_cursor`.
|
|
19998
|
-
*/
|
|
19999
|
-
'page[cursor]'?: string;
|
|
20000
|
-
/**
|
|
20001
|
-
* 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`.
|
|
20002
|
-
*/
|
|
20003
|
-
'page[limit]'?: number;
|
|
20004
|
-
page?: string;
|
|
20005
20370
|
};
|
|
20006
|
-
url: '/api/v1/competencies/
|
|
20371
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels';
|
|
20007
20372
|
};
|
|
20008
|
-
export type
|
|
20373
|
+
export type ListLevelsErrors = {
|
|
20009
20374
|
/**
|
|
20010
20375
|
* Bad Request
|
|
20011
20376
|
*/
|
|
@@ -20015,44 +20380,982 @@ export type ListQualificationsErrors = {
|
|
|
20015
20380
|
*/
|
|
20016
20381
|
403: Problem;
|
|
20017
20382
|
};
|
|
20018
|
-
export type
|
|
20019
|
-
export type
|
|
20383
|
+
export type ListLevelsError = ListLevelsErrors[keyof ListLevelsErrors];
|
|
20384
|
+
export type ListLevelsResponses = {
|
|
20020
20385
|
/**
|
|
20021
20386
|
* Success
|
|
20022
20387
|
*/
|
|
20023
20388
|
200: {
|
|
20024
20389
|
meta: Meta;
|
|
20025
20390
|
links: Links;
|
|
20026
|
-
data: Array<
|
|
20391
|
+
data: Array<CompetencyLevelResponseObject>;
|
|
20027
20392
|
};
|
|
20028
20393
|
};
|
|
20029
|
-
export type
|
|
20030
|
-
export type
|
|
20031
|
-
body?:
|
|
20394
|
+
export type ListLevelsResponse = ListLevelsResponses[keyof ListLevelsResponses];
|
|
20395
|
+
export type CreateLevelData = {
|
|
20396
|
+
body?: CompetencyLevelParameters;
|
|
20032
20397
|
path: {
|
|
20033
|
-
|
|
20398
|
+
standard_id: string;
|
|
20399
|
+
version_id: string;
|
|
20034
20400
|
};
|
|
20035
20401
|
query?: never;
|
|
20036
|
-
url: '/api/v1/competencies/
|
|
20402
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels';
|
|
20037
20403
|
};
|
|
20038
|
-
export type
|
|
20404
|
+
export type CreateLevelErrors = {
|
|
20405
|
+
/**
|
|
20406
|
+
* Bad Request
|
|
20407
|
+
*/
|
|
20408
|
+
400: Problem;
|
|
20039
20409
|
/**
|
|
20040
20410
|
* Forbidden
|
|
20041
20411
|
*/
|
|
20042
20412
|
403: Problem;
|
|
20413
|
+
};
|
|
20414
|
+
export type CreateLevelError = CreateLevelErrors[keyof CreateLevelErrors];
|
|
20415
|
+
export type CreateLevelResponses = {
|
|
20043
20416
|
/**
|
|
20044
|
-
*
|
|
20417
|
+
* Created
|
|
20045
20418
|
*/
|
|
20046
|
-
|
|
20419
|
+
201: CompetencyLevelResponseObject;
|
|
20047
20420
|
};
|
|
20048
|
-
export type
|
|
20049
|
-
export type
|
|
20421
|
+
export type CreateLevelResponse = CreateLevelResponses[keyof CreateLevelResponses];
|
|
20422
|
+
export type DeleteLevelData = {
|
|
20423
|
+
body?: never;
|
|
20424
|
+
path: {
|
|
20425
|
+
standard_id: string;
|
|
20426
|
+
version_id: string;
|
|
20427
|
+
id: string;
|
|
20428
|
+
};
|
|
20429
|
+
query?: never;
|
|
20430
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}';
|
|
20431
|
+
};
|
|
20432
|
+
export type DeleteLevelErrors = {
|
|
20050
20433
|
/**
|
|
20051
|
-
*
|
|
20434
|
+
* Forbidden
|
|
20052
20435
|
*/
|
|
20053
|
-
|
|
20436
|
+
403: unknown;
|
|
20054
20437
|
};
|
|
20055
|
-
export type
|
|
20438
|
+
export type DeleteLevelResponses = {
|
|
20439
|
+
/**
|
|
20440
|
+
* No Content
|
|
20441
|
+
*/
|
|
20442
|
+
204: void;
|
|
20443
|
+
};
|
|
20444
|
+
export type DeleteLevelResponse = DeleteLevelResponses[keyof DeleteLevelResponses];
|
|
20445
|
+
export type GetLevelData = {
|
|
20446
|
+
body?: never;
|
|
20447
|
+
path: {
|
|
20448
|
+
standard_id: string;
|
|
20449
|
+
version_id: string;
|
|
20450
|
+
id: string;
|
|
20451
|
+
};
|
|
20452
|
+
query?: never;
|
|
20453
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}';
|
|
20454
|
+
};
|
|
20455
|
+
export type GetLevelErrors = {
|
|
20456
|
+
/**
|
|
20457
|
+
* Forbidden
|
|
20458
|
+
*/
|
|
20459
|
+
403: Problem;
|
|
20460
|
+
/**
|
|
20461
|
+
* Not Found
|
|
20462
|
+
*/
|
|
20463
|
+
404: Problem;
|
|
20464
|
+
};
|
|
20465
|
+
export type GetLevelError = GetLevelErrors[keyof GetLevelErrors];
|
|
20466
|
+
export type GetLevelResponses = {
|
|
20467
|
+
/**
|
|
20468
|
+
* Success
|
|
20469
|
+
*/
|
|
20470
|
+
200: CompetencyLevelResponseObject;
|
|
20471
|
+
};
|
|
20472
|
+
export type GetLevelResponse = GetLevelResponses[keyof GetLevelResponses];
|
|
20473
|
+
export type UpdateLevelData = {
|
|
20474
|
+
body?: CompetencyLevelParameters;
|
|
20475
|
+
path: {
|
|
20476
|
+
standard_id: string;
|
|
20477
|
+
version_id: string;
|
|
20478
|
+
id: string;
|
|
20479
|
+
};
|
|
20480
|
+
query?: never;
|
|
20481
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}';
|
|
20482
|
+
};
|
|
20483
|
+
export type UpdateLevelErrors = {
|
|
20484
|
+
/**
|
|
20485
|
+
* Bad Request
|
|
20486
|
+
*/
|
|
20487
|
+
400: Problem;
|
|
20488
|
+
/**
|
|
20489
|
+
* Forbidden
|
|
20490
|
+
*/
|
|
20491
|
+
403: Problem;
|
|
20492
|
+
};
|
|
20493
|
+
export type UpdateLevelError = UpdateLevelErrors[keyof UpdateLevelErrors];
|
|
20494
|
+
export type UpdateLevelResponses = {
|
|
20495
|
+
/**
|
|
20496
|
+
* Success
|
|
20497
|
+
*/
|
|
20498
|
+
200: CompetencyLevelResponseObject;
|
|
20499
|
+
};
|
|
20500
|
+
export type UpdateLevelResponse = UpdateLevelResponses[keyof UpdateLevelResponses];
|
|
20501
|
+
export type MoveCompetencyLevelData = {
|
|
20502
|
+
body?: CompetencySortOrderMoveParameters;
|
|
20503
|
+
path: {
|
|
20504
|
+
standard_id: string;
|
|
20505
|
+
version_id: string;
|
|
20506
|
+
level_id: string;
|
|
20507
|
+
};
|
|
20508
|
+
query?: never;
|
|
20509
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/move';
|
|
20510
|
+
};
|
|
20511
|
+
export type MoveCompetencyLevelErrors = {
|
|
20512
|
+
/**
|
|
20513
|
+
* Bad Request
|
|
20514
|
+
*/
|
|
20515
|
+
400: Problem;
|
|
20516
|
+
/**
|
|
20517
|
+
* Forbidden
|
|
20518
|
+
*/
|
|
20519
|
+
403: Problem;
|
|
20520
|
+
/**
|
|
20521
|
+
* Unmovable
|
|
20522
|
+
*/
|
|
20523
|
+
422: Problem;
|
|
20524
|
+
};
|
|
20525
|
+
export type MoveCompetencyLevelError = MoveCompetencyLevelErrors[keyof MoveCompetencyLevelErrors];
|
|
20526
|
+
export type MoveCompetencyLevelResponses = {
|
|
20527
|
+
/**
|
|
20528
|
+
* Success
|
|
20529
|
+
*/
|
|
20530
|
+
200: CompetencyLevelResponseObject;
|
|
20531
|
+
};
|
|
20532
|
+
export type MoveCompetencyLevelResponse = MoveCompetencyLevelResponses[keyof MoveCompetencyLevelResponses];
|
|
20533
|
+
export type ListKeyActivitiesData = {
|
|
20534
|
+
body?: never;
|
|
20535
|
+
path: {
|
|
20536
|
+
standard_id: string;
|
|
20537
|
+
version_id: string;
|
|
20538
|
+
level_id: string;
|
|
20539
|
+
};
|
|
20540
|
+
query?: {
|
|
20541
|
+
filter?: string;
|
|
20542
|
+
'filter[unexpected]'?: string;
|
|
20543
|
+
};
|
|
20544
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities';
|
|
20545
|
+
};
|
|
20546
|
+
export type ListKeyActivitiesErrors = {
|
|
20547
|
+
/**
|
|
20548
|
+
* Bad Request
|
|
20549
|
+
*/
|
|
20550
|
+
400: Problem;
|
|
20551
|
+
/**
|
|
20552
|
+
* Forbidden
|
|
20553
|
+
*/
|
|
20554
|
+
403: Problem;
|
|
20555
|
+
};
|
|
20556
|
+
export type ListKeyActivitiesError = ListKeyActivitiesErrors[keyof ListKeyActivitiesErrors];
|
|
20557
|
+
export type ListKeyActivitiesResponses = {
|
|
20558
|
+
/**
|
|
20559
|
+
* Success
|
|
20560
|
+
*/
|
|
20561
|
+
200: {
|
|
20562
|
+
meta: Meta;
|
|
20563
|
+
links: Links;
|
|
20564
|
+
data: Array<CompetencyKeyActivityResponseObject>;
|
|
20565
|
+
};
|
|
20566
|
+
};
|
|
20567
|
+
export type ListKeyActivitiesResponse = ListKeyActivitiesResponses[keyof ListKeyActivitiesResponses];
|
|
20568
|
+
export type CreateKeyActivityData = {
|
|
20569
|
+
body?: CompetencyKeyActivityParameters;
|
|
20570
|
+
path: {
|
|
20571
|
+
standard_id: string;
|
|
20572
|
+
version_id: string;
|
|
20573
|
+
level_id: string;
|
|
20574
|
+
};
|
|
20575
|
+
query?: never;
|
|
20576
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities';
|
|
20577
|
+
};
|
|
20578
|
+
export type CreateKeyActivityErrors = {
|
|
20579
|
+
/**
|
|
20580
|
+
* Bad Request
|
|
20581
|
+
*/
|
|
20582
|
+
400: Problem;
|
|
20583
|
+
/**
|
|
20584
|
+
* Forbidden
|
|
20585
|
+
*/
|
|
20586
|
+
403: Problem;
|
|
20587
|
+
};
|
|
20588
|
+
export type CreateKeyActivityError = CreateKeyActivityErrors[keyof CreateKeyActivityErrors];
|
|
20589
|
+
export type CreateKeyActivityResponses = {
|
|
20590
|
+
/**
|
|
20591
|
+
* Created
|
|
20592
|
+
*/
|
|
20593
|
+
201: CompetencyKeyActivityResponseObject;
|
|
20594
|
+
};
|
|
20595
|
+
export type CreateKeyActivityResponse = CreateKeyActivityResponses[keyof CreateKeyActivityResponses];
|
|
20596
|
+
export type DeleteKeyActivityData = {
|
|
20597
|
+
body?: never;
|
|
20598
|
+
path: {
|
|
20599
|
+
standard_id: string;
|
|
20600
|
+
version_id: string;
|
|
20601
|
+
level_id: string;
|
|
20602
|
+
id: string;
|
|
20603
|
+
};
|
|
20604
|
+
query?: never;
|
|
20605
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}';
|
|
20606
|
+
};
|
|
20607
|
+
export type DeleteKeyActivityErrors = {
|
|
20608
|
+
/**
|
|
20609
|
+
* Forbidden
|
|
20610
|
+
*/
|
|
20611
|
+
403: unknown;
|
|
20612
|
+
};
|
|
20613
|
+
export type DeleteKeyActivityResponses = {
|
|
20614
|
+
/**
|
|
20615
|
+
* No Content
|
|
20616
|
+
*/
|
|
20617
|
+
204: void;
|
|
20618
|
+
};
|
|
20619
|
+
export type DeleteKeyActivityResponse = DeleteKeyActivityResponses[keyof DeleteKeyActivityResponses];
|
|
20620
|
+
export type GetKeyActivityData = {
|
|
20621
|
+
body?: never;
|
|
20622
|
+
path: {
|
|
20623
|
+
standard_id: string;
|
|
20624
|
+
version_id: string;
|
|
20625
|
+
level_id: string;
|
|
20626
|
+
id: string;
|
|
20627
|
+
};
|
|
20628
|
+
query?: never;
|
|
20629
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}';
|
|
20630
|
+
};
|
|
20631
|
+
export type GetKeyActivityErrors = {
|
|
20632
|
+
/**
|
|
20633
|
+
* Forbidden
|
|
20634
|
+
*/
|
|
20635
|
+
403: Problem;
|
|
20636
|
+
};
|
|
20637
|
+
export type GetKeyActivityError = GetKeyActivityErrors[keyof GetKeyActivityErrors];
|
|
20638
|
+
export type GetKeyActivityResponses = {
|
|
20639
|
+
/**
|
|
20640
|
+
* Success
|
|
20641
|
+
*/
|
|
20642
|
+
200: CompetencyKeyActivityResponseObject;
|
|
20643
|
+
};
|
|
20644
|
+
export type GetKeyActivityResponse = GetKeyActivityResponses[keyof GetKeyActivityResponses];
|
|
20645
|
+
export type UpdateKeyActivityData = {
|
|
20646
|
+
body?: CompetencyKeyActivityParameters;
|
|
20647
|
+
path: {
|
|
20648
|
+
standard_id: string;
|
|
20649
|
+
version_id: string;
|
|
20650
|
+
level_id: string;
|
|
20651
|
+
id: string;
|
|
20652
|
+
};
|
|
20653
|
+
query?: never;
|
|
20654
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}';
|
|
20655
|
+
};
|
|
20656
|
+
export type UpdateKeyActivityErrors = {
|
|
20657
|
+
/**
|
|
20658
|
+
* Bad Request
|
|
20659
|
+
*/
|
|
20660
|
+
400: Problem;
|
|
20661
|
+
/**
|
|
20662
|
+
* Forbidden
|
|
20663
|
+
*/
|
|
20664
|
+
403: Problem;
|
|
20665
|
+
};
|
|
20666
|
+
export type UpdateKeyActivityError = UpdateKeyActivityErrors[keyof UpdateKeyActivityErrors];
|
|
20667
|
+
export type UpdateKeyActivityResponses = {
|
|
20668
|
+
/**
|
|
20669
|
+
* Success
|
|
20670
|
+
*/
|
|
20671
|
+
200: CompetencyKeyActivityResponseObject;
|
|
20672
|
+
};
|
|
20673
|
+
export type UpdateKeyActivityResponse = UpdateKeyActivityResponses[keyof UpdateKeyActivityResponses];
|
|
20674
|
+
export type MoveCompetencyKeyActivityData = {
|
|
20675
|
+
body?: CompetencySortOrderMoveParameters;
|
|
20676
|
+
path: {
|
|
20677
|
+
standard_id: string;
|
|
20678
|
+
version_id: string;
|
|
20679
|
+
level_id: string;
|
|
20680
|
+
key_activity_id: string;
|
|
20681
|
+
};
|
|
20682
|
+
query?: never;
|
|
20683
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/move';
|
|
20684
|
+
};
|
|
20685
|
+
export type MoveCompetencyKeyActivityErrors = {
|
|
20686
|
+
/**
|
|
20687
|
+
* Bad Request
|
|
20688
|
+
*/
|
|
20689
|
+
400: Problem;
|
|
20690
|
+
/**
|
|
20691
|
+
* Forbidden
|
|
20692
|
+
*/
|
|
20693
|
+
403: Problem;
|
|
20694
|
+
/**
|
|
20695
|
+
* Unmovable
|
|
20696
|
+
*/
|
|
20697
|
+
422: Problem;
|
|
20698
|
+
};
|
|
20699
|
+
export type MoveCompetencyKeyActivityError = MoveCompetencyKeyActivityErrors[keyof MoveCompetencyKeyActivityErrors];
|
|
20700
|
+
export type MoveCompetencyKeyActivityResponses = {
|
|
20701
|
+
/**
|
|
20702
|
+
* Success
|
|
20703
|
+
*/
|
|
20704
|
+
200: CompetencyKeyActivityResponseObject;
|
|
20705
|
+
};
|
|
20706
|
+
export type MoveCompetencyKeyActivityResponse = MoveCompetencyKeyActivityResponses[keyof MoveCompetencyKeyActivityResponses];
|
|
20707
|
+
export type ListCriteriaData = {
|
|
20708
|
+
body?: never;
|
|
20709
|
+
path: {
|
|
20710
|
+
standard_id: string;
|
|
20711
|
+
version_id: string;
|
|
20712
|
+
level_id: string;
|
|
20713
|
+
key_activity_id: string;
|
|
20714
|
+
};
|
|
20715
|
+
query?: {
|
|
20716
|
+
filter?: string;
|
|
20717
|
+
'filter[unexpected]'?: string;
|
|
20718
|
+
};
|
|
20719
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria';
|
|
20720
|
+
};
|
|
20721
|
+
export type ListCriteriaErrors = {
|
|
20722
|
+
/**
|
|
20723
|
+
* Bad Request
|
|
20724
|
+
*/
|
|
20725
|
+
400: Problem;
|
|
20726
|
+
/**
|
|
20727
|
+
* Forbidden
|
|
20728
|
+
*/
|
|
20729
|
+
403: Problem;
|
|
20730
|
+
};
|
|
20731
|
+
export type ListCriteriaError = ListCriteriaErrors[keyof ListCriteriaErrors];
|
|
20732
|
+
export type ListCriteriaResponses = {
|
|
20733
|
+
/**
|
|
20734
|
+
* Success
|
|
20735
|
+
*/
|
|
20736
|
+
200: {
|
|
20737
|
+
meta: Meta;
|
|
20738
|
+
links: Links;
|
|
20739
|
+
data: Array<CompetencyCriterionResponseObject>;
|
|
20740
|
+
};
|
|
20741
|
+
};
|
|
20742
|
+
export type ListCriteriaResponse = ListCriteriaResponses[keyof ListCriteriaResponses];
|
|
20743
|
+
export type CreateCriterionData = {
|
|
20744
|
+
body?: CompetencyCriterionParameters;
|
|
20745
|
+
path: {
|
|
20746
|
+
standard_id: string;
|
|
20747
|
+
version_id: string;
|
|
20748
|
+
level_id: string;
|
|
20749
|
+
key_activity_id: string;
|
|
20750
|
+
};
|
|
20751
|
+
query?: never;
|
|
20752
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria';
|
|
20753
|
+
};
|
|
20754
|
+
export type CreateCriterionErrors = {
|
|
20755
|
+
/**
|
|
20756
|
+
* Bad Request
|
|
20757
|
+
*/
|
|
20758
|
+
400: Problem;
|
|
20759
|
+
/**
|
|
20760
|
+
* Forbidden
|
|
20761
|
+
*/
|
|
20762
|
+
403: Problem;
|
|
20763
|
+
};
|
|
20764
|
+
export type CreateCriterionError = CreateCriterionErrors[keyof CreateCriterionErrors];
|
|
20765
|
+
export type CreateCriterionResponses = {
|
|
20766
|
+
/**
|
|
20767
|
+
* Created
|
|
20768
|
+
*/
|
|
20769
|
+
201: CompetencyCriterionResponseObject;
|
|
20770
|
+
};
|
|
20771
|
+
export type CreateCriterionResponse = CreateCriterionResponses[keyof CreateCriterionResponses];
|
|
20772
|
+
export type DeleteCriterionData = {
|
|
20773
|
+
body?: never;
|
|
20774
|
+
path: {
|
|
20775
|
+
standard_id: string;
|
|
20776
|
+
version_id: string;
|
|
20777
|
+
level_id: string;
|
|
20778
|
+
key_activity_id: string;
|
|
20779
|
+
id: string;
|
|
20780
|
+
};
|
|
20781
|
+
query?: never;
|
|
20782
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}';
|
|
20783
|
+
};
|
|
20784
|
+
export type DeleteCriterionErrors = {
|
|
20785
|
+
/**
|
|
20786
|
+
* Forbidden
|
|
20787
|
+
*/
|
|
20788
|
+
403: unknown;
|
|
20789
|
+
};
|
|
20790
|
+
export type DeleteCriterionResponses = {
|
|
20791
|
+
/**
|
|
20792
|
+
* No Content
|
|
20793
|
+
*/
|
|
20794
|
+
204: void;
|
|
20795
|
+
};
|
|
20796
|
+
export type DeleteCriterionResponse = DeleteCriterionResponses[keyof DeleteCriterionResponses];
|
|
20797
|
+
export type GetCriterionData = {
|
|
20798
|
+
body?: never;
|
|
20799
|
+
path: {
|
|
20800
|
+
standard_id: string;
|
|
20801
|
+
version_id: string;
|
|
20802
|
+
level_id: string;
|
|
20803
|
+
key_activity_id: string;
|
|
20804
|
+
id: string;
|
|
20805
|
+
};
|
|
20806
|
+
query?: never;
|
|
20807
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}';
|
|
20808
|
+
};
|
|
20809
|
+
export type GetCriterionErrors = {
|
|
20810
|
+
/**
|
|
20811
|
+
* Forbidden
|
|
20812
|
+
*/
|
|
20813
|
+
403: Problem;
|
|
20814
|
+
};
|
|
20815
|
+
export type GetCriterionError = GetCriterionErrors[keyof GetCriterionErrors];
|
|
20816
|
+
export type GetCriterionResponses = {
|
|
20817
|
+
/**
|
|
20818
|
+
* Success
|
|
20819
|
+
*/
|
|
20820
|
+
200: CompetencyCriterionResponseObject;
|
|
20821
|
+
};
|
|
20822
|
+
export type GetCriterionResponse = GetCriterionResponses[keyof GetCriterionResponses];
|
|
20823
|
+
export type UpdateCriterionData = {
|
|
20824
|
+
body?: CompetencyCriterionParameters;
|
|
20825
|
+
path: {
|
|
20826
|
+
standard_id: string;
|
|
20827
|
+
version_id: string;
|
|
20828
|
+
level_id: string;
|
|
20829
|
+
key_activity_id: string;
|
|
20830
|
+
id: string;
|
|
20831
|
+
};
|
|
20832
|
+
query?: never;
|
|
20833
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}';
|
|
20834
|
+
};
|
|
20835
|
+
export type UpdateCriterionErrors = {
|
|
20836
|
+
/**
|
|
20837
|
+
* Bad Request
|
|
20838
|
+
*/
|
|
20839
|
+
400: Problem;
|
|
20840
|
+
/**
|
|
20841
|
+
* Forbidden
|
|
20842
|
+
*/
|
|
20843
|
+
403: Problem;
|
|
20844
|
+
};
|
|
20845
|
+
export type UpdateCriterionError = UpdateCriterionErrors[keyof UpdateCriterionErrors];
|
|
20846
|
+
export type UpdateCriterionResponses = {
|
|
20847
|
+
/**
|
|
20848
|
+
* Success
|
|
20849
|
+
*/
|
|
20850
|
+
200: CompetencyCriterionResponseObject;
|
|
20851
|
+
};
|
|
20852
|
+
export type UpdateCriterionResponse = UpdateCriterionResponses[keyof UpdateCriterionResponses];
|
|
20853
|
+
export type MoveCompetencyCriterionData = {
|
|
20854
|
+
body?: CompetencySortOrderMoveParameters;
|
|
20855
|
+
path: {
|
|
20856
|
+
standard_id: string;
|
|
20857
|
+
version_id: string;
|
|
20858
|
+
level_id: string;
|
|
20859
|
+
key_activity_id: string;
|
|
20860
|
+
criterion_id: string;
|
|
20861
|
+
};
|
|
20862
|
+
query?: never;
|
|
20863
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{criterion_id}/move';
|
|
20864
|
+
};
|
|
20865
|
+
export type MoveCompetencyCriterionErrors = {
|
|
20866
|
+
/**
|
|
20867
|
+
* Bad Request
|
|
20868
|
+
*/
|
|
20869
|
+
400: Problem;
|
|
20870
|
+
/**
|
|
20871
|
+
* Forbidden
|
|
20872
|
+
*/
|
|
20873
|
+
403: Problem;
|
|
20874
|
+
/**
|
|
20875
|
+
* Unmovable
|
|
20876
|
+
*/
|
|
20877
|
+
422: Problem;
|
|
20878
|
+
};
|
|
20879
|
+
export type MoveCompetencyCriterionError = MoveCompetencyCriterionErrors[keyof MoveCompetencyCriterionErrors];
|
|
20880
|
+
export type MoveCompetencyCriterionResponses = {
|
|
20881
|
+
/**
|
|
20882
|
+
* Success
|
|
20883
|
+
*/
|
|
20884
|
+
200: CompetencyCriterionResponseObject;
|
|
20885
|
+
};
|
|
20886
|
+
export type MoveCompetencyCriterionResponse = MoveCompetencyCriterionResponses[keyof MoveCompetencyCriterionResponses];
|
|
20887
|
+
export type ListQualificationsData = {
|
|
20888
|
+
body?: never;
|
|
20889
|
+
path?: never;
|
|
20890
|
+
query?: {
|
|
20891
|
+
/**
|
|
20892
|
+
* Standings held by this candidate.
|
|
20893
|
+
*/
|
|
20894
|
+
'filter[candidate_user_id]'?: string;
|
|
20895
|
+
/**
|
|
20896
|
+
* Standings against this standard.
|
|
20897
|
+
*/
|
|
20898
|
+
'filter[competencies_standard_id]'?: string;
|
|
20899
|
+
/**
|
|
20900
|
+
* Standings at this tier.
|
|
20901
|
+
*/
|
|
20902
|
+
'filter[level_sort_order]'?: number;
|
|
20903
|
+
filter?: string;
|
|
20904
|
+
'filter[unexpected]'?: string;
|
|
20905
|
+
/**
|
|
20906
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
20907
|
+
* `meta.page.next_cursor`.
|
|
20908
|
+
*/
|
|
20909
|
+
'page[cursor]'?: string;
|
|
20910
|
+
/**
|
|
20911
|
+
* 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`.
|
|
20912
|
+
*/
|
|
20913
|
+
'page[limit]'?: number;
|
|
20914
|
+
page?: string;
|
|
20915
|
+
};
|
|
20916
|
+
url: '/api/v1/competencies/qualifications';
|
|
20917
|
+
};
|
|
20918
|
+
export type ListQualificationsErrors = {
|
|
20919
|
+
/**
|
|
20920
|
+
* Bad Request
|
|
20921
|
+
*/
|
|
20922
|
+
400: Problem;
|
|
20923
|
+
/**
|
|
20924
|
+
* Forbidden
|
|
20925
|
+
*/
|
|
20926
|
+
403: Problem;
|
|
20927
|
+
};
|
|
20928
|
+
export type ListQualificationsError = ListQualificationsErrors[keyof ListQualificationsErrors];
|
|
20929
|
+
export type ListQualificationsResponses = {
|
|
20930
|
+
/**
|
|
20931
|
+
* Success
|
|
20932
|
+
*/
|
|
20933
|
+
200: {
|
|
20934
|
+
meta: Meta;
|
|
20935
|
+
links: Links;
|
|
20936
|
+
data: Array<CompetencyQualificationResponseObject>;
|
|
20937
|
+
};
|
|
20938
|
+
};
|
|
20939
|
+
export type ListQualificationsResponse = ListQualificationsResponses[keyof ListQualificationsResponses];
|
|
20940
|
+
export type GetQualificationData = {
|
|
20941
|
+
body?: never;
|
|
20942
|
+
path: {
|
|
20943
|
+
id: string;
|
|
20944
|
+
};
|
|
20945
|
+
query?: never;
|
|
20946
|
+
url: '/api/v1/competencies/qualifications/{id}';
|
|
20947
|
+
};
|
|
20948
|
+
export type GetQualificationErrors = {
|
|
20949
|
+
/**
|
|
20950
|
+
* Forbidden
|
|
20951
|
+
*/
|
|
20952
|
+
403: Problem;
|
|
20953
|
+
/**
|
|
20954
|
+
* Not Found
|
|
20955
|
+
*/
|
|
20956
|
+
404: Problem;
|
|
20957
|
+
};
|
|
20958
|
+
export type GetQualificationError = GetQualificationErrors[keyof GetQualificationErrors];
|
|
20959
|
+
export type GetQualificationResponses = {
|
|
20960
|
+
/**
|
|
20961
|
+
* Success
|
|
20962
|
+
*/
|
|
20963
|
+
200: CompetencyQualificationResponseObject;
|
|
20964
|
+
};
|
|
20965
|
+
export type GetQualificationResponse = GetQualificationResponses[keyof GetQualificationResponses];
|
|
20966
|
+
export type ListStandardsData = {
|
|
20967
|
+
body?: never;
|
|
20968
|
+
path?: never;
|
|
20969
|
+
query?: {
|
|
20970
|
+
/**
|
|
20971
|
+
* Case-insensitive substring match on the standard name.
|
|
20972
|
+
*/
|
|
20973
|
+
'filter[name]'?: string;
|
|
20974
|
+
/**
|
|
20975
|
+
* Standards filed under this department.
|
|
20976
|
+
*/
|
|
20977
|
+
'filter[companies_department_id]'?: string;
|
|
20978
|
+
/**
|
|
20979
|
+
* `active` has a promoted revision and is not archived. `draft` has a draft and no active revision. `archived` is archived.
|
|
20980
|
+
*/
|
|
20981
|
+
'filter[catalog_status]'?: 'active' | 'draft' | 'archived';
|
|
20982
|
+
'filter[created_at][gte]'?: string;
|
|
20983
|
+
'filter[created_at][lte]'?: string;
|
|
20984
|
+
'filter[updated_at][gte]'?: string;
|
|
20985
|
+
'filter[updated_at][lte]'?: string;
|
|
20986
|
+
filter?: string;
|
|
20987
|
+
'filter[unexpected]'?: string;
|
|
20988
|
+
/**
|
|
20989
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
20990
|
+
* `meta.page.next_cursor`.
|
|
20991
|
+
*/
|
|
20992
|
+
'page[cursor]'?: string;
|
|
20993
|
+
/**
|
|
20994
|
+
* 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`.
|
|
20995
|
+
*/
|
|
20996
|
+
'page[limit]'?: number;
|
|
20997
|
+
page?: string;
|
|
20998
|
+
};
|
|
20999
|
+
url: '/api/v1/competencies/standards';
|
|
21000
|
+
};
|
|
21001
|
+
export type ListStandardsErrors = {
|
|
21002
|
+
/**
|
|
21003
|
+
* Bad Request
|
|
21004
|
+
*/
|
|
21005
|
+
400: Problem;
|
|
21006
|
+
/**
|
|
21007
|
+
* Forbidden
|
|
21008
|
+
*/
|
|
21009
|
+
403: Problem;
|
|
21010
|
+
/**
|
|
21011
|
+
* Unprocessable Content
|
|
21012
|
+
*/
|
|
21013
|
+
422: Problem;
|
|
21014
|
+
};
|
|
21015
|
+
export type ListStandardsError = ListStandardsErrors[keyof ListStandardsErrors];
|
|
21016
|
+
export type ListStandardsResponses = {
|
|
21017
|
+
/**
|
|
21018
|
+
* Success
|
|
21019
|
+
*/
|
|
21020
|
+
200: {
|
|
21021
|
+
meta: Meta;
|
|
21022
|
+
links: Links;
|
|
21023
|
+
data: Array<CompetencyStandardResponseObject>;
|
|
21024
|
+
};
|
|
21025
|
+
};
|
|
21026
|
+
export type ListStandardsResponse = ListStandardsResponses[keyof ListStandardsResponses];
|
|
21027
|
+
export type CreateStandardData = {
|
|
21028
|
+
body?: CompetencyStandardParameters;
|
|
21029
|
+
path?: never;
|
|
21030
|
+
query?: never;
|
|
21031
|
+
url: '/api/v1/competencies/standards';
|
|
21032
|
+
};
|
|
21033
|
+
export type CreateStandardErrors = {
|
|
21034
|
+
/**
|
|
21035
|
+
* Bad Request
|
|
21036
|
+
*/
|
|
21037
|
+
400: Problem;
|
|
21038
|
+
/**
|
|
21039
|
+
* Forbidden
|
|
21040
|
+
*/
|
|
21041
|
+
403: Problem;
|
|
21042
|
+
/**
|
|
21043
|
+
* Not Found
|
|
21044
|
+
*/
|
|
21045
|
+
404: Problem;
|
|
21046
|
+
/**
|
|
21047
|
+
* Unprocessable Content
|
|
21048
|
+
*/
|
|
21049
|
+
422: Problem;
|
|
21050
|
+
};
|
|
21051
|
+
export type CreateStandardError = CreateStandardErrors[keyof CreateStandardErrors];
|
|
21052
|
+
export type CreateStandardResponses = {
|
|
21053
|
+
/**
|
|
21054
|
+
* Created
|
|
21055
|
+
*/
|
|
21056
|
+
201: CompetencyStandardResponseObject;
|
|
21057
|
+
};
|
|
21058
|
+
export type CreateStandardResponse = CreateStandardResponses[keyof CreateStandardResponses];
|
|
21059
|
+
export type GetStandardData = {
|
|
21060
|
+
body?: never;
|
|
21061
|
+
path: {
|
|
21062
|
+
id: string;
|
|
21063
|
+
};
|
|
21064
|
+
query?: never;
|
|
21065
|
+
url: '/api/v1/competencies/standards/{id}';
|
|
21066
|
+
};
|
|
21067
|
+
export type GetStandardErrors = {
|
|
21068
|
+
/**
|
|
21069
|
+
* Forbidden
|
|
21070
|
+
*/
|
|
21071
|
+
403: Problem;
|
|
21072
|
+
/**
|
|
21073
|
+
* Not Found
|
|
21074
|
+
*/
|
|
21075
|
+
404: Problem;
|
|
21076
|
+
};
|
|
21077
|
+
export type GetStandardError = GetStandardErrors[keyof GetStandardErrors];
|
|
21078
|
+
export type GetStandardResponses = {
|
|
21079
|
+
/**
|
|
21080
|
+
* Success
|
|
21081
|
+
*/
|
|
21082
|
+
200: CompetencyStandardResponseObject;
|
|
21083
|
+
};
|
|
21084
|
+
export type GetStandardResponse = GetStandardResponses[keyof GetStandardResponses];
|
|
21085
|
+
export type UpdateStandardData = {
|
|
21086
|
+
body?: CompetencyStandardUpdateParameters;
|
|
21087
|
+
path: {
|
|
21088
|
+
id: string;
|
|
21089
|
+
};
|
|
21090
|
+
query?: never;
|
|
21091
|
+
url: '/api/v1/competencies/standards/{id}';
|
|
21092
|
+
};
|
|
21093
|
+
export type UpdateStandardErrors = {
|
|
21094
|
+
/**
|
|
21095
|
+
* Bad Request
|
|
21096
|
+
*/
|
|
21097
|
+
400: Problem;
|
|
21098
|
+
/**
|
|
21099
|
+
* Forbidden
|
|
21100
|
+
*/
|
|
21101
|
+
403: Problem;
|
|
21102
|
+
/**
|
|
21103
|
+
* Not Found
|
|
21104
|
+
*/
|
|
21105
|
+
404: Problem;
|
|
21106
|
+
};
|
|
21107
|
+
export type UpdateStandardError = UpdateStandardErrors[keyof UpdateStandardErrors];
|
|
21108
|
+
export type UpdateStandardResponses = {
|
|
21109
|
+
/**
|
|
21110
|
+
* Success
|
|
21111
|
+
*/
|
|
21112
|
+
200: CompetencyStandardResponseObject;
|
|
21113
|
+
};
|
|
21114
|
+
export type UpdateStandardResponse = UpdateStandardResponses[keyof UpdateStandardResponses];
|
|
21115
|
+
export type UnarchiveCompetencyStandardData = {
|
|
21116
|
+
body?: never;
|
|
21117
|
+
path: {
|
|
21118
|
+
standard_id: string;
|
|
21119
|
+
};
|
|
21120
|
+
query?: never;
|
|
21121
|
+
url: '/api/v1/competencies/standards/{standard_id}/archive';
|
|
21122
|
+
};
|
|
21123
|
+
export type UnarchiveCompetencyStandardErrors = {
|
|
21124
|
+
/**
|
|
21125
|
+
* Forbidden
|
|
21126
|
+
*/
|
|
21127
|
+
403: Problem;
|
|
21128
|
+
/**
|
|
21129
|
+
* Not Found
|
|
21130
|
+
*/
|
|
21131
|
+
404: Problem;
|
|
21132
|
+
};
|
|
21133
|
+
export type UnarchiveCompetencyStandardError = UnarchiveCompetencyStandardErrors[keyof UnarchiveCompetencyStandardErrors];
|
|
21134
|
+
export type UnarchiveCompetencyStandardResponses = {
|
|
21135
|
+
/**
|
|
21136
|
+
* Success
|
|
21137
|
+
*/
|
|
21138
|
+
200: CompetencyStandardResponseObject;
|
|
21139
|
+
};
|
|
21140
|
+
export type UnarchiveCompetencyStandardResponse = UnarchiveCompetencyStandardResponses[keyof UnarchiveCompetencyStandardResponses];
|
|
21141
|
+
export type ArchiveCompetencyStandardData = {
|
|
21142
|
+
body?: CompetencyStandardArchiveParametersWritable;
|
|
21143
|
+
path: {
|
|
21144
|
+
standard_id: string;
|
|
21145
|
+
};
|
|
21146
|
+
query?: never;
|
|
21147
|
+
url: '/api/v1/competencies/standards/{standard_id}/archive';
|
|
21148
|
+
};
|
|
21149
|
+
export type ArchiveCompetencyStandardErrors = {
|
|
21150
|
+
/**
|
|
21151
|
+
* Bad Request
|
|
21152
|
+
*/
|
|
21153
|
+
400: Problem;
|
|
21154
|
+
/**
|
|
21155
|
+
* Forbidden
|
|
21156
|
+
*/
|
|
21157
|
+
403: Problem;
|
|
21158
|
+
/**
|
|
21159
|
+
* Not Found
|
|
21160
|
+
*/
|
|
21161
|
+
404: Problem;
|
|
21162
|
+
};
|
|
21163
|
+
export type ArchiveCompetencyStandardError = ArchiveCompetencyStandardErrors[keyof ArchiveCompetencyStandardErrors];
|
|
21164
|
+
export type ArchiveCompetencyStandardResponses = {
|
|
21165
|
+
/**
|
|
21166
|
+
* Created
|
|
21167
|
+
*/
|
|
21168
|
+
201: CompetencyStandardResponseObject;
|
|
21169
|
+
};
|
|
21170
|
+
export type ArchiveCompetencyStandardResponse = ArchiveCompetencyStandardResponses[keyof ArchiveCompetencyStandardResponses];
|
|
21171
|
+
export type ListCompetencyStandardVersionsData = {
|
|
21172
|
+
body?: never;
|
|
21173
|
+
path: {
|
|
21174
|
+
standard_id: string;
|
|
21175
|
+
};
|
|
21176
|
+
query?: {
|
|
21177
|
+
/**
|
|
21178
|
+
* Revision status: draft, active, or superseded.
|
|
21179
|
+
*/
|
|
21180
|
+
'filter[status]'?: 'draft' | 'active' | 'superseded';
|
|
21181
|
+
'filter[created_at][gte]'?: string;
|
|
21182
|
+
'filter[created_at][lte]'?: string;
|
|
21183
|
+
'filter[updated_at][gte]'?: string;
|
|
21184
|
+
'filter[updated_at][lte]'?: string;
|
|
21185
|
+
filter?: string;
|
|
21186
|
+
'filter[unexpected]'?: string;
|
|
21187
|
+
/**
|
|
21188
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
21189
|
+
* `meta.page.next_cursor`.
|
|
21190
|
+
*/
|
|
21191
|
+
'page[cursor]'?: string;
|
|
21192
|
+
/**
|
|
21193
|
+
* 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`.
|
|
21194
|
+
*/
|
|
21195
|
+
'page[limit]'?: number;
|
|
21196
|
+
page?: string;
|
|
21197
|
+
};
|
|
21198
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions';
|
|
21199
|
+
};
|
|
21200
|
+
export type ListCompetencyStandardVersionsErrors = {
|
|
21201
|
+
/**
|
|
21202
|
+
* Bad Request
|
|
21203
|
+
*/
|
|
21204
|
+
400: Problem;
|
|
21205
|
+
/**
|
|
21206
|
+
* Forbidden
|
|
21207
|
+
*/
|
|
21208
|
+
403: Problem;
|
|
21209
|
+
/**
|
|
21210
|
+
* Unprocessable Content
|
|
21211
|
+
*/
|
|
21212
|
+
422: Problem;
|
|
21213
|
+
};
|
|
21214
|
+
export type ListCompetencyStandardVersionsError = ListCompetencyStandardVersionsErrors[keyof ListCompetencyStandardVersionsErrors];
|
|
21215
|
+
export type ListCompetencyStandardVersionsResponses = {
|
|
21216
|
+
/**
|
|
21217
|
+
* Success
|
|
21218
|
+
*/
|
|
21219
|
+
200: {
|
|
21220
|
+
meta: Meta;
|
|
21221
|
+
links: Links;
|
|
21222
|
+
data: Array<CompetencyStandardVersionResponseObject>;
|
|
21223
|
+
};
|
|
21224
|
+
};
|
|
21225
|
+
export type ListCompetencyStandardVersionsResponse = ListCompetencyStandardVersionsResponses[keyof ListCompetencyStandardVersionsResponses];
|
|
21226
|
+
export type CreateCompetencyStandardVersionData = {
|
|
21227
|
+
body?: CompetencyStandardVersionParameters;
|
|
21228
|
+
path: {
|
|
21229
|
+
standard_id: string;
|
|
21230
|
+
};
|
|
21231
|
+
query?: never;
|
|
21232
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions';
|
|
21233
|
+
};
|
|
21234
|
+
export type CreateCompetencyStandardVersionErrors = {
|
|
21235
|
+
/**
|
|
21236
|
+
* Bad Request
|
|
21237
|
+
*/
|
|
21238
|
+
400: Problem;
|
|
21239
|
+
/**
|
|
21240
|
+
* Forbidden
|
|
21241
|
+
*/
|
|
21242
|
+
403: Problem;
|
|
21243
|
+
/**
|
|
21244
|
+
* Unprocessable Content
|
|
21245
|
+
*/
|
|
21246
|
+
422: Problem;
|
|
21247
|
+
};
|
|
21248
|
+
export type CreateCompetencyStandardVersionError = CreateCompetencyStandardVersionErrors[keyof CreateCompetencyStandardVersionErrors];
|
|
21249
|
+
export type CreateCompetencyStandardVersionResponses = {
|
|
21250
|
+
/**
|
|
21251
|
+
* Created
|
|
21252
|
+
*/
|
|
21253
|
+
201: CompetencyStandardVersionResponseObject;
|
|
21254
|
+
};
|
|
21255
|
+
export type CreateCompetencyStandardVersionResponse = CreateCompetencyStandardVersionResponses[keyof CreateCompetencyStandardVersionResponses];
|
|
21256
|
+
export type DeleteCompetencyStandardVersionData = {
|
|
21257
|
+
body?: never;
|
|
21258
|
+
path: {
|
|
21259
|
+
standard_id: string;
|
|
21260
|
+
id: string;
|
|
21261
|
+
};
|
|
21262
|
+
query?: never;
|
|
21263
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{id}';
|
|
21264
|
+
};
|
|
21265
|
+
export type DeleteCompetencyStandardVersionErrors = {
|
|
21266
|
+
/**
|
|
21267
|
+
* Forbidden
|
|
21268
|
+
*/
|
|
21269
|
+
403: unknown;
|
|
21270
|
+
};
|
|
21271
|
+
export type DeleteCompetencyStandardVersionResponses = {
|
|
21272
|
+
/**
|
|
21273
|
+
* No Content
|
|
21274
|
+
*/
|
|
21275
|
+
204: void;
|
|
21276
|
+
};
|
|
21277
|
+
export type DeleteCompetencyStandardVersionResponse = DeleteCompetencyStandardVersionResponses[keyof DeleteCompetencyStandardVersionResponses];
|
|
21278
|
+
export type GetCompetencyStandardVersionData = {
|
|
21279
|
+
body?: never;
|
|
21280
|
+
path: {
|
|
21281
|
+
standard_id: string;
|
|
21282
|
+
id: string;
|
|
21283
|
+
};
|
|
21284
|
+
query?: never;
|
|
21285
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{id}';
|
|
21286
|
+
};
|
|
21287
|
+
export type GetCompetencyStandardVersionErrors = {
|
|
21288
|
+
/**
|
|
21289
|
+
* Forbidden
|
|
21290
|
+
*/
|
|
21291
|
+
403: Problem;
|
|
21292
|
+
/**
|
|
21293
|
+
* Not Found
|
|
21294
|
+
*/
|
|
21295
|
+
404: Problem;
|
|
21296
|
+
};
|
|
21297
|
+
export type GetCompetencyStandardVersionError = GetCompetencyStandardVersionErrors[keyof GetCompetencyStandardVersionErrors];
|
|
21298
|
+
export type GetCompetencyStandardVersionResponses = {
|
|
21299
|
+
/**
|
|
21300
|
+
* Success
|
|
21301
|
+
*/
|
|
21302
|
+
200: CompetencyStandardVersionResponseObject;
|
|
21303
|
+
};
|
|
21304
|
+
export type GetCompetencyStandardVersionResponse = GetCompetencyStandardVersionResponses[keyof GetCompetencyStandardVersionResponses];
|
|
21305
|
+
export type UpdateCompetencyStandardVersionData = {
|
|
21306
|
+
body?: CompetencyStandardVersionParameters;
|
|
21307
|
+
path: {
|
|
21308
|
+
standard_id: string;
|
|
21309
|
+
id: string;
|
|
21310
|
+
};
|
|
21311
|
+
query?: never;
|
|
21312
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{id}';
|
|
21313
|
+
};
|
|
21314
|
+
export type UpdateCompetencyStandardVersionErrors = {
|
|
21315
|
+
/**
|
|
21316
|
+
* Bad Request
|
|
21317
|
+
*/
|
|
21318
|
+
400: Problem;
|
|
21319
|
+
/**
|
|
21320
|
+
* Forbidden
|
|
21321
|
+
*/
|
|
21322
|
+
403: Problem;
|
|
21323
|
+
};
|
|
21324
|
+
export type UpdateCompetencyStandardVersionError = UpdateCompetencyStandardVersionErrors[keyof UpdateCompetencyStandardVersionErrors];
|
|
21325
|
+
export type UpdateCompetencyStandardVersionResponses = {
|
|
21326
|
+
/**
|
|
21327
|
+
* Success
|
|
21328
|
+
*/
|
|
21329
|
+
200: CompetencyStandardVersionResponseObject;
|
|
21330
|
+
};
|
|
21331
|
+
export type UpdateCompetencyStandardVersionResponse = UpdateCompetencyStandardVersionResponses[keyof UpdateCompetencyStandardVersionResponses];
|
|
21332
|
+
export type PromoteCompetencyStandardVersionData = {
|
|
21333
|
+
body?: CompetencyStandardVersionPromotionParameters;
|
|
21334
|
+
path: {
|
|
21335
|
+
standard_id: string;
|
|
21336
|
+
version_id: string;
|
|
21337
|
+
};
|
|
21338
|
+
query?: never;
|
|
21339
|
+
url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/promotion';
|
|
21340
|
+
};
|
|
21341
|
+
export type PromoteCompetencyStandardVersionErrors = {
|
|
21342
|
+
/**
|
|
21343
|
+
* Bad Request
|
|
21344
|
+
*/
|
|
21345
|
+
400: Problem;
|
|
21346
|
+
/**
|
|
21347
|
+
* Forbidden
|
|
21348
|
+
*/
|
|
21349
|
+
403: Problem;
|
|
21350
|
+
};
|
|
21351
|
+
export type PromoteCompetencyStandardVersionError = PromoteCompetencyStandardVersionErrors[keyof PromoteCompetencyStandardVersionErrors];
|
|
21352
|
+
export type PromoteCompetencyStandardVersionResponses = {
|
|
21353
|
+
/**
|
|
21354
|
+
* Created
|
|
21355
|
+
*/
|
|
21356
|
+
201: CompetencyStandardVersionResponseObject;
|
|
21357
|
+
};
|
|
21358
|
+
export type PromoteCompetencyStandardVersionResponse = PromoteCompetencyStandardVersionResponses[keyof PromoteCompetencyStandardVersionResponses];
|
|
20056
21359
|
export type ListChecksData = {
|
|
20057
21360
|
body?: never;
|
|
20058
21361
|
path?: never;
|