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

package/src/resources/legal-entities.ts

@@ -10,17 +10,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class LegalEntities extends APIResource {
-  /**
-   * Retrieve a specific legal entity
-   */
-  retrieve(
-    id: string,
-    query: LegalEntityRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<LegalEntityRetrieveResponse> {
-    return this._client.get(path`/legal-entities/${id}`, { query, ...options });
-  }
-
   /**
    * A List of legal entities
    *
@@ -34,6 +23,17 @@ export class LegalEntities extends APIResource {
   ): PagePromise<LegalEntitiesPageCursorURL, LegalEntity> {
     return this._client.getAPIList('/legal-entities', PageCursorURL<LegalEntity>, { query, ...options });
   }
+
+  /**
+   * Retrieve a specific legal entity
+   */
+  retrieve(
+    id: string,
+    query: LegalEntityRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LegalEntityRetrieveResponse> {
+    return this._client.get(path`/legal-entities/${id}`, { query, ...options });
+  }
 }
 
 export type LegalEntitiesPageCursorURL = PageCursorURL<LegalEntity>;
@@ -331,6 +331,7 @@ export namespace LegalEntity {
       | 'SL'
       | 'SG'
       | 'SX'
+      | 'SY'
       | 'SK'
       | 'SI'
       | 'SB'
@@ -385,22 +386,22 @@ export namespace LegalEntity {
  */
 export interface LegalEntityRetrieveResponse extends BusinessPartnersAPI.Meta, LegalEntity {}
 
-export interface LegalEntityRetrieveParams {
-  expand?: string;
-}
-
 export interface LegalEntityListParams {
   expand?: string;
 
   order_by?: string;
 }
 
+export interface LegalEntityRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace LegalEntities {
   export {
     type LegalEntity as LegalEntity,
     type LegalEntityRetrieveResponse as LegalEntityRetrieveResponse,
     type LegalEntitiesPageCursorURL as LegalEntitiesPageCursorURL,
-    type LegalEntityRetrieveParams as LegalEntityRetrieveParams,
     type LegalEntityListParams as LegalEntityListParams,
+    type LegalEntityRetrieveParams as LegalEntityRetrieveParams,
   };
 }

package/src/resources/levels.ts

@@ -9,17 +9,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Levels extends APIResource {
-  /**
-   * Retrieve a specific level
-   */
-  retrieve(
-    id: string,
-    query: LevelRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<LevelRetrieveResponse> {
-    return this._client.get(path`/levels/${id}`, { query, ...options });
-  }
-
   /**
    * A List of levels
    *
@@ -33,6 +22,17 @@ export class Levels extends APIResource {
   ): PagePromise<LevelsPageCursorURL, Level> {
     return this._client.getAPIList('/levels', PageCursorURL<Level>, { query, ...options });
   }
+
+  /**
+   * Retrieve a specific level
+   */
+  retrieve(
+    id: string,
+    query: LevelRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LevelRetrieveResponse> {
+    return this._client.get(path`/levels/${id}`, { query, ...options });
+  }
 }
 
 export type LevelsPageCursorURL = PageCursorURL<Level>;
@@ -107,22 +107,22 @@ export interface Level {
  */
 export interface LevelRetrieveResponse extends BusinessPartnersAPI.Meta, Level {}
 
-export interface LevelRetrieveParams {
-  expand?: string;
-}
-
 export interface LevelListParams {
   expand?: string;
 
   order_by?: string;
 }
 
+export interface LevelRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace Levels {
   export {
     type Level as Level,
     type LevelRetrieveResponse as LevelRetrieveResponse,
     type LevelsPageCursorURL as LevelsPageCursorURL,
-    type LevelRetrieveParams as LevelRetrieveParams,
     type LevelListParams as LevelListParams,
+    type LevelRetrieveParams as LevelRetrieveParams,
   };
 }

package/src/resources/location-factors.ts

@@ -8,17 +8,10 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class LocationFactors extends APIResource {
-  /**
-   * Retrieve a specific location factor
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<LocationFactorRetrieveResponse> {
-    return this._client.get(path`/location-factors/${id}`, options);
-  }
-
   /**
    * A List of location factors
    *
-   * - Requires: `Internal Testing`
+   * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
@@ -30,14 +23,18 @@ export class LocationFactors extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieve a specific location factor
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<LocationFactorRetrieveResponse> {
+    return this._client.get(path`/location-factors/${id}`, options);
+  }
 }
 
 export type LocationFactorListResponsesPageCursorURL = PageCursorURL<LocationFactorListResponse>;
 
-/**
- * Meta information for the response.
- */
-export interface LocationFactorRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface LocationFactorListResponse {
   /**
    * Identifier field
    */
@@ -61,7 +58,7 @@ export interface LocationFactorRetrieveResponse extends BusinessPartnersAPI.Meta
   /**
    * Country information set to the country code
    */
-  country?: LocationFactorRetrieveResponse.Country;
+  country?: LocationFactorListResponse.Country;
 
   /**
    * Human-readable name for the location factor
@@ -74,7 +71,7 @@ export interface LocationFactorRetrieveResponse extends BusinessPartnersAPI.Meta
   labour_bucket?: string;
 }
 
-export namespace LocationFactorRetrieveResponse {
+export namespace LocationFactorListResponse {
   /**
    * Country information set to the country code
    */
@@ -284,6 +281,7 @@ export namespace LocationFactorRetrieveResponse {
       | 'SL'
       | 'SG'
       | 'SX'
+      | 'SY'
       | 'SK'
       | 'SI'
       | 'SB'
@@ -333,7 +331,10 @@ export namespace LocationFactorRetrieveResponse {
   }
 }
 
-export interface LocationFactorListResponse {
+/**
+ * Meta information for the response.
+ */
+export interface LocationFactorRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * Identifier field
    */
@@ -357,7 +358,7 @@ export interface LocationFactorListResponse {
   /**
    * Country information set to the country code
    */
-  country?: LocationFactorListResponse.Country;
+  country?: LocationFactorRetrieveResponse.Country;
 
   /**
    * Human-readable name for the location factor
@@ -370,7 +371,7 @@ export interface LocationFactorListResponse {
   labour_bucket?: string;
 }
 
-export namespace LocationFactorListResponse {
+export namespace LocationFactorRetrieveResponse {
   /**
    * Country information set to the country code
    */
@@ -580,6 +581,7 @@ export namespace LocationFactorListResponse {
       | 'SL'
       | 'SG'
       | 'SX'
+      | 'SY'
       | 'SK'
       | 'SI'
       | 'SB'
@@ -635,8 +637,8 @@ export interface LocationFactorListParams {
 
 export declare namespace LocationFactors {
   export {
-    type LocationFactorRetrieveResponse as LocationFactorRetrieveResponse,
     type LocationFactorListResponse as LocationFactorListResponse,
+    type LocationFactorRetrieveResponse as LocationFactorRetrieveResponse,
     type LocationFactorListResponsesPageCursorURL as LocationFactorListResponsesPageCursorURL,
     type LocationFactorListParams as LocationFactorListParams,
   };

package/src/resources/object-categories.ts

@@ -8,6 +8,15 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class ObjectCategories extends APIResource {
+  /**
+   * A List of object categories
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<ObjectCategoriesPageCursorURL, ObjectCategory> {
+    return this._client.getAPIList('/object-categories/', PageCursorURL<ObjectCategory>, options);
+  }
+
   /**
    * Create a new object category
    */
@@ -36,15 +45,6 @@ export class ObjectCategories extends APIResource {
     return this._client.patch(path`/object-categories/${id}/`, { body, ...options });
   }
 
-  /**
-   * A List of object categories
-   *
-   * - Requires: `API Tier 1`
-   */
-  list(options?: RequestOptions): PagePromise<ObjectCategoriesPageCursorURL, ObjectCategory> {
-    return this._client.getAPIList('/object-categories/', PageCursorURL<ObjectCategory>, options);
-  }
-
   /**
    * Delete a object category
    */

package/src/resources/schedules.ts

@@ -9,17 +9,6 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class Schedules extends APIResource {
-  /**
-   * Retrieve a specific schedule
-   */
-  retrieve(
-    id: string,
-    query: ScheduleRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ScheduleRetrieveResponse> {
-    return this._client.get(path`/schedules/${id}`, { query, ...options });
-  }
-
   /**
    * A List of schedules
    *
@@ -33,14 +22,32 @@ export class Schedules extends APIResource {
   ): PagePromise<ScheduleListResponsesPageCursorURL, ScheduleListResponse> {
     return this._client.getAPIList('/schedules', PageCursorURL<ScheduleListResponse>, { query, ...options });
   }
+
+  /**
+   * Create a new schedule
+   */
+  create(
+    body: ScheduleCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ScheduleCreateResponse> {
+    return this._client.post('/schedules', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific schedule
+   */
+  retrieve(
+    id: string,
+    query: ScheduleRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ScheduleRetrieveResponse> {
+    return this._client.get(path`/schedules/${id}`, { query, ...options });
+  }
 }
 
 export type ScheduleListResponsesPageCursorURL = PageCursorURL<ScheduleListResponse>;
 
-/**
- * Meta information for the response.
- */
-export interface ScheduleRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface ScheduleListResponse {
   /**
    * Identifier field
    */
@@ -101,9 +108,28 @@ export interface ScheduleRetrieveResponse extends BusinessPartnersAPI.Meta {
    * The IDs of the observers of the schedule.
    */
   observers_id?: Array<string>;
+
+  /**
+   * The settings of the schedule.
+   */
+  settings?: ScheduleListResponse.Settings;
 }
 
-export interface ScheduleListResponse {
+export namespace ScheduleListResponse {
+  /**
+   * The settings of the schedule.
+   */
+  export interface Settings {
+    /**
+     * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
+     * Accepted values are defined by the tz database, listed here:
+     * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+     */
+    timezone?: string;
+  }
+}
+
+export interface ScheduleCreateResponse {
   /**
    * Identifier field
    */
@@ -164,10 +190,110 @@ export interface ScheduleListResponse {
    * The IDs of the observers of the schedule.
    */
   observers_id?: Array<string>;
+
+  /**
+   * The settings of the schedule.
+   */
+  settings?: ScheduleCreateResponse.Settings;
 }
 
-export interface ScheduleRetrieveParams {
-  expand?: string;
+export namespace ScheduleCreateResponse {
+  /**
+   * The settings of the schedule.
+   */
+  export interface Settings {
+    /**
+     * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
+     * Accepted values are defined by the tz database, listed here:
+     * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+     */
+    timezone?: string;
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface ScheduleRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether the requesting role can edit the schedule.
+   */
+  can_edit?: boolean;
+
+  /**
+   * The managers of the schedule.
+   *
+   * Expandable field
+   */
+  managers?: Array<WorkersAPI.Worker>;
+
+  /**
+   * The IDs of the managers of the schedule.
+   */
+  managers_id?: Array<string>;
+
+  /**
+   * The members of the schedule.
+   *
+   * Expandable field
+   */
+  members?: Array<WorkersAPI.Worker>;
+
+  /**
+   * The IDs of the members of the schedule.
+   */
+  members_id?: Array<string>;
+
+  /**
+   * The name of the schedule.
+   */
+  name?: string;
+
+  /**
+   * The observers of the schedule.
+   *
+   * Expandable field
+   */
+  observers?: Array<WorkersAPI.Worker>;
+
+  /**
+   * The IDs of the observers of the schedule.
+   */
+  observers_id?: Array<string>;
+
+  /**
+   * The settings of the schedule.
+   */
+  settings?: ScheduleRetrieveResponse.Settings;
+}
+
+export namespace ScheduleRetrieveResponse {
+  /**
+   * The settings of the schedule.
+   */
+  export interface Settings {
+    /**
+     * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
+     * Accepted values are defined by the tz database, listed here:
+     * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+     */
+    timezone?: string;
+  }
 }
 
 export interface ScheduleListParams {
@@ -176,12 +302,59 @@ export interface ScheduleListParams {
   order_by?: string;
 }
 
+export interface ScheduleCreateParams {
+  /**
+   * The IDs of the managers of the schedule.
+   */
+  managers_id?: Array<string>;
+
+  /**
+   * The IDs of the members of the schedule.
+   */
+  members_id?: Array<string>;
+
+  /**
+   * The name of the schedule.
+   */
+  name?: string;
+
+  /**
+   * The IDs of the observers of the schedule.
+   */
+  observers_id?: Array<string>;
+
+  /**
+   * The settings of the schedule.
+   */
+  settings?: ScheduleCreateParams.Settings;
+}
+
+export namespace ScheduleCreateParams {
+  /**
+   * The settings of the schedule.
+   */
+  export interface Settings {
+    /**
+     * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
+     * Accepted values are defined by the tz database, listed here:
+     * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+     */
+    timezone?: string;
+  }
+}
+
+export interface ScheduleRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace Schedules {
   export {
-    type ScheduleRetrieveResponse as ScheduleRetrieveResponse,
     type ScheduleListResponse as ScheduleListResponse,
+    type ScheduleCreateResponse as ScheduleCreateResponse,
+    type ScheduleRetrieveResponse as ScheduleRetrieveResponse,
     type ScheduleListResponsesPageCursorURL as ScheduleListResponsesPageCursorURL,
-    type ScheduleRetrieveParams as ScheduleRetrieveParams,
     type ScheduleListParams as ScheduleListParams,
+    type ScheduleCreateParams as ScheduleCreateParams,
+    type ScheduleRetrieveParams as ScheduleRetrieveParams,
   };
 }

package/src/resources/shared.ts

@@ -244,6 +244,7 @@ export type CountryCode =
   | 'SL'
   | 'SG'
   | 'SX'
+  | 'SY'
   | 'SK'
   | 'SI'
   | 'SB'

package/src/resources/shift-inputs.ts

@@ -10,6 +10,24 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class ShiftInputs extends APIResource {
+  /**
+   * A List of shift inputs
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `name`
+   * - Expandable fields: `creator`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: ShiftInputListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ShiftInputListResponsesPageCursorURL, ShiftInputListResponse> {
+    return this._client.getAPIList('/shift-inputs', PageCursorURL<ShiftInputListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Create a new shift input
    */
@@ -39,24 +57,6 @@ export class ShiftInputs extends APIResource {
     return this._client.patch(path`/shift-inputs/${id}`, { body, ...options });
   }
 
-  /**
-   * A List of shift inputs
-   *
-   * - Requires: `API Tier 2`
-   * - Filterable fields: `name`
-   * - Expandable fields: `creator`
-   * - Sortable fields: `id`, `created_at`, `updated_at`
-   */
-  list(
-    query: ShiftInputListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ShiftInputListResponsesPageCursorURL, ShiftInputListResponse> {
-    return this._client.getAPIList('/shift-inputs', PageCursorURL<ShiftInputListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
   /**
    * Delete a shift input
    */
@@ -97,7 +97,7 @@ export interface ShiftInput {
   creator_id?: string;
 }
 
-export interface ShiftInputCreateResponse {
+export interface ShiftInputListResponse {
   /**
    * Identifier field
    */
@@ -151,10 +151,7 @@ export interface ShiftInputCreateResponse {
   managed_by?: string;
 }
 
-/**
- * Meta information for the response.
- */
-export interface ShiftInputRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface ShiftInputCreateResponse {
   /**
    * Identifier field
    */
@@ -208,7 +205,10 @@ export interface ShiftInputRetrieveResponse extends BusinessPartnersAPI.Meta {
   managed_by?: string;
 }
 
-export interface ShiftInputUpdateResponse {
+/**
+ * Meta information for the response.
+ */
+export interface ShiftInputRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * Identifier field
    */
@@ -262,7 +262,7 @@ export interface ShiftInputUpdateResponse {
   managed_by?: string;
 }
 
-export interface ShiftInputListResponse {
+export interface ShiftInputUpdateResponse {
   /**
    * Identifier field
    */
@@ -316,6 +316,14 @@ export interface ShiftInputListResponse {
   managed_by?: string;
 }
 
+export interface ShiftInputListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
 export interface ShiftInputCreateParams {
   /**
    * Two letter string designating country code which the shift input is associated.
@@ -374,25 +382,17 @@ export interface ShiftInputUpdateParams {
   creator_id?: string;
 }
 
-export interface ShiftInputListParams {
-  expand?: string;
-
-  filter?: string;
-
-  order_by?: string;
-}
-
 export declare namespace ShiftInputs {
   export {
     type ShiftInput as ShiftInput,
+    type ShiftInputListResponse as ShiftInputListResponse,
     type ShiftInputCreateResponse as ShiftInputCreateResponse,
     type ShiftInputRetrieveResponse as ShiftInputRetrieveResponse,
     type ShiftInputUpdateResponse as ShiftInputUpdateResponse,
-    type ShiftInputListResponse as ShiftInputListResponse,
     type ShiftInputListResponsesPageCursorURL as ShiftInputListResponsesPageCursorURL,
+    type ShiftInputListParams as ShiftInputListParams,
     type ShiftInputCreateParams as ShiftInputCreateParams,
     type ShiftInputRetrieveParams as ShiftInputRetrieveParams,
     type ShiftInputUpdateParams as ShiftInputUpdateParams,
-    type ShiftInputListParams as ShiftInputListParams,
   };
 }