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

package/src/resources/package-managed-installs.ts

@@ -0,0 +1,156 @@
+// 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 PackageManagedInstalls extends APIResource {
+  /**
+   * Start installing a published managed package version asynchronously. Unmanaged
+   * packages must use POST /package-installs/ instead.
+   */
+  create(
+    body: PackageManagedInstallCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PackageManagedInstallCreateResponse> {
+    return this._client.post('/package-managed-installs/', { body, ...options });
+  }
+
+  /**
+   * Retrieve the status of a managed package install.
+   */
+  retrieve(installID: string, options?: RequestOptions): APIPromise<PackageManagedInstallRetrieveResponse> {
+    return this._client.get(path`/package-managed-installs/${installID}/`, options);
+  }
+}
+
+/**
+ * Living managed package install in a subscriber company.
+ */
+export interface PackageManagedInstallCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The install key of the managed package install
+   */
+  install_key?: string;
+
+  /**
+   * The published package version currently installed or being installed
+   */
+  installed_version_id?: string;
+
+  /**
+   * The package key of the managed package
+   */
+  package_key?: string;
+
+  /**
+   * Component to open after installation completes
+   */
+  post_install_landing_component?: unknown;
+
+  /**
+   * Installation progress entries
+   */
+  progress?: Array<unknown>;
+
+  /**
+   * Managed install status (INSTALLING, UPDATING, UNINSTALLING, ACTIVE,
+   * ACTIVE_WITH_WARNINGS, UNINSTALLED, FAILED, or UNINSTALL_FAILED)
+   */
+  status?: string;
+}
+
+/**
+ * Living managed package install in a subscriber company.
+ */
+export interface PackageManagedInstallRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The install key of the managed package install
+   */
+  install_key?: string;
+
+  /**
+   * The published package version currently installed or being installed
+   */
+  installed_version_id?: string;
+
+  /**
+   * The package key of the managed package
+   */
+  package_key?: string;
+
+  /**
+   * Component to open after installation completes
+   */
+  post_install_landing_component?: unknown;
+
+  /**
+   * Installation progress entries
+   */
+  progress?: Array<unknown>;
+
+  /**
+   * Managed install status (INSTALLING, UPDATING, UNINSTALLING, ACTIVE,
+   * ACTIVE_WITH_WARNINGS, UNINSTALLED, FAILED, or UNINSTALL_FAILED)
+   */
+  status?: string;
+}
+
+export interface PackageManagedInstallCreateParams {
+  /**
+   * The install key for this managed package install.
+   */
+  install_key: string;
+
+  /**
+   * The package key of the managed package to install.
+   */
+  package_key: string;
+
+  /**
+   * The published package version to install.
+   */
+  version_id: string;
+}
+
+export declare namespace PackageManagedInstalls {
+  export {
+    type PackageManagedInstallCreateResponse as PackageManagedInstallCreateResponse,
+    type PackageManagedInstallRetrieveResponse as PackageManagedInstallRetrieveResponse,
+    type PackageManagedInstallCreateParams as PackageManagedInstallCreateParams,
+  };
+}

package/src/resources/package-sandbox-links.ts

