@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.
@@ -733,7 +733,7 @@ export class AssetsCategories {
733
733
  /**
734
734
  * Create Category
735
735
  *
736
- * Only documented body keys are accepted, including inside `category_attributes`. An undeclared key returns 400 before any category or assignment is written.
736
+ * Only documented body keys are accepted. An undeclared top-level key returns 400, and an undeclared key inside a `category_attributes` row returns 422 at that row; neither writes a category or assignment.
737
737
  *
738
738
  * **Required scope:**
739
739
  *
@@ -784,7 +784,7 @@ export class AssetsCategories {
784
784
  /**
785
785
  * Update Category
786
786
  *
787
- * Only documented body keys are accepted, including inside `category_attributes`. An undeclared key returns 400 before any category or assignment is written.
787
+ * Only documented body keys are accepted. An undeclared top-level key returns 400, and an undeclared key inside a `category_attributes` row returns 422 at that row; neither writes a category or assignment.
788
788
  *
789
789
  * **Required scope:**
790
790
  *
@@ -1211,7 +1211,7 @@ export class AssetsItems {
1211
1211
  /**
1212
1212
  * Create service event
1213
1213
  *
1214
- * Undeclared JSON-body keys, including keys within attachments_attributes, return 400 unknown_key before any service-event or attachment changes are saved.
1214
+ * An undeclared JSON-body key returns 400 unknown_key, and an undeclared or wrongly typed key within an attachments_attributes row returns 422 at that row, before any service-event or attachment changes are saved.
1215
1215
  *
1216
1216
  * **Required scope:**
1217
1217
  *
@@ -1262,7 +1262,7 @@ export class AssetsItems {
1262
1262
  /**
1263
1263
  * Update service event
1264
1264
  *
1265
- * Undeclared JSON-body keys, including keys within attachments_attributes, return 400 unknown_key before any service-event or attachment changes are saved.
1265
+ * An undeclared JSON-body key returns 400 unknown_key, and an undeclared or wrongly typed key within an attachments_attributes row returns 422 at that row, before any service-event or attachment changes are saved.
1266
1266
  *
1267
1267
  * **Required scope:**
1268
1268
  *
@@ -2783,6 +2783,320 @@ export class CompetenciesAssessorAuthorizations {
2783
2783
  });
2784
2784
  }
2785
2785
  }
2786
+ export class CompetenciesLevels {
2787
+ /**
2788
+ * List competence levels
2789
+ *
2790
+ * **Required scope:**
2791
+ *
2792
+ * `competencies.standards.versions.levels:read`
2793
+ *
2794
+ */
2795
+ static listLevels(options) {
2796
+ return (options.client ?? client).get({
2797
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2798
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels',
2799
+ ...options
2800
+ });
2801
+ }
2802
+ /**
2803
+ * Create competence level
2804
+ *
2805
+ * Appends a level to a draft revision. sort_order is server-assigned, starting at 0.
2806
+ *
2807
+ * **Required scope:**
2808
+ *
2809
+ * `competencies.standards.versions.levels:create`
2810
+ *
2811
+ */
2812
+ static createLevel(options) {
2813
+ return (options.client ?? client).post({
2814
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2815
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels',
2816
+ ...options,
2817
+ headers: {
2818
+ 'Content-Type': 'application/json',
2819
+ ...options.headers
2820
+ }
2821
+ });
2822
+ }
2823
+ /**
2824
+ * Delete competence level
2825
+ *
2826
+ * **Required scope:**
2827
+ *
2828
+ * `competencies.standards.versions.levels:delete`
2829
+ *
2830
+ */
2831
+ static deleteLevel(options) {
2832
+ return (options.client ?? client).delete({
2833
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2834
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}',
2835
+ ...options
2836
+ });
2837
+ }
2838
+ /**
2839
+ * Show competence level
2840
+ *
2841
+ * **Required scope:**
2842
+ *
2843
+ * `competencies.standards.versions.levels:read`
2844
+ *
2845
+ */
2846
+ static getLevel(options) {
2847
+ return (options.client ?? client).get({
2848
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2849
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}',
2850
+ ...options
2851
+ });
2852
+ }
2853
+ /**
2854
+ * Update competence level
2855
+ *
2856
+ * **Required scope:**
2857
+ *
2858
+ * `competencies.standards.versions.levels:update`
2859
+ *
2860
+ */
2861
+ static updateLevel(options) {
2862
+ return (options.client ?? client).patch({
2863
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2864
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{id}',
2865
+ ...options,
2866
+ headers: {
2867
+ 'Content-Type': 'application/json',
2868
+ ...options.headers
2869
+ }
2870
+ });
2871
+ }
2872
+ /**
2873
+ * Move competence level
2874
+ *
2875
+ * **Required scope:**
2876
+ *
2877
+ * `competencies.standards.versions.levels.moves:create`
2878
+ *
2879
+ */
2880
+ static moveCompetencyLevel(options) {
2881
+ return (options.client ?? client).post({
2882
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2883
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/move',
2884
+ ...options,
2885
+ headers: {
2886
+ 'Content-Type': 'application/json',
2887
+ ...options.headers
2888
+ }
2889
+ });
2890
+ }
2891
+ }
2892
+ export class CompetenciesKeyActivities {
2893
+ /**
2894
+ * List competence key activities
2895
+ *
2896
+ * **Required scope:**
2897
+ *
2898
+ * `competencies.standards.versions.levels.key_activities:read`
2899
+ *
2900
+ */
2901
+ static listKeyActivities(options) {
2902
+ return (options.client ?? client).get({
2903
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2904
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities',
2905
+ ...options
2906
+ });
2907
+ }
2908
+ /**
2909
+ * Create competence key activity
2910
+ *
2911
+ * **Required scope:**
2912
+ *
2913
+ * `competencies.standards.versions.levels.key_activities:create`
2914
+ *
2915
+ */
2916
+ static createKeyActivity(options) {
2917
+ return (options.client ?? client).post({
2918
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2919
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities',
2920
+ ...options,
2921
+ headers: {
2922
+ 'Content-Type': 'application/json',
2923
+ ...options.headers
2924
+ }
2925
+ });
2926
+ }
2927
+ /**
2928
+ * Delete competence key activity
2929
+ *
2930
+ * **Required scope:**
2931
+ *
2932
+ * `competencies.standards.versions.levels.key_activities:delete`
2933
+ *
2934
+ */
2935
+ static deleteKeyActivity(options) {
2936
+ return (options.client ?? client).delete({
2937
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2938
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}',
2939
+ ...options
2940
+ });
2941
+ }
2942
+ /**
2943
+ * Show competence key activity
2944
+ *
2945
+ * **Required scope:**
2946
+ *
2947
+ * `competencies.standards.versions.levels.key_activities:read`
2948
+ *
2949
+ */
2950
+ static getKeyActivity(options) {
2951
+ return (options.client ?? client).get({
2952
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2953
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}',
2954
+ ...options
2955
+ });
2956
+ }
2957
+ /**
2958
+ * Update competence key activity
2959
+ *
2960
+ * **Required scope:**
2961
+ *
2962
+ * `competencies.standards.versions.levels.key_activities:update`
2963
+ *
2964
+ */
2965
+ static updateKeyActivity(options) {
2966
+ return (options.client ?? client).patch({
2967
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2968
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{id}',
2969
+ ...options,
2970
+ headers: {
2971
+ 'Content-Type': 'application/json',
2972
+ ...options.headers
2973
+ }
2974
+ });
2975
+ }
2976
+ /**
2977
+ * Move competence key activity
2978
+ *
2979
+ * **Required scope:**
2980
+ *
2981
+ * `competencies.standards.versions.levels.key_activities.moves:create`
2982
+ *
2983
+ */
2984
+ static moveCompetencyKeyActivity(options) {
2985
+ return (options.client ?? client).post({
2986
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
2987
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/move',
2988
+ ...options,
2989
+ headers: {
2990
+ 'Content-Type': 'application/json',
2991
+ ...options.headers
2992
+ }
2993
+ });
2994
+ }
2995
+ }
2996
+ export class CompetenciesCriteria {
2997
+ /**
2998
+ * List competence criteria
2999
+ *
3000
+ * **Required scope:**
3001
+ *
3002
+ * `competencies.standards.versions.levels.key_activities.criteria:read`
3003
+ *
3004
+ */
3005
+ static listCriteria(options) {
3006
+ return (options.client ?? client).get({
3007
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3008
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria',
3009
+ ...options
3010
+ });
3011
+ }
3012
+ /**
3013
+ * Create competence criterion
3014
+ *
3015
+ * **Required scope:**
3016
+ *
3017
+ * `competencies.standards.versions.levels.key_activities.criteria:create`
3018
+ *
3019
+ */
3020
+ static createCriterion(options) {
3021
+ return (options.client ?? client).post({
3022
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3023
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria',
3024
+ ...options,
3025
+ headers: {
3026
+ 'Content-Type': 'application/json',
3027
+ ...options.headers
3028
+ }
3029
+ });
3030
+ }
3031
+ /**
3032
+ * Delete competence criterion
3033
+ *
3034
+ * **Required scope:**
3035
+ *
3036
+ * `competencies.standards.versions.levels.key_activities.criteria:delete`
3037
+ *
3038
+ */
3039
+ static deleteCriterion(options) {
3040
+ return (options.client ?? client).delete({
3041
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3042
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}',
3043
+ ...options
3044
+ });
3045
+ }
3046
+ /**
3047
+ * Show competence criterion
3048
+ *
3049
+ * **Required scope:**
3050
+ *
3051
+ * `competencies.standards.versions.levels.key_activities.criteria:read`
3052
+ *
3053
+ */
3054
+ static getCriterion(options) {
3055
+ return (options.client ?? client).get({
3056
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3057
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}',
3058
+ ...options
3059
+ });
3060
+ }
3061
+ /**
3062
+ * Update competence criterion
3063
+ *
3064
+ * **Required scope:**
3065
+ *
3066
+ * `competencies.standards.versions.levels.key_activities.criteria:update`
3067
+ *
3068
+ */
3069
+ static updateCriterion(options) {
3070
+ return (options.client ?? client).patch({
3071
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3072
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{id}',
3073
+ ...options,
3074
+ headers: {
3075
+ 'Content-Type': 'application/json',
3076
+ ...options.headers
3077
+ }
3078
+ });
3079
+ }
3080
+ /**
3081
+ * Move competence criterion
3082
+ *
3083
+ * **Required scope:**
3084
+ *
3085
+ * `competencies.standards.versions.levels.key_activities.criteria.moves:create`
3086
+ *
3087
+ */
3088
+ static moveCompetencyCriterion(options) {
3089
+ return (options.client ?? client).post({
3090
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3091
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/levels/{level_id}/key_activities/{key_activity_id}/criteria/{criterion_id}/move',
3092
+ ...options,
3093
+ headers: {
3094
+ 'Content-Type': 'application/json',
3095
+ ...options.headers
3096
+ }
3097
+ });
3098
+ }
3099
+ }
2786
3100
  export class CompetenciesQualifications {
2787
3101
  /**
2788
3102
  * List competence qualifications
@@ -2820,6 +3134,244 @@ export class CompetenciesQualifications {
2820
3134
  });
2821
3135
  }
2822
3136
  }
3137
+ export class CompetenciesStandards {
3138
+ /**
3139
+ * List competence standards
3140
+ *
3141
+ * Lists competence standards for the key's company, including drafts and
3142
+ * archived standards. current_version_id and draft_version_id point at named
3143
+ * revisions, not a valid-time slice.
3144
+ *
3145
+ *
3146
+ * **Required scope:**
3147
+ *
3148
+ * `competencies.standards:read`
3149
+ *
3150
+ */
3151
+ static listStandards(options) {
3152
+ return (options?.client ?? client).get({
3153
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3154
+ url: '/api/v1/competencies/standards',
3155
+ ...options
3156
+ });
3157
+ }
3158
+ /**
3159
+ * Create competence standard
3160
+ *
3161
+ * Creates a standard and opens revision 1 as a draft. The revision number
3162
+ * is server-assigned.
3163
+ *
3164
+ *
3165
+ * **Required scope:**
3166
+ *
3167
+ * `competencies.standards:create`
3168
+ *
3169
+ */
3170
+ static createStandard(options) {
3171
+ return (options?.client ?? client).post({
3172
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3173
+ url: '/api/v1/competencies/standards',
3174
+ ...options,
3175
+ headers: {
3176
+ 'Content-Type': 'application/json',
3177
+ ...options?.headers
3178
+ }
3179
+ });
3180
+ }
3181
+ /**
3182
+ * Show competence standard
3183
+ *
3184
+ * **Required scope:**
3185
+ *
3186
+ * `competencies.standards:read`
3187
+ *
3188
+ */
3189
+ static getStandard(options) {
3190
+ return (options.client ?? client).get({
3191
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3192
+ url: '/api/v1/competencies/standards/{id}',
3193
+ ...options
3194
+ });
3195
+ }
3196
+ /**
3197
+ * Update competence standard
3198
+ *
3199
+ * **Required scope:**
3200
+ *
3201
+ * `competencies.standards:update`
3202
+ *
3203
+ */
3204
+ static updateStandard(options) {
3205
+ return (options.client ?? client).patch({
3206
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3207
+ url: '/api/v1/competencies/standards/{id}',
3208
+ ...options,
3209
+ headers: {
3210
+ 'Content-Type': 'application/json',
3211
+ ...options.headers
3212
+ }
3213
+ });
3214
+ }
3215
+ /**
3216
+ * Unarchive competence standard
3217
+ *
3218
+ * **Required scope:**
3219
+ *
3220
+ * `competencies.standards.archives:delete`
3221
+ *
3222
+ */
3223
+ static unarchiveCompetencyStandard(options) {
3224
+ return (options.client ?? client).delete({
3225
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3226
+ url: '/api/v1/competencies/standards/{standard_id}/archive',
3227
+ ...options
3228
+ });
3229
+ }
3230
+ /**
3231
+ * Archive competence standard
3232
+ *
3233
+ * **Required scope:**
3234
+ *
3235
+ * `competencies.standards.archives:create`
3236
+ *
3237
+ */
3238
+ static archiveCompetencyStandard(options) {
3239
+ return (options.client ?? client).post({
3240
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3241
+ url: '/api/v1/competencies/standards/{standard_id}/archive',
3242
+ ...options,
3243
+ headers: {
3244
+ 'Content-Type': 'application/json',
3245
+ ...options.headers
3246
+ }
3247
+ });
3248
+ }
3249
+ }
3250
+ export class CompetenciesStandardVersions {
3251
+ /**
3252
+ * List competence standard revisions
3253
+ *
3254
+ * Lists named revisions of one standard, newest revision first. These rows
3255
+ * are Competencies::StandardVersion records. They are not a temporal history,
3256
+ * and this path does not accept as_of.
3257
+ *
3258
+ *
3259
+ * **Required scope:**
3260
+ *
3261
+ * `competencies.standards.versions:read`
3262
+ *
3263
+ */
3264
+ static listCompetencyStandardVersions(options) {
3265
+ return (options.client ?? client).get({
3266
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3267
+ url: '/api/v1/competencies/standards/{standard_id}/versions',
3268
+ ...options
3269
+ });
3270
+ }
3271
+ /**
3272
+ * Cut competence standard revision
3273
+ *
3274
+ * Copies the active revision's level, key-activity, and criterion tree into
3275
+ * the next draft. The controlled PDF is not copied.
3276
+ *
3277
+ *
3278
+ * **Required scope:**
3279
+ *
3280
+ * `competencies.standards.versions:create`
3281
+ *
3282
+ */
3283
+ static createCompetencyStandardVersion(options) {
3284
+ return (options.client ?? client).post({
3285
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3286
+ url: '/api/v1/competencies/standards/{standard_id}/versions',
3287
+ ...options,
3288
+ headers: {
3289
+ 'Content-Type': 'application/json',
3290
+ ...options.headers
3291
+ }
3292
+ });
3293
+ }
3294
+ /**
3295
+ * Delete competence standard revision
3296
+ *
3297
+ * Deletes a draft revision. Deleting the standard's only revision deletes
3298
+ * the standard. Published revisions are refused.
3299
+ *
3300
+ *
3301
+ * **Required scope:**
3302
+ *
3303
+ * `competencies.standards.versions:delete`
3304
+ *
3305
+ */
3306
+ static deleteCompetencyStandardVersion(options) {
3307
+ return (options.client ?? client).delete({
3308
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3309
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{id}',
3310
+ ...options
3311
+ });
3312
+ }
3313
+ /**
3314
+ * Show competence standard revision
3315
+ *
3316
+ * **Required scope:**
3317
+ *
3318
+ * `competencies.standards.versions:read`
3319
+ *
3320
+ */
3321
+ static getCompetencyStandardVersion(options) {
3322
+ return (options.client ?? client).get({
3323
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3324
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{id}',
3325
+ ...options
3326
+ });
3327
+ }
3328
+ /**
3329
+ * Update competence standard revision
3330
+ *
3331
+ * Updates change notes on a draft revision. Published revisions are refused.
3332
+ *
3333
+ * **Required scope:**
3334
+ *
3335
+ * `competencies.standards.versions:update`
3336
+ *
3337
+ */
3338
+ static updateCompetencyStandardVersion(options) {
3339
+ return (options.client ?? client).patch({
3340
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3341
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{id}',
3342
+ ...options,
3343
+ headers: {
3344
+ 'Content-Type': 'application/json',
3345
+ ...options.headers
3346
+ }
3347
+ });
3348
+ }
3349
+ /**
3350
+ * Promote competence standard revision
3351
+ *
3352
+ * Publishes a draft revision, stamps the approver, and supersedes the previous active
3353
+ * revision. A user key promotes as its user. A company key names an admin or safety
3354
+ * manager in approved_by_user_id. Promoting the active revision returns it with its
3355
+ * approval unchanged. A superseded revision cannot be promoted.
3356
+ *
3357
+ *
3358
+ * **Required scope:**
3359
+ *
3360
+ * `competencies.standards.versions.promotions:create`
3361
+ *
3362
+ */
3363
+ static promoteCompetencyStandardVersion(options) {
3364
+ return (options.client ?? client).post({
3365
+ security: [{ name: 'X-Api-Key', type: 'apiKey' }],
3366
+ url: '/api/v1/competencies/standards/{standard_id}/versions/{version_id}/promotion',
3367
+ ...options,
3368
+ headers: {
3369
+ 'Content-Type': 'application/json',
3370
+ ...options.headers
3371
+ }
3372
+ });
3373
+ }
3374
+ }
2823
3375
  export class ComplianceChecks {
2824
3376
  /**
2825
3377
  * List compliance checks
@@ -4044,8 +4596,9 @@ export class JobWageDeterminationRateRules {
4044
4596
  * Requires a user-scoped API key; company keys without a user
4045
4597
  * receive 403 user_scoped_key_required.
4046
4598
  *
4047
- * Unknown fields return 400. Malformed conditions or nonnumeric
4048
- * cents return 422. Concurrent writes to the determination
4599
+ * Unknown top-level fields and missing recipe fields return 400.
4600
+ * Malformed recipe values or keys and nonnumeric cents return
4601
+ * 422. Concurrent writes to the determination
4049
4602
  * family can return retryable 503 without creating a rule or package.
4050
4603
  *
4051
4604
  *