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

package/src/resources/functions/functions.ts

@@ -33,6 +33,19 @@ export class Functions extends APIResource {
   deployments: DeploymentsAPI.Deployments = new DeploymentsAPI.Deployments(this._client);
   executions: ExecutionsAPI.Executions = new ExecutionsAPI.Executions(this._client);
 
+  /**
+   * A List of functions
+   *
+   * - Requires: `API Tier 2`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: FunctionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<FunctionsPageCursorURL, Function> {
+    return this._client.getAPIList('/functions/', PageCursorURL<Function>, { query, ...options });
+  }
+
   /**
    * Create a new function
    */
@@ -58,19 +71,6 @@ export class Functions extends APIResource {
     return this._client.patch(path`/functions/${functionAPIName}/`, { body, ...options });
   }
 
-  /**
-   * A List of functions
-   *
-   * - Requires: `Functions API`
-   * - Sortable fields: `id`, `created_at`, `updated_at`
-   */
-  list(
-    query: FunctionListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<FunctionsPageCursorURL, Function> {
-    return this._client.getAPIList('/functions/', PageCursorURL<Function>, { query, ...options });
-  }
-
   /**
    * Create a new function dev bundle
    */
@@ -133,6 +133,10 @@ export interface FunctionCreateDevBundleResponse {
   contents?: string;
 }
 
+export interface FunctionListParams {
+  order_by?: string;
+}
+
 export interface FunctionCreateParams {
   /**
    * The API name of the function
@@ -187,10 +191,6 @@ export interface FunctionUpdateParams {
   name?: string;
 }
 
-export interface FunctionListParams {
-  order_by?: string;
-}
-
 Functions.Deployments = Deployments;
 Functions.Executions = Executions;
 
@@ -199,9 +199,9 @@ export declare namespace Functions {
     type Function as Function,
     type FunctionCreateDevBundleResponse as FunctionCreateDevBundleResponse,
     type FunctionsPageCursorURL as FunctionsPageCursorURL,
+    type FunctionListParams as FunctionListParams,
     type FunctionCreateParams as FunctionCreateParams,
     type FunctionUpdateParams as FunctionUpdateParams,
-    type FunctionListParams as FunctionListParams,
   };
 
   export {
@@ -216,14 +216,14 @@ export declare namespace Functions {
 
   export {
     Executions as Executions,
+    type ExecutionListResponse as ExecutionListResponse,
     type ExecutionCreateResponse as ExecutionCreateResponse,
     type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
-    type ExecutionListResponse as ExecutionListResponse,
     type ExecutionListLogsResponse as ExecutionListLogsResponse,
     type ExecutionListResponsesPageCursorURL as ExecutionListResponsesPageCursorURL,
+    type ExecutionListParams as ExecutionListParams,
     type ExecutionCreateParams as ExecutionCreateParams,
     type ExecutionRetrieveParams as ExecutionRetrieveParams,
-    type ExecutionListParams as ExecutionListParams,
     type ExecutionListLogsParams as ExecutionListLogsParams,
   };
 }

package/src/resources/functions/index.ts

@@ -11,13 +11,13 @@ export {
 } from './deployments';
 export {
   Executions,
+  type ExecutionListResponse,
   type ExecutionCreateResponse,
   type ExecutionRetrieveResponse,
-  type ExecutionListResponse,
   type ExecutionListLogsResponse,
+  type ExecutionListParams,
   type ExecutionCreateParams,
   type ExecutionRetrieveParams,
-  type ExecutionListParams,
   type ExecutionListLogsParams,
   type ExecutionListResponsesPageCursorURL,
 } from './executions';
@@ -25,8 +25,8 @@ export {
   Functions,
   type Function,
   type FunctionCreateDevBundleResponse,
+  type FunctionListParams,
   type FunctionCreateParams,
   type FunctionUpdateParams,
-  type FunctionListParams,
   type FunctionsPageCursorURL,
 } from './functions';

package/src/resources/headcount-positions.ts

@@ -15,21 +15,10 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class HeadcountPositions extends APIResource {
-  /**
-   * Retrieve a specific headcount position
-   */
-  retrieve(
-    id: string,
-    query: HeadcountPositionRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<HeadcountPositionRetrieveResponse> {
-    return this._client.get(path`/headcount-positions/${id}`, { query, ...options });
-  }
-
   /**
    * A List of headcount positions
    *
-   * - Requires: `Internal Testing`
+   * - Requires: `API Tier 2`
    * - Filterable fields: `created_at`, `position_id`, `position_type`,
    *   `position_sub_type`, `department_id`, `work_location_id`, `level_id`,
    *   `teams_id`, `job_requisition_id`, `recruiter_id`, `headcount_owner_id`,
@@ -53,14 +42,22 @@ export class HeadcountPositions extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieve a specific headcount position
+   */
+  retrieve(
+    id: string,
+    query: HeadcountPositionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<HeadcountPositionRetrieveResponse> {
+    return this._client.get(path`/headcount-positions/${id}`, { query, ...options });
+  }
 }
 
 export type HeadcountPositionListResponsesPageCursorURL = PageCursorURL<HeadcountPositionListResponse>;
 
-/**
- * Meta information for the response.
- */
-export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface HeadcountPositionListResponse {
   /**
    * Identifier field
    */
@@ -79,7 +76,7 @@ export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.M
   /**
    * Compensation data synched from worker compensation
    */
-  actual_compensation?: HeadcountPositionRetrieveResponse.ActualCompensation;
+  actual_compensation?: HeadcountPositionListResponse.ActualCompensation;
 
   /**
    * Worker for whom this headcount position was requested as a backfill
@@ -96,7 +93,7 @@ export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.M
   /**
    * Compensation data defined through comp band
    */
-  comp_band_compensation?: HeadcountPositionRetrieveResponse.CompBandCompensation;
+  comp_band_compensation?: HeadcountPositionListResponse.CompBandCompensation;
 
   /**
    * Most recent start date estimate or the actual hire date if already filled
@@ -154,7 +151,7 @@ export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.M
    *
    * Expandable field
    */
-  job_function?: HeadcountPositionRetrieveResponse.JobFunction;
+  job_function?: HeadcountPositionListResponse.JobFunction;
 
   /**
    * ID for the job function the headcount is assigned to
@@ -190,7 +187,7 @@ export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.M
    *
    * Expandable field
    */
-  location_factor?: HeadcountPositionRetrieveResponse.LocationFactor;
+  location_factor?: HeadcountPositionListResponse.LocationFactor;
 
   /**
    * ID for the location factor the headcount is assigned to
@@ -208,22 +205,46 @@ export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.M
   position_id?: string;
 
   /**
-   * More granular type of headcount position, such as BACKFILL,
-   * FORECASTED_ATTRITION, HIRING_STAGE, etc.
-   */
-  position_sub_type?: string;
-
-  /**
-   * Type of headcount position, such as ACTIVE or OPEN_HEADCOUNT
-   */
-  position_type?: string;
+   * More granular classification of headcount position type. `NEW` New headcount
+   * created, typically paired with the OPEN_HEADCOUNT type. `BACKFILL` Replacement
+   * headcount for someone who left the company. `FORECASTED_ATTRITION` Headcount
+   * that does not count toward the budget, also known as provisional position in the
+   * application, `HIRING_STAGE` Person is going through the hiring process, paired
+   * with the FUTURE_START type. `OFFER_STAGE` Offer has been extended to a
+   * candidate, awaiting their decision. Paired with the FUTURE_START type.
+   * `OFFER_ACCEPTED` Candidate has accepted the offer but has not yet started.
+   * Paired with the FUTURE_START type. `PLAN_CHANGE` Headcount status changed due to
+   * business decision. Paired with CLOSED type. `TERMINATED` Role was filled, but
+   * the employee was separated from the company. Paired with CLOSED type.
+   * `TRANSFERRED` Employee moved internally to another role. Paired with CLOSED
+   * type.
+   */
+  position_sub_type?:
+    | 'NEW'
+    | 'BACKFILL'
+    | 'FORECASTED_ATTRITION'
+    | 'HIRING_STAGE'
+    | 'OFFER_STAGE'
+    | 'OFFER_ACCEPTED'
+    | 'PLAN_CHANGE'
+    | 'TERMINATED'
+    | 'TRANSFERRED';
+
+  /**
+   * Type of headcount position. `OPEN_HEADCOUNT` A headcount position that's not yet
+   * filled. `FUTURE_START` Headcount where a candidate is going through the hiring
+   * process, or an offer has been accepted, but the person has not yet started.
+   * `ACTIVE` Headcount where a candidate has been hired and started. `CLOSED`
+   * Headcount that's no longer available to fill.
+   */
+  position_type?: 'OPEN_HEADCOUNT' | 'FUTURE_START' | 'ACTIVE' | 'CLOSED';
 
   /**
    * Priority assigned to this headcount
    *
    * Expandable field
    */
-  priority?: HeadcountPositionRetrieveResponse.Priority;
+  priority?: HeadcountPositionListResponse.Priority;
 
   /**
    * ID for the headcount priority
@@ -291,7 +312,7 @@ export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.M
   worker_id?: string;
 }
 
-export namespace HeadcountPositionRetrieveResponse {
+export namespace HeadcountPositionListResponse {
   /**
    * Compensation data synched from worker compensation
    */
@@ -825,6 +846,7 @@ export namespace HeadcountPositionRetrieveResponse {
         | 'SL'
         | 'SG'
         | 'SX'
+        | 'SY'
         | 'SK'
         | 'SI'
         | 'SB'
@@ -902,7 +924,10 @@ export namespace HeadcountPositionRetrieveResponse {
   }
 }
 
-export interface HeadcountPositionListResponse {
+/**
+ * Meta information for the response.
+ */
+export interface HeadcountPositionRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * Identifier field
    */
@@ -921,7 +946,7 @@ export interface HeadcountPositionListResponse {
   /**
    * Compensation data synched from worker compensation
    */
-  actual_compensation?: HeadcountPositionListResponse.ActualCompensation;
+  actual_compensation?: HeadcountPositionRetrieveResponse.ActualCompensation;
 
   /**
    * Worker for whom this headcount position was requested as a backfill
@@ -938,7 +963,7 @@ export interface HeadcountPositionListResponse {
   /**
    * Compensation data defined through comp band
    */
-  comp_band_compensation?: HeadcountPositionListResponse.CompBandCompensation;
+  comp_band_compensation?: HeadcountPositionRetrieveResponse.CompBandCompensation;
 
   /**
    * Most recent start date estimate or the actual hire date if already filled
@@ -996,7 +1021,7 @@ export interface HeadcountPositionListResponse {
    *
    * Expandable field
    */
-  job_function?: HeadcountPositionListResponse.JobFunction;
+  job_function?: HeadcountPositionRetrieveResponse.JobFunction;
 
   /**
    * ID for the job function the headcount is assigned to
@@ -1032,7 +1057,7 @@ export interface HeadcountPositionListResponse {
    *
    * Expandable field
    */
-  location_factor?: HeadcountPositionListResponse.LocationFactor;
+  location_factor?: HeadcountPositionRetrieveResponse.LocationFactor;
 
   /**
    * ID for the location factor the headcount is assigned to
@@ -1050,22 +1075,46 @@ export interface HeadcountPositionListResponse {
   position_id?: string;
 
   /**
-   * More granular type of headcount position, such as BACKFILL,
-   * FORECASTED_ATTRITION, HIRING_STAGE, etc.
-   */
-  position_sub_type?: string;
-
-  /**
-   * Type of headcount position, such as ACTIVE or OPEN_HEADCOUNT
-   */
-  position_type?: string;
+   * More granular classification of headcount position type. `NEW` New headcount
+   * created, typically paired with the OPEN_HEADCOUNT type. `BACKFILL` Replacement
+   * headcount for someone who left the company. `FORECASTED_ATTRITION` Headcount
+   * that does not count toward the budget, also known as provisional position in the
+   * application, `HIRING_STAGE` Person is going through the hiring process, paired
+   * with the FUTURE_START type. `OFFER_STAGE` Offer has been extended to a
+   * candidate, awaiting their decision. Paired with the FUTURE_START type.
+   * `OFFER_ACCEPTED` Candidate has accepted the offer but has not yet started.
+   * Paired with the FUTURE_START type. `PLAN_CHANGE` Headcount status changed due to
+   * business decision. Paired with CLOSED type. `TERMINATED` Role was filled, but
+   * the employee was separated from the company. Paired with CLOSED type.
+   * `TRANSFERRED` Employee moved internally to another role. Paired with CLOSED
+   * type.
+   */
+  position_sub_type?:
+    | 'NEW'
+    | 'BACKFILL'
+    | 'FORECASTED_ATTRITION'
+    | 'HIRING_STAGE'
+    | 'OFFER_STAGE'
+    | 'OFFER_ACCEPTED'
+    | 'PLAN_CHANGE'
+    | 'TERMINATED'
+    | 'TRANSFERRED';
+
+  /**
+   * Type of headcount position. `OPEN_HEADCOUNT` A headcount position that's not yet
+   * filled. `FUTURE_START` Headcount where a candidate is going through the hiring
+   * process, or an offer has been accepted, but the person has not yet started.
+   * `ACTIVE` Headcount where a candidate has been hired and started. `CLOSED`
+   * Headcount that's no longer available to fill.
+   */
+  position_type?: 'OPEN_HEADCOUNT' | 'FUTURE_START' | 'ACTIVE' | 'CLOSED';
 
   /**
    * Priority assigned to this headcount
    *
    * Expandable field
    */
-  priority?: HeadcountPositionListResponse.Priority;
+  priority?: HeadcountPositionRetrieveResponse.Priority;
 
   /**
    * ID for the headcount priority
@@ -1133,7 +1182,7 @@ export interface HeadcountPositionListResponse {
   worker_id?: string;
 }
 
-export namespace HeadcountPositionListResponse {
+export namespace HeadcountPositionRetrieveResponse {
   /**
    * Compensation data synched from worker compensation
    */
@@ -1667,6 +1716,7 @@ export namespace HeadcountPositionListResponse {
         | 'SL'
         | 'SG'
         | 'SX'
+        | 'SY'
         | 'SK'
         | 'SI'
         | 'SB'
@@ -1744,10 +1794,6 @@ export namespace HeadcountPositionListResponse {
   }
 }
 
-export interface HeadcountPositionRetrieveParams {
-  expand?: string;
-}
-
 export interface HeadcountPositionListParams {
   expand?: string;
 
@@ -1756,12 +1802,16 @@ export interface HeadcountPositionListParams {
   order_by?: string;
 }
 
+export interface HeadcountPositionRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace HeadcountPositions {
   export {
-    type HeadcountPositionRetrieveResponse as HeadcountPositionRetrieveResponse,
     type HeadcountPositionListResponse as HeadcountPositionListResponse,
+    type HeadcountPositionRetrieveResponse as HeadcountPositionRetrieveResponse,
     type HeadcountPositionListResponsesPageCursorURL as HeadcountPositionListResponsesPageCursorURL,
-    type HeadcountPositionRetrieveParams as HeadcountPositionRetrieveParams,
     type HeadcountPositionListParams as HeadcountPositionListParams,
+    type HeadcountPositionRetrieveParams as HeadcountPositionRetrieveParams,
   };
 }

package/src/resources/headcount-priorities.ts

@@ -8,17 +8,10 @@ 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`
+   * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
@@ -30,14 +23,18 @@ export class HeadcountPriorities extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieve a specific headcount priority
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<HeadcountPriorityRetrieveResponse> {
+    return this._client.get(path`/headcount-priorities/${id}`, options);
+  }
 }
 
 export type HeadcountPriorityListResponsesPageCursorURL = PageCursorURL<HeadcountPriorityListResponse>;
 
-/**
- * Meta information for the response.
- */
-export interface HeadcountPriorityRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface HeadcountPriorityListResponse {
   /**
    * Identifier field
    */
@@ -59,7 +56,10 @@ export interface HeadcountPriorityRetrieveResponse extends BusinessPartnersAPI.M
   name?: string;
 }
 
-export interface HeadcountPriorityListResponse {
+/**
+ * Meta information for the response.
+ */
+export interface HeadcountPriorityRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * Identifier field
    */
@@ -87,8 +87,8 @@ export interface HeadcountPriorityListParams {
 
 export declare namespace HeadcountPriorities {
   export {
-    type HeadcountPriorityRetrieveResponse as HeadcountPriorityRetrieveResponse,
     type HeadcountPriorityListResponse as HeadcountPriorityListResponse,
+    type HeadcountPriorityRetrieveResponse as HeadcountPriorityRetrieveResponse,
     type HeadcountPriorityListResponsesPageCursorURL as HeadcountPriorityListResponsesPageCursorURL,
     type HeadcountPriorityListParams as HeadcountPriorityListParams,
   };