@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/job-functions.ts

@@ -0,0 +1,95 @@
+// 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 { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class JobFunctions extends APIResource {
+  /**
+   * Retrieve a specific job function
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<JobFunctionRetrieveResponse> {
+    return this._client.get(path`/job-functions/${id}`, options);
+  }
+
+  /**
+   * A List of job functions
+   *
+   * - Requires: `Internal Testing`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: JobFunctionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<JobFunctionListResponsesPageCursorURL, JobFunctionListResponse> {
+    return this._client.getAPIList('/job-functions', PageCursorURL<JobFunctionListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type JobFunctionListResponsesPageCursorURL = PageCursorURL<JobFunctionListResponse>;
+
+/**
+ * Meta information for the response.
+ */
+export interface JobFunctionRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Displayed name of the job function
+   */
+  name?: string;
+}
+
+export interface JobFunctionListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Displayed name of the job function
+   */
+  name?: string;
+}
+
+export interface JobFunctionListParams {
+  order_by?: string;
+}
+
+export declare namespace JobFunctions {
+  export {
+    type JobFunctionRetrieveResponse as JobFunctionRetrieveResponse,
+    type JobFunctionListResponse as JobFunctionListResponse,
+    type JobFunctionListResponsesPageCursorURL as JobFunctionListResponsesPageCursorURL,
+    type JobFunctionListParams as JobFunctionListParams,
+  };
+}

package/src/resources/job-pay-rate-exceptions.ts

