@rippling/rippling-sdk 0.2.0-alpha.29 → 0.2.0-alpha.30

package/src/resources/functions/functions.ts

@@ -35,7 +35,7 @@ export class Functions extends APIResource {
   executions: ExecutionsAPI.Executions = new ExecutionsAPI.Executions(this._client);
 
   /**
-   * A List of functions
+   * A list of functions.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -48,14 +48,14 @@ export class Functions extends APIResource {
   }
 
   /**
-   * Create a new function
+   * Create a new function.
    */
   create(body: FunctionCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<Function> {
     return this._client.post('/functions/', { body, ...options });
   }
 
   /**
-   * Retrieve a specific function
+   * Retrieve a specific function.
    */
   retrieve(functionAPIName: string, options?: RequestOptions): APIPromise<Function> {
     return this._client.get(path`/functions/${functionAPIName}/`, options);
@@ -73,13 +73,14 @@ export class Functions extends APIResource {
   }
 
   /**
-   * Create a new function dev bundle
+   * Create a new function dev bundle.
    */
   createDevBundle(
     functionAPIName: string,
+    body?: FunctionCreateDevBundleParams | null | undefined,
     options?: RequestOptions,
   ): APIPromise<FunctionCreateDevBundleResponse> {
-    return this._client.post(path`/functions/${functionAPIName}/dev_bundles/`, options);
+    return this._client.post(path`/functions/${functionAPIName}/dev_bundles/`, { body, ...options });
   }
 }
 
@@ -176,11 +177,6 @@ export interface FunctionCreateParams {
 }
 
 export interface FunctionUpdateParams {
-  /**
-   * The API name of the function
-   */
-  api_name?: string;
-
   /**
    * The current draft of code for the function
    */
@@ -196,17 +192,14 @@ export interface FunctionUpdateParams {
    */
   description?: string;
 
-  /**
-   * Whether this function runs asynchronously
-   */
-  is_async?: boolean;
-
   /**
    * The function name
    */
   name?: string;
 }
 
+export interface FunctionCreateDevBundleParams {}
+
 Functions.Deployments = Deployments;
 Functions.Executions = Executions;
 
@@ -218,6 +211,7 @@ export declare namespace Functions {
     type FunctionListParams as FunctionListParams,
     type FunctionCreateParams as FunctionCreateParams,
     type FunctionUpdateParams as FunctionUpdateParams,
+    type FunctionCreateDevBundleParams as FunctionCreateDevBundleParams,
   };
 
   export {

package/src/resources/functions/index.ts

@@ -26,5 +26,6 @@ export {
   type FunctionListParams,
   type FunctionCreateParams,
   type FunctionUpdateParams,
+  type FunctionCreateDevBundleParams,
   type FunctionsPageCursorURL,
 } from './functions';

package/src/resources/headcount-positions.ts

@@ -19,7 +19,7 @@ import { path } from '../internal/utils/path';
  */
 export class HeadcountPositions extends APIResource {
   /**
-   * A List of headcount positions
+   * A list of headcount positions.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `created_at`, `position_id`, `position_type`,

package/src/resources/headcount-priorities.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class HeadcountPriorities extends APIResource {
   /**
-   * A List of headcount priorities
+   * A list of headcount priorities.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/index.ts

@@ -1,11 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './shared';
-export {
-  AssignReview,
-  type AssignReviewCreateResponse,
-  type AssignReviewCreateParams,
-} from './assign-review';
 export {
   BusinessPartnerGroups,
   type BusinessPartnerGroup,
@@ -54,16 +49,6 @@ export {
   type CompensationRetrieveParams,
   type CompensationsPageCursorURL,
 } from './compensations';
-export {
-  CreateAppNotification,
-  type CreateAppNotificationCreateResponse,
-  type CreateAppNotificationCreateParams,
-} from './create-app-notification';
-export {
-  CreateGcalEvent,
-  type CreateGcalEventCreateResponse,
-  type CreateGcalEventCreateParams,
-} from './create-gcal-event';
 export {
   CustomApps,
   type CustomAppListResponse,
@@ -108,11 +93,6 @@ export {
   type CustomSettingUpdateParams,
   type CustomSettingListResponsesPageCursorURL,
 } from './custom-settings';
-export {
-  DeleteCustomObjectRecord,
-  type DeleteCustomObjectRecordCreateResponse,
-  type DeleteCustomObjectRecordCreateParams,
-} from './delete-custom-object-record';
 export {
   Departments,
   type Department,
@@ -124,6 +104,11 @@ export {
   type DepartmentsPageCursorURL,
 } from './departments';
 export { DraftHires, type DraftHireCreateResponse, type DraftHireCreateParams } from './draft-hires';
+export {
+  EarningTypes,
+  type EarningTypeListResponse,
+  type EarningTypeListResponsesPageCursorURL,
+} from './earning-types';
 export {
   EmploymentTypes,
   type CompanyEmploymentType,
@@ -136,7 +121,6 @@ export {
   type EntitlementListResponse,
   type EntitlementListResponsesPageCursorURL,
 } from './entitlements';
-export { EvaluateRql, type EvaluateRqlCreateResponse, type EvaluateRqlCreateParams } from './evaluate-rql';
 export {
   Functions,
   type Function,
@@ -144,6 +128,7 @@ export {
   type FunctionListParams,
   type FunctionCreateParams,
   type FunctionUpdateParams,
+  type FunctionCreateDevBundleParams,
   type FunctionsPageCursorURL,
 } from './functions/functions';
 export {
@@ -309,6 +294,13 @@ export {
   type ObjectCategoryUpdateParams,
   type ObjectCategoriesPageCursorURL,
 } from './object-categories';
+export {
+  PayrollRuns,
+  type PayrollRunListResponse,
+  type PayrollRunRetrieveResponse,
+  type PayrollRunListParams,
+  type PayrollRunListResponsesPageCursorURL,
+} from './payroll-runs';
 export {
   PlatformCapabilities,
   type PlatformCapabilityListResponse,
@@ -320,7 +312,7 @@ export {
   type ReportRunRetrieveResponse,
   type ReportRunCreateParams,
 } from './report-runs';
-export { RunQuery, type RunQueryCreateResponse, type RunQueryCreateParams } from './run-query';
+export { Reports, type ReportRetrieveResponse } from './reports/reports';
 export { SSOMeResource, type SSOMe, type SSOMeListParams } from './sso-me';
 export {
   Schedules,
@@ -334,26 +326,6 @@ export {
   type ScheduleUpdateParams,
   type ScheduleListResponsesPageCursorURL,
 } from './schedules';
-export { SendEmail, type SendEmailCreateResponse, type SendEmailCreateParams } from './send-email';
-export {
-  SendHTTPRequest,
-  type SendHTTPRequestCreateResponse,
-  type SendHTTPRequestCreateParams,
-} from './send-http-request';
-export {
-  SendPushNotification,
-  type SendPushNotificationCreateResponse,
-  type SendPushNotificationCreateParams,
-} from './send-push-notification';
-export {
-  SendReportSftp,
-  type SendReportSftpCreateResponse,
-  type SendReportSftpCreateParams,
-} from './send-report-sftp';
-export { SendSMS, type SendSMSCreateResponse, type SendSMSCreateParams } from './send-sms';
-export { SendSlack, type SendSlackCreateResponse, type SendSlackCreateParams } from './send-slack';
-export { SendSurvey, type SendSurveyCreateResponse, type SendSurveyCreateParams } from './send-survey';
-export { SendTeams, type SendTeamCreateResponse, type SendTeamCreateParams } from './send-teams';
 export {
   ShiftAssignments,
   type ShiftAssignmentUpdateCustomfieldsResponse,
@@ -458,16 +430,6 @@ export {
   type UnassignedshiftUpdateParams,
   type UnassignedshiftListResponsesPageCursorURL,
 } from './unassignedshifts';
-export {
-  UpdateCustomObjectRecord,
-  type UpdateCustomObjectRecordCreateResponse,
-  type UpdateCustomObjectRecordCreateParams,
-} from './update-custom-object-record';
-export {
-  UpsertCustomObject,
-  type UpsertCustomObjectCreateResponse,
-  type UpsertCustomObjectCreateParams,
-} from './upsert-custom-object';
 export {
   Users,
   type User,
@@ -492,3 +454,8 @@ export {
   type WorkerRetrieveParams,
   type WorkersPageCursorURL,
 } from './workers';
+export {
+  WorkflowActionExecutions,
+  type WorkflowActionExecutionCreateResponse,
+  type WorkflowActionExecutionCreateParams,
+} from './workflow-action-executions';

package/src/resources/job-assignments.ts

@@ -16,7 +16,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobAssignments extends APIResource {
   /**
-   * A List of job assignments
+   * A list of job assignments.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `job_code_id`
@@ -49,7 +49,7 @@ export class JobAssignments extends APIResource {
   }
 
   /**
-   * Updated a specific job assignment
+   * Update a specific job assignment.
    */
   update(id: string, body: JobAssignmentUpdateParams, options?: RequestOptions): APIPromise<JobAssignment> {
     return this._client.patch(path`/job-assignments/${id}/`, { body, ...options });
@@ -66,7 +66,7 @@ export class JobAssignments extends APIResource {
   }
 
   /**
-   * A List of attribute change logs
+   * A list of attribute change logs.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `changed_by_worker`

package/src/resources/job-codes.ts

@@ -20,7 +20,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobCodes extends APIResource {
   /**
-   * A List of job codes
+   * A list of job codes.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `job_dimension_id`, `group_id`
@@ -54,7 +54,7 @@ export class JobCodes extends APIResource {
   }
 
   /**
-   * Updated a specific job code
+   * Update a specific job code.
    */
   update(id: string, body: JobCodeUpdateParams, options?: RequestOptions): APIPromise<JobCode> {
     return this._client.patch(path`/job-codes/${id}/`, { body, ...options });
@@ -71,7 +71,7 @@ export class JobCodes extends APIResource {
   }
 
   /**
-   * A List of attribute change logs
+   * A list of attribute change logs.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `changed_by_worker`

package/src/resources/job-dimensions.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobDimensions extends APIResource {
   /**
-   * A List of job dimensions
+   * A list of job dimensions.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `name`
@@ -41,7 +41,7 @@ export class JobDimensions extends APIResource {
   }
 
   /**
-   * Updated a specific job dimension
+   * Update a specific job dimension.
    */
   update(id: string, body: JobDimensionUpdateParams, options?: RequestOptions): APIPromise<JobDimension> {
     return this._client.patch(path`/job-dimensions/${id}/`, { body, ...options });

package/src/resources/job-functions.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobFunctions extends APIResource {
   /**
-   * A List of job functions
+   * A list of job functions.
    *
    * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`

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

@@ -15,7 +15,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobPayRateExceptions extends APIResource {
   /**
-   * A List of job pay rate exceptions
+   * A list of job pay rate exceptions.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `job_code_id`
@@ -44,7 +44,7 @@ export class JobPayRateExceptions extends APIResource {
   }
 
   /**
-   * A List of attribute change logs
+   * A list of attribute change logs.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `changed_by_worker`

package/src/resources/job-requisitions.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class JobRequisitions extends APIResource {
   /**
-   * A List of job requisitions
+   * A list of job requisitions.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/kiosk-badges.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class KioskBadges extends APIResource {
   /**
-   * A List of kiosk badges
+   * A list of kiosk badges.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `badge_id`
@@ -50,7 +50,7 @@ export class KioskBadges extends APIResource {
   }
 
   /**
-   * Updated a specific kiosk badge
+   * Update a specific kiosk badge.
    */
   update(
     id: string,

package/src/resources/leave-accruals.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class LeaveAccruals extends APIResource {
   /**
-   * A List of leave accruals
+   * A list of leave accruals.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `leave_type_id`, `accrual_date`

package/src/resources/leave-balances.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class LeaveBalances extends APIResource {
   /**
-   * A List of leave balances
+   * A list of leave balances.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `leave_type_id`

package/src/resources/leave-requests.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class LeaveRequests extends APIResource {
   /**
-   * A List of leave requests
+   * A list of leave requests.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `requester_id`, `reviewer_id`, `status`,
@@ -51,7 +51,7 @@ export class LeaveRequests extends APIResource {
   }
 
   /**
-   * Updated a specific leave request
+   * Update a specific leave request.
    */
   update(
     id: string,

package/src/resources/leave-types.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class LeaveTypes extends APIResource {
   /**
-   * A List of leave types
+   * A list of leave types.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `name`

package/src/resources/legal-entities.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class LegalEntities extends APIResource {
   /**
-   * A List of legal entities
+   * A list of legal entities.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `parent`, `company`

package/src/resources/levels.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class Levels extends APIResource {
   /**
-   * A List of levels
+   * A list of levels.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `parent`, `track`

package/src/resources/location-factors.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class LocationFactors extends APIResource {
   /**
-   * A List of location factors
+   * A list of location factors.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/metadata/components.ts

@@ -9,9 +9,9 @@ import { RequestOptions } from '../../internal/request-options';
  */
 export class Components extends APIResource {
   /**
-   * A List of metadata components
+   * A list of metadata components.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Metadata Platform API`
    */
   list(options?: RequestOptions): PagePromise<ComponentListResponsesPageCursorURL, ComponentListResponse> {
     return this._client.getAPIList('/metadata/components/', PageCursorURL<ComponentListResponse>, options);

package/src/resources/metadata/metadata.ts

@@ -19,9 +19,9 @@ export class Metadata extends APIResource {
   types: TypesAPI.Types = new TypesAPI.Types(this._client);
 
   /**
-   * A List of metadata components
+   * A list of metadata components.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Metadata Platform API`
    */
   list(options?: RequestOptions): PagePromise<MetadataListResponsesPageCursorURL, MetadataListResponse> {
     return this._client.getAPIList('/metadata/', PageCursorURL<MetadataListResponse>, options);

package/src/resources/metadata/summary.ts

@@ -9,9 +9,9 @@ import { RequestOptions } from '../../internal/request-options';
  */
 export class Summary extends APIResource {
   /**
-   * A List of metadata summary
+   * A list of metadata summary.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Metadata Platform API`
    */
   list(options?: RequestOptions): PagePromise<SummaryListResponsesPageCursorURL, SummaryListResponse> {
     return this._client.getAPIList('/metadata/summary/', PageCursorURL<SummaryListResponse>, options);

package/src/resources/metadata/types.ts

@@ -9,9 +9,9 @@ import { RequestOptions } from '../../internal/request-options';
  */
 export class Types extends APIResource {
   /**
-   * A List of metadata types
+   * A list of metadata types.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Metadata Platform API`
    */
   list(options?: RequestOptions): PagePromise<TypeListResponsesPageCursorURL, TypeListResponse> {
     return this._client.getAPIList('/metadata/types/', PageCursorURL<TypeListResponse>, options);

package/src/resources/object-categories.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class ObjectCategories extends APIResource {
   /**
-   * A List of object categories
+   * A list of object categories.
    *
    * - Requires: `API Tier 1`
    */
@@ -21,7 +21,7 @@ export class ObjectCategories extends APIResource {
   }
 
   /**
-   * Create a new object category
+   * Create a new object category.
    */
   create(
     body: ObjectCategoryCreateParams | null | undefined = {},
@@ -31,14 +31,14 @@ export class ObjectCategories extends APIResource {
   }
 
   /**
-   * Retrieve a specific object category
+   * Retrieve a specific object category.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<ObjectCategory> {
     return this._client.get(path`/object-categories/${id}/`, options);
   }
 
   /**
-   * Updated a specific object category
+   * Update a specific object category.
    */
   update(
     id: string,
@@ -49,7 +49,7 @@ export class ObjectCategories extends APIResource {
   }
 
   /**
-   * Delete a object category
+   * Delete a object category.
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/object-categories/${id}/`, {
@@ -89,14 +89,26 @@ export interface ObjectCategory {
 }
 
 export interface ObjectCategoryCreateParams {
+  /**
+   * A description of the category.
+   */
   description?: string;
 
+  /**
+   * The name of the category.
+   */
   name?: string;
 }
 
 export interface ObjectCategoryUpdateParams {
+  /**
+   * A description of the category.
+   */
   description?: string;
 
+  /**
+   * The name of the category.
+   */
   name?: string;
 }