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

package/src/resources/metadata/metadata.ts

@@ -1,30 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as ComponentSchemasAPI from './component-schemas';
-import { ComponentSchemaGetParams, ComponentSchemaGetResponse, ComponentSchemas } from './component-schemas';
-import * as ComponentTypesAPI from './component-types';
-import { ComponentTypeListResponse, ComponentTypes } from './component-types';
 import * as ComponentsAPI from './components';
 import {
   ComponentDeployParams,
   ComponentDeployResponse,
-  ComponentExtractParams,
-  ComponentExtractResponse,
   ComponentValidateParams,
   ComponentValidateResponse,
-  ComponentValidateV2Params,
-  ComponentValidateV2Response,
   Components,
 } from './components';
 import * as DeploymentRunsAPI from './deployment-runs';
 import {
   DeploymentRunCreateParams,
   DeploymentRunCreateResponse,
-  DeploymentRunCreateV2Params,
-  DeploymentRunCreateV2Response,
   DeploymentRunGetResponse,
-  DeploymentRunGetV2Response,
   DeploymentRuns,
 } from './deployment-runs';
 import * as SchemaAPI from './schema';
@@ -35,10 +24,7 @@ import * as ValidationRunsAPI from './validation-runs';
 import {
   ValidationRunCreateParams,
   ValidationRunCreateResponse,
-  ValidationRunCreateV2Params,
-  ValidationRunCreateV2Response,
   ValidationRunGetResponse,
-  ValidationRunGetV2Response,
   ValidationRuns,
 } from './validation-runs';
 import { APIPromise } from '../../core/api-promise';
