@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/headcount-priorities.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 HeadcountPriorities extends APIResource {
+  /**
+   * Retrieve a specific headcount priority
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<HeadcountPriorityRetrieveResponse> {
+    return this._client.get(path`/headcount-priorities/${id}`, options);
+  }
+
+  /**
+   * A List of headcount priorities
+   *
+   * - Requires: `Internal Testing`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: HeadcountPriorityListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<HeadcountPriorityListResponsesPageCursorURL, HeadcountPriorityListResponse> {
+    return this._client.getAPIList('/headcount-priorities', PageCursorURL<HeadcountPriorityListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type HeadcountPriorityListResponsesPageCursorURL = PageCursorURL<HeadcountPriorityListResponse>;
+
+/**
+ * Meta information for the response.
+ */
+export interface HeadcountPriorityRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Display name of the headcount priority
+   */
+  name?: string;
+}
+
+export interface HeadcountPriorityListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Display name of the headcount priority
+   */
+  name?: string;
+}
+
+export interface HeadcountPriorityListParams {
+  order_by?: string;
+}
+
+export declare namespace HeadcountPriorities {
+  export {
+    type HeadcountPriorityRetrieveResponse as HeadcountPriorityRetrieveResponse,
+    type HeadcountPriorityListResponse as HeadcountPriorityListResponse,
+    type HeadcountPriorityListResponsesPageCursorURL as HeadcountPriorityListResponsesPageCursorURL,
+    type HeadcountPriorityListParams as HeadcountPriorityListParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,322 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './shared';
+export {
+  BusinessPartnerGroups,
+  type BusinessPartnerGroup,
+  type BusinessPartnerGroupRetrieveResponse,
+  type BusinessPartnerGroupCreateParams,
+  type BusinessPartnerGroupRetrieveParams,
+  type BusinessPartnerGroupListParams,
+  type BusinessPartnerGroupsPageCursorURL,
+} from './business-partner-groups';
+export {
+  BusinessPartners,
+  type BusinessPartner,
+  type Meta,
+  type BusinessPartnerRetrieveResponse,
+  type BusinessPartnerCreateParams,
+  type BusinessPartnerRetrieveParams,
+  type BusinessPartnerListParams,
+  type BusinessPartnersPageCursorURL,
+} from './business-partners';
+export {
+  CandidateApplications,
+  type CandidateApplicationListResponse,
+  type CandidateApplicationListParams,
+  type CandidateApplicationListResponsesPageCursorURL,
+} from './candidate-applications';
+export {
+  Candidates,
+  type CandidateListResponse,
+  type CandidateListParams,
+  type CandidateListResponsesPageCursorURL,
+} from './candidates';
+export { Companies, type Company, type CompanyListParams, type CompaniesPageCursorURL } from './companies';
+export {
+  Compensations,
+  type Compensation,
+  type CompensationRetrieveResponse,
+  type CompensationRetrieveParams,
+  type CompensationListParams,
+  type CompensationsPageCursorURL,
+} from './compensations';
+export {
+  CustomFields,
+  type CustomFieldListResponse,
+  type CustomFieldListParams,
+  type CustomFieldListResponsesPageCursorURL,
+} from './custom-fields';
+export {
+  CustomObjects,
+  type CustomObject,
+  type CustomObjectCreateParams,
+  type CustomObjectUpdateParams,
+  type CustomObjectsPageCursorURL,
+} from './custom-objects/custom-objects';
+export {
+  Departments,
+  type Department,
+  type DepartmentRetrieveResponse,
+  type DepartmentRetrieveParams,
+  type DepartmentListParams,
+  type DepartmentsPageCursorURL,
+} from './departments';
+export {
+  EmploymentTypes,
+  type CompanyEmploymentType,
+  type EmploymentTypeRetrieveResponse,
+  type EmploymentTypeListParams,
+  type CompanyEmploymentTypesPageCursorURL,
+} from './employment-types';
+export {
+  Entitlements,
+  type EntitlementListResponse,
+  type EntitlementListResponsesPageCursorURL,
+} from './entitlements';
+export {
+  Functions,
+  type Function,
+  type FunctionCreateDevBundleResponse,
+  type FunctionCreateParams,
+  type FunctionUpdateParams,
+  type FunctionListParams,
+  type FunctionsPageCursorURL,
+} from './functions/functions';
+export {
+  HeadcountPositions,
+  type HeadcountPositionRetrieveResponse,
+  type HeadcountPositionListResponse,
+  type HeadcountPositionRetrieveParams,
+  type HeadcountPositionListParams,
+  type HeadcountPositionListResponsesPageCursorURL,
+} from './headcount-positions';
+export {
+  HeadcountPriorities,
+  type HeadcountPriorityRetrieveResponse,
+  type HeadcountPriorityListResponse,
+  type HeadcountPriorityListParams,
+  type HeadcountPriorityListResponsesPageCursorURL,
+} from './headcount-priorities';
+export {
+  JobAssignments,
+  type AttributeChangeDetails,
+  type JobAssignment,
+  type JobAssignmentRetrieveResponse,
+  type JobAssignmentRetrieveParams,
+  type JobAssignmentListParams,
+  type JobAssignmentListChangeLogParams,
+  type AttributeChangeDetailsPageCursorURL,
+  type JobAssignmentsPageCursorURL,
+} from './job-assignments';
+export {
+  JobCodes,
+  type JobCode,
+  type JobCodeRequest,
+  type JobCodeRetrieveResponse,
+  type JobCodeCreateParams,
+  type JobCodeRetrieveParams,
+  type JobCodeUpdateParams,
+  type JobCodeListParams,
+  type JobCodeListChangeLogParams,
+  type JobCodesPageCursorURL,
+} from './job-codes';
+export {
+  JobDimensions,
+  type JobDimension,
+  type JobDimensionRequest,
+  type JobDimensionRetrieveResponse,
+  type JobDimensionCreateParams,
+  type JobDimensionUpdateParams,
+  type JobDimensionListParams,
+  type JobDimensionsPageCursorURL,
+} from './job-dimensions';
+export {
+  JobFunctions,
+  type JobFunctionRetrieveResponse,
+  type JobFunctionListResponse,
+  type JobFunctionListParams,
+  type JobFunctionListResponsesPageCursorURL,
+} from './job-functions';
+export {
+  JobPayRateExceptions,
+  type JobPayRateException,
+  type JobPayRateExceptionRetrieveResponse,
+  type JobPayRateExceptionRetrieveParams,
+  type JobPayRateExceptionListParams,
+  type JobPayRateExceptionListChangeLogParams,
+  type JobPayRateExceptionsPageCursorURL,
+} from './job-pay-rate-exceptions';
+export {
+  JobRequisitions,
+  type JobRequisition,
+  type JobRequisitionListParams,
+  type JobRequisitionsPageCursorURL,
+} from './job-requisitions';
+export {
+  KioskBadges,
+  type TimeKioskBadge,
+  type KioskBadgeCreateResponse,
+  type KioskBadgeRetrieveResponse,
+  type KioskBadgeUpdateResponse,
+  type KioskBadgeListResponse,
+  type KioskBadgeCreateParams,
+  type KioskBadgeRetrieveParams,
+  type KioskBadgeUpdateParams,
+  type KioskBadgeListParams,
+  type KioskBadgeListResponsesPageCursorURL,
+} from './kiosk-badges';
+export {
+  LeaveBalances,
+  type LeaveBalance,
+  type LeaveBalanceRetrieveResponse,
+  type LeaveBalanceRetrieveParams,
+  type LeaveBalanceListParams,
+  type LeaveBalancesPageCursorURL,
+} from './leave-balances';
+export {
+  LeaveRequests,
+  type LeaveRequest,
+  type LeaveRequestCreateResponse,
+  type LeaveRequestRetrieveResponse,
+  type LeaveRequestUpdateResponse,
+  type LeaveRequestListResponse,
+  type LeaveRequestCreateParams,
+  type LeaveRequestRetrieveParams,
+  type LeaveRequestUpdateParams,
+  type LeaveRequestListParams,
+  type LeaveRequestListResponsesPageCursorURL,
+} from './leave-requests';
+export {
+  LeaveTypes,
+  type LeaveType,
+  type LeaveTypeRetrieveResponse,
+  type LeaveTypeListParams,
+  type LeaveTypesPageCursorURL,
+} from './leave-types';
+export {
+  LegalEntities,
+  type LegalEntity,
+  type LegalEntityRetrieveResponse,
+  type LegalEntityRetrieveParams,
+  type LegalEntityListParams,
+  type LegalEntitiesPageCursorURL,
+} from './legal-entities';
+export {
+  Levels,
+  type Level,
+  type LevelRetrieveResponse,
+  type LevelRetrieveParams,
+  type LevelListParams,
+  type LevelsPageCursorURL,
+} from './levels';
+export {
+  LocationFactors,
+  type LocationFactorRetrieveResponse,
+  type LocationFactorListResponse,
+  type LocationFactorListParams,
+  type LocationFactorListResponsesPageCursorURL,
+} from './location-factors';
+export {
+  ObjectCategories,
+  type ObjectCategory,
+  type ObjectCategoryCreateParams,
+  type ObjectCategoryUpdateParams,
+  type ObjectCategoriesPageCursorURL,
+} from './object-categories';
+export { SSOMeResource, type SSOMe, type SSOMeRetrieveParams } from './sso-me';
+export {
+  Schedules,
+  type ScheduleRetrieveResponse,
+  type ScheduleListResponse,
+  type ScheduleRetrieveParams,
+  type ScheduleListParams,
+  type ScheduleListResponsesPageCursorURL,
+} from './schedules';
+export {
+  ShiftInputs,
+  type ShiftInput,
+  type ShiftInputCreateResponse,
+  type ShiftInputRetrieveResponse,
+  type ShiftInputUpdateResponse,
+  type ShiftInputListResponse,
+  type ShiftInputCreateParams,
+  type ShiftInputRetrieveParams,
+  type ShiftInputUpdateParams,
+  type ShiftInputListParams,
+  type ShiftInputListResponsesPageCursorURL,
+} from './shift-inputs';
+export {
+  Shiftassignments,
+  type ShiftassignmentRetrieveResponse,
+  type ShiftassignmentListResponse,
+  type ShiftassignmentRetrieveParams,
+  type ShiftassignmentListParams,
+  type ShiftassignmentListResponsesPageCursorURL,
+} from './shiftassignments';
+export {
+  Supergroups,
+  type Supergroup,
+  type SupergroupRetrieveResponse,
+  type SupergroupListParams,
+  type SupergroupsPageCursorURL,
+} from './supergroups/supergroups';
+export {
+  Teams,
+  type Team,
+  type TeamRetrieveResponse,
+  type TeamRetrieveParams,
+  type TeamListParams,
+  type TeamsPageCursorURL,
+} from './teams';
+export {
+  TimeCards,
+  type PayPeriod,
+  type TimeCard,
+  type TimeCardRetrieveResponse,
+  type TimeCardRetrieveParams,
+  type TimeCardListParams,
+  type TimeCardsPageCursorURL,
+} from './time-cards';
+export {
+  TimeEntries,
+  type TimeEntry,
+  type TimeEntryCreateResponse,
+  type TimeEntryRetrieveResponse,
+  type TimeEntryUpdateResponse,
+  type TimeEntryListResponse,
+  type TimeEntryCreateParams,
+  type TimeEntryRetrieveParams,
+  type TimeEntryUpdateParams,
+  type TimeEntryListParams,
+  type TimeEntryListResponsesPageCursorURL,
+} from './time-entries';
+export {
+  Tracks,
+  type Track,
+  type TrackRetrieveResponse,
+  type TrackListParams,
+  type TracksPageCursorURL,
+} from './tracks';
+export {
+  Users,
+  type User,
+  type UserRetrieveResponse,
+  type UserListParams,
+  type UsersPageCursorURL,
+} from './users';
+export {
+  WorkLocations,
+  type WorkLocation,
+  type WorkLocationRetrieveResponse,
+  type WorkLocationListParams,
+  type WorkLocationsPageCursorURL,
+} from './work-locations';
+export {
+  Workers,
+  type Worker,
+  type WorkerRetrieveResponse,
+  type WorkerRetrieveParams,
+  type WorkerListParams,
+  type WorkersPageCursorURL,
+} from './workers';

package/src/resources/job-assignments.ts

@@ -0,0 +1,227 @@
+// 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 JobCodesAPI from './job-codes';
+import * as JobPayRateExceptionsAPI from './job-pay-rate-exceptions';
+import * as WorkersAPI from './workers';
+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 JobAssignments extends APIResource {
+  /**
+   * Retrieve a specific job assignment
+   */
+  retrieve(
+    id: string,
+    query: JobAssignmentRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<JobAssignmentRetrieveResponse> {
+    return this._client.get(path`/job-assignments/${id}`, { query, ...options });
+  }
+
+  /**
+   * A List of job assignments
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `job_code_id`
+   * - Expandable fields: `worker`, `job_code`, `job_pay_rate_exceptions`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: JobAssignmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<JobAssignmentsPageCursorURL, JobAssignment> {
+    return this._client.getAPIList('/job-assignments', PageCursorURL<JobAssignment>, { query, ...options });
+  }
+
+  /**
+   * A List of attribute change logs
+   *
+   * - Requires: `API Tier 2`
+   * - Expandable fields: `changed_by_worker`
+   * - Sortable fields: `id`
+   */
+  listChangeLog(
+    jobAssignmentID: string,
+    query: JobAssignmentListChangeLogParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AttributeChangeDetailsPageCursorURL, AttributeChangeDetails> {
+    return this._client.getAPIList(
+      path`/job-assignments/${jobAssignmentID}/change-log`,
+      PageCursorURL<AttributeChangeDetails>,
+      { query, ...options },
+    );
+  }
+}
+
+export type JobAssignmentsPageCursorURL = PageCursorURL<JobAssignment>;
+
+export type AttributeChangeDetailsPageCursorURL = PageCursorURL<AttributeChangeDetails>;
+
+export interface AttributeChangeDetails {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * List of attributes that were modified as part of the change.
+   */
+  attribute_changes?: Array<AttributeChangeDetails.AttributeChange>;
+
+  /**
+   * Worker who made the change
+   *
+   * Expandable field
+   */
+  changed_by_worker?: WorkersAPI.Worker;
+
+  /**
+   * Identifier of worker who made the change
+   */
+  changed_by_worker_id?: string;
+
+  /**
+   * The time the change was requested by worker
+   */
+  created_at?: string;
+
+  /**
+   * The time the change was scheduled to take effect on
+   */
+  effective_from_date?: string;
+
+  /**
+   * Reason provided by worker for making the change
+   */
+  reason?: string;
+
+  /**
+   * The time the change was applied
+   */
+  updated_at?: string;
+}
+
+export namespace AttributeChangeDetails {
+  export interface AttributeChange {
+    /**
+     * The name of attribute changed.
+     */
+    attribute_name?: string;
+
+    /**
+     * New value of attribute, after the change
+     */
+    new_attribute_value?: unknown;
+
+    /**
+     * Old value of attribute, before the change.
+     */
+    old_attribute_value?: unknown;
+  }
+}
+
+export interface JobAssignment {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Identifier of job that is assigned to worker
+   */
+  job_code_id: string;
+
+  /**
+   * The pay rate for job assigned to worker. This can be different from the job's
+   * standard pay rate and can be overriden for a worker.
+   */
+  job_pay_rate: number;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Identifier of worker to whom job is assigned.
+   */
+  worker_id: string;
+
+  /**
+   * Base compensation rate of worker
+   */
+  base_pay_rate?: number;
+
+  /**
+   * Job that is assigned to worker
+   *
+   * Expandable field
+   */
+  job_code?: JobCodesAPI.JobCode;
+
+  /**
+   * Pay rate exceptions applicable for the worker based on certain exception
+   * dimension values.
+   *
+   * Expandable field
+   */
+  job_pay_rate_exceptions?: Array<JobPayRateExceptionsAPI.JobPayRateException>;
+
+  /**
+   * Identifier of pay rate exceptions applicable for the worker based on certain
+   * exception dimension values.
+   */
+  job_pay_rate_exceptions_id?: Array<string>;
+
+  /**
+   * Worker to whom job is assigned.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface JobAssignmentRetrieveResponse extends BusinessPartnersAPI.Meta, JobAssignment {}
+
+export interface JobAssignmentRetrieveParams {
+  expand?: string;
+}
+
+export interface JobAssignmentListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface JobAssignmentListChangeLogParams {
+  expand?: string;
+
+  order_by?: string;
+}
+
+export declare namespace JobAssignments {
+  export {
+    type AttributeChangeDetails as AttributeChangeDetails,
+    type JobAssignment as JobAssignment,
+    type JobAssignmentRetrieveResponse as JobAssignmentRetrieveResponse,
+    type JobAssignmentsPageCursorURL as JobAssignmentsPageCursorURL,
+    type AttributeChangeDetailsPageCursorURL as AttributeChangeDetailsPageCursorURL,
+    type JobAssignmentRetrieveParams as JobAssignmentRetrieveParams,
+    type JobAssignmentListParams as JobAssignmentListParams,
+    type JobAssignmentListChangeLogParams as JobAssignmentListChangeLogParams,
+  };
+}