@rippling/rippling-sdk 0.2.0-alpha.20

package/resources/job-codes.d.mts

@@ -0,0 +1,358 @@
+import { APIResource } from "../core/resource.mjs";
+import * as BusinessPartnersAPI from "./business-partners.mjs";
+import * as DepartmentsAPI from "./departments.mjs";
+import * as JobAssignmentsAPI from "./job-assignments.mjs";
+import { AttributeChangeDetailsPageCursorURL } from "./job-assignments.mjs";
+import * as JobDimensionsAPI from "./job-dimensions.mjs";
+import * as JobPayRateExceptionsAPI from "./job-pay-rate-exceptions.mjs";
+import * as Shared from "./shared.mjs";
+import * as WorkLocationsAPI from "./work-locations.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class JobCodes extends APIResource {
+    /**
+     * Create a new job code
+     */
+    create(body: JobCodeCreateParams, options?: RequestOptions): APIPromise<JobCode>;
+    /**
+     * Retrieve a specific job code
+     */
+    retrieve(id: string, query?: JobCodeRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<JobCodeRetrieveResponse>;
+    /**
+     * Updated a specific job code
+     */
+    update(id: string, body: JobCodeUpdateParams, options?: RequestOptions): APIPromise<JobCode>;
+    /**
+     * A List of job codes
+     *
+     * - Requires: `API Tier 2`
+     * - Filterable fields: `job_dimension_id`, `group_id`
+     * - Expandable fields: `job_dimension`, `work_location`, `department`,
+     *   `pay_rate_exceptions`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query?: JobCodeListParams | null | undefined, options?: RequestOptions): PagePromise<JobCodesPageCursorURL, JobCode>;
+    /**
+     * Delete a job code
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * A List of attribute change logs
+     *
+     * - Requires: `API Tier 2`
+     * - Expandable fields: `changed_by_worker`
+     * - Sortable fields: `id`
+     */
+    listChangeLog(jobCodeID: string, query?: JobCodeListChangeLogParams | null | undefined, options?: RequestOptions): PagePromise<AttributeChangeDetailsPageCursorURL, JobAssignmentsAPI.AttributeChangeDetails>;
+}
+export type JobCodesPageCursorURL = PageCursorURL<JobCode>;
+export interface JobCode {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * The ID of the job dimension this job code belongs to.
+     */
+    job_dimension_id: string;
+    /**
+     * The name of the job dimension.
+     */
+    name: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * The custom location of the job code. This location will be used for tax
+     * calculation purposes if using US Payroll when an employee is working at this job
+     * code.
+     */
+    custom_location?: JobCode.CustomLocation;
+    /**
+     * The department associated with the job code.
+     *
+     * Expandable field
+     */
+    department?: DepartmentsAPI.Department;
+    /**
+     * The department associated with the job code.
+     */
+    department_id?: string;
+    /**
+     * The unique identifier of the job code in an outside system.
+     */
+    external_id?: string;
+    /**
+     * The ID of the job roster group.
+     */
+    group_id?: string;
+    /**
+     * The job dimension this job code belongs to.
+     *
+     * Expandable field
+     */
+    job_dimension?: JobDimensionsAPI.JobDimension;
+    /**
+     * The pay rate for job, if job code is associated with pay rate.
+     */
+    pay_rate?: number;
+    /**
+     * Pay rate overrides for the job based on exception dimension values.
+     *
+     * Expandable field
+     */
+    pay_rate_exceptions?: Array<JobPayRateExceptionsAPI.JobPayRateException>;
+    /**
+     * Pay rate overrides id for the job based on exception dimension values.
+     */
+    pay_rate_exceptions_id?: Array<string>;
+    /**
+     * The work location associated with the job code.
+     *
+     * Expandable field
+     */
+    work_location?: WorkLocationsAPI.WorkLocation;
+    /**
+     * The work location associated with the job code.
+     */
+    work_location_id?: string;
+}
+export declare namespace JobCode {
+    /**
+     * The custom location of the job code. This location will be used for tax
+     * calculation purposes if using US Payroll when an employee is working at this job
+     * code.
+     */
+    interface CustomLocation {
+        /**
+         * The address of the custom location.
+         */
+        address: Shared.Address;
+    }
+}
+export interface JobCodeRequest {
+    /**
+     * The ID of the job dimension this job code belongs to.
+     */
+    job_dimension_id: string;
+    /**
+     * The name of the job dimension.
+     */
+    name: string;
+    /**
+     * The custom location of the job code. This location will be used for tax
+     * calculation purposes if using US Payroll when an employee is working at this job
+     * code.
+     */
+    custom_location?: JobCodeRequest.CustomLocation;
+    /**
+     * The unique identifier of the job code in an outside system.
+     */
+    external_id?: string;
+}
+export declare namespace JobCodeRequest {
+    /**
+     * The custom location of the job code. This location will be used for tax
+     * calculation purposes if using US Payroll when an employee is working at this job
+     * code.
+     */
+    interface CustomLocation {
+        /**
+         * The address of the custom location.
+         */
+        address: CustomLocation.Address;
+    }
+    namespace CustomLocation {
+        /**
+         * The address of the custom location.
+         */
+        interface Address {
+            /**
+             * The country component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            country?: Shared.CountryCode;
+            /**
+             * The city or locality component.
+             */
+            locality?: string;
+            /**
+             * The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            postal_code?: string;
+            /**
+             * The state or region component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            region?: string;
+            /**
+             * The full street address component, which may include house number, street name,
+             * P.O. box, and multi-line extended street address information, pursuant to SCIM
+             * RFC 7643 4.1.2..
+             */
+            street_address?: string;
+            /**
+             * The classification of the address.
+             */
+            type?: 'HOME' | 'WORK' | 'OTHER';
+        }
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface JobCodeRetrieveResponse extends BusinessPartnersAPI.Meta, JobCode {
+}
+export interface JobCodeCreateParams {
+    /**
+     * The ID of the job dimension this job code belongs to.
+     */
+    job_dimension_id: string;
+    /**
+     * The name of the job dimension.
+     */
+    name: string;
+    /**
+     * The custom location of the job code. This location will be used for tax
+     * calculation purposes if using US Payroll when an employee is working at this job
+     * code.
+     */
+    custom_location?: JobCodeCreateParams.CustomLocation;
+    /**
+     * The unique identifier of the job code in an outside system.
+     */
+    external_id?: string;
+}
+export declare namespace JobCodeCreateParams {
+    /**
+     * The custom location of the job code. This location will be used for tax
+     * calculation purposes if using US Payroll when an employee is working at this job
+     * code.
+     */
+    interface CustomLocation {
+        /**
+         * The address of the custom location.
+         */
+        address: CustomLocation.Address;
+    }
+    namespace CustomLocation {
+        /**
+         * The address of the custom location.
+         */
+        interface Address {
+            /**
+             * The country component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            country?: Shared.CountryCode;
+            /**
+             * The city or locality component.
+             */
+            locality?: string;
+            /**
+             * The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            postal_code?: string;
+            /**
+             * The state or region component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            region?: string;
+            /**
+             * The full street address component, which may include house number, street name,
+             * P.O. box, and multi-line extended street address information, pursuant to SCIM
+             * RFC 7643 4.1.2..
+             */
+            street_address?: string;
+            /**
+             * The classification of the address.
+             */
+            type?: 'HOME' | 'WORK' | 'OTHER';
+        }
+    }
+}
+export interface JobCodeRetrieveParams {
+    expand?: string;
+}
+export interface JobCodeUpdateParams {
+    /**
+     * The ID of the job dimension this job code belongs to.
+     */
+    job_dimension_id: string;
+    /**
+     * The name of the job dimension.
+     */
+    name: string;
+    /**
+     * The custom location of the job code. This location will be used for tax
+     * calculation purposes if using US Payroll when an employee is working at this job
+     * code.
+     */
+    custom_location?: JobCodeUpdateParams.CustomLocation;
+    /**
+     * The unique identifier of the job code in an outside system.
+     */
+    external_id?: string;
+}
+export declare namespace JobCodeUpdateParams {
+    /**
+     * The custom location of the job code. This location will be used for tax
+     * calculation purposes if using US Payroll when an employee is working at this job
+     * code.
+     */
+    interface CustomLocation {
+        /**
+         * The address of the custom location.
+         */
+        address: CustomLocation.Address;
+    }
+    namespace CustomLocation {
+        /**
+         * The address of the custom location.
+         */
+        interface Address {
+            /**
+             * The country component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            country?: Shared.CountryCode;
+            /**
+             * The city or locality component.
+             */
+            locality?: string;
+            /**
+             * The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            postal_code?: string;
+            /**
+             * The state or region component, pursuant to SCIM RFC 7643 4.1.2.
+             */
+            region?: string;
+            /**
+             * The full street address component, which may include house number, street name,
+             * P.O. box, and multi-line extended street address information, pursuant to SCIM
+             * RFC 7643 4.1.2..
+             */
+            street_address?: string;
+            /**
+             * The classification of the address.
+             */
+            type?: 'HOME' | 'WORK' | 'OTHER';
+        }
+    }
+}
+export interface JobCodeListParams {
+    expand?: string;
+    filter?: string;
+    order_by?: string;
+}
+export interface JobCodeListChangeLogParams {
+    expand?: string;
+    order_by?: string;
+}
+export declare namespace JobCodes {
+    export { type JobCode as JobCode, type JobCodeRequest as JobCodeRequest, type JobCodeRetrieveResponse as JobCodeRetrieveResponse, type JobCodesPageCursorURL as JobCodesPageCursorURL, type JobCodeCreateParams as JobCodeCreateParams, type JobCodeRetrieveParams as JobCodeRetrieveParams, type JobCodeUpdateParams as JobCodeUpdateParams, type JobCodeListParams as JobCodeListParams, type JobCodeListChangeLogParams as JobCodeListChangeLogParams, };
+}
+export { type AttributeChangeDetailsPageCursorURL };
+//# sourceMappingURL=job-codes.d.mts.map

package/resources/job-codes.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-codes.d.mts","sourceRoot":"","sources":["../src/resources/job-codes.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,KAAK,cAAc;OACnB,KAAK,iBAAiB;OACtB,EAAE,mCAAmC,EAAE;OACvC,KAAK,gBAAgB;OACrB,KAAK,uBAAuB;OAC5B,KAAK,MAAM;OACX,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAE9B,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,OAAO,CAAC;IAI9C;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;OAMG;IACH,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,iBAAiB,CAAC,sBAAsB,CAAC;CAO9F;AAED,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;AAE3D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAEzC;;;;OAIG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC;IAEvC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,aAAa,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;IAEzE;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;;;OAIG;IACH,aAAa,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAE9C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,yBAAiB,OAAO,CAAC;IACvB;;;;OAIG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;KACzB;CACF;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,eAAe,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC;IAEhD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;;OAIG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;KACjC;IAED,UAAiB,cAAc,CAAC;QAC9B;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YAE7B;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;;eAIG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;SAClC;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB,CAAC,IAAI,EAAE,OAAO;CAAG;AAErF,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,eAAe,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC;IAErD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;;OAIG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;KACjC;IAED,UAAiB,cAAc,CAAC;QAC9B;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YAE7B;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;;eAIG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;SAClC;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,eAAe,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC;IAErD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;;OAIG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;KACjC;IAED,UAAiB,cAAc,CAAC;QAC9B;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;YAE7B;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;;;eAIG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;SAClC;KACF;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,mCAAmC,EAAE,CAAC"}