@@ -0,0 +1,144 @@
+// 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 JobAssignmentsAPI from './job-assignments';
+import { AttributeChangeDetailsPageCursorURL } from './job-assignments';
+import * as JobCodesAPI from './job-codes';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class JobPayRateExceptions extends APIResource {
+  /**
+   * Retrieve a specific job pay rate exception
+   */
+  retrieve(
+    id: string,
+    query: JobPayRateExceptionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JobPayRateExceptionRetrieveResponse> {
+    return this._client.get(path`/job-pay-rate-exceptions/${id}`, { query, ...options });
+  }
+
+  /**
+   * A List of job pay rate exceptions
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `job_code_id`
+   * - Expandable fields: `job_code`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: JobPayRateExceptionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<JobPayRateExceptionsPageCursorURL, JobPayRateException> {
+    return this._client.getAPIList('/job-pay-rate-exceptions', PageCursorURL<JobPayRateException>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * A List of attribute change logs
+   *
+   * - Requires: `API Tier 2`
+   * - Expandable fields: `changed_by_worker`
+   * - Sortable fields: `id`
+   */
+  listChangeLog(
+    jobPayRateExceptionID: string,
+    query: JobPayRateExceptionListChangeLogParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AttributeChangeDetailsPageCursorURL, JobAssignmentsAPI.AttributeChangeDetails> {
+    return this._client.getAPIList(
+      path`/job-pay-rate-exceptions/${jobPayRateExceptionID}/change-log`,
+      PageCursorURL<JobAssignmentsAPI.AttributeChangeDetails>,
+      { query, ...options },
+    );
+  }
+}
+
+export type JobPayRateExceptionsPageCursorURL = PageCursorURL<JobPayRateException>;
+
+export interface JobPayRateException {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Identifier of dimension object on which exception is configured. This objects
+   * details can be queried from exception_dimension_type's resource
+   */
+  exception_dimension_id: string;
+
+  /**
+   * Identifier of Job for which exception is configured.
+   */
+  job_code_id: string;
+
+  /**
+   * The pay rate for exception on job_code_id and exception_dimension_id combination
+   */
+  pay_rate: number;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Type of dimension on which exception is configured
+   */
+  exception_dimension_type?: 'JOB_CODE' | 'LEVEL' | 'TEAM' | 'DEPARTMENT' | 'WORK_LOCATION';
+
+  /**
+   * Job for which exception is configured.
+   *
+   * Expandable field
+   */
+  job_code?: JobCodesAPI.JobCode;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface JobPayRateExceptionRetrieveResponse extends BusinessPartnersAPI.Meta, JobPayRateException {}
+
+export interface JobPayRateExceptionRetrieveParams {
+  expand?: string;
+}
+
+export interface JobPayRateExceptionListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface JobPayRateExceptionListChangeLogParams {
+  expand?: string;
+
+  order_by?: string;
+}
+
+export declare namespace JobPayRateExceptions {
+  export {
+    type JobPayRateException as JobPayRateException,
+    type JobPayRateExceptionRetrieveResponse as JobPayRateExceptionRetrieveResponse,
+    type JobPayRateExceptionsPageCursorURL as JobPayRateExceptionsPageCursorURL,
+    type JobPayRateExceptionRetrieveParams as JobPayRateExceptionRetrieveParams,
+    type JobPayRateExceptionListParams as JobPayRateExceptionListParams,
+    type JobPayRateExceptionListChangeLogParams as JobPayRateExceptionListChangeLogParams,
+  };
+}
+
+export { type AttributeChangeDetailsPageCursorURL };

package/src/resources/job-requisitions.ts

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+export class JobRequisitions extends APIResource {
+  /**
+   * A List of job requisitions
+   *
+   * - Requires: `API Tier 2`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: JobRequisitionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<JobRequisitionsPageCursorURL, JobRequisition> {
+    return this._client.getAPIList('/job-requisitions', PageCursorURL<JobRequisition>, { query, ...options });
+  }
+}
+
+export type JobRequisitionsPageCursorURL = PageCursorURL<JobRequisition>;
+
+export interface JobRequisition {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Job requisition name
+   */
+  name: string;
+
+  /**
+   * Job requisition status
+   */
+  status: 'OPEN' | 'CLOSED' | 'PUBLISHED' | 'DRAFT' | 'ARCHIVED';
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+export interface JobRequisitionListParams {
+  order_by?: string;
+}
+
+export declare namespace JobRequisitions {
+  export {
+    type JobRequisition as JobRequisition,
+    type JobRequisitionsPageCursorURL as JobRequisitionsPageCursorURL,
+    type JobRequisitionListParams as JobRequisitionListParams,
+  };
+}

package/src/resources/kiosk-badges.ts

@@ -0,0 +1,343 @@
+// 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 WorkersAPI from './workers';
+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 KioskBadges extends APIResource {
+  /**
+   * Create a new kiosk badge
+   */
+  create(body: KioskBadgeCreateParams, options?: RequestOptions): APIPromise<KioskBadgeCreateResponse> {
+    return this._client.post('/kiosk-badges', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific kiosk badge
+   */
+  retrieve(
+    id: string,
+    query: KioskBadgeRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<KioskBadgeRetrieveResponse> {
+    return this._client.get(path`/kiosk-badges/${id}`, { query, ...options });
+  }
+
+  /**
+   * Updated a specific kiosk badge
+   */
+  update(
+    id: string,
+    body: KioskBadgeUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<KioskBadgeUpdateResponse> {
+    return this._client.patch(path`/kiosk-badges/${id}`, { body, ...options });
+  }
+
+  /**
+   * A List of kiosk badges
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `badge_id`
+   * - Expandable fields: `worker`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: KioskBadgeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<KioskBadgeListResponsesPageCursorURL, KioskBadgeListResponse> {
+    return this._client.getAPIList('/kiosk-badges', PageCursorURL<KioskBadgeListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a kiosk badge
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/kiosk-badges/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type KioskBadgeListResponsesPageCursorURL = PageCursorURL<KioskBadgeListResponse>;
+
+export interface TimeKioskBadge {
+  /**
+   * The ID associated with the badge. Not to be confused with the record's ID.
+   */
+  badge_id: string;
+
+  /**
+   * Whether this badge can be used with the Kiosk app.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The ID of the worker associated with the badge.
+   */
+  worker_id?: string;
+
+  /**
+   * The employee number of the worker associated with the badge.
+   */
+  worker_number?: number;
+}
+
+export interface KioskBadgeCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The ID associated with the badge. Not to be confused with the record's ID.
+   */
+  badge_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether this badge can be used with the Kiosk app.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The worker associated with the badge.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker associated with the badge.
+   */
+  worker_id?: string;
+
+  /**
+   * The employee number of the worker associated with the badge.
+   */
+  worker_number?: number;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface KioskBadgeRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The ID associated with the badge. Not to be confused with the record's ID.
+   */
+  badge_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether this badge can be used with the Kiosk app.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The worker associated with the badge.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker associated with the badge.
+   */
+  worker_id?: string;
+
+  /**
+   * The employee number of the worker associated with the badge.
+   */
+  worker_number?: number;
+}
+
+export interface KioskBadgeUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The ID associated with the badge. Not to be confused with the record's ID.
+   */
+  badge_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether this badge can be used with the Kiosk app.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The worker associated with the badge.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker associated with the badge.
+   */
+  worker_id?: string;
+
+  /**
+   * The employee number of the worker associated with the badge.
+   */
+  worker_number?: number;
+}
+
+export interface KioskBadgeListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The ID associated with the badge. Not to be confused with the record's ID.
+   */
+  badge_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether this badge can be used with the Kiosk app.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The worker associated with the badge.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker associated with the badge.
+   */
+  worker_id?: string;
+
+  /**
+   * The employee number of the worker associated with the badge.
+   */
+  worker_number?: number;
+}
+
+export interface KioskBadgeCreateParams {
+  /**
+   * The ID associated with the badge. Not to be confused with the record's ID.
+   */
+  badge_id: string;
+
+  /**
+   * Whether this badge can be used with the Kiosk app.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The ID of the worker associated with the badge.
+   */
+  worker_id?: string;
+
+  /**
+   * The employee number of the worker associated with the badge.
+   */
+  worker_number?: number;
+}
+
+export interface KioskBadgeRetrieveParams {
+  expand?: string;
+}
+
+export interface KioskBadgeUpdateParams {
+  /**
+   * The ID associated with the badge. Not to be confused with the record's ID.
+   */
+  badge_id: string;
+
+  /**
+   * Whether this badge can be used with the Kiosk app.
+   */
+  is_enabled?: boolean;
+
+  /**
+   * The ID of the worker associated with the badge.
+   */
+  worker_id?: string;
+
+  /**
+   * The employee number of the worker associated with the badge.
+   */
+  worker_number?: number;
+}
+
+export interface KioskBadgeListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export declare namespace KioskBadges {
+  export {
+    type TimeKioskBadge as TimeKioskBadge,
+    type KioskBadgeCreateResponse as KioskBadgeCreateResponse,
+    type KioskBadgeRetrieveResponse as KioskBadgeRetrieveResponse,
+    type KioskBadgeUpdateResponse as KioskBadgeUpdateResponse,
+    type KioskBadgeListResponse as KioskBadgeListResponse,
+    type KioskBadgeListResponsesPageCursorURL as KioskBadgeListResponsesPageCursorURL,
+    type KioskBadgeCreateParams as KioskBadgeCreateParams,
+    type KioskBadgeRetrieveParams as KioskBadgeRetrieveParams,
+    type KioskBadgeUpdateParams as KioskBadgeUpdateParams,
+    type KioskBadgeListParams as KioskBadgeListParams,
+  };
+}