@rippling/rippling-sdk 0.2.0-alpha.21 → 0.2.0-alpha.22

package/src/resources/index.ts

@@ -5,9 +5,9 @@ export {
   BusinessPartnerGroups,
   type BusinessPartnerGroup,
   type BusinessPartnerGroupRetrieveResponse,
+  type BusinessPartnerGroupListParams,
   type BusinessPartnerGroupCreateParams,
   type BusinessPartnerGroupRetrieveParams,
-  type BusinessPartnerGroupListParams,
   type BusinessPartnerGroupsPageCursorURL,
 } from './business-partner-groups';
 export {
@@ -15,9 +15,9 @@ export {
   type BusinessPartner,
   type Meta,
   type BusinessPartnerRetrieveResponse,
+  type BusinessPartnerListParams,
   type BusinessPartnerCreateParams,
   type BusinessPartnerRetrieveParams,
-  type BusinessPartnerListParams,
   type BusinessPartnersPageCursorURL,
 } from './business-partners';
 export {
@@ -37,8 +37,8 @@ export {
   Compensations,
   type Compensation,
   type CompensationRetrieveResponse,
-  type CompensationRetrieveParams,
   type CompensationListParams,
+  type CompensationRetrieveParams,
   type CompensationsPageCursorURL,
 } from './compensations';
 export {
@@ -58,10 +58,11 @@ export {
   Departments,
   type Department,
   type DepartmentRetrieveResponse,
-  type DepartmentRetrieveParams,
   type DepartmentListParams,
+  type DepartmentRetrieveParams,
   type DepartmentsPageCursorURL,
 } from './departments';
+export { DraftHires, type DraftHireCreateResponse, type DraftHireCreateParams } from './draft-hires';
 export {
   EmploymentTypes,
   type CompanyEmploymentType,
@@ -78,23 +79,23 @@ export {
   Functions,
   type Function,
   type FunctionCreateDevBundleResponse,
+  type FunctionListParams,
   type FunctionCreateParams,
   type FunctionUpdateParams,
-  type FunctionListParams,
   type FunctionsPageCursorURL,
 } from './functions/functions';
 export {
   HeadcountPositions,
-  type HeadcountPositionRetrieveResponse,
   type HeadcountPositionListResponse,
-  type HeadcountPositionRetrieveParams,
+  type HeadcountPositionRetrieveResponse,
   type HeadcountPositionListParams,
+  type HeadcountPositionRetrieveParams,
   type HeadcountPositionListResponsesPageCursorURL,
 } from './headcount-positions';
 export {
   HeadcountPriorities,
-  type HeadcountPriorityRetrieveResponse,
   type HeadcountPriorityListResponse,
+  type HeadcountPriorityRetrieveResponse,
   type HeadcountPriorityListParams,
   type HeadcountPriorityListResponsesPageCursorURL,
 } from './headcount-priorities';
@@ -103,8 +104,8 @@ export {
   type AttributeChangeDetails,
   type JobAssignment,
   type JobAssignmentRetrieveResponse,
-  type JobAssignmentRetrieveParams,
   type JobAssignmentListParams,
+  type JobAssignmentRetrieveParams,
   type JobAssignmentListChangeLogParams,
   type AttributeChangeDetailsPageCursorURL,
   type JobAssignmentsPageCursorURL,
@@ -114,10 +115,10 @@ export {
   type JobCode,
   type JobCodeRequest,
   type JobCodeRetrieveResponse,
+  type JobCodeListParams,
   type JobCodeCreateParams,
   type JobCodeRetrieveParams,
   type JobCodeUpdateParams,
-  type JobCodeListParams,
   type JobCodeListChangeLogParams,
   type JobCodesPageCursorURL,
 } from './job-codes';
@@ -126,15 +127,15 @@ export {
   type JobDimension,
   type JobDimensionRequest,
   type JobDimensionRetrieveResponse,
+  type JobDimensionListParams,
   type JobDimensionCreateParams,
   type JobDimensionUpdateParams,
-  type JobDimensionListParams,
   type JobDimensionsPageCursorURL,
 } from './job-dimensions';
 export {
   JobFunctions,
-  type JobFunctionRetrieveResponse,
   type JobFunctionListResponse,
+  type JobFunctionRetrieveResponse,
   type JobFunctionListParams,
   type JobFunctionListResponsesPageCursorURL,
 } from './job-functions';
@@ -142,8 +143,8 @@ export {
   JobPayRateExceptions,
   type JobPayRateException,
   type JobPayRateExceptionRetrieveResponse,
-  type JobPayRateExceptionRetrieveParams,
   type JobPayRateExceptionListParams,
+  type JobPayRateExceptionRetrieveParams,
   type JobPayRateExceptionListChangeLogParams,
   type JobPayRateExceptionsPageCursorURL,
 } from './job-pay-rate-exceptions';
@@ -156,35 +157,42 @@ export {
 export {
   KioskBadges,
   type TimeKioskBadge,
+  type KioskBadgeListResponse,
   type KioskBadgeCreateResponse,
   type KioskBadgeRetrieveResponse,
   type KioskBadgeUpdateResponse,
-  type KioskBadgeListResponse,
+  type KioskBadgeListParams,
   type KioskBadgeCreateParams,
   type KioskBadgeRetrieveParams,
   type KioskBadgeUpdateParams,
-  type KioskBadgeListParams,
   type KioskBadgeListResponsesPageCursorURL,
 } from './kiosk-badges';
+export {
+  LeaveAccruals,
+  type LeaveAccrualRetrieveResponse,
+  type LeaveAccrualCreateResponse,
+  type LeaveAccrualRetrieveParams,
+  type LeaveAccrualCreateParams,
+} from './leave-accruals';
 export {
   LeaveBalances,
   type LeaveBalance,
   type LeaveBalanceRetrieveResponse,
-  type LeaveBalanceRetrieveParams,
   type LeaveBalanceListParams,
+  type LeaveBalanceRetrieveParams,
   type LeaveBalancesPageCursorURL,
 } from './leave-balances';
 export {
   LeaveRequests,
   type LeaveRequest,
+  type LeaveRequestListResponse,
   type LeaveRequestCreateResponse,
   type LeaveRequestRetrieveResponse,
   type LeaveRequestUpdateResponse,
-  type LeaveRequestListResponse,
+  type LeaveRequestListParams,
   type LeaveRequestCreateParams,
   type LeaveRequestRetrieveParams,
   type LeaveRequestUpdateParams,
-  type LeaveRequestListParams,
   type LeaveRequestListResponsesPageCursorURL,
 } from './leave-requests';
 export {
@@ -198,22 +206,22 @@ export {
   LegalEntities,
   type LegalEntity,
   type LegalEntityRetrieveResponse,
-  type LegalEntityRetrieveParams,
   type LegalEntityListParams,
+  type LegalEntityRetrieveParams,
   type LegalEntitiesPageCursorURL,
 } from './legal-entities';
 export {
   Levels,
   type Level,
   type LevelRetrieveResponse,
-  type LevelRetrieveParams,
   type LevelListParams,
+  type LevelRetrieveParams,
   type LevelsPageCursorURL,
 } from './levels';
 export {
   LocationFactors,
-  type LocationFactorRetrieveResponse,
   type LocationFactorListResponse,
+  type LocationFactorRetrieveResponse,
   type LocationFactorListParams,
   type LocationFactorListResponsesPageCursorURL,
 } from './location-factors';
@@ -227,31 +235,31 @@ export {
 export { SSOMeResource, type SSOMe, type SSOMeRetrieveParams } from './sso-me';
 export {
   Schedules,
-  type ScheduleRetrieveResponse,
   type ScheduleListResponse,
-  type ScheduleRetrieveParams,
+  type ScheduleRetrieveResponse,
   type ScheduleListParams,
+  type ScheduleRetrieveParams,
   type ScheduleListResponsesPageCursorURL,
 } from './schedules';
 export {
   ShiftInputs,
   type ShiftInput,
+  type ShiftInputListResponse,
   type ShiftInputCreateResponse,
   type ShiftInputRetrieveResponse,
   type ShiftInputUpdateResponse,
-  type ShiftInputListResponse,
+  type ShiftInputListParams,
   type ShiftInputCreateParams,
   type ShiftInputRetrieveParams,
   type ShiftInputUpdateParams,
-  type ShiftInputListParams,
   type ShiftInputListResponsesPageCursorURL,
 } from './shift-inputs';
 export {
   Shiftassignments,
-  type ShiftassignmentRetrieveResponse,
   type ShiftassignmentListResponse,
-  type ShiftassignmentRetrieveParams,
+  type ShiftassignmentRetrieveResponse,
   type ShiftassignmentListParams,
+  type ShiftassignmentRetrieveParams,
   type ShiftassignmentListResponsesPageCursorURL,
 } from './shiftassignments';
 export {
@@ -265,8 +273,8 @@ export {
   Teams,
   type Team,
   type TeamRetrieveResponse,
-  type TeamRetrieveParams,
   type TeamListParams,
+  type TeamRetrieveParams,
   type TeamsPageCursorURL,
 } from './teams';
 export {
@@ -274,21 +282,21 @@ export {
   type PayPeriod,
   type TimeCard,
   type TimeCardRetrieveResponse,
-  type TimeCardRetrieveParams,
   type TimeCardListParams,
+  type TimeCardRetrieveParams,
   type TimeCardsPageCursorURL,
 } from './time-cards';
 export {
   TimeEntries,
   type TimeEntry,
+  type TimeEntryListResponse,
   type TimeEntryCreateResponse,
   type TimeEntryRetrieveResponse,
   type TimeEntryUpdateResponse,
-  type TimeEntryListResponse,
+  type TimeEntryListParams,
   type TimeEntryCreateParams,
   type TimeEntryRetrieveParams,
   type TimeEntryUpdateParams,
-  type TimeEntryListParams,
   type TimeEntryListResponsesPageCursorURL,
 } from './time-entries';
 export {
@@ -316,7 +324,7 @@ export {
   Workers,
   type Worker,
   type WorkerRetrieveResponse,
-  type WorkerRetrieveParams,
   type WorkerListParams,
+  type WorkerRetrieveParams,
   type WorkersPageCursorURL,
 } from './workers';

package/src/resources/job-assignments.ts

@@ -11,17 +11,6 @@ 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
    *
@@ -37,6 +26,17 @@ export class JobAssignments extends APIResource {
     return this._client.getAPIList('/job-assignments', PageCursorURL<JobAssignment>, { query, ...options });
   }
 
+  /**
+   * 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 attribute change logs
    *
@@ -195,10 +195,6 @@ export interface JobAssignment {
  */
 export interface JobAssignmentRetrieveResponse extends BusinessPartnersAPI.Meta, JobAssignment {}
 
-export interface JobAssignmentRetrieveParams {
-  expand?: string;
-}
-
 export interface JobAssignmentListParams {
   expand?: string;
 
@@ -207,6 +203,10 @@ export interface JobAssignmentListParams {
   order_by?: string;
 }
 
+export interface JobAssignmentRetrieveParams {
+  expand?: string;
+}
+
 export interface JobAssignmentListChangeLogParams {
   expand?: string;
 
@@ -220,8 +220,8 @@ export declare namespace JobAssignments {
     type JobAssignmentRetrieveResponse as JobAssignmentRetrieveResponse,
     type JobAssignmentsPageCursorURL as JobAssignmentsPageCursorURL,
     type AttributeChangeDetailsPageCursorURL as AttributeChangeDetailsPageCursorURL,
-    type JobAssignmentRetrieveParams as JobAssignmentRetrieveParams,
     type JobAssignmentListParams as JobAssignmentListParams,
+    type JobAssignmentRetrieveParams as JobAssignmentRetrieveParams,
     type JobAssignmentListChangeLogParams as JobAssignmentListChangeLogParams,
   };
 }

package/src/resources/job-codes.ts

@@ -16,6 +16,22 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class JobCodes extends APIResource {
+  /**
+   * 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 });
+  }
+
   /**
    * Create a new job code
    */
@@ -41,22 +57,6 @@ export class JobCodes extends APIResource {
     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
    */
@@ -277,6 +277,14 @@ export namespace JobCodeRequest {
  */
 export interface JobCodeRetrieveResponse extends BusinessPartnersAPI.Meta, JobCode {}
 
+export interface JobCodeListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
 export interface JobCodeCreateParams {
   /**
    * The ID of the job dimension this job code belongs to.
@@ -435,14 +443,6 @@ export namespace JobCodeUpdateParams {
   }
 }
 
-export interface JobCodeListParams {
-  expand?: string;
-
-  filter?: string;
-
-  order_by?: string;
-}
-
 export interface JobCodeListChangeLogParams {
   expand?: string;
 
@@ -455,10 +455,10 @@ export declare namespace JobCodes {
     type JobCodeRequest as JobCodeRequest,
     type JobCodeRetrieveResponse as JobCodeRetrieveResponse,
     type JobCodesPageCursorURL as JobCodesPageCursorURL,
+    type JobCodeListParams as JobCodeListParams,
     type JobCodeCreateParams as JobCodeCreateParams,
     type JobCodeRetrieveParams as JobCodeRetrieveParams,
     type JobCodeUpdateParams as JobCodeUpdateParams,
-    type JobCodeListParams as JobCodeListParams,
     type JobCodeListChangeLogParams as JobCodeListChangeLogParams,
   };
 }

package/src/resources/job-dimensions.ts

@@ -9,6 +9,20 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class JobDimensions extends APIResource {
+  /**
+   * 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 });
+  }
+
   /**
    * Create a new job dimension
    */
@@ -30,20 +44,6 @@ export class JobDimensions extends APIResource {
     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
    */
@@ -132,6 +132,12 @@ export interface JobDimensionRequest {
  */
 export interface JobDimensionRetrieveResponse extends BusinessPartnersAPI.Meta, JobDimension {}
 
+export interface JobDimensionListParams {
+  filter?: string;
+
+  order_by?: string;
+}
+
 export interface JobDimensionCreateParams {
   /**
    * The name of the job dimension
@@ -182,20 +188,14 @@ export interface JobDimensionUpdateParams {
   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 JobDimensionListParams as JobDimensionListParams,
     type JobDimensionCreateParams as JobDimensionCreateParams,
     type JobDimensionUpdateParams as JobDimensionUpdateParams,
-    type JobDimensionListParams as JobDimensionListParams,
   };
 }

package/src/resources/job-functions.ts

@@ -8,17 +8,10 @@ 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`
+   * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
@@ -30,14 +23,18 @@ export class JobFunctions extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieve a specific job function
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<JobFunctionRetrieveResponse> {
+    return this._client.get(path`/job-functions/${id}`, options);
+  }
 }
 
 export type JobFunctionListResponsesPageCursorURL = PageCursorURL<JobFunctionListResponse>;
 
-/**
- * Meta information for the response.
- */
-export interface JobFunctionRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface JobFunctionListResponse {
   /**
    * Identifier field
    */
@@ -59,7 +56,10 @@ export interface JobFunctionRetrieveResponse extends BusinessPartnersAPI.Meta {
   name?: string;
 }
 
-export interface JobFunctionListResponse {
+/**
+ * Meta information for the response.
+ */
+export interface JobFunctionRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * Identifier field
    */
@@ -87,8 +87,8 @@ export interface JobFunctionListParams {
 
 export declare namespace JobFunctions {
   export {
-    type JobFunctionRetrieveResponse as JobFunctionRetrieveResponse,
     type JobFunctionListResponse as JobFunctionListResponse,
+    type JobFunctionRetrieveResponse as JobFunctionRetrieveResponse,
     type JobFunctionListResponsesPageCursorURL as JobFunctionListResponsesPageCursorURL,
     type JobFunctionListParams as JobFunctionListParams,
   };

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

@@ -11,17 +11,6 @@ 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
    *
@@ -40,6 +29,17 @@ 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 attribute change logs
    *
@@ -112,10 +112,6 @@ export interface JobPayRateException {
  */
 export interface JobPayRateExceptionRetrieveResponse extends BusinessPartnersAPI.Meta, JobPayRateException {}
 
-export interface JobPayRateExceptionRetrieveParams {
-  expand?: string;
-}
-
 export interface JobPayRateExceptionListParams {
   expand?: string;
 
@@ -124,6 +120,10 @@ export interface JobPayRateExceptionListParams {
   order_by?: string;
 }
 
+export interface JobPayRateExceptionRetrieveParams {
+  expand?: string;
+}
+
 export interface JobPayRateExceptionListChangeLogParams {
   expand?: string;
 
@@ -135,8 +135,8 @@ export declare namespace JobPayRateExceptions {
     type JobPayRateException as JobPayRateException,
     type JobPayRateExceptionRetrieveResponse as JobPayRateExceptionRetrieveResponse,
     type JobPayRateExceptionsPageCursorURL as JobPayRateExceptionsPageCursorURL,
-    type JobPayRateExceptionRetrieveParams as JobPayRateExceptionRetrieveParams,
     type JobPayRateExceptionListParams as JobPayRateExceptionListParams,
+    type JobPayRateExceptionRetrieveParams as JobPayRateExceptionRetrieveParams,
     type JobPayRateExceptionListChangeLogParams as JobPayRateExceptionListChangeLogParams,
   };
 }