@rippling/rippling-sdk 0.2.0-alpha.95 → 0.2.0-alpha.97

package/src/resources/packages/packages.ts

@@ -11,7 +11,14 @@ import {
 import * as NextVersionsAPI from './next-versions';
 import { NextVersionCreateParams, NextVersionCreateResponse, NextVersions } from './next-versions';
 import * as VersionsAPI from './versions';
-import { VersionCreateParams, VersionCreateResponse, Versions } from './versions';
+import {
+  VersionCreateParams,
+  VersionCreateResponse,
+  VersionListParams,
+  VersionListResponse,
+  VersionListResponsesPageCursorURL,
+  Versions,
+} from './versions';
 import { APIPromise } from '../../core/api-promise';
 import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
@@ -29,7 +36,7 @@ export class Packages extends APIResource {
   nextVersions: NextVersionsAPI.NextVersions = new NextVersionsAPI.NextVersions(this._client);
 
   /**
-   * A list of package publish.
+   * A list of packages.
    *
    * - Requires: `Unity Packages V2 Platform API`
    * - Filterable fields: `package_key`
@@ -43,31 +50,35 @@ export class Packages extends APIResource {
   }
 
   /**
-   * Create a new package publish
+   * Create a new package
    */
   create(body: PackageCreateParams, options?: RequestOptions): APIPromise<PackageCreateResponse> {
     return this._client.post('/packages/', { body, ...options });
   }
 
   /**
-   * Retrieve a specific package publish
+   * Retrieve a specific package
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<PackageRetrieveResponse> {
-    return this._client.get(path`/packages/${id}/`, options);
+  retrieve(packageKey: string, options?: RequestOptions): APIPromise<PackageRetrieveResponse> {
+    return this._client.get(path`/packages/${packageKey}/`, options);
   }
 
   /**
-   * Update a specific package publish.
+   * Update a specific package.
    */
-  update(id: string, body: PackageUpdateParams, options?: RequestOptions): APIPromise<PackageUpdateResponse> {
-    return this._client.patch(path`/packages/${id}/`, { body, ...options });
+  update(
+    packageKey: string,
+    body: PackageUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<PackageUpdateResponse> {
+    return this._client.patch(path`/packages/${packageKey}/`, { body, ...options });
   }
 
   /**
-   * Delete a package publish
+   * Delete a package
    */
-  delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/packages/${id}/`, {
+  delete(packageKey: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/packages/${packageKey}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -348,7 +359,10 @@ export declare namespace Packages {
 
   export {
     Versions as Versions,
+    type VersionListResponse as VersionListResponse,
     type VersionCreateResponse as VersionCreateResponse,
+    type VersionListResponsesPageCursorURL as VersionListResponsesPageCursorURL,
+    type VersionListParams as VersionListParams,
     type VersionCreateParams as VersionCreateParams,
   };
 

package/src/resources/packages/versions.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -10,7 +11,22 @@ import { path } from '../../internal/utils/path';
  */
 export class Versions extends APIResource {
   /**
-   * Create a new package publish.
+   * List package versions belonging to a package.
+   */
+  list(
+    packageKey: string,
+    query: VersionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<VersionListResponsesPageCursorURL, VersionListResponse> {
+    return this._client.getAPIList(
+      path`/packages/${packageKey}/versions/`,
+      PageCursorURL<VersionListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Create a new package version.
    */
   create(
     packageKey: string,
@@ -21,6 +37,60 @@ export class Versions extends APIResource {
   }
 }
 
+export type VersionListResponsesPageCursorURL = PageCursorURL<VersionListResponse>;
+
+export interface VersionListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The semantic version number for this package version
+   */
+  version_number: string;
+
+  /**
+   * Components included in this package version
+   */
+  components?: Array<unknown>;
+
+  /**
+   * The description of the package version
+   */
+  description?: string;
+
+  /**
+   * Whether this package version has been published
+   */
+  is_published?: boolean;
+
+  /**
+   * The display name of the parent package
+   */
+  package_display_name?: string;
+
+  /**
+   * The ID of the parent package
+   */
+  package_id?: string;
+
+  /**
+   * The package key of the parent package
+   */
+  package_key?: string;
+}
+
 export interface VersionCreateResponse {
   /**
    * Identifier field
@@ -73,6 +143,15 @@ export interface VersionCreateResponse {
   package_key?: string;
 }
 
+export interface VersionListParams {
+  cursor?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+}
+
 export interface VersionCreateParams {
   /**
    * The semantic version number for this package version
@@ -87,7 +166,10 @@ export interface VersionCreateParams {
 
 export declare namespace Versions {
   export {
+    type VersionListResponse as VersionListResponse,
     type VersionCreateResponse as VersionCreateResponse,
+    type VersionListResponsesPageCursorURL as VersionListResponsesPageCursorURL,
+    type VersionListParams as VersionListParams,
     type VersionCreateParams as VersionCreateParams,
   };
 }

package/src/resources/sandboxes.ts

@@ -41,6 +41,16 @@ export class Sandboxes extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Get the company and administrator role used to enter a developer sandbox.
+   */
+  developerSandboxEntryRoles(
+    id: string,
+    options?: RequestOptions,
+  ): APIPromise<SandboxDeveloperSandboxEntryRolesResponse> {
+    return this._client.get(path`/sandboxes/${id}/developer-sandbox-entry-roles/`, options);
+  }
 }
 
 export type SandboxListResponsesPageCursorURL = PageCursorURL<SandboxListResponse>;
@@ -51,11 +61,6 @@ export interface SandboxListResponse {
    */
   id: string;
 
-  /**
-   * Type-specific sandbox configuration.
-   */
-  config_override: SandboxListResponse.ConfigOverride;
-
   /**
    * Record creation date
    */
@@ -76,13 +81,18 @@ export interface SandboxListResponse {
    */
   updated_at: string;
 
+  /**
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
+   */
+  config_override?: SandboxListResponse.ConfigOverride;
+
   /**
    * Optional sandbox description.
    */
   description?: string;
 
   /**
-   * Required for developer sandboxes; generated for full-data sandboxes.
+   * Server-generated sandbox handle.
    */
   handle?: string;
 
@@ -94,7 +104,7 @@ export interface SandboxListResponse {
 
 export namespace SandboxListResponse {
   /**
-   * Type-specific sandbox configuration.
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
    */
   export interface ConfigOverride {
     /**
@@ -304,11 +314,6 @@ export interface SandboxCreateResponse {
    */
   id: string;
 
-  /**
-   * Type-specific sandbox configuration.
-   */
-  config_override: SandboxCreateResponse.ConfigOverride;
-
   /**
    * Record creation date
    */
@@ -329,13 +334,18 @@ export interface SandboxCreateResponse {
    */
   updated_at: string;
 
+  /**
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
+   */
+  config_override?: SandboxCreateResponse.ConfigOverride;
+
   /**
    * Optional sandbox description.
    */
   description?: string;
 
   /**
-   * Required for developer sandboxes; generated for full-data sandboxes.
+   * Server-generated sandbox handle.
    */
   handle?: string;
 
@@ -347,7 +357,7 @@ export interface SandboxCreateResponse {
 
 export namespace SandboxCreateResponse {
   /**
-   * Type-specific sandbox configuration.
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
    */
   export interface ConfigOverride {
     /**
@@ -551,6 +561,21 @@ export namespace SandboxCreateResponse {
   }
 }
 
+/**
+ * Company and administrator role used to enter a developer sandbox.
+ */
+export interface SandboxDeveloperSandboxEntryRolesResponse {
+  /**
+   * The unique identifier of the sandbox company's administrator role.
+   */
+  admin_role_id: string | null;
+
+  /**
+   * The unique identifier of the company inside the sandbox.
+   */
+  target_company_id: string | null;
+}
+
 export interface SandboxListParams {
   cursor?: string;
 
@@ -565,11 +590,6 @@ export interface SandboxListParams {
 }
 
 export interface SandboxCreateParams {
-  /**
-   * Type-specific sandbox configuration.
-   */
-  config_override: SandboxCreateParams.ConfigOverride;
-
   /**
    * Display name of the sandbox.
    */
@@ -581,19 +601,19 @@ export interface SandboxCreateParams {
   type: string;
 
   /**
-   * Optional sandbox description.
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
    */
-  description?: string;
+  config_override?: SandboxCreateParams.ConfigOverride;
 
   /**
-   * Required for developer sandboxes; generated for full-data sandboxes.
+   * Optional sandbox description.
    */
-  handle?: string;
+  description?: string;
 }
 
 export namespace SandboxCreateParams {
   /**
-   * Type-specific sandbox configuration.
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
    */
   export interface ConfigOverride {
     /**
@@ -801,6 +821,7 @@ export declare namespace Sandboxes {
   export {
     type SandboxListResponse as SandboxListResponse,
     type SandboxCreateResponse as SandboxCreateResponse,
+    type SandboxDeveloperSandboxEntryRolesResponse as SandboxDeveloperSandboxEntryRolesResponse,
     type SandboxListResponsesPageCursorURL as SandboxListResponsesPageCursorURL,
     type SandboxListParams as SandboxListParams,
     type SandboxCreateParams as SandboxCreateParams,

package/src/resources/sites.ts

@@ -720,7 +720,8 @@ export namespace SiteFileOperationsParams {
     kind: string;
 
     /**
-     * Operation type. Supported values are put, rename, move, and delete.
+     * Operation type. Supported values are put, rename, move, and delete. move is
+     * valid for files only; directories support put, rename, and delete.
      */
     op: string;
 

package/src/resources/workers.ts

@@ -343,6 +343,11 @@ export interface Worker {
    */
   compensation?: CompensationsAPI.Compensation;
 
+  /**
+   * The compensation grade assigned to the worker, if any.
+   */
+  compensation_grade?: Worker.CompensationGrade;
+
   /**
    * The compensation package for the worker.
    */
@@ -744,11 +749,22 @@ export interface Worker {
    */
   number?: number;
 
+  /**
+   * The worker's earliest start date across their employment history, excluding INIT
+   * roles.
+   */
+  original_start_date?: string;
+
   /**
    * The worker's overtime exemption status.
    */
   overtime_exemption?: 'EXEMPT' | 'NON_EXEMPT';
 
+  /**
+   * The ID of the pay schedule currently associated with the worker.
+   */
+  pay_schedule_id?: string;
+
   /**
    * The worker's associated personal email address.
    */
@@ -823,9 +839,29 @@ export interface Worker {
    * The worker's associated work email address.
    */
   work_email?: string;
+
+  /**
+   * The worker's scheduled working hours for each day of the week.
+   */
+  work_schedule?: { [key: string]: Worker.WorkSchedule };
 }
 
 export namespace Worker {
+  /**
+   * The compensation grade assigned to the worker, if any.
+   */
+  export interface CompensationGrade {
+    /**
+     * The compensation grade's unique identifier.
+     */
+    id?: string;
+
+    /**
+     * The compensation grade's label.
+     */
+    label?: string;
+  }
+
   /**
    * Country level fields for the worker.
    */
@@ -945,6 +981,16 @@ export namespace Worker {
       | 'RESCIND'
       | 'RENEGE';
   }
+
+  /**
+   * The scheduled working hours for a day of the week.
+   */
+  export interface WorkSchedule {
+    /**
+     * The number of scheduled working hours for the day.
+     */
+    hours?: number;
+  }
 }
 
 /**