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

package/src/resources/time-entries.ts

@@ -22,6 +22,137 @@ export class TimeEntries extends APIResource {
    *   `updated_at`
    * - Expandable fields: `worker`, `time_card`
    * - Sortable fields: `id`, `created_at`, `updated_at`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /time-entries/?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": []
+   *       },
+   *       "start_time": "string",
+   *       "end_time": "string",
+   *       "comments": [
+   *         {}
+   *       ],
+   *       "job_shifts": [
+   *         {}
+   *       ],
+   *       "breaks": [
+   *         {}
+   *       ],
+   *       "premiums": [
+   *         {}
+   *       ],
+   *       "piece_rate_premiums": [
+   *         {}
+   *       ],
+   *       "segments": [
+   *         {}
+   *       ],
+   *       "time_entry_summary": {
+   *         "over_time_hours": "string",
+   *         "double_over_time_hours": "string",
+   *         "regular_hours": "string",
+   *         "duration": "string"
+   *       },
+   *       "time_card_id": "string",
+   *       "time_card": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "worker_id": "string",
+   *         "worker": {},
+   *         "pay_period": {},
+   *         "summary": {}
+   *       },
+   *       "tags": [
+   *         "string"
+   *       ],
+   *       "idempotency_key": "string",
+   *       "create_extra_hours_run": false,
+   *       "status": "DRAFT",
+   *       "pay_period": {
+   *         "start_date": "string",
+   *         "end_date": "string",
+   *         "pay_schedule_id": "string"
+   *       },
+   *       "shift_input_values": [
+   *         {}
+   *       ]
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     query: TimeEntryListParams | null | undefined = {},
@@ -35,6 +166,211 @@ export class TimeEntries extends APIResource {
 
   /**
    * Create a new time entry
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /time-entries/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "worker_id": "worker_id"
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "string",
+   *   "created_at": "string",
+   *   "updated_at": "string",
+   *   "worker_id": "string",
+   *   "worker": {
+   *     "id": "string",
+   *     "created_at": "string",
+   *     "updated_at": "string"
+   *   },
+   *   "start_time": "string",
+   *   "end_time": "string",
+   *   "comments": [
+   *     {}
+   *   ],
+   *   "job_shifts": [
+   *     {}
+   *   ],
+   *   "breaks": [
+   *     {}
+   *   ],
+   *   "premiums": [
+   *     {}
+   *   ],
+   *   "piece_rate_premiums": [
+   *     {}
+   *   ],
+   *   "segments": [
+   *     {}
+   *   ],
+   *   "time_entry_summary": {},
+   *   "time_card_id": "string",
+   *   "time_card": {
+   *     "id": "string",
+   *     "created_at": "string",
+   *     "updated_at": "string",
+   *     "worker_id": "string",
+   *     "worker": {
+   *       "id": "string",
+   *       "created_at": "string",
+   *       "updated_at": "string",
+   *       "user_id": "string",
+   *       "user": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string"
+   *       },
+   *       "is_manager": false,
+   *       "manager_id": "string",
+   *       "manager": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string"
+   *       },
+   *       "legal_entity_id": "string",
+   *       "legal_entity": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string"
+   *       },
+   *       "country": "AF",
+   *       "start_date": "string",
+   *       "end_date": "string",
+   *       "number": 0,
+   *       "work_email": "string",
+   *       "personal_email": "string",
+   *       "status": "INIT",
+   *       "location": {
+   *         "type": "REMOTE",
+   *         "work_location_id": "string"
+   *       },
+   *       "employment_type_id": "string",
+   *       "employment_type": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "label": "string"
+   *       },
+   *       "gender": "MALE",
+   *       "date_of_birth": "string",
+   *       "race": "BLACK",
+   *       "ethnicity": "HISPANIC_OR_LATINO",
+   *       "citizenship": "AF",
+   *       "compensation_id": "string",
+   *       "compensation": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string"
+   *       },
+   *       "overtime_exemption": "EXEMPT",
+   *       "department_id": "string",
+   *       "department": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "name": "string"
+   *       },
+   *       "teams_id": [
+   *         "string"
+   *       ],
+   *       "teams": [
+   *         {}
+   *       ],
+   *       "title": "string",
+   *       "title_effective_date": "string",
+   *       "level_id": "string",
+   *       "level": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "name": "string"
+   *       },
+   *       "job_function_id": "string",
+   *       "job_function": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "name": "string"
+   *       },
+   *       "termination_details": {
+   *         "type": "VOLUNTARY",
+   *         "reason": "string"
+   *       },
+   *       "pay_schedule_id": "string",
+   *       "work_schedule": {},
+   *       "compensation_grade": {
+   *         "id": "string",
+   *         "label": "string"
+   *       },
+   *       "original_start_date": "string",
+   *       "custom_fields": [
+   *         "string"
+   *       ],
+   *       "country_fields": {
+   *         "us": {},
+   *         "ca": {},
+   *         "nz": {}
+   *       },
+   *       "business_partners_id": [
+   *         "string"
+   *       ],
+   *       "business_partners": [
+   *         {}
+   *       ]
+   *     },
+   *     "pay_period": {
+   *       "start_date": "string",
+   *       "end_date": "string",
+   *       "pay_schedule_id": "string"
+   *     },
+   *     "summary": {
+   *       "earnings": 0,
+   *       "hours_worked_by_job_code": [
+   *         {}
+   *       ],
+   *       "premiums": 0,
+   *       "approved_hours": 0,
+   *       "paid_hours": 0,
+   *       "total_hours": 0,
+   *       "total_paid_time_off_hours": 0,
+   *       "total_holiday_hours": 0,
+   *       "total_unpaid_time_off_hours": 0,
+   *       "regular_hours": 0,
+   *       "overtime_hours": 0,
+   *       "double_overtime_hours": 0,
+   *       "unpaid_break_hours_by_entry": 0
+   *     }
+   *   },
+   *   "tags": [
+   *     "string"
+   *   ],
+   *   "idempotency_key": "string",
+   *   "create_extra_hours_run": false,
+   *   "status": "DRAFT",
+   *   "pay_period": {
+   *     "start_date": "string",
+   *     "end_date": "string",
+   *     "pay_schedule_id": "string"
+   *   },
+   *   "shift_input_values": [
+   *     {
+   *       "shift_input_id": "string",
+   *       "value": {},
+   *       "author_id": "string"
+   *     }
+   *   ]
+   * }
+   * ```
    */
   create(body: TimeEntryCreateParams, options?: RequestOptions): APIPromise<TimeEntryCreateResponse> {
     return this._client.post('/time-entries/', { body, ...options });
@@ -42,6 +378,26 @@ export class TimeEntries extends APIResource {
 
   /**
    * Retrieve a specific time entry
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /time-entries/{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,
@@ -53,6 +409,211 @@ export class TimeEntries extends APIResource {
 
   /**
    * Update a specific time entry.
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * PATCH /time-entries/{id}/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "worker_id": "worker_id"
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "string",
+   *   "created_at": "string",
+   *   "updated_at": "string",
+   *   "worker_id": "string",
+   *   "worker": {
+   *     "id": "string",
+   *     "created_at": "string",
+   *     "updated_at": "string"
+   *   },
+   *   "start_time": "string",
+   *   "end_time": "string",
+   *   "comments": [
+   *     {}
+   *   ],
+   *   "job_shifts": [
+   *     {}
+   *   ],
+   *   "breaks": [
+   *     {}
+   *   ],
+   *   "premiums": [
+   *     {}
+   *   ],
+   *   "piece_rate_premiums": [
+   *     {}
+   *   ],
+   *   "segments": [
+   *     {}
+   *   ],
+   *   "time_entry_summary": {},
+   *   "time_card_id": "string",
+   *   "time_card": {
+   *     "id": "string",
+   *     "created_at": "string",
+   *     "updated_at": "string",
+   *     "worker_id": "string",
+   *     "worker": {
+   *       "id": "string",
+   *       "created_at": "string",
+   *       "updated_at": "string",
+   *       "user_id": "string",
+   *       "user": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string"
+   *       },
+   *       "is_manager": false,
+   *       "manager_id": "string",
+   *       "manager": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string"
+   *       },
+   *       "legal_entity_id": "string",
+   *       "legal_entity": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string"
+   *       },
+   *       "country": "AF",
+   *       "start_date": "string",
+   *       "end_date": "string",
+   *       "number": 0,
+   *       "work_email": "string",
+   *       "personal_email": "string",
+   *       "status": "INIT",
+   *       "location": {
+   *         "type": "REMOTE",
+   *         "work_location_id": "string"
+   *       },
+   *       "employment_type_id": "string",
+   *       "employment_type": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "label": "string"
+   *       },
+   *       "gender": "MALE",
+   *       "date_of_birth": "string",
+   *       "race": "BLACK",
+   *       "ethnicity": "HISPANIC_OR_LATINO",
+   *       "citizenship": "AF",
+   *       "compensation_id": "string",
+   *       "compensation": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string"
+   *       },
+   *       "overtime_exemption": "EXEMPT",
+   *       "department_id": "string",
+   *       "department": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "name": "string"
+   *       },
+   *       "teams_id": [
+   *         "string"
+   *       ],
+   *       "teams": [
+   *         {}
+   *       ],
+   *       "title": "string",
+   *       "title_effective_date": "string",
+   *       "level_id": "string",
+   *       "level": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "name": "string"
+   *       },
+   *       "job_function_id": "string",
+   *       "job_function": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "name": "string"
+   *       },
+   *       "termination_details": {
+   *         "type": "VOLUNTARY",
+   *         "reason": "string"
+   *       },
+   *       "pay_schedule_id": "string",
+   *       "work_schedule": {},
+   *       "compensation_grade": {
+   *         "id": "string",
+   *         "label": "string"
+   *       },
+   *       "original_start_date": "string",
+   *       "custom_fields": [
+   *         "string"
+   *       ],
+   *       "country_fields": {
+   *         "us": {},
+   *         "ca": {},
+   *         "nz": {}
+   *       },
+   *       "business_partners_id": [
+   *         "string"
+   *       ],
+   *       "business_partners": [
+   *         {}
+   *       ]
+   *     },
+   *     "pay_period": {
+   *       "start_date": "string",
+   *       "end_date": "string",
+   *       "pay_schedule_id": "string"
+   *     },
+   *     "summary": {
+   *       "earnings": 0,
+   *       "hours_worked_by_job_code": [
+   *         {}
+   *       ],
+   *       "premiums": 0,
+   *       "approved_hours": 0,
+   *       "paid_hours": 0,
+   *       "total_hours": 0,
+   *       "total_paid_time_off_hours": 0,
+   *       "total_holiday_hours": 0,
+   *       "total_unpaid_time_off_hours": 0,
+   *       "regular_hours": 0,
+   *       "overtime_hours": 0,
+   *       "double_overtime_hours": 0,
+   *       "unpaid_break_hours_by_entry": 0
+   *     }
+   *   },
+   *   "tags": [
+   *     "string"
+   *   ],
+   *   "idempotency_key": "string",
+   *   "create_extra_hours_run": false,
+   *   "status": "DRAFT",
+   *   "pay_period": {
+   *     "start_date": "string",
+   *     "end_date": "string",
+   *     "pay_schedule_id": "string"
+   *   },
+   *   "shift_input_values": [
+   *     {
+   *       "shift_input_id": "string",
+   *       "value": {},
+   *       "author_id": "string"
+   *     }
+   *   ]
+   * }
+   * ```
    */
   update(
     id: string,
@@ -64,6 +625,16 @@ export class TimeEntries extends APIResource {
 
   /**
    * Delete a time entry
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * DELETE /time-entries/{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`/time-entries/${id}/`, {