@rippling/rippling-sdk 0.2.0-alpha.82 → 0.2.0-alpha.83

package/resources/leave-program-evaluations.d.ts

@@ -12,9 +12,11 @@ export declare class LeaveProgramEvaluations extends APIResource {
 }
 export interface LeaveProgramEvaluationCreateResponse {
     /**
-     * Combined leave plan derived from all non-ineligible program results.
+     * Combined leave plan derived from all non-ineligible program results. Join
+     * program_results by program_code for eligibility, pay rates, and gaps;
+     * program_contributions carry placement windows only.
      */
-    leave_plan: unknown;
+    leave_plan: LeaveProgramEvaluationCreateResponse.LeavePlan;
     /**
      * Structured evidence gaps reported by evaluated eligibility rules.
      */
@@ -22,9 +24,261 @@ export interface LeaveProgramEvaluationCreateResponse {
     /**
      * Per-program rule outputs in evaluation order.
      */
-    program_results: Array<unknown>;
+    program_results: Array<LeaveProgramEvaluationCreateResponse.ProgramResult>;
 }
 export declare namespace LeaveProgramEvaluationCreateResponse {
+    /**
+     * Combined leave plan derived from all non-ineligible program results. Join
+     * program_results by program_code for eligibility, pay rates, and gaps;
+     * program_contributions carry placement windows only.
+     */
+    interface LeavePlan {
+        /**
+         * Flattened balance adjustment directives from payable program results.
+         */
+        balance_adjustments: Array<LeavePlan.BalanceAdjustment>;
+        /**
+         * Requested leave start date used for this plan.
+         */
+        claim_start_date: string;
+        /**
+         * Contiguous spans where the same program set overlaps.
+         */
+        coverage_segments: Array<LeavePlan.CoverageSegment>;
+        /**
+         * Flattened payroll earning directives from payable program results.
+         */
+        earnings: Array<LeavePlan.Earning>;
+        /**
+         * Estimated per-paycheck amounts when claim_end_date and pay schedule are known.
+         */
+        pay_periods: Array<LeavePlan.PayPeriod>;
+        /**
+         * Per-program placement windows on the claim.
+         */
+        program_contributions: Array<LeavePlan.ProgramContribution>;
+        /**
+         * Requested leave end date used for this plan, if provided.
+         */
+        claim_end_date?: string;
+        /**
+         * Merged bookable leave request directive, if any.
+         */
+        leave_request?: LeavePlan.LeaveRequest;
+    }
+    namespace LeavePlan {
+        interface BalanceAdjustment {
+            /**
+             * Adjustment amount serialized as a decimal string.
+             */
+            amount: string;
+            /**
+             * Leave type to adjust if applying the evaluation.
+             */
+            leave_type: string;
+            /**
+             * Unit for the adjustment amount, such as WEEKS, DAYS, or HOURS.
+             */
+            unit: string;
+            /**
+             * Accrual type to use when applying the adjustment.
+             */
+            accrual_type?: string;
+        }
+        interface CoverageSegment {
+            /**
+             * Programs active over this segment.
+             */
+            program_codes: Array<string>;
+            /**
+             * Segment start date.
+             */
+            start_date: string;
+            /**
+             * Segment end date, if known.
+             */
+            end_date?: string;
+        }
+        interface Earning {
+            /**
+             * Earning amount serialized as a decimal string.
+             */
+            amount: string;
+            /**
+             * Earning type to use if booking a payroll earning from the evaluation.
+             */
+            earning_type: string;
+            /**
+             * ISO 4217 currency code for the earning amount.
+             */
+            currency?: string;
+            /**
+             * Number of benefit weeks represented by this earning, serialized as a decimal
+             * string.
+             */
+            weeks?: string;
+        }
+        interface PayPeriod {
+            /**
+             * Estimated program-level pay slices in this pay period.
+             */
+            contributions: Array<PayPeriod.Contribution>;
+            /**
+             * Estimated pay period end date.
+             */
+            period_end: string;
+            /**
+             * Estimated pay period start date.
+             */
+            period_start: string;
+            /**
+             * Total estimated carrier-paid amount in this pay period.
+             */
+            carrier_total?: PayPeriod.CarrierTotal;
+            /**
+             * Total estimated employer-paid amount in this pay period.
+             */
+            employer_total?: PayPeriod.EmployerTotal;
+            /**
+             * Total estimated government-paid amount in this pay period.
+             */
+            government_total?: PayPeriod.GovernmentTotal;
+            /**
+             * Total estimated amount in this pay period.
+             */
+            total?: PayPeriod.Total;
+        }
+        namespace PayPeriod {
+            interface Contribution {
+                /**
+                 * Estimated amount for this program slice.
+                 */
+                amount: Contribution.Amount;
+                /**
+                 * Who pays the employee for this program slice.
+                 */
+                pay_source: 'GOVERNMENT' | 'CARRIER' | 'EMPLOYER';
+                /**
+                 * Program contributing pay in this pay period.
+                 */
+                program_code: string;
+            }
+            namespace Contribution {
+                /**
+                 * Estimated amount for this program slice.
+                 */
+                interface Amount {
+                    /**
+                     * Decimal monetary amount serialized as a string.
+                     */
+                    amount: string;
+                    /**
+                     * ISO 4217 currency code for the amount.
+                     */
+                    currency: string;
+                }
+            }
+            /**
+             * Total estimated carrier-paid amount in this pay period.
+             */
+            interface CarrierTotal {
+                /**
+                 * Decimal monetary amount serialized as a string.
+                 */
+                amount: string;
+                /**
+                 * ISO 4217 currency code for the amount.
+                 */
+                currency: string;
+            }
+            /**
+             * Total estimated employer-paid amount in this pay period.
+             */
+            interface EmployerTotal {
+                /**
+                 * Decimal monetary amount serialized as a string.
+                 */
+                amount: string;
+                /**
+                 * ISO 4217 currency code for the amount.
+                 */
+                currency: string;
+            }
+            /**
+             * Total estimated government-paid amount in this pay period.
+             */
+            interface GovernmentTotal {
+                /**
+                 * Decimal monetary amount serialized as a string.
+                 */
+                amount: string;
+                /**
+                 * ISO 4217 currency code for the amount.
+                 */
+                currency: string;
+            }
+            /**
+             * Total estimated amount in this pay period.
+             */
+            interface Total {
+                /**
+                 * Decimal monetary amount serialized as a string.
+                 */
+                amount: string;
+                /**
+                 * ISO 4217 currency code for the amount.
+                 */
+                currency: string;
+            }
+        }
+        interface ProgramContribution {
+            /**
+             * Whether this program has an estimated pay rate.
+             */
+            pay_status: 'NOT_APPLICABLE' | 'ESTIMATED';
+            /**
+             * Leave program code active on this claim window.
+             */
+            program_code: string;
+            /**
+             * Program placement start date.
+             */
+            start_date: string;
+            /**
+             * Program placement end date, if known.
+             */
+            end_date?: string;
+            /**
+             * Leave type associated with this program placement.
+             */
+            leave_type?: string;
+            /**
+             * Human-readable leave type label.
+             */
+            leave_type_label?: string;
+        }
+        /**
+         * Merged bookable leave request directive, if any.
+         */
+        interface LeaveRequest {
+            /**
+             * Leave type to use if booking a leave request from the evaluation.
+             */
+            leave_type: string;
+            /**
+             * Recommended leave request start date.
+             */
+            start_date: string;
+            /**
+             * Recommended leave request end date, if known.
+             */
+            end_date?: string;
+            /**
+             * Optional leave request status to use when booking.
+             */
+            status?: string;
+        }
+    }
     interface MissingEvidence {
         /**
          * Expected answer type for this evidence key.
@@ -43,6 +297,252 @@ export declare namespace LeaveProgramEvaluationCreateResponse {
          */
         program_codes: Array<string>;
     }
+    interface ProgramResult {
+        /**
+         * Derived eligibility status for this program.
+         */
+        eligibility: 'eligible' | 'ineligible' | 'partially_eligible';
+        /**
+         * UNKNOWN evidence keys to fix before eligibility can be fully resolved.
+         */
+        gaps: Array<string>;
+        /**
+         * Whether the result is eligible and not blocked by payment-blocking requirements.
+         */
+        is_payable: boolean;
+        /**
+         * Leave program code evaluated by the rules engine.
+         */
+        program_code: string;
+        /**
+         * Eligibility and assumption validations run for this program.
+         */
+        program_validations: Array<ProgramResult.ProgramValidation>;
+        /**
+         * Legacy explanatory components for this program.
+         */
+        components?: Array<ProgramResult.Component>;
+        /**
+         * Bookable directives emitted by this program.
+         */
+        directives?: ProgramResult.Directives;
+        /**
+         * Time entitlement for this program, if any.
+         */
+        entitlement?: ProgramResult.Entitlement;
+        /**
+         * Job-protection details for this program, if any.
+         */
+        job_protection?: ProgramResult.JobProtection;
+        /**
+         * Estimated wage-replacement rate for this program, if any.
+         */
+        pay_rate?: ProgramResult.PayRate;
+        /**
+         * Who pays the employee for this program's wage-replacement slice.
+         */
+        pay_source?: 'GOVERNMENT' | 'CARRIER' | 'EMPLOYER';
+        /**
+         * Human-readable pay summary for this program.
+         */
+        pay_summary?: string;
+        /**
+         * Outstanding artifacts or actions for this program.
+         */
+        program_requirements?: Array<ProgramResult.ProgramRequirement>;
+    }
+    namespace ProgramResult {
+        interface ProgramValidation {
+            /**
+             * Human-readable validation message.
+             */
+            message: string;
+            /**
+             * Validation outcome.
+             */
+            outcome: 'PASSED' | 'FAILED' | 'UNKNOWN' | 'ASSUMED';
+            /**
+             * Machine-readable validation function that produced this outcome.
+             */
+            validation_func: string;
+            /**
+             * Evidence key or field path inspected by the validation.
+             */
+            data_source?: string;
+            /**
+             * Observed value at evaluation time, if available.
+             */
+            value?: string;
+        }
+        interface Component {
+            /**
+             * Category of explanatory result component.
+             */
+            kind: 'ELIGIBILITY' | 'PAY' | 'TIME' | 'OTHER';
+            /**
+             * Human-readable summary for this component.
+             */
+            summary: string;
+            /**
+             * Additional component-specific data.
+             */
+            data?: unknown;
+            /**
+             * Optional machine-readable subtype for the component.
+             */
+            subkind?: string;
+        }
+        /**
+         * Bookable directives emitted by this program.
+         */
+        interface Directives {
+            /**
+             * Balance adjustment directives emitted by payable program results.
+             */
+            balance_adjustments?: Array<Directives.BalanceAdjustment>;
+            /**
+             * Payroll earning directives emitted by payable program results.
+             */
+            earnings?: Array<Directives.Earning>;
+            /**
+             * Leave request directive emitted by payable program results.
+             */
+            leave_request?: Directives.LeaveRequest;
+        }
+        namespace Directives {
+            interface BalanceAdjustment {
+                /**
+                 * Adjustment amount serialized as a decimal string.
+                 */
+                amount: string;
+                /**
+                 * Leave type to adjust if applying the evaluation.
+                 */
+                leave_type: string;
+                /**
+                 * Unit for the adjustment amount, such as WEEKS, DAYS, or HOURS.
+                 */
+                unit: string;
+                /**
+                 * Accrual type to use when applying the adjustment.
+                 */
+                accrual_type?: string;
+            }
+            interface Earning {
+                /**
+                 * Earning amount serialized as a decimal string.
+                 */
+                amount: string;
+                /**
+                 * Earning type to use if booking a payroll earning from the evaluation.
+                 */
+                earning_type: string;
+                /**
+                 * ISO 4217 currency code for the earning amount.
+                 */
+                currency?: string;
+                /**
+                 * Number of benefit weeks represented by this earning, serialized as a decimal
+                 * string.
+                 */
+                weeks?: string;
+            }
+            /**
+             * Leave request directive emitted by payable program results.
+             */
+            interface LeaveRequest {
+                /**
+                 * Leave type to use if booking a leave request from the evaluation.
+                 */
+                leave_type: string;
+                /**
+                 * Recommended leave request start date.
+                 */
+                start_date: string;
+                /**
+                 * Recommended leave request end date, if known.
+                 */
+                end_date?: string;
+                /**
+                 * Optional leave request status to use when booking.
+                 */
+                status?: string;
+            }
+        }
+        /**
+         * Time entitlement for this program, if any.
+         */
+        interface Entitlement {
+            /**
+             * Entitlement amount serialized as a decimal string.
+             */
+            amount: string;
+            /**
+             * Leave type associated with the entitlement.
+             */
+            leave_type: string;
+            /**
+             * Unit for the entitlement amount, such as WEEKS, DAYS, or HOURS.
+             */
+            unit: string;
+        }
+        /**
+         * Job-protection details for this program, if any.
+         */
+        interface JobProtection {
+            /**
+             * Job-restoration right provided by the program.
+             */
+            restoration: string;
+            /**
+             * Whether the program continues group health coverage.
+             */
+            continues_group_health?: boolean;
+        }
+        /**
+         * Estimated wage-replacement rate for this program, if any.
+         */
+        interface PayRate {
+            /**
+             * Wage-replacement phases for the program.
+             */
+            phases: Array<PayRate.Phase>;
+        }
+        namespace PayRate {
+            interface Phase {
+                /**
+                 * Pay amount for this phase serialized as a decimal string.
+                 */
+                amount: string;
+                /**
+                 * ISO 4217 currency code for this pay phase.
+                 */
+                currency?: string;
+                /**
+                 * Number of days this phase lasts. Null means the phase runs to the window end.
+                 */
+                duration_days?: number;
+                /**
+                 * Pay-rate unit for this phase, such as DAILY, WEEKLY, or BIWEEKLY.
+                 */
+                unit?: string;
+            }
+        }
+        interface ProgramRequirement {
+            /**
+             * Machine-readable requirement key.
+             */
+            key: string;
+            /**
+             * Human-readable requirement summary.
+             */
+            summary: string;
+            /**
+             * Whether this requirement blocks payment until resolved.
+             */
+            blocks_payment?: boolean;
+        }
+    }
 }
 export interface LeaveProgramEvaluationCreateParams {
     /**
@@ -61,6 +561,11 @@ export interface LeaveProgramEvaluationCreateParams {
      * Optional date the child entered the family for bonding leave programs.
      */
     child_entered_family_date?: string;
+    /**
+     * Optional requested leave end date. When set, leave_plan.pay_periods includes
+     * estimated per-paycheck amounts for programs that publish pay rates.
+     */
+    claim_end_date?: string;
     /**
      * Demo/test-company only evidence overrides for exercising eligibility scenarios
      * when the role's real data would not qualify.
@@ -68,6 +573,8 @@ export interface LeaveProgramEvaluationCreateParams {
     evidence_override?: unknown;
     /**
      * Optional parental leave relationship type for parental leave programs.
+     * Deprecated for most bonding evaluations, but still accepted for backwards
+     * compatibility with 2024-08-01 SDK callers.
      */
     parental_leave_type?: 'birthing_parent' | 'non_birthing_parent' | 'adoption_parent' | 'supporting_person' | 'foster_parent';
     /**

package/resources/leave-program-evaluations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"leave-program-evaluations.d.ts","sourceRoot":"","sources":["../src/resources/leave-program-evaluations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;IACtD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAGpD;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,oCAAoC,CAAC,eAAe,CAAC,CAAC;IAE9E;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACjC;AAED,yBAAiB,oCAAoC,CAAC;IACpD,UAAiB,eAAe;QAC9B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EACR,SAAS,GACT,sBAAsB,GACtB,yBAAyB,GACzB,SAAS,GACT,UAAU,GACV,OAAO,CAAC;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,mBAAmB,CAAC,EAChB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}
+{"version":3,"file":"leave-program-evaluations.d.ts","sourceRoot":"","sources":["../src/resources/leave-program-evaluations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;IACtD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAGpD;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;OAIG;IACH,UAAU,EAAE,oCAAoC,CAAC,SAAS,CAAC;IAE3D;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,oCAAoC,CAAC,eAAe,CAAC,CAAC;IAE9E;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,oCAAoC,CAAC,aAAa,CAAC,CAAC;CAC5E;AAED,yBAAiB,oCAAoC,CAAC;IACpD;;;;OAIG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,mBAAmB,EAAE,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAExD;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAEpD;;WAEG;QACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAEnC;;WAEG;QACH,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAExC;;WAEG;QACH,qBAAqB,EAAE,KAAK,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QAE5D;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC;KACxC;IAED,UAAiB,SAAS,CAAC;QACzB,UAAiB,iBAAiB;YAChC;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,eAAe;YAC9B;;eAEG;YACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE7B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,SAAS;YACxB;;eAEG;YACH,aAAa,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAE7C;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,aAAa,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC;YAEvC;;eAEG;YACH,cAAc,CAAC,EAAE,SAAS,CAAC,aAAa,CAAC;YAEzC;;eAEG;YACH,gBAAgB,CAAC,EAAE,SAAS,CAAC,eAAe,CAAC;YAE7C;;eAEG;YACH,KAAK,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;SACzB;QAED,UAAiB,SAAS,CAAC;YACzB,UAAiB,YAAY;gBAC3B;;mBAEG;gBACH,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC;gBAE5B;;mBAEG;gBACH,UAAU,EAAE,YAAY,GAAG,SAAS,GAAG,UAAU,CAAC;gBAElD;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;aACtB;YAED,UAAiB,YAAY,CAAC;gBAC5B;;mBAEG;gBACH,UAAiB,MAAM;oBACrB;;uBAEG;oBACH,MAAM,EAAE,MAAM,CAAC;oBAEf;;uBAEG;oBACH,QAAQ,EAAE,MAAM,CAAC;iBAClB;aACF;YAED;;eAEG;YACH,UAAiB,YAAY;gBAC3B;;mBAEG;gBACH,MAAM,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;aAClB;YAED;;eAEG;YACH,UAAiB,aAAa;gBAC5B;;mBAEG;gBACH,MAAM,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;aAClB;YAED;;eAEG;YACH,UAAiB,eAAe;gBAC9B;;mBAEG;gBACH,MAAM,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;aAClB;YAED;;eAEG;YACH,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,MAAM,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;aAClB;SACF;QAED,UAAiB,mBAAmB;YAClC;;eAEG;YACH,UAAU,EAAE,gBAAgB,GAAG,WAAW,CAAC;YAE3C;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;SAC3B;QAED;;WAEG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB;KACF;IAED,UAAiB,eAAe;QAC9B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B;IAED,UAAiB,aAAa;QAC5B;;WAEG;QACH,WAAW,EAAE,UAAU,GAAG,YAAY,GAAG,oBAAoB,CAAC;QAE9D;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,mBAAmB,EAAE,KAAK,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;QAE5D;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAE5C;;WAEG;QACH,UAAU,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC;QAEtC;;WAEG;QACH,WAAW,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC;QAExC;;WAEG;QACH,cAAc,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC;QAE7C;;WAEG;QACH,QAAQ,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC;QAEjC;;WAEG;QACH,UAAU,CAAC,EAAE,YAAY,GAAG,SAAS,GAAG,UAAU,CAAC;QAEnD;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;KAChE;IAED,UAAiB,aAAa,CAAC;QAC7B,UAAiB,iBAAiB;YAChC;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,OAAO,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;YAErD;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,SAAS;YACxB;;eAEG;YACH,IAAI,EAAE,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;YAE/C;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,OAAO,CAAC;YAEf;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;YAE1D;;eAEG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC;SACzC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,iBAAiB;gBAChC;;mBAEG;gBACH,MAAM,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC;aACvB;YAED,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,MAAM,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED;;eAEG;YACH,UAAiB,YAAY;gBAC3B;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,UAAU,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;aACjB;SACF;QAED;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;SAClC;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,MAAM,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,aAAa,CAAC,EAAE,MAAM,CAAC;gBAEvB;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;SACF;QAED,UAAiB,kBAAkB;YACjC;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC;SAC1B;KACF;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,EACR,SAAS,GACT,sBAAsB,GACtB,yBAAyB,GACzB,SAAS,GACT,UAAU,GACV,OAAO,CAAC;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,mBAAmB,CAAC,EAChB,iBAAiB,GACjB,qBAAqB,GACrB,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,CAAC;IAEpB;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC;IAC/C,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}

package/resources/levels.d.mts

@@ -16,10 +16,22 @@ export declare class Levels extends APIResource {
      * - Sortable fields: `id`, `created_at`, `updated_at`
      */
     list(query?: LevelListParams | null | undefined, options?: RequestOptions): PagePromise<LevelsPageCursorURL, Level>;
+    /**
+     * Create a new level
+     */
+    create(body: LevelCreateParams, options?: RequestOptions): APIPromise<Level>;
     /**
      * Retrieve a specific level
      */
     retrieve(id: string, query?: LevelRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<LevelRetrieveResponse>;
+    /**
+     * Update a specific level.
+     */
+    update(id: string, body?: LevelUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Level>;
+    /**
+     * Delete a level
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
 }
 export type LevelsPageCursorURL = PageCursorURL<Level>;
 export interface Level {
@@ -43,6 +55,10 @@ export interface Level {
      * The description of the level.
      */
     description?: string;
+    /**
+     * The experience requirements for the level.
+     */
+    experience_requirements?: string;
     /**
      * Global level is used to track the seniority of levels. The higher up a level is
      * placed on the page, the more senior and higher-ranked the level. Global level is
@@ -65,6 +81,10 @@ export interface Level {
      * The rank of the level within its track.
      */
     rank?: number;
+    /**
+     * The scope of responsibilities for the level.
+     */
+    scope_of_responsibilities?: string;
     /**
      * The track associated with the level, if it's not a global level.
      *
@@ -72,7 +92,8 @@ export interface Level {
      */
     track?: TracksAPI.Track;
     /**
-     * The track associated with the level, if it's not a global level.
+     * The track associated with the level. Required during creation and cannot be
+     * changed through this API.
      */
     track_id?: string;
 }
@@ -86,10 +107,51 @@ export interface LevelListParams {
     expand?: string;
     order_by?: string;
 }
+export interface LevelCreateParams {
+    /**
+     * The name of the level. Must be unique within the company or organization.
+     */
+    name: string;
+    /**
+     * The track associated with the level. Required during creation and cannot be
+     * changed through this API.
+     */
+    track_id: string;
+    /**
+     * The description of the level.
+     */
+    description?: string;
+    /**
+     * The experience requirements for the level.
+     */
+    experience_requirements?: string;
+    /**
+     * The scope of responsibilities for the level.
+     */
+    scope_of_responsibilities?: string;
+}
 export interface LevelRetrieveParams {
     expand?: string;
 }
+export interface LevelUpdateParams {
+    /**
+     * The description of the level.
+     */
+    description?: string;
+    /**
+     * The experience requirements for the level.
+     */
+    experience_requirements?: string;
+    /**
+     * The name of the level. Must be unique within the company or organization.
+     */
+    name?: string;
+    /**
+     * The scope of responsibilities for the level.
+     */
+    scope_of_responsibilities?: string;
+}
 export declare namespace Levels {
-    export { type Level as Level, type LevelRetrieveResponse as LevelRetrieveResponse, type LevelsPageCursorURL as LevelsPageCursorURL, type LevelListParams as LevelListParams, type LevelRetrieveParams as LevelRetrieveParams, };
+    export { type Level as Level, type LevelRetrieveResponse as LevelRetrieveResponse, type LevelsPageCursorURL as LevelsPageCursorURL, type LevelListParams as LevelListParams, type LevelCreateParams as LevelCreateParams, type LevelRetrieveParams as LevelRetrieveParams, type LevelUpdateParams as LevelUpdateParams, };
 }
 //# sourceMappingURL=levels.d.mts.map

package/resources/levels.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"levels.d.mts","sourceRoot":"","sources":["../src/resources/levels.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,KAAK,CAAC;IAI1C;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAGrC;AAED,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;AAEvD,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB,CAAC,IAAI,EAAE,KAAK;CAAG;AAEjF,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"levels.d.mts","sourceRoot":"","sources":["../src/resources/levels.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAEhE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,KAAK,CAAC;IAI1C;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;AAEvD,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB,CAAC,IAAI,EAAE,KAAK;CAAG;AAEjF,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}