@rippling/rippling-sdk 0.2.0-alpha.87 → 0.2.0-alpha.89

package/src/resources/package-uninstalls.ts

@@ -0,0 +1,168 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Author, publish, and install Unity Packages V2 packages
+ */
+export class PackageUninstalls extends APIResource {
+  /**
+   * Start uninstalling a managed package install asynchronously.
+   */
+  create(
+    body: PackageUninstallCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PackageUninstallCreateResponse> {
+    return this._client.post('/package-uninstalls/', { body, ...options });
+  }
+
+  /**
+   * Retrieve the status of a managed package uninstallation.
+   */
+  retrieve(trackerID: string, options?: RequestOptions): APIPromise<PackageUninstallRetrieveResponse> {
+    return this._client.get(path`/package-uninstalls/${trackerID}/`, options);
+  }
+}
+
+/**
+ * Async managed package uninstall tracker for subscriber companies.
+ */
+export interface PackageUninstallCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when uninstallation failed
+   */
+  error_message?: string;
+
+  /**
+   * The install key of the managed package install
+   */
+  install_key?: string;
+
+  /**
+   * The installed package version being uninstalled
+   */
+  installed_version_id?: string;
+
+  /**
+   * The managed package install being uninstalled
+   */
+  managed_install_id?: string;
+
+  /**
+   * The package key of the managed package
+   */
+  package_key?: string;
+
+  /**
+   * Uninstallation status (IN_PROGRESS, COMPLETE, or FAILED)
+   */
+  status?: string;
+
+  /**
+   * Uninstall plan snapshot when available
+   */
+  uninstall_plan?: unknown;
+
+  /**
+   * Components uninstalled so far
+   */
+  uninstalled_components?: Array<unknown>;
+}
+
+/**
+ * Async managed package uninstall tracker for subscriber companies.
+ */
+export interface PackageUninstallRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when uninstallation failed
+   */
+  error_message?: string;
+
+  /**
+   * The install key of the managed package install
+   */
+  install_key?: string;
+
+  /**
+   * The installed package version being uninstalled
+   */
+  installed_version_id?: string;
+
+  /**
+   * The managed package install being uninstalled
+   */
+  managed_install_id?: string;
+
+  /**
+   * The package key of the managed package
+   */
+  package_key?: string;
+
+  /**
+   * Uninstallation status (IN_PROGRESS, COMPLETE, or FAILED)
+   */
+  status?: string;
+
+  /**
+   * Uninstall plan snapshot when available
+   */
+  uninstall_plan?: unknown;
+
+  /**
+   * Components uninstalled so far
+   */
+  uninstalled_components?: Array<unknown>;
+}
+
+export interface PackageUninstallCreateParams {
+  /**
+   * The install key of the managed package install to uninstall.
+   */
+  install_key: string;
+
+  /**
+   * The package key of the managed package to uninstall.
+   */
+  package_key: string;
+}
+
+export declare namespace PackageUninstalls {
+  export {
+    type PackageUninstallCreateResponse as PackageUninstallCreateResponse,
+    type PackageUninstallRetrieveResponse as PackageUninstallRetrieveResponse,
+    type PackageUninstallCreateParams as PackageUninstallCreateParams,
+  };
+}

package/src/resources/package-version-component-updates.ts

@@ -0,0 +1,154 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Author, publish, and install Unity Packages V2 packages
+ */
+export class PackageVersionComponentUpdates extends APIResource {
+  /**
+   * Start an asynchronous package version component update or preview for a draft
+   * version. Returns a tracker immediately (202). Poll GET
+   * /package-version-component-updates/{id}/ until status is COMPLETE or FAILED.
+   * When is_preview_mode is true, the version is not saved; extraction_result is the
+   * would-change diff. When false, the version is persisted and extraction_result is
+   * the did-change diff.
+   */
+  create(
+    body: PackageVersionComponentUpdateCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PackageVersionComponentUpdateCreateResponse> {
+    return this._client.post('/package-version-component-updates/', { body, ...options });
+  }
+
+  /**
+   * Poll a package version component update or preview tracker. On COMPLETE,
+   * extraction_result contains added_nodes, removed_nodes, updated_nodes, and
+   * package_version_id. On FAILED, status is FAILED and error_message is set. Same
+   * response shape for preview and apply.
+   */
+  retrieve(
+    trackerID: string,
+    options?: RequestOptions,
+  ): APIPromise<PackageVersionComponentUpdateRetrieveResponse> {
+    return this._client.get(path`/package-version-component-updates/${trackerID}/`, options);
+  }
+}
+
+/**
+ * Async package version component-update tracker for publisher companies.
+ */
+export interface PackageVersionComponentUpdateCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when the update failed
+   */
+  error_message?: string;
+
+  /**
+   * Diff of added, removed, and updated nodes when status is COMPLETE. In preview
+   * mode this is what would change; in apply mode this is what did change. Null
+   * while the update is in progress.
+   */
+  extraction_result?: unknown;
+
+  /**
+   * The package version being updated
+   */
+  package_version_id?: string;
+
+  /**
+   * Update status (IN_PROGRESS, COMPLETE, or FAILED)
+   */
+  status?: string;
+}
+
+/**
+ * Async package version component-update tracker for publisher companies.
+ */
+export interface PackageVersionComponentUpdateRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when the update failed
+   */
+  error_message?: string;
+
+  /**
+   * Diff of added, removed, and updated nodes when status is COMPLETE. In preview
+   * mode this is what would change; in apply mode this is what did change. Null
+   * while the update is in progress.
+   */
+  extraction_result?: unknown;
+
+  /**
+   * The package version being updated
+   */
+  package_version_id?: string;
+
+  /**
+   * Update status (IN_PROGRESS, COMPLETE, or FAILED)
+   */
+  status?: string;
+}
+
+export interface PackageVersionComponentUpdateCreateParams {
+  /**
+   * The update action to perform.
+   */
+  action: 'ADD' | 'REMOVE' | 'REFRESH';
+
+  /**
+   * The draft package version to update.
+   */
+  version_id: string;
+
+  /**
+   * When true, compute the component diff without persisting the version. When
+   * false, apply and save the changes. Same tracker contract in both modes.
+   */
+  is_preview_mode?: boolean;
+
+  /**
+   * Component identifiers required for ADD and REMOVE.
+   */
+  nodes?: Array<unknown>;
+}
+
+export declare namespace PackageVersionComponentUpdates {
+  export {
+    type PackageVersionComponentUpdateCreateResponse as PackageVersionComponentUpdateCreateResponse,
+    type PackageVersionComponentUpdateRetrieveResponse as PackageVersionComponentUpdateRetrieveResponse,
+    type PackageVersionComponentUpdateCreateParams as PackageVersionComponentUpdateCreateParams,
+  };
+}

