@rippling/rippling-sdk 0.2.0-alpha.100 → 0.2.0-alpha.102

package/src/resources/device-orders.ts

@@ -19,6 +19,93 @@ export class DeviceOrders extends APIResource {
    * - Filterable fields: `worker_id`, `status`
    * - Expandable fields: `worker`
    * - Sortable fields: `id`, `created_at`, `updated_at`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /device-orders/?filter=filter&expand=expand&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {
+   *         "name": "date_of_birth",
+   *         "reason": "Insufficient entitlements"
+   *       }
+   *     ]
+   *   },
+   *   "results": [
+   *     {
+   *       "id": "string",
+   *       "created_at": "string",
+   *       "updated_at": "string",
+   *       "worker_id": "string",
+   *       "worker": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "user_id": "string",
+   *         "user": {},
+   *         "is_manager": "string",
+   *         "manager_id": "string",
+   *         "manager": {},
+   *         "legal_entity_id": "string",
+   *         "legal_entity": {},
+   *         "country": "AF",
+   *         "start_date": "string",
+   *         "end_date": "string",
+   *         "number": "string",
+   *         "work_email": "string",
+   *         "personal_email": "string",
+   *         "status": "INIT",
+   *         "location": {},
+   *         "employment_type_id": "string",
+   *         "employment_type": {},
+   *         "gender": "MALE",
+   *         "date_of_birth": "string",
+   *         "race": "BLACK",
+   *         "ethnicity": "HISPANIC_OR_LATINO",
+   *         "citizenship": "AF",
+   *         "compensation_id": "string",
+   *         "compensation": {},
+   *         "overtime_exemption": "EXEMPT",
+   *         "department_id": "string",
+   *         "department": {},
+   *         "teams_id": [],
+   *         "teams": [],
+   *         "title": "string",
+   *         "title_effective_date": "string",
+   *         "level_id": "string",
+   *         "level": {},
+   *         "job_function_id": "string",
+   *         "job_function": {},
+   *         "termination_details": {},
+   *         "pay_schedule_id": "string",
+   *         "work_schedule": {},
+   *         "compensation_grade": {},
+   *         "original_start_date": "string",
+   *         "custom_fields": [],
+   *         "country_fields": {},
+   *         "business_partners_id": [],
+   *         "business_partners": []
+   *       },
+   *       "order_type": "string",
+   *       "status": "string",
+   *       "warehouse_provider": "string",
+   *       "requested_by_id": "string",
+   *       "cancel_requested": false,
+   *       "completed_at": "string"
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     query: DeviceOrderListParams | null | undefined = {},
@@ -32,6 +119,26 @@ export class DeviceOrders extends APIResource {
 
   /**
    * Retrieve a specific device order
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /device-orders/{id}/?expand=expand HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {}
+   *     ]
+   *   }
+   * }
+   * ```
    */
   retrieve(
     id: string,

package/src/resources/devices.ts

@@ -20,6 +20,105 @@ export class Devices extends APIResource {
    *   `enrollment_status`
    * - Expandable fields: `worker`, `pending_actions`
    * - Sortable fields: `id`, `created_at`, `updated_at`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /devices/?filter=filter&expand=expand&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {
+   *         "name": "date_of_birth",
+   *         "reason": "Insufficient entitlements"
+   *       }
+   *     ]
+   *   },
+   *   "results": [
+   *     {
+   *       "id": "string",
+   *       "created_at": "string",
+   *       "updated_at": "string",
+   *       "serial_number": "string",
+   *       "worker_id": "string",
+   *       "worker": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "user_id": "string",
+   *         "user": {},
+   *         "is_manager": "string",
+   *         "manager_id": "string",
+   *         "manager": {},
+   *         "legal_entity_id": "string",
+   *         "legal_entity": {},
+   *         "country": "AF",
+   *         "start_date": "string",
+   *         "end_date": "string",
+   *         "number": "string",
+   *         "work_email": "string",
+   *         "personal_email": "string",
+   *         "status": "INIT",
+   *         "location": {},
+   *         "employment_type_id": "string",
+   *         "employment_type": {},
+   *         "gender": "MALE",
+   *         "date_of_birth": "string",
+   *         "race": "BLACK",
+   *         "ethnicity": "HISPANIC_OR_LATINO",
+   *         "citizenship": "AF",
+   *         "compensation_id": "string",
+   *         "compensation": {},
+   *         "overtime_exemption": "EXEMPT",
+   *         "department_id": "string",
+   *         "department": {},
+   *         "teams_id": [],
+   *         "teams": [],
+   *         "title": "string",
+   *         "title_effective_date": "string",
+   *         "level_id": "string",
+   *         "level": {},
+   *         "job_function_id": "string",
+   *         "job_function": {},
+   *         "termination_details": {},
+   *         "pay_schedule_id": "string",
+   *         "work_schedule": {},
+   *         "compensation_grade": {},
+   *         "original_start_date": "string",
+   *         "custom_fields": [],
+   *         "country_fields": {},
+   *         "business_partners_id": [],
+   *         "business_partners": []
+   *       },
+   *       "platform": "MACOS",
+   *       "model": "string",
+   *       "os_name": "string",
+   *       "os_version": "string",
+   *       "lifecycle_state": "INIT",
+   *       "enrollment_status": "ENROLLED",
+   *       "mdm_provider": "RIPPLING",
+   *       "is_managed": false,
+   *       "is_encrypted": false,
+   *       "last_checkin_at": "string",
+   *       "last_mdm_sync_at": "string",
+   *       "pending_actions_id": [
+   *         "string"
+   *       ],
+   *       "pending_actions": [
+   *         {}
+   *       ]
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     query: DeviceListParams | null | undefined = {},
@@ -30,6 +129,26 @@ export class Devices extends APIResource {
 
   /**
    * Retrieve a specific device
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /devices/{id}/?expand=expand HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {}
+   *     ]
+   *   }
+   * }
+   * ```
    */
   retrieve(
     id: string,

package/src/resources/draft-hires.ts

@@ -11,6 +11,49 @@ import { RequestOptions } from '../internal/request-options';
 export class DraftHires extends APIResource {
   /**
    * Create bulk draft hire
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /draft-hires/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "draft_hires": [
+   *     {
+   *       "employment_info": {
+   *         "employment_type_id": "employment_type_id",
+   *         "title": "title"
+   *       },
+   *       "personal_info": {
+   *         "invite_email": "invite_email",
+   *         "name": {}
+   *       },
+   *       "work_location_info": {}
+   *     }
+   *   ]
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "invalid_items": [],
+   *   "successful_results": [
+   *     {
+   *       "draft_hire_role_id": "string",
+   *       "status": "string",
+   *       "message": "string",
+   *       "errors": [
+   *         "string"
+   *       ]
+   *     }
+   *   ]
+   * }
+   * ```
    */
   create(body: DraftHireCreateParams, options?: RequestOptions): APIPromise<DraftHireCreateResponse> {
     return this._client.post('/draft-hires/', { body, ...options });

package/src/resources/draft-transitions.ts

@@ -12,6 +12,26 @@ import { path } from '../internal/utils/path';
 export class DraftTransitions extends APIResource {
   /**
    * Retrieve a specific draft transition
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /draft-transitions/{id}/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {}
+   *     ]
+   *   }
+   * }
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<DraftTransitionRetrieveResponse> {
     return this._client.get(path`/draft-transitions/${id}/`, options);
@@ -19,6 +39,46 @@ export class DraftTransitions extends APIResource {
 
   /**
    * Create a new draft transition
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /draft-transitions/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "effective_at": "effective_at",
+   *   "items": [
+   *     {
+   *       "changes": {},
+   *       "role_id": "role_id"
+   *     }
+   *   ],
+   *   "timezone": "timezone"
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "effective_at": "string",
+   *   "timezone": "string",
+   *   "items": [
+   *     {
+   *       "role_id": "string",
+   *       "draft_grouping_preference": "APPEND_TO_MATCHING_DRAFT",
+   *       "changes": {
+   *         "employment_info": {},
+   *         "work_location_info": {},
+   *         "country_specific_info": {}
+   *       }
+   *     }
+   *   ]
+   * }
+   * ```
    */
   create(
     body: DraftTransitionCreateParams,

package/src/resources/earning-types.ts

@@ -12,6 +12,38 @@ export class EarningTypes extends APIResource {
    * A list of earning-types.
    *
    * - Requires: `Global Payroll`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /earning-types/?limit=50&cursor=cursor HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {
+   *         "name": "date_of_birth",
+   *         "reason": "Insufficient entitlements"
+   *       }
+   *     ]
+   *   },
+   *   "results": [
+   *     {
+   *       "id": "string",
+   *       "earning_code": "string",
+   *       "display_name": "string",
+   *       "country_code": "string"
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     query: EarningTypeListParams | null | undefined = {},

package/src/resources/earnings-inputs.ts

@@ -15,6 +15,51 @@ export class EarningsInputs extends APIResource {
    * A list of earnings-inputs.
    *
    * - Requires: `Global Payroll`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /earnings-inputs/?limit=50&cursor=cursor HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {
+   *         "name": "date_of_birth",
+   *         "reason": "Insufficient entitlements"
+   *       }
+   *     ]
+   *   },
+   *   "results": [
+   *     {
+   *       "id": "string",
+   *       "run_id": "string",
+   *       "worker_id": "string",
+   *       "status": "string",
+   *       "pay_period_basis_date": "string",
+   *       "earning_code": "string",
+   *       "assignment_type": "string",
+   *       "amount": "string",
+   *       "hours": "string",
+   *       "earning_start_date": "string",
+   *       "earning_end_date": "string",
+   *       "time_labels": [
+   *         "string"
+   *       ],
+   *       "external_id": "string",
+   *       "company_entity_id": "string",
+   *       "is_overridden": false
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     query: EarningsInputListParams | null | undefined = {},
@@ -28,6 +73,41 @@ export class EarningsInputs extends APIResource {
 
   /**
    * Create a new earnings-input
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /earnings-inputs/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {}
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "string",
+   *   "run_id": "string",
+   *   "worker_id": "string",
+   *   "status": "string",
+   *   "pay_period_basis_date": "string",
+   *   "earning_code": "string",
+   *   "assignment_type": "string",
+   *   "amount": "string",
+   *   "hours": "string",
+   *   "earning_start_date": "string",
+   *   "earning_end_date": "string",
+   *   "time_labels": [
+   *     "string"
+   *   ],
+   *   "external_id": "string",
+   *   "company_entity_id": "string",
+   *   "is_overridden": false
+   * }
+   * ```
    */
   create(
     body: EarningsInputCreateParams | null | undefined = {},
@@ -38,6 +118,16 @@ export class EarningsInputs extends APIResource {
 
   /**
    * Delete a earnings-input
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * DELETE /earnings-inputs/{id}/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 204 No Content
+   * ```
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/earnings-inputs/${id}/`, {

package/src/resources/employee-documents.ts

@@ -10,6 +10,48 @@ import { RequestOptions } from '../internal/request-options';
 export class EmployeeDocuments extends APIResource {
   /**
    * Create a new employee document
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /employee-documents/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "items": [
+   *     {
+   *       "documents": [
+   *         {
+   *           "file_id": "file_id"
+   *         }
+   *       ],
+   *       "worker_id": "worker_id"
+   *     }
+   *   ]
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "string",
+   *   "created_at": "string",
+   *   "updated_at": "string",
+   *   "items": [
+   *     {
+   *       "worker_id": "string",
+   *       "documents": [
+   *         {}
+   *       ],
+   *       "folder_id": "string",
+   *       "on_invalid_folder": "fail"
+   *     }
+   *   ]
+   * }
+   * ```
    */
   create(
     body: EmployeeDocumentCreateParams,

package/src/resources/employment-types.ts

@@ -16,6 +16,42 @@ export class EmploymentTypes extends APIResource {
    *
    * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /employment-types/?order_by=order_by&limit=50&cursor=cursor HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {
+   *         "name": "date_of_birth",
+   *         "reason": "Insufficient entitlements"
+   *       }
+   *     ]
+   *   },
+   *   "results": [
+   *     {
+   *       "id": "string",
+   *       "created_at": "string",
+   *       "updated_at": "string",
+   *       "label": "string",
+   *       "name": "string",
+   *       "type": "CONTRACTOR",
+   *       "compensation_time_period": "HOURLY",
+   *       "amount_worked": "PART-TIME"
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     query: EmploymentTypeListParams | null | undefined = {},
@@ -29,6 +65,26 @@ export class EmploymentTypes extends APIResource {
 
   /**
    * Retrieve a specific employment type
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /employment-types/{id}/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {}
+   *     ]
+   *   }
+   * }
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<EmploymentTypeRetrieveResponse> {
     return this._client.get(path`/employment-types/${id}/`, options);

package/src/resources/entitlements.ts

@@ -12,6 +12,37 @@ export class Entitlements extends APIResource {
    * A list of entitlements.
    *
    * - Requires: `API Tier 1`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /entitlements/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "__meta": {
+   *     "redacted_fields": [
+   *       {
+   *         "name": "date_of_birth",
+   *         "reason": "Insufficient entitlements"
+   *       }
+   *     ]
+   *   },
+   *   "results": [
+   *     {
+   *       "id": "string",
+   *       "description": "string",
+   *       "display_name": "string"
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     options?: RequestOptions,