@@ -50,10 +36,6 @@ import { RequestOptions } from '../../internal/request-options';
 export class Metadata extends APIResource {
   types: TypesAPI.Types = new TypesAPI.Types(this._client);
   schema: SchemaAPI.Schema = new SchemaAPI.Schema(this._client);
-  componentTypes: ComponentTypesAPI.ComponentTypes = new ComponentTypesAPI.ComponentTypes(this._client);
-  componentSchemas: ComponentSchemasAPI.ComponentSchemas = new ComponentSchemasAPI.ComponentSchemas(
-    this._client,
-  );
   components: ComponentsAPI.Components = new ComponentsAPI.Components(this._client);
   validationRuns: ValidationRunsAPI.ValidationRuns = new ValidationRunsAPI.ValidationRuns(this._client);
   deploymentRuns: DeploymentRunsAPI.DeploymentRuns = new DeploymentRunsAPI.DeploymentRuns(this._client);
@@ -159,8 +141,6 @@ export interface MetadataExtractParams {
 
 Metadata.Types = Types;
 Metadata.Schema = Schema;
-Metadata.ComponentTypes = ComponentTypes;
-Metadata.ComponentSchemas = ComponentSchemas;
 Metadata.Components = Components;
 Metadata.ValidationRuns = ValidationRuns;
 Metadata.DeploymentRuns = DeploymentRuns;
@@ -179,43 +159,25 @@ export declare namespace Metadata {
     type SchemaGetParams as SchemaGetParams,
   };
 
-  export { ComponentTypes as ComponentTypes, type ComponentTypeListResponse as ComponentTypeListResponse };
-
-  export {
-    ComponentSchemas as ComponentSchemas,
-    type ComponentSchemaGetResponse as ComponentSchemaGetResponse,
-    type ComponentSchemaGetParams as ComponentSchemaGetParams,
-  };
-
   export {
     Components as Components,
-    type ComponentExtractResponse as ComponentExtractResponse,
-    type ComponentValidateV2Response as ComponentValidateV2Response,
     type ComponentValidateResponse as ComponentValidateResponse,
     type ComponentDeployResponse as ComponentDeployResponse,
-    type ComponentExtractParams as ComponentExtractParams,
-    type ComponentValidateV2Params as ComponentValidateV2Params,
     type ComponentValidateParams as ComponentValidateParams,
     type ComponentDeployParams as ComponentDeployParams,
   };
 
   export {
     ValidationRuns as ValidationRuns,
-    type ValidationRunCreateV2Response as ValidationRunCreateV2Response,
-    type ValidationRunGetV2Response as ValidationRunGetV2Response,
     type ValidationRunCreateResponse as ValidationRunCreateResponse,
     type ValidationRunGetResponse as ValidationRunGetResponse,
-    type ValidationRunCreateV2Params as ValidationRunCreateV2Params,
     type ValidationRunCreateParams as ValidationRunCreateParams,
   };
 
   export {
     DeploymentRuns as DeploymentRuns,
-    type DeploymentRunCreateV2Response as DeploymentRunCreateV2Response,
-    type DeploymentRunGetV2Response as DeploymentRunGetV2Response,
     type DeploymentRunCreateResponse as DeploymentRunCreateResponse,
     type DeploymentRunGetResponse as DeploymentRunGetResponse,
-    type DeploymentRunCreateV2Params as DeploymentRunCreateV2Params,
     type DeploymentRunCreateParams as DeploymentRunCreateParams,
   };
 }

package/src/resources/metadata/validation-runs.ts

@@ -10,71 +10,6 @@ import { path } from '../../internal/utils/path';
  * Custom objects defined by the company
  */
 export class ValidationRuns extends APIResource {
-  /**
-   * Queue validation for a metadata component package and return a run id for
-   * polling.
-   *
-   * Requires the Metadata entitlement.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.metadata.validationRuns.createV2({
-   *     components: [
-   *       {
-   *         type: 'CUSTOM_OBJECT',
-   *         api_name: 'purchase_order__c',
-   *         name: 'Purchase Order',
-   *         description: 'Tracks purchase requests',
-   *         category_api_name: 'procurement__c',
-   *       },
-   *       {
-   *         type: 'CUSTOM_OBJECT_FIELD',
-   *         custom_object_api_name: 'purchase_order__c',
-   *         field_api_name: 'amount__c',
-   *         field_display_name: 'Amount',
-   *         data_type: {
-   *           field_type: 'CURRENCY',
-   *           currency: 'USD',
-   *           num_of_decimal_places: 2,
-   *         },
-   *         is_standard: false,
-   *       },
-   *     ],
-   *   });
-   * ```
-   */
-  createV2(
-    params: ValidationRunCreateV2Params,
-    options?: RequestOptions,
-  ): APIPromise<ValidationRunCreateV2Response> {
-    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
-    return this._client.post('/metadata/v2/validation-runs/', {
-      body,
-      ...options,
-      headers: buildHeaders([
-        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
-        options?.headers,
-      ]),
-    });
-  }
-
-  /**
-   * Poll a metadata validation run until the terminal field is true.
-   *
-   * Requires the Metadata entitlement.
-   *
-   * @example
-   * ```ts
-   * const response = await client.metadata.validationRuns.getV2(
-   *   'run_id',
-   * );
-   * ```
-   */
-  getV2(runID: string, options?: RequestOptions): APIPromise<ValidationRunGetV2Response> {
-    return this._client.get(path`/metadata/v2/validation-runs/${runID}/`, options);
-  }
-
   /**
    * Queue validation for a metadata component package and return a run id for
    * polling.
@@ -140,80 +75,6 @@ export class ValidationRuns extends APIResource {
   }
 }
 
-export interface ValidationRunCreateV2Response {
-  /**
-   * Metadata run id.
-   */
-  id: string;
-
-  progress: { [key: string]: unknown };
-
-  /**
-   * Suggested client polling delay in milliseconds.
-   */
-  retry_after_ms: number;
-
-  status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
-
-  /**
-   * Whether the run has reached a terminal status.
-   */
-  terminal: boolean;
-
-  type: 'validation' | 'deployment';
-
-  created_at?: string | null;
-
-  error?: { [key: string]: unknown } | null;
-
-  expires_at?: string | null;
-
-  finished_at?: string | null;
-
-  result?: { [key: string]: unknown } | null;
-
-  started_at?: string | null;
-
-  updated_at?: string | null;
-}
-
-export interface ValidationRunGetV2Response {
-  /**
-   * Metadata run id.
-   */
-  id: string;
-
-  progress: { [key: string]: unknown };
-
-  /**
-   * Suggested client polling delay in milliseconds.
-   */
-  retry_after_ms: number;
-
-  status: 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'expired';
-
-  /**
-   * Whether the run has reached a terminal status.
-   */
-  terminal: boolean;
-
-  type: 'validation' | 'deployment';
-
-  created_at?: string | null;
-
-  error?: { [key: string]: unknown } | null;
-
-  expires_at?: string | null;
-
-  finished_at?: string | null;
-
-  result?: { [key: string]: unknown } | null;
-
-  started_at?: string | null;
-
-  updated_at?: string | null;
-}
-
 export interface ValidationRunCreateResponse {
   /**
    * Metadata run id.
@@ -288,34 +149,6 @@ export interface ValidationRunGetResponse {
   updated_at?: string | null;
 }
 
-export interface ValidationRunCreateV2Params {
-  /**
-   * Body param: Complete package of metadata components, including dependencies.
-   */
-  components: Array<ValidationRunCreateV2Params.Component>;
-
-  /**
-   * Header param: Optional idempotency key used to deduplicate retried create
-   * requests.
-   */
-  'Idempotency-Key'?: string;
-}
-
-export namespace ValidationRunCreateV2Params {
-  /**
-   * A metadata component config. The `type` field selects the concrete component
-   * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
-   */
-  export interface Component {
-    /**
-     * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
-     */
-    type: string;
-
-    [k: string]: unknown;
-  }
-}
-
 export interface ValidationRunCreateParams {
   /**
    * Body param: Complete package of metadata components, including dependencies.
@@ -346,11 +179,8 @@ export namespace ValidationRunCreateParams {
 
 export declare namespace ValidationRuns {
   export {
-    type ValidationRunCreateV2Response as ValidationRunCreateV2Response,
-    type ValidationRunGetV2Response as ValidationRunGetV2Response,
     type ValidationRunCreateResponse as ValidationRunCreateResponse,
     type ValidationRunGetResponse as ValidationRunGetResponse,
-    type ValidationRunCreateV2Params as ValidationRunCreateV2Params,
     type ValidationRunCreateParams as ValidationRunCreateParams,
   };
 }

package/src/resources/package-upgrades.ts

@@ -0,0 +1,183 @@
+// 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 PackageUpgrades extends APIResource {
+  /**
+   * Start upgrading a managed package install asynchronously.
+   */
+  create(
+    body: PackageUpgradeCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PackageUpgradeCreateResponse> {
+    return this._client.post('/package-upgrades/', { body, ...options });
+  }
+
+  /**
+   * Retrieve the status of a managed package upgrade.
+   */
+  retrieve(trackerID: string, options?: RequestOptions): APIPromise<PackageUpgradeRetrieveResponse> {
+    return this._client.get(path`/package-upgrades/${trackerID}/`, options);
+  }
+}
+
+/**
+ * Async managed package upgrade tracker for subscriber companies.
+ */
+export interface PackageUpgradeCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when upgrade failed
+   */
+  error_message?: string;
+
+  /**
+   * The install key of the managed package install
+   */
+  install_key?: string;
+
+  /**
+   * The published package version being upgraded to
+   */
+  new_version_id?: string;
+
+  /**
+   * The currently installed package version being upgraded from
+   */
+  old_version_id?: string;
+
+  /**
+   * The package key of the managed package
+   */
+  package_key?: string;
+
+  /**
+   * Component to open after upgrade completes
+   */
+  post_install_landing_component?: unknown;
+
+  /**
+   * Upgrade status (IN_PROGRESS, COMPLETE, or FAILED)
+   */
+  status?: string;
+
+  /**
+   * Upgrade plan snapshot when available
+   */
+  upgrade_plan?: unknown;
+
+  /**
+   * Components upgraded so far
+   */
+  upgraded_components?: Array<unknown>;
+}
+
+/**
+ * Async managed package upgrade tracker for subscriber companies.
+ */
+export interface PackageUpgradeRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Error message when upgrade failed
+   */
+  error_message?: string;
+
+  /**
+   * The install key of the managed package install
+   */
+  install_key?: string;
+
+  /**
+   * The published package version being upgraded to
+   */
+  new_version_id?: string;
+
+  /**
+   * The currently installed package version being upgraded from
+   */
+  old_version_id?: string;
+
+  /**
+   * The package key of the managed package
+   */
+  package_key?: string;
+
+  /**
+   * Component to open after upgrade completes
+   */
+  post_install_landing_component?: unknown;
+
+  /**
+   * Upgrade status (IN_PROGRESS, COMPLETE, or FAILED)
+   */
+  status?: string;
+
+  /**
+   * Upgrade plan snapshot when available
+   */
+  upgrade_plan?: unknown;
+
+  /**
+   * Components upgraded so far
+   */
+  upgraded_components?: Array<unknown>;
+}
+
+export interface PackageUpgradeCreateParams {
+  /**
+   * The install key of the managed package install to upgrade.
+   */
+  install_key: string;
+
+  /**
+   * The package key of the managed package to upgrade.
+   */
+  package_key: string;
+
+  /**
+   * The published package version to upgrade to.
+   */
+  version_id: string;
+}
+
+export declare namespace PackageUpgrades {
+  export {
+    type PackageUpgradeCreateResponse as PackageUpgradeCreateResponse,
+    type PackageUpgradeRetrieveResponse as PackageUpgradeRetrieveResponse,
+    type PackageUpgradeCreateParams as PackageUpgradeCreateParams,
+  };
+}

