@rippling/rippling-sdk 0.2.0-alpha.26 → 0.2.0-alpha.28

package/src/resources/custom-pages.ts

@@ -0,0 +1,247 @@
+// 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 CustomPages extends APIResource {
+  /**
+   * A List of CustomPage
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<CustomPageListResponsesPageCursorURL, CustomPageListResponse> {
+    return this._client.getAPIList('/custom-pages/', PageCursorURL<CustomPageListResponse>, options);
+  }
+
+  /**
+   * Create a new CustomPage
+   */
+  create(
+    body: CustomPageCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomPageCreateResponse> {
+    return this._client.post('/custom-pages/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific CustomPage
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<CustomPageRetrieveResponse> {
+    return this._client.get(path`/custom-pages/${id}/`, options);
+  }
+
+  /**
+   * Updated a specific CustomPage
+   */
+  update(
+    id: string,
+    body: CustomPageUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomPageUpdateResponse> {
+    return this._client.patch(path`/custom-pages/${id}/`, { body, ...options });
+  }
+
+  /**
+   * Delete a CustomPage
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/custom-pages/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type CustomPageListResponsesPageCursorURL = PageCursorURL<CustomPageListResponse>;
+
+export interface CustomPageListResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the page
+   */
+  created_by?: string;
+
+  /**
+   * The ID of the Rippling Function that renders this page
+   */
+  function_id?: string;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+
+  /**
+   * The ID of the role that last modified the page
+   */
+  updated_by?: string;
+}
+
+export interface CustomPageCreateResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the page
+   */
+  created_by?: string;
+
+  /**
+   * The ID of the Rippling Function that renders this page
+   */
+  function_id?: string;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+
+  /**
+   * The ID of the role that last modified the page
+   */
+  updated_by?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface CustomPageRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the page
+   */
+  created_by?: string;
+
+  /**
+   * The ID of the Rippling Function that renders this page
+   */
+  function_id?: string;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+
+  /**
+   * The ID of the role that last modified the page
+   */
+  updated_by?: string;
+}
+
+export interface CustomPageUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the page
+   */
+  created_by?: string;
+
+  /**
+   * The ID of the Rippling Function that renders this page
+   */
+  function_id?: string;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+
+  /**
+   * Record update date
+   */
+  updated_at?: string;
+
+  /**
+   * The ID of the role that last modified the page
+   */
+  updated_by?: string;
+}
+
+export interface CustomPageCreateParams {
+  /**
+   * The ID of the Rippling Function that renders this page
+   */
+  function_id?: string;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+}
+
+export interface CustomPageUpdateParams {
+  /**
+   * The ID of the Rippling Function that renders this page
+   */
+  function_id?: string;
+
+  /**
+   * The display name of the custom page
+   */
+  name?: string;
+}
+
+export declare namespace CustomPages {
+  export {
+    type CustomPageListResponse as CustomPageListResponse,
+    type CustomPageCreateResponse as CustomPageCreateResponse,
+    type CustomPageRetrieveResponse as CustomPageRetrieveResponse,
+    type CustomPageUpdateResponse as CustomPageUpdateResponse,
+    type CustomPageListResponsesPageCursorURL as CustomPageListResponsesPageCursorURL,
+    type CustomPageCreateParams as CustomPageCreateParams,
+    type CustomPageUpdateParams as CustomPageUpdateParams,
+  };
+}

package/src/resources/custom-settings.ts

@@ -19,7 +19,7 @@ export class CustomSettings extends APIResource {
     query: CustomSettingListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CustomSettingListResponsesPageCursorURL, CustomSettingListResponse> {
-    return this._client.getAPIList('/custom-settings', PageCursorURL<CustomSettingListResponse>, {
+    return this._client.getAPIList('/custom-settings/', PageCursorURL<CustomSettingListResponse>, {
       query,
       ...options,
     });
@@ -32,14 +32,14 @@ export class CustomSettings extends APIResource {
     body: CustomSettingCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CustomSettingCreateResponse> {
-    return this._client.post('/custom-settings', { body, ...options });
+    return this._client.post('/custom-settings/', { body, ...options });
   }
 
   /**
    * Retrieve a specific Setting
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<CustomSettingRetrieveResponse> {
-    return this._client.get(path`/custom-settings/${id}`, options);
+    return this._client.get(path`/custom-settings/${id}/`, options);
   }
 
   /**
@@ -50,14 +50,14 @@ export class CustomSettings extends APIResource {
     body: CustomSettingUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<CustomSettingUpdateResponse> {
-    return this._client.patch(path`/custom-settings/${id}`, { body, ...options });
+    return this._client.patch(path`/custom-settings/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a Setting
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/custom-settings/${id}`, {
+    return this._client.delete(path`/custom-settings/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

package/src/resources/departments.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Departments used by the company
+ */
 export class Departments extends APIResource {
   /**
    * A List of departments
@@ -19,14 +22,14 @@ export class Departments extends APIResource {
     query: DepartmentListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<DepartmentsPageCursorURL, Department> {
-    return this._client.getAPIList('/departments', PageCursorURL<Department>, { query, ...options });
+    return this._client.getAPIList('/departments/', PageCursorURL<Department>, { query, ...options });
   }
 
   /**
    * Create a new department
    */
   create(body: DepartmentCreateParams, options?: RequestOptions): APIPromise<Department> {
-    return this._client.post('/departments', { body, ...options });
+    return this._client.post('/departments/', { body, ...options });
   }
 
   /**
@@ -37,14 +40,14 @@ export class Departments extends APIResource {
     query: DepartmentRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<DepartmentRetrieveResponse> {
-    return this._client.get(path`/departments/${id}`, { query, ...options });
+    return this._client.get(path`/departments/${id}/`, { query, ...options });
   }
 
   /**
    * Updated a specific department
    */
   update(id: string, body: DepartmentUpdateParams, options?: RequestOptions): APIPromise<Department> {
-    return this._client.patch(path`/departments/${id}`, { body, ...options });
+    return this._client.patch(path`/departments/${id}/`, { body, ...options });
   }
 }
 

package/src/resources/draft-hires.ts

@@ -5,6 +5,9 @@ import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Candidates who have not yet started work at the company
+ */
 export class DraftHires extends APIResource {
   /**
    * Create bulk draft hire

package/src/resources/employment-types.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Employment types used by the company
+ */
 export class EmploymentTypes extends APIResource {
   /**
    * A List of employment types
@@ -18,7 +21,7 @@ export class EmploymentTypes extends APIResource {
     query: EmploymentTypeListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CompanyEmploymentTypesPageCursorURL, CompanyEmploymentType> {
-    return this._client.getAPIList('/employment-types', PageCursorURL<CompanyEmploymentType>, {
+    return this._client.getAPIList('/employment-types/', PageCursorURL<CompanyEmploymentType>, {
       query,
       ...options,
     });
@@ -28,7 +31,7 @@ export class EmploymentTypes extends APIResource {
    * Retrieve a specific employment type
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<EmploymentTypeRetrieveResponse> {
-    return this._client.get(path`/employment-types/${id}`, options);
+    return this._client.get(path`/employment-types/${id}/`, options);
   }
 }
 

package/src/resources/entitlements.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Availability of API features to the company or Partners.
+ */
 export class Entitlements extends APIResource {
   /**
    * A List of entitlements
@@ -13,7 +16,7 @@ export class Entitlements extends APIResource {
   list(
     options?: RequestOptions,
   ): PagePromise<EntitlementListResponsesPageCursorURL, EntitlementListResponse> {
-    return this._client.getAPIList('/entitlements', PageCursorURL<EntitlementListResponse>, options);
+    return this._client.getAPIList('/entitlements/', PageCursorURL<EntitlementListResponse>, options);
   }
 }
 

package/src/resources/functions/deployments.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Deployments extends APIResource {
   /**
    * A List of function deployments

package/src/resources/functions/executions.ts

@@ -6,6 +6,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Executions extends APIResource {
   /**
    * A List of function executions

package/src/resources/functions/functions.ts

@@ -27,6 +27,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Functions extends APIResource {
   deployments: DeploymentsAPI.Deployments = new DeploymentsAPI.Deployments(this._client);
   executions: ExecutionsAPI.Executions = new ExecutionsAPI.Executions(this._client);
@@ -118,6 +121,11 @@ export interface Function {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */
@@ -156,6 +164,11 @@ export interface FunctionCreateParams {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */
@@ -183,6 +196,11 @@ export interface FunctionUpdateParams {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */

package/src/resources/headcount-positions.ts

@@ -14,6 +14,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Headcount allocations for the company
+ */
 export class HeadcountPositions extends APIResource {
   /**
    * A List of headcount positions
@@ -37,7 +40,7 @@ export class HeadcountPositions extends APIResource {
     query: HeadcountPositionListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<HeadcountPositionListResponsesPageCursorURL, HeadcountPositionListResponse> {
-    return this._client.getAPIList('/headcount-positions', PageCursorURL<HeadcountPositionListResponse>, {
+    return this._client.getAPIList('/headcount-positions/', PageCursorURL<HeadcountPositionListResponse>, {
       query,
       ...options,
     });
@@ -51,7 +54,7 @@ export class HeadcountPositions extends APIResource {
     query: HeadcountPositionRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<HeadcountPositionRetrieveResponse> {
-    return this._client.get(path`/headcount-positions/${id}`, { query, ...options });
+    return this._client.get(path`/headcount-positions/${id}/`, { query, ...options });
   }
 }
 

package/src/resources/headcount-priorities.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Organizational classifications used to categorize hiring needs based on business urgency and strategic importance
+ */
 export class HeadcountPriorities extends APIResource {
   /**
    * A List of headcount priorities
@@ -18,7 +21,7 @@ export class HeadcountPriorities extends APIResource {
     query: HeadcountPriorityListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<HeadcountPriorityListResponsesPageCursorURL, HeadcountPriorityListResponse> {
-    return this._client.getAPIList('/headcount-priorities', PageCursorURL<HeadcountPriorityListResponse>, {
+    return this._client.getAPIList('/headcount-priorities/', PageCursorURL<HeadcountPriorityListResponse>, {
       query,
       ...options,
     });
@@ -28,7 +31,7 @@ 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);
+    return this._client.get(path`/headcount-priorities/${id}/`, options);
   }
 }
 

package/src/resources/index.ts

@@ -49,6 +49,21 @@ export {
   type CompensationRetrieveParams,
   type CompensationsPageCursorURL,
 } from './compensations';
+export {
+  CreateAppNotification,
+  type CreateAppNotificationCreateResponse,
+  type CreateAppNotificationCreateParams,
+} from './create-app-notification';
+export {
+  CustomApps,
+  type CustomAppListResponse,
+  type CustomAppCreateResponse,
+  type CustomAppRetrieveResponse,
+  type CustomAppUpdateResponse,
+  type CustomAppCreateParams,
+  type CustomAppUpdateParams,
+  type CustomAppListResponsesPageCursorURL,
+} from './custom-apps';
 export {
   CustomFields,
   type CustomFieldListResponse,
@@ -62,6 +77,16 @@ export {
   type CustomObjectUpdateParams,
   type CustomObjectsPageCursorURL,
 } from './custom-objects/custom-objects';
+export {
+  CustomPages,
+  type CustomPageListResponse,
+  type CustomPageCreateResponse,
+  type CustomPageRetrieveResponse,
+  type CustomPageUpdateResponse,
+  type CustomPageCreateParams,
+  type CustomPageUpdateParams,
+  type CustomPageListResponsesPageCursorURL,
+} from './custom-pages';
 export {
   CustomSettings,
   type CustomSettingListResponse,
@@ -256,6 +281,11 @@ export {
   type LocationFactorListParams,
   type LocationFactorListResponsesPageCursorURL,
 } from './location-factors';
+export {
+  Metadata,
+  type MetadataListResponse,
+  type MetadataListResponsesPageCursorURL,
+} from './metadata/metadata';
 export {
   ObjectCategories,
   type ObjectCategory,
@@ -263,13 +293,19 @@ export {
   type ObjectCategoryUpdateParams,
   type ObjectCategoriesPageCursorURL,
 } from './object-categories';
+export {
+  PlatformCapabilities,
+  type PlatformCapabilityListResponse,
+  type PlatformCapabilityListResponsesPageCursorURL,
+} from './platform-capabilities';
 export {
   ReportRuns,
   type ReportRunCreateResponse,
   type ReportRunRetrieveResponse,
   type ReportRunCreateParams,
 } from './report-runs';
-export { SSOMeResource, type SSOMe, type SSOMeRetrieveParams } from './sso-me';
+export { RunQuery, type RunQueryCreateResponse, type RunQueryCreateParams } from './run-query';
+export { SSOMeResource, type SSOMe, type SSOMeListParams } from './sso-me';
 export {
   Schedules,
   type ScheduleListResponse,
@@ -282,6 +318,8 @@ export {
   type ScheduleUpdateParams,
   type ScheduleListResponsesPageCursorURL,
 } from './schedules';
+export { SendEmail, type SendEmailCreateResponse, type SendEmailCreateParams } from './send-email';
+export { SendSlack, type SendSlackCreateResponse, type SendSlackCreateParams } from './send-slack';
 export {
   ShiftAssignments,
   type ShiftAssignmentUpdateCustomfieldsResponse,

package/src/resources/job-assignments.ts

@@ -11,6 +11,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobAssignments extends APIResource {
   /**
    * A List of job assignments
@@ -24,14 +27,14 @@ export class JobAssignments extends APIResource {
     query: JobAssignmentListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<JobAssignmentsPageCursorURL, JobAssignment> {
-    return this._client.getAPIList('/job-assignments', PageCursorURL<JobAssignment>, { query, ...options });
+    return this._client.getAPIList('/job-assignments/', PageCursorURL<JobAssignment>, { query, ...options });
   }
 
   /**
    * Create a new job assignment
    */
   create(body: JobAssignmentCreateParams, options?: RequestOptions): APIPromise<JobAssignment> {
-    return this._client.post('/job-assignments', { body, ...options });
+    return this._client.post('/job-assignments/', { body, ...options });
   }
 
   /**
@@ -42,21 +45,21 @@ export class JobAssignments extends APIResource {
     query: JobAssignmentRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<JobAssignmentRetrieveResponse> {
-    return this._client.get(path`/job-assignments/${id}`, { query, ...options });
+    return this._client.get(path`/job-assignments/${id}/`, { query, ...options });
   }
 
   /**
    * Updated a specific job assignment
    */
   update(id: string, body: JobAssignmentUpdateParams, options?: RequestOptions): APIPromise<JobAssignment> {
-    return this._client.patch(path`/job-assignments/${id}`, { body, ...options });
+    return this._client.patch(path`/job-assignments/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a job assignment
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/job-assignments/${id}`, {
+    return this._client.delete(path`/job-assignments/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -75,7 +78,7 @@ export class JobAssignments extends APIResource {
     options?: RequestOptions,
   ): PagePromise<AttributeChangeDetailsPageCursorURL, AttributeChangeDetails> {
     return this._client.getAPIList(
-      path`/job-assignments/${jobAssignmentID}/change-log`,
+      path`/job-assignments/${jobAssignmentID}/change-log/`,
       PageCursorURL<AttributeChangeDetails>,
       { query, ...options },
     );