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

package/src/resources/kiosk-badges.ts

@@ -10,6 +10,24 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class KioskBadges extends APIResource {
+  /**
+   * A List of kiosk badges
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `badge_id`
+   * - Expandable fields: `worker`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: KioskBadgeListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<KioskBadgeListResponsesPageCursorURL, KioskBadgeListResponse> {
+    return this._client.getAPIList('/kiosk-badges', PageCursorURL<KioskBadgeListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Create a new kiosk badge
    */
@@ -39,24 +57,6 @@ export class KioskBadges extends APIResource {
     return this._client.patch(path`/kiosk-badges/${id}`, { body, ...options });
   }
 
-  /**
-   * A List of kiosk badges
-   *
-   * - Requires: `API Tier 2`
-   * - Filterable fields: `badge_id`
-   * - Expandable fields: `worker`
-   * - Sortable fields: `id`, `created_at`, `updated_at`
-   */
-  list(
-    query: KioskBadgeListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<KioskBadgeListResponsesPageCursorURL, KioskBadgeListResponse> {
-    return this._client.getAPIList('/kiosk-badges', PageCursorURL<KioskBadgeListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
   /**
    * Delete a kiosk badge
    */
@@ -92,7 +92,7 @@ export interface TimeKioskBadge {
   worker_number?: number;
 }
 
-export interface KioskBadgeCreateResponse {
+export interface KioskBadgeListResponse {
   /**
    * Identifier field
    */
@@ -136,10 +136,7 @@ export interface KioskBadgeCreateResponse {
   worker_number?: number;
 }
 
-/**
- * Meta information for the response.
- */
-export interface KioskBadgeRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface KioskBadgeCreateResponse {
   /**
    * Identifier field
    */
@@ -183,7 +180,10 @@ export interface KioskBadgeRetrieveResponse extends BusinessPartnersAPI.Meta {
   worker_number?: number;
 }
 
-export interface KioskBadgeUpdateResponse {
+/**
+ * Meta information for the response.
+ */
+export interface KioskBadgeRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * Identifier field
    */
@@ -227,7 +227,7 @@ export interface KioskBadgeUpdateResponse {
   worker_number?: number;
 }
 
-export interface KioskBadgeListResponse {
+export interface KioskBadgeUpdateResponse {
   /**
    * Identifier field
    */
@@ -271,6 +271,14 @@ export interface KioskBadgeListResponse {
   worker_number?: number;
 }
 
+export interface KioskBadgeListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
 export interface KioskBadgeCreateParams {
   /**
    * The ID associated with the badge. Not to be confused with the record's ID.
@@ -319,25 +327,17 @@ export interface KioskBadgeUpdateParams {
   worker_number?: number;
 }
 
-export interface KioskBadgeListParams {
-  expand?: string;
-
-  filter?: string;
-
-  order_by?: string;
-}
-
 export declare namespace KioskBadges {
   export {
     type TimeKioskBadge as TimeKioskBadge,
+    type KioskBadgeListResponse as KioskBadgeListResponse,
     type KioskBadgeCreateResponse as KioskBadgeCreateResponse,
     type KioskBadgeRetrieveResponse as KioskBadgeRetrieveResponse,
     type KioskBadgeUpdateResponse as KioskBadgeUpdateResponse,
-    type KioskBadgeListResponse as KioskBadgeListResponse,
     type KioskBadgeListResponsesPageCursorURL as KioskBadgeListResponsesPageCursorURL,
+    type KioskBadgeListParams as KioskBadgeListParams,
     type KioskBadgeCreateParams as KioskBadgeCreateParams,
     type KioskBadgeRetrieveParams as KioskBadgeRetrieveParams,
     type KioskBadgeUpdateParams as KioskBadgeUpdateParams,
-    type KioskBadgeListParams as KioskBadgeListParams,
   };
 }

package/src/resources/leave-accruals.ts

@@ -0,0 +1,261 @@
+// 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 * as WorkersAPI from './workers';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class LeaveAccruals extends APIResource {
+  /**
+   * Retrieve a specific leave accrual
+   */
+  retrieve(
+    id: string,
+    query: LeaveAccrualRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LeaveAccrualRetrieveResponse> {
+    return this._client.get(path`/leave-accruals/${id}`, { query, ...options });
+  }
+
+  /**
+   * Create a new leave accrual
+   */
+  create(body: LeaveAccrualCreateParams, options?: RequestOptions): APIPromise<LeaveAccrualCreateResponse> {
+    return this._client.post('/leave-accruals', { body, ...options });
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The date when this accrual becomes effective
+   */
+  accrual_date: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The ID of the worker who granted this accrual. This is typically the Time Off
+   * admin.
+   */
+  grantor_id: string;
+
+  /**
+   * The company leave type ID associated with this accrual
+   */
+  leave_type_id: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The ID of the worker for whom the accrual is for
+   */
+  worker_id: string;
+
+  /**
+   * The comment for this accrual. This is required if the leave policy requires a
+   * comment on accruals.
+   */
+  comment?: string;
+
+  /**
+   * The date when this accrual expires (if applicable)
+   */
+  expiration_date?: string;
+
+  /**
+   * The worker who granted this accrual. This is typically the Time Off admin.
+   *
+   * Expandable field
+   */
+  grantor?: WorkersAPI.Worker;
+
+  /**
+   * The monetary value of this accrual (for policies with monetary tracking)
+   */
+  monetary_amount_accrued?: number;
+
+  /**
+   * The number of days accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in days.
+   */
+  num_days?: number;
+
+  /**
+   * The number of hours accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in hours.
+   */
+  num_hours?: number;
+
+  /**
+   * The worker for whom the accrual is for
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+/**
+ * Leave accrual resource representing time off credits granted to employees.
+ *
+ *     Leave accruals track the allocation of paid time off (vacation, sick days, etc.)
+ *     to employees based on company policies, manual grants, or other accrual sources.
+ */
+export interface LeaveAccrualCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The date when this accrual becomes effective
+   */
+  accrual_date: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The ID of the worker who granted this accrual. This is typically the Time Off
+   * admin.
+   */
+  grantor_id: string;
+
+  /**
+   * The company leave type ID associated with this accrual
+   */
+  leave_type_id: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The ID of the worker for whom the accrual is for
+   */
+  worker_id: string;
+
+  /**
+   * The comment for this accrual. This is required if the leave policy requires a
+   * comment on accruals.
+   */
+  comment?: string;
+
+  /**
+   * The date when this accrual expires (if applicable)
+   */
+  expiration_date?: string;
+
+  /**
+   * The worker who granted this accrual. This is typically the Time Off admin.
+   *
+   * Expandable field
+   */
+  grantor?: WorkersAPI.Worker;
+
+  /**
+   * The monetary value of this accrual (for policies with monetary tracking)
+   */
+  monetary_amount_accrued?: number;
+
+  /**
+   * The number of days accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in days.
+   */
+  num_days?: number;
+
+  /**
+   * The number of hours accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in hours.
+   */
+  num_hours?: number;
+
+  /**
+   * The worker for whom the accrual is for
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export interface LeaveAccrualRetrieveParams {
+  expand?: string;
+}
+
+export interface LeaveAccrualCreateParams {
+  /**
+   * The date when this accrual becomes effective
+   */
+  accrual_date: string;
+
+  /**
+   * The ID of the worker who granted this accrual. This is typically the Time Off
+   * admin.
+   */
+  grantor_id: string;
+
+  /**
+   * The company leave type ID associated with this accrual
+   */
+  leave_type_id: string;
+
+  /**
+   * The ID of the worker for whom the accrual is for
+   */
+  worker_id: string;
+
+  /**
+   * The comment for this accrual. This is required if the leave policy requires a
+   * comment on accruals.
+   */
+  comment?: string;
+
+  /**
+   * The date when this accrual expires (if applicable)
+   */
+  expiration_date?: string;
+
+  /**
+   * The monetary value of this accrual (for policies with monetary tracking)
+   */
+  monetary_amount_accrued?: number;
+
+  /**
+   * The number of days accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in days.
+   */
+  num_days?: number;
+
+  /**
+   * The number of hours accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in hours.
+   */
+  num_hours?: number;
+}
+
+export declare namespace LeaveAccruals {
+  export {
+    type LeaveAccrualRetrieveResponse as LeaveAccrualRetrieveResponse,
+    type LeaveAccrualCreateResponse as LeaveAccrualCreateResponse,
+    type LeaveAccrualRetrieveParams as LeaveAccrualRetrieveParams,
+    type LeaveAccrualCreateParams as LeaveAccrualCreateParams,
+  };
+}

package/src/resources/leave-balances.ts

@@ -10,17 +10,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class LeaveBalances extends APIResource {
-  /**
-   * Retrieve a specific leave balance
-   */
-  retrieve(
-    id: string,
-    query: LeaveBalanceRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<LeaveBalanceRetrieveResponse> {
-    return this._client.get(path`/leave-balances/${id}`, { query, ...options });
-  }
-
   /**
    * A List of leave balances
    *
@@ -35,6 +24,17 @@ export class LeaveBalances extends APIResource {
   ): PagePromise<LeaveBalancesPageCursorURL, LeaveBalance> {
     return this._client.getAPIList('/leave-balances', PageCursorURL<LeaveBalance>, { query, ...options });
   }
+
+  /**
+   * Retrieve a specific leave balance
+   */
+  retrieve(
+    id: string,
+    query: LeaveBalanceRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LeaveBalanceRetrieveResponse> {
+    return this._client.get(path`/leave-balances/${id}`, { query, ...options });
+  }
 }
 
 export type LeaveBalancesPageCursorURL = PageCursorURL<LeaveBalance>;
@@ -102,10 +102,6 @@ export interface LeaveBalance {
  */
 export interface LeaveBalanceRetrieveResponse extends BusinessPartnersAPI.Meta, LeaveBalance {}
 
-export interface LeaveBalanceRetrieveParams {
-  expand?: string;
-}
-
 export interface LeaveBalanceListParams {
   expand?: string;
 
@@ -114,12 +110,16 @@ export interface LeaveBalanceListParams {
   order_by?: string;
 }
 
+export interface LeaveBalanceRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace LeaveBalances {
   export {
     type LeaveBalance as LeaveBalance,
     type LeaveBalanceRetrieveResponse as LeaveBalanceRetrieveResponse,
     type LeaveBalancesPageCursorURL as LeaveBalancesPageCursorURL,
-    type LeaveBalanceRetrieveParams as LeaveBalanceRetrieveParams,
     type LeaveBalanceListParams as LeaveBalanceListParams,
+    type LeaveBalanceRetrieveParams as LeaveBalanceRetrieveParams,
   };
 }

package/src/resources/leave-requests.ts

@@ -10,6 +10,25 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class LeaveRequests extends APIResource {
+  /**
+   * A List of leave requests
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `requester_id`, `reviewer_id`, `status`,
+   *   `leave_policy_id`, `leave_type_id`, `start_date`, `end_date`
+   * - Expandable fields: `worker`, `requester`, `leave_type`, `reviewer`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: LeaveRequestListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<LeaveRequestListResponsesPageCursorURL, LeaveRequestListResponse> {
+    return this._client.getAPIList('/leave-requests', PageCursorURL<LeaveRequestListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Create a new leave request
    */
@@ -38,25 +57,6 @@ export class LeaveRequests extends APIResource {
   ): APIPromise<LeaveRequestUpdateResponse> {
     return this._client.patch(path`/leave-requests/${id}`, { body, ...options });
   }
-
-  /**
-   * A List of leave requests
-   *
-   * - Requires: `API Tier 2`
-   * - Filterable fields: `worker_id`, `requester_id`, `reviewer_id`, `status`,
-   *   `leave_policy_id`, `leave_type_id`, `start_date`, `end_date`
-   * - Expandable fields: `worker`, `requester`, `leave_type`, `reviewer`
-   * - Sortable fields: `id`, `created_at`, `updated_at`
-   */
-  list(
-    query: LeaveRequestListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<LeaveRequestListResponsesPageCursorURL, LeaveRequestListResponse> {
-    return this._client.getAPIList('/leave-requests', PageCursorURL<LeaveRequestListResponse>, {
-      query,
-      ...options,
-    });
-  }
 }
 
 export type LeaveRequestListResponsesPageCursorURL = PageCursorURL<LeaveRequestListResponse>;
@@ -145,7 +145,7 @@ export interface LeaveRequest {
   start_time?: string;
 }
 
-export interface LeaveRequestCreateResponse {
+export interface LeaveRequestListResponse {
   /**
    * Identifier field
    */
@@ -189,7 +189,7 @@ export interface LeaveRequestCreateResponse {
   /**
    * The specific dates taken off and the amount of time taken off for each one.
    */
-  days_take_off?: Array<LeaveRequestCreateResponse.DaysTakeOff>;
+  days_take_off?: Array<LeaveRequestListResponse.DaysTakeOff>;
 
   /**
    * The end time of the leave request.
@@ -277,7 +277,7 @@ export interface LeaveRequestCreateResponse {
   worker?: WorkersAPI.Worker;
 }
 
-export namespace LeaveRequestCreateResponse {
+export namespace LeaveRequestListResponse {
   export interface DaysTakeOff {
     /**
      * The date of the day off.
@@ -291,10 +291,7 @@ export namespace LeaveRequestCreateResponse {
   }
 }
 
-/**
- * Meta information for the response.
- */
-export interface LeaveRequestRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface LeaveRequestCreateResponse {
   /**
    * Identifier field
    */
@@ -338,7 +335,7 @@ export interface LeaveRequestRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * The specific dates taken off and the amount of time taken off for each one.
    */
-  days_take_off?: Array<LeaveRequestRetrieveResponse.DaysTakeOff>;
+  days_take_off?: Array<LeaveRequestCreateResponse.DaysTakeOff>;
 
   /**
    * The end time of the leave request.
@@ -426,7 +423,7 @@ export interface LeaveRequestRetrieveResponse extends BusinessPartnersAPI.Meta {
   worker?: WorkersAPI.Worker;
 }
 
-export namespace LeaveRequestRetrieveResponse {
+export namespace LeaveRequestCreateResponse {
   export interface DaysTakeOff {
     /**
      * The date of the day off.
@@ -440,7 +437,10 @@ export namespace LeaveRequestRetrieveResponse {
   }
 }
 
-export interface LeaveRequestUpdateResponse {
+/**
+ * Meta information for the response.
+ */
+export interface LeaveRequestRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * Identifier field
    */
@@ -484,7 +484,7 @@ export interface LeaveRequestUpdateResponse {
   /**
    * The specific dates taken off and the amount of time taken off for each one.
    */
-  days_take_off?: Array<LeaveRequestUpdateResponse.DaysTakeOff>;
+  days_take_off?: Array<LeaveRequestRetrieveResponse.DaysTakeOff>;
 
   /**
    * The end time of the leave request.
@@ -572,7 +572,7 @@ export interface LeaveRequestUpdateResponse {
   worker?: WorkersAPI.Worker;
 }
 
-export namespace LeaveRequestUpdateResponse {
+export namespace LeaveRequestRetrieveResponse {
   export interface DaysTakeOff {
     /**
      * The date of the day off.
@@ -586,7 +586,7 @@ export namespace LeaveRequestUpdateResponse {
   }
 }
 
-export interface LeaveRequestListResponse {
+export interface LeaveRequestUpdateResponse {
   /**
    * Identifier field
    */
@@ -630,7 +630,7 @@ export interface LeaveRequestListResponse {
   /**
    * The specific dates taken off and the amount of time taken off for each one.
    */
-  days_take_off?: Array<LeaveRequestListResponse.DaysTakeOff>;
+  days_take_off?: Array<LeaveRequestUpdateResponse.DaysTakeOff>;
 
   /**
    * The end time of the leave request.
@@ -718,7 +718,7 @@ export interface LeaveRequestListResponse {
   worker?: WorkersAPI.Worker;
 }
 
-export namespace LeaveRequestListResponse {
+export namespace LeaveRequestUpdateResponse {
   export interface DaysTakeOff {
     /**
      * The date of the day off.
@@ -732,6 +732,14 @@ export namespace LeaveRequestListResponse {
   }
 }
 
+export interface LeaveRequestListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
 export interface LeaveRequestCreateParams {
   /**
    * The end date of the leave request.
@@ -904,25 +912,17 @@ export interface LeaveRequestUpdateParams {
   start_time?: string;
 }
 
-export interface LeaveRequestListParams {
-  expand?: string;
-
-  filter?: string;
-
-  order_by?: string;
-}
-
 export declare namespace LeaveRequests {
   export {
     type LeaveRequest as LeaveRequest,
+    type LeaveRequestListResponse as LeaveRequestListResponse,
     type LeaveRequestCreateResponse as LeaveRequestCreateResponse,
     type LeaveRequestRetrieveResponse as LeaveRequestRetrieveResponse,
     type LeaveRequestUpdateResponse as LeaveRequestUpdateResponse,
-    type LeaveRequestListResponse as LeaveRequestListResponse,
     type LeaveRequestListResponsesPageCursorURL as LeaveRequestListResponsesPageCursorURL,
+    type LeaveRequestListParams as LeaveRequestListParams,
     type LeaveRequestCreateParams as LeaveRequestCreateParams,
     type LeaveRequestRetrieveParams as LeaveRequestRetrieveParams,
     type LeaveRequestUpdateParams as LeaveRequestUpdateParams,
-    type LeaveRequestListParams as LeaveRequestListParams,
   };
 }

package/src/resources/leave-types.ts

@@ -8,13 +8,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class LeaveTypes extends APIResource {
-  /**
-   * Retrieve a specific leave type
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<LeaveTypeRetrieveResponse> {
-    return this._client.get(path`/leave-types/${id}`, options);
-  }
-
   /**
    * A List of leave types
    *
@@ -28,6 +21,13 @@ export class LeaveTypes extends APIResource {
   ): PagePromise<LeaveTypesPageCursorURL, LeaveType> {
     return this._client.getAPIList('/leave-types', PageCursorURL<LeaveType>, { query, ...options });
   }
+
+  /**
+   * Retrieve a specific leave type
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<LeaveTypeRetrieveResponse> {
+    return this._client.get(path`/leave-types/${id}`, options);
+  }
 }
 
 export type LeaveTypesPageCursorURL = PageCursorURL<LeaveType>;