package/src/resources/package-versions/index.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { NextVersions, type NextVersionCreateResponse, type NextVersionCreateParams } from './next-versions';
+export {
+  PackageVersions,
+  type PackageVersionUpdateResponse,
+  type PackageVersionUpdateParams,
+} from './package-versions';

package/src/resources/package-versions/next-versions.ts

@@ -0,0 +1,95 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Author, publish, and install Unity Packages V2 packages
+ */
+export class NextVersions extends APIResource {
+  /**
+   * Create a new unpublished package version by re-extracting the components from
+   * the latest published version. The source version is identified by version_id in
+   * the path and must be the package's latest published version.
+   */
+  create(
+    versionID: string,
+    body: NextVersionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<NextVersionCreateResponse> {
+    return this._client.post(path`/package-versions/${versionID}/next-versions/`, { body, ...options });
+  }
+}
+
+export interface NextVersionCreateResponse {
+  /**
+   * 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 NextVersionCreateParams {
+  /**
+   * The version number for the new unpublished draft.
+   */
+  version_number: string;
+
+  /**
+   * Optional description for the new draft.
+   */
+  description?: string;
+}
+
+export declare namespace NextVersions {
+  export {
+    type NextVersionCreateResponse as NextVersionCreateResponse,
+    type NextVersionCreateParams as NextVersionCreateParams,
+  };
+}

package/src/resources/package-versions/package-versions.ts

@@ -0,0 +1,100 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as NextVersionsAPI from './next-versions';
+import { NextVersionCreateParams, NextVersionCreateResponse, NextVersions } from './next-versions';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Author, publish, and install Unity Packages V2 packages
+ */
+export class PackageVersions extends APIResource {
+  nextVersions: NextVersionsAPI.NextVersions = new NextVersionsAPI.NextVersions(this._client);
+
+  /**
+   * Update the description of an unpublished package version.
+   */
+  update(
+    versionID: string,
+    body: PackageVersionUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<PackageVersionUpdateResponse> {
+    return this._client.patch(path`/package-versions/${versionID}/`, { body, ...options });
+  }
+}
+
+export interface PackageVersionUpdateResponse {
+  /**
+   * 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 PackageVersionUpdateParams {
+  /**
+   * The new description for the draft package version.
+   */
+  description: string;
+}
+
+PackageVersions.NextVersions = NextVersions;
+
+export declare namespace PackageVersions {
+  export {
+    type PackageVersionUpdateResponse as PackageVersionUpdateResponse,
+    type PackageVersionUpdateParams as PackageVersionUpdateParams,
+  };
+
+  export {
+    NextVersions as NextVersions,
+    type NextVersionCreateResponse as NextVersionCreateResponse,
+    type NextVersionCreateParams as NextVersionCreateParams,
+  };
+}

package/src/resources/package-versions.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './package-versions/index';

package/src/resources/packages/packages.ts

@@ -260,6 +260,11 @@ export interface PackageListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/packages/versions.ts

@@ -23,24 +23,29 @@ export class Versions extends APIResource {
 
 export interface VersionCreateResponse {
   /**
-   * The semantic version number for this package version
+   * Identifier field
    */
-  version_number: string;
+  id: string;
 
   /**
-   * The unique identifier of the package version
+   * Record creation date
    */
-  id?: string;
+  created_at: string;
 
   /**
-   * Components included in this package version
+   * Record update date
    */
-  components?: Array<unknown>;
+  updated_at: string;
 
   /**
-   * Record creation date
+   * The semantic version number for this package version
    */
-  created_at?: string;
+  version_number: string;
+
+  /**
+   * Components included in this package version
+   */
+  components?: Array<unknown>;
 
   /**
    * The description of the package version
@@ -66,11 +71,6 @@ export interface VersionCreateResponse {
    * The package key of the parent package
    */
   package_key?: string;
-
-  /**
-   * Record update date
-   */
-  updated_at?: string;
 }
 
 export interface VersionCreateParams {
@@ -79,11 +79,6 @@ export interface VersionCreateParams {
    */
   version_number: string;
 
-  /**
-   * Components included in this package version
-   */
-  components?: Array<unknown>;
-
   /**
    * The description of the package version
    */

package/src/resources/payroll-runs/payroll-runs.ts

@@ -248,6 +248,13 @@ export namespace PayrollRunRetrieveResponse {
 }
 
 export interface PayrollRunListParams {
+  cursor?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/payroll-runs/worker-payroll-records.ts

@@ -244,6 +244,11 @@ export interface WorkerPayrollRecordListParams {
    * OData-style filter. Only `worker_id in ('<id1>', '<id2>', ...)` is supported.
    */
   filter?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
 }
 
 export declare namespace WorkerPayrollRecords {