package/src/resources/package-versions.ts

@@ -1,3 +1,88 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './package-versions/index';
+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,
+  };
+}

package/src/resources/packages/available-upgrades.ts

@@ -0,0 +1,51 @@
+// 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 AvailableUpgrades extends APIResource {
+  /**
+   * List published package versions higher than the version installed for the given
+   * install_key.
+   */
+  retrieve(
+    packageKey: string,
+    query: AvailableUpgradeRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<AvailableUpgradeRetrieveResponse> {
+    return this._client.get(path`/packages/${packageKey}/available-upgrades/`, { query, ...options });
+  }
+}
+
+export interface AvailableUpgradeRetrieveResponse {
+  results?: Array<AvailableUpgradeRetrieveResponse.Result>;
+}
+
+export namespace AvailableUpgradeRetrieveResponse {
+  export interface Result {
+    id?: string;
+
+    description?: string;
+
+    version_number?: string;
+  }
+}
+
+export interface AvailableUpgradeRetrieveParams {
+  /**
+   * The install key of the managed package install.
+   */
+  install_key: string;
+}
+
+export declare namespace AvailableUpgrades {
+  export {
+    type AvailableUpgradeRetrieveResponse as AvailableUpgradeRetrieveResponse,
+    type AvailableUpgradeRetrieveParams as AvailableUpgradeRetrieveParams,
+  };
+}

package/src/resources/packages/index.ts

@@ -1,5 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  AvailableUpgrades,
+  type AvailableUpgradeRetrieveResponse,
+  type AvailableUpgradeRetrieveParams,
+} from './available-upgrades';
+export { NextVersions, type NextVersionCreateResponse, type NextVersionCreateParams } from './next-versions';
 export {
   Packages,
   type PackageListResponse,

package/src/resources/{package-versions → packages}/next-versions.ts

@@ -11,15 +11,15 @@ import { path } from '../../internal/utils/path';
 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.
+   * the package's latest published version. Returns the new PackageVersion. The
+   * source is always package.latest_version.
    */
   create(
-    versionID: string,
+    packageKey: string,
     body: NextVersionCreateParams,
     options?: RequestOptions,
   ): APIPromise<NextVersionCreateResponse> {
-    return this._client.post(path`/package-versions/${versionID}/next-versions/`, { body, ...options });
+    return this._client.post(path`/packages/${packageKey}/next-versions/`, { body, ...options });
   }
 }