@@ -0,0 +1,195 @@
+// 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 PackageSandboxLinks extends APIResource {
+  /**
+   * Link a package to a sandbox in EDIT or INSTALL mode.
+   */
+  create(
+    body: PackageSandboxLinkCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PackageSandboxLinkCreateResponse> {
+    return this._client.post('/package-sandbox-links/', { body, ...options });
+  }
+
+  /**
+   * Retrieve the status of a package sandbox link.
+   */
+  retrieve(trackerID: string, options?: RequestOptions): APIPromise<PackageSandboxLinkRetrieveResponse> {
+    return this._client.get(path`/package-sandbox-links/${trackerID}/`, options);
+  }
+}
+
+/**
+ * Request to link a package to a sandbox, or poll an EDIT-mode installation
+ * tracker.
+ */
+export interface PackageSandboxLinkCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * How the sandbox is linked to the package (INSTALL or EDIT)
+   */
+  mode: string;
+
+  /**
+   * The package key to link into the sandbox
+   */
+  package_key: string;
+
+  /**
+   * The company receiving the sandbox package installation
+   */
+  sandbox_company_id: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when EDIT-mode linking failed
+   */
+  error_message?: string;
+
+  /**
+   * Installation record ID when EDIT-mode linking completes
+   */
+  installation_record_id?: string;
+
+  /**
+   * The internal sandbox installation tracker ID
+   */
+  installation_tracker_id?: string;
+
+  /**
+   * The package version being linked in EDIT mode
+   */
+  package_version_id?: string;
+
+  /**
+   * Component to open after EDIT-mode linking completes
+   */
+  post_install_landing_component?: unknown;
+
+  /**
+   * EDIT-mode installation progress entries
+   */
+  progress?: Array<unknown>;
+
+  /**
+   * INSTALL completion status, or EDIT installation tracker status
+   */
+  status?: string;
+}
+
+/**
+ * Request to link a package to a sandbox, or poll an EDIT-mode installation
+ * tracker.
+ */
+export interface PackageSandboxLinkRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * How the sandbox is linked to the package (INSTALL or EDIT)
+   */
+  mode: string;
+
+  /**
+   * The package key to link into the sandbox
+   */
+  package_key: string;
+
+  /**
+   * The company receiving the sandbox package installation
+   */
+  sandbox_company_id: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when EDIT-mode linking failed
+   */
+  error_message?: string;
+
+  /**
+   * Installation record ID when EDIT-mode linking completes
+   */
+  installation_record_id?: string;
+
+  /**
+   * The internal sandbox installation tracker ID
+   */
+  installation_tracker_id?: string;
+
+  /**
+   * The package version being linked in EDIT mode
+   */
+  package_version_id?: string;
+
+  /**
+   * Component to open after EDIT-mode linking completes
+   */
+  post_install_landing_component?: unknown;
+
+  /**
+   * EDIT-mode installation progress entries
+   */
+  progress?: Array<unknown>;
+
+  /**
+   * INSTALL completion status, or EDIT installation tracker status
+   */
+  status?: string;
+}
+
+export interface PackageSandboxLinkCreateParams {
+  /**
+   * How the sandbox is linked to the package (INSTALL or EDIT)
+   */
+  mode: string;
+
+  /**
+   * The package key to link into the sandbox
+   */
+  package_key: string;
+
+  /**
+   * The company receiving the sandbox package installation
+   */
+  sandbox_company_id: string;
+}
+
+export declare namespace PackageSandboxLinks {
+  export {
+    type PackageSandboxLinkCreateResponse as PackageSandboxLinkCreateResponse,
+    type PackageSandboxLinkRetrieveResponse as PackageSandboxLinkRetrieveResponse,
+    type PackageSandboxLinkCreateParams as PackageSandboxLinkCreateParams,
+  };
+}

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

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  PackageVersions,
+  type PackageVersionRetrieveResponse,
+  type PackageVersionUpdateResponse,
+  type PackageVersionUpdateParams,
+} from './package-versions';
+export { Publish, type PublishCreateResponse } from './publish';

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

@@ -0,0 +1,156 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as PublishAPI from './publish';
+import { Publish, PublishCreateResponse } from './publish';
+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 {
+  publish: PublishAPI.Publish = new PublishAPI.Publish(this._client);
+
+  /**
+   * Get a package version by ID.
+   */
+  retrieve(versionID: string, options?: RequestOptions): APIPromise<PackageVersionRetrieveResponse> {
+    return this._client.get(path`/package-versions/${versionID}/`, options);
+  }
+
+  /**
+   * 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 PackageVersionRetrieveResponse {
+  /**
+   * 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 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.Publish = Publish;
+
+export declare namespace PackageVersions {
+  export {
+    type PackageVersionRetrieveResponse as PackageVersionRetrieveResponse,
+    type PackageVersionUpdateResponse as PackageVersionUpdateResponse,
+    type PackageVersionUpdateParams as PackageVersionUpdateParams,
+  };
+
+  export { Publish as Publish, type PublishCreateResponse as PublishCreateResponse };
+}

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

@@ -0,0 +1,74 @@
+// 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 Publish extends APIResource {
+  /**
+   * Publish a draft package version.
+   */
+  create(versionID: string, options?: RequestOptions): APIPromise<PublishCreateResponse> {
+    return this._client.post(path`/package-versions/${versionID}/publish/`, options);
+  }
+}
+
+export interface PublishCreateResponse {
+  /**
+   * 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 declare namespace Publish {
+  export { type PublishCreateResponse as PublishCreateResponse };
+}

package/src/resources/package-versions.ts

@@ -1,88 +1,3 @@
 // 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 PackageVersions extends APIResource {
-  /**
-   * 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;
-}
-
-export declare namespace PackageVersions {
-  export {
-    type PackageVersionUpdateResponse as PackageVersionUpdateResponse,
-    type PackageVersionUpdateParams as PackageVersionUpdateParams,
-  };
-}
+export * from './package-versions/index';

package/src/resources/packages/index.ts

@@ -17,4 +17,11 @@ export {
   type PackageUpdateParams,
   type PackageListResponsesPageCursorURL,
 } from './packages';
-export { Versions, type VersionCreateResponse, type VersionCreateParams } from './versions';
+export {
+  Versions,
+  type VersionListResponse,
+  type VersionCreateResponse,
+  type VersionListParams,
+  type VersionCreateParams,
+  type VersionListResponsesPageCursorURL,
+} from './versions';