@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/job-codes.ts

@@ -0,0 +1,466 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import * as DepartmentsAPI from './departments';
+import * as JobAssignmentsAPI from './job-assignments';
+import { AttributeChangeDetailsPageCursorURL } from './job-assignments';
+import * as JobDimensionsAPI from './job-dimensions';
+import * as JobPayRateExceptionsAPI from './job-pay-rate-exceptions';
+import * as Shared from './shared';
+import * as WorkLocationsAPI from './work-locations';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class JobCodes extends APIResource {
+  /**
+   * Create a new job code
+   */
+  create(body: JobCodeCreateParams, options?: RequestOptions): APIPromise<JobCode> {
+    return this._client.post('/job-codes', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific job code
+   */
+  retrieve(
+    id: string,
+    query: JobCodeRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JobCodeRetrieveResponse> {
+    return this._client.get(path`/job-codes/${id}`, { query, ...options });
+  }
+
+  /**
+   * Updated a specific job code
+   */
+  update(id: string, body: JobCodeUpdateParams, options?: RequestOptions): APIPromise<JobCode> {
+    return this._client.patch(path`/job-codes/${id}`, { body, ...options });
+  }
+
+  /**
+   * 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> {
+    return this._client.getAPIList('/job-codes', PageCursorURL<JobCode>, { query, ...options });
+  }
+
+  /**
+   * Delete a job code
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/job-codes/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * 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> {
+    return this._client.getAPIList(
+      path`/job-codes/${jobCodeID}/change-log`,
+      PageCursorURL<JobAssignmentsAPI.AttributeChangeDetails>,
+      { query, ...options },
+    );
+  }
+}
+
+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 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.
+   */
+  export 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 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.
+   */
+  export interface CustomLocation {
+    /**
+     * The address of the custom location.
+     */
+    address: CustomLocation.Address;
+  }
+
+  export namespace CustomLocation {
+    /**
+     * The address of the custom location.
+     */
+    export 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 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.
+   */
+  export interface CustomLocation {
+    /**
+     * The address of the custom location.
+     */
+    address: CustomLocation.Address;
+  }
+
+  export namespace CustomLocation {
+    /**
+     * The address of the custom location.
+     */
+    export 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 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.
+   */
+  export interface CustomLocation {
+    /**
+     * The address of the custom location.
+     */
+    address: CustomLocation.Address;
+  }
+
+  export namespace CustomLocation {
+    /**
+     * The address of the custom location.
+     */
+    export 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 };

package/src/resources/job-dimensions.ts

@@ -0,0 +1,201 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class JobDimensions extends APIResource {
+  /**
+   * Create a new job dimension
+   */
+  create(body: JobDimensionCreateParams, options?: RequestOptions): APIPromise<JobDimension> {
+    return this._client.post('/job-dimensions', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific job dimension
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<JobDimensionRetrieveResponse> {
+    return this._client.get(path`/job-dimensions/${id}`, options);
+  }
+
+  /**
+   * Updated a specific job dimension
+   */
+  update(id: string, body: JobDimensionUpdateParams, options?: RequestOptions): APIPromise<JobDimension> {
+    return this._client.patch(path`/job-dimensions/${id}`, { body, ...options });
+  }
+
+  /**
+   * A List of job dimensions
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `name`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: JobDimensionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<JobDimensionsPageCursorURL, JobDimension> {
+    return this._client.getAPIList('/job-dimensions', PageCursorURL<JobDimension>, { query, ...options });
+  }
+
+  /**
+   * Delete a job dimension
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/job-dimensions/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type JobDimensionsPageCursorURL = PageCursorURL<JobDimension>;
+
+export interface JobDimension {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the job dimension
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The unique identifier of the job dimension in a third party system
+   */
+  external_id?: string;
+
+  /**
+   * The ID of the dimension roster group.
+   */
+  group_id?: string;
+
+  /**
+   * Whether the job dimension includes codes related to a custom location. Only one
+   * dimension can have this set to true.
+   */
+  includes_custom_location?: boolean;
+
+  /**
+   * The roster type of the dimension. PER_DIMENSION means that there is a group on
+   * the dimension level and employees within that group have access to all job codes
+   * in the dimension. PER_JOB_CODE means that each job code has its own group.
+   */
+  roster_type?: 'PER_DIMENSION' | 'PER_JOB_CODE';
+}
+
+export interface JobDimensionRequest {
+  /**
+   * The name of the job dimension
+   */
+  name: string;
+
+  /**
+   * The unique identifier of the job dimension in a third party system
+   */
+  external_id?: string;
+
+  /**
+   * Whether the job dimension includes codes related to a custom location. Only one
+   * dimension can have this set to true.
+   */
+  includes_custom_location?: boolean;
+
+  /**
+   * The roster type of the dimension. PER_DIMENSION means that there is a group on
+   * the dimension level and employees within that group have access to all job codes
+   * in the dimension. PER_JOB_CODE means that each job code has its own group.
+   */
+  roster_type?: 'PER_DIMENSION' | 'PER_JOB_CODE';
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface JobDimensionRetrieveResponse extends BusinessPartnersAPI.Meta, JobDimension {}
+
+export interface JobDimensionCreateParams {
+  /**
+   * The name of the job dimension
+   */
+  name: string;
+
+  /**
+   * The unique identifier of the job dimension in a third party system
+   */
+  external_id?: string;
+
+  /**
+   * Whether the job dimension includes codes related to a custom location. Only one
+   * dimension can have this set to true.
+   */
+  includes_custom_location?: boolean;
+
+  /**
+   * The roster type of the dimension. PER_DIMENSION means that there is a group on
+   * the dimension level and employees within that group have access to all job codes
+   * in the dimension. PER_JOB_CODE means that each job code has its own group.
+   */
+  roster_type?: 'PER_DIMENSION' | 'PER_JOB_CODE';
+}
+
+export interface JobDimensionUpdateParams {
+  /**
+   * The name of the job dimension
+   */
+  name: string;
+
+  /**
+   * The unique identifier of the job dimension in a third party system
+   */
+  external_id?: string;
+
+  /**
+   * Whether the job dimension includes codes related to a custom location. Only one
+   * dimension can have this set to true.
+   */
+  includes_custom_location?: boolean;
+
+  /**
+   * The roster type of the dimension. PER_DIMENSION means that there is a group on
+   * the dimension level and employees within that group have access to all job codes
+   * in the dimension. PER_JOB_CODE means that each job code has its own group.
+   */
+  roster_type?: 'PER_DIMENSION' | 'PER_JOB_CODE';
+}
+
+export interface JobDimensionListParams {
+  filter?: string;
+
+  order_by?: string;
+}
+
+export declare namespace JobDimensions {
+  export {
+    type JobDimension as JobDimension,
+    type JobDimensionRequest as JobDimensionRequest,
+    type JobDimensionRetrieveResponse as JobDimensionRetrieveResponse,
+    type JobDimensionsPageCursorURL as JobDimensionsPageCursorURL,
+    type JobDimensionCreateParams as JobDimensionCreateParams,
+    type JobDimensionUpdateParams as JobDimensionUpdateParams,
+    type JobDimensionListParams as JobDimensionListParams,
+  };
+}