@rippling/rippling-sdk 0.2.0-alpha.96 → 0.2.0-alpha.98

package/src/resources/metadata/metadata.ts

@@ -57,6 +57,25 @@ export class Metadata extends APIResource {
   ): APIPromise<MetadataExtractResponse> {
     return this._client.get('/metadata/extract/', { query, ...options });
   }
+
+  /**
+   * Extract exact metadata components and their complete dependency closure.
+   *
+   * Requires the Metadata entitlement.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metadata.extractByIdentifiers(
+   *   { identifiers: [{ foo: 'bar' }] },
+   * );
+   * ```
+   */
+  extractByIdentifiers(
+    body: MetadataExtractByIdentifiersParams,
+    options?: RequestOptions,
+  ): APIPromise<MetadataExtractByIdentifiersResponse> {
+    return this._client.post('/metadata/extract/', { body, ...options });
+  }
 }
 
 export interface MetadataExtractResponse {
@@ -127,6 +146,35 @@ export namespace MetadataExtractResponse {
   }
 }
 
+export interface MetadataExtractByIdentifiersResponse {
+  /**
+   * Full component configs needed to recreate the requested roots.
+   */
+  component_configs: Array<MetadataExtractByIdentifiersResponse.ComponentConfig>;
+
+  external_managed_dependencies: Array<{ [key: string]: unknown }>;
+
+  /**
+   * Topological install order for the extracted package.
+   */
+  install_order: Array<{ [key: string]: unknown }>;
+}
+
+export namespace MetadataExtractByIdentifiersResponse {
+  /**
+   * A metadata component config. The `type` field selects the concrete component
+   * schema. Fetch type-specific fields from GET /metadata/schema/?type=<TYPE>.
+   */
+  export interface ComponentConfig {
+    /**
+     * Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.
+     */
+    type: string;
+
+    [k: string]: unknown;
+  }
+}
+
 export interface MetadataExtractParams {
   /**
    * Maximum search results to return when q is provided.
@@ -139,6 +187,10 @@ export interface MetadataExtractParams {
   q?: string;
 }
 
+export interface MetadataExtractByIdentifiersParams {
+  identifiers: Array<{ [key: string]: unknown }>;
+}
+
 Metadata.Types = Types;
 Metadata.Schema = Schema;
 Metadata.Components = Components;
@@ -148,7 +200,9 @@ Metadata.DeploymentRuns = DeploymentRuns;
 export declare namespace Metadata {
   export {
     type MetadataExtractResponse as MetadataExtractResponse,
+    type MetadataExtractByIdentifiersResponse as MetadataExtractByIdentifiersResponse,
     type MetadataExtractParams as MetadataExtractParams,
+    type MetadataExtractByIdentifiersParams as MetadataExtractByIdentifiersParams,
   };
 
   export { Types as Types, type TypeListResponse as TypeListResponse };

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/sandboxes.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
 import { APIPromise } from '../core/api-promise';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { buildHeaders } from '../internal/headers';
@@ -32,6 +33,13 @@ export class Sandboxes extends APIResource {
     return this._client.post('/sandboxes/', { body, ...options });
   }
 
+  /**
+   * Retrieve a specific sandbox
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SandboxRetrieveResponse> {
+    return this._client.get(path`/sandboxes/${id}/`, options);
+  }
+
   /**
    * Delete a sandbox
    */
@@ -561,6 +569,262 @@ export namespace SandboxCreateResponse {
   }
 }
 
+/**
+ * Meta information for the response.
+ */
+export interface SandboxRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Display name of the sandbox.
+   */
+  name: string;
+
+  /**
+   * Sandbox type: developer or full data.
+   */
+  type: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
+   */
+  config_override?: SandboxRetrieveResponse.ConfigOverride;
+
+  /**
+   * Optional sandbox description.
+   */
+  description?: string;
+
+  /**
+   * Server-generated sandbox handle.
+   */
+  handle?: string;
+
+  /**
+   * Current lifecycle status.
+   */
+  status?: string;
+}
+
+export namespace SandboxRetrieveResponse {
+  /**
+   * Type-specific sandbox configuration. Optional for developer sandboxes.
+   */
+  export interface ConfigOverride {
+    /**
+     * Custom objects copied into the sandbox.
+     */
+    custom_objects?: ConfigOverride.CustomObjects;
+
+    /**
+     * Required for developer sandboxes and omitted for full-data sandboxes.
+     */
+    developer?: ConfigOverride.Developer;
+
+    /**
+     * General outbound notification controls.
+     */
+    general_notifications?: ConfigOverride.GeneralNotifications;
+
+    /**
+     * Required for connected full-data sandboxes.
+     */
+    integrations?: ConfigOverride.Integrations;
+
+    /**
+     * Required for full-data sandboxes. Developer sandboxes default to CONNECTED.
+     */
+    sandbox_mode?: 'CONNECTED' | 'ISOLATED';
+
+    /**
+     * Workflow webhook controls.
+     */
+    workflow_webhooks?: ConfigOverride.WorkflowWebhooks;
+  }
+
+  export namespace ConfigOverride {
+    /**
+     * Custom objects copied into the sandbox.
+     */
+    export interface CustomObjects {
+      /**
+       * Custom object API names copied into the sandbox.
+       */
+      co_api_names?: Array<string>;
+    }
+
+    /**
+     * Required for developer sandboxes and omitted for full-data sandboxes.
+     */
+    export interface Developer {
+      /**
+       * Seed company size for the developer sandbox.
+       */
+      company_size: 'SMALL' | 'MID' | 'XL';
+    }
+
+    /**
+     * General outbound notification controls.
+     */
+    export interface GeneralNotifications {
+      /**
+       * Email notification configuration.
+       */
+      email: GeneralNotifications.Email;
+
+      /**
+       * Push notification configuration.
+       */
+      push_notifications: GeneralNotifications.PushNotifications;
+
+      /**
+       * SMS notification configuration.
+       */
+      sms: GeneralNotifications.SMS;
+
+      /**
+       * Slack notification configuration.
+       */
+      slack?: GeneralNotifications.Slack;
+
+      /**
+       * Microsoft Teams notification configuration.
+       */
+      teams?: GeneralNotifications.Teams;
+    }
+
+    export namespace GeneralNotifications {
+      /**
+       * Email notification configuration.
+       */
+      export interface Email {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+
+      /**
+       * Push notification configuration.
+       */
+      export interface PushNotifications {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+
+      /**
+       * SMS notification configuration.
+       */
+      export interface SMS {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+
+      /**
+       * Slack notification configuration.
+       */
+      export interface Slack {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Public channels allowed to receive outbound messages.
+         */
+        allowed_public_channels?: Array<string>;
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+
+      /**
+       * Microsoft Teams notification configuration.
+       */
+      export interface Teams {
+        /**
+         * Whether outbound messages are allowed or suppressed.
+         */
+        outbound_behavior: 'SUPPRESS' | 'ALLOW';
+
+        /**
+         * Public channels allowed to receive outbound messages.
+         */
+        allowed_public_channels?: Array<string>;
+
+        /**
+         * Users allowed to receive outbound messages.
+         */
+        allowed_users?: Array<string>;
+      }
+    }
+
+    /**
+     * Required for connected full-data sandboxes.
+     */
+    export interface Integrations {
+      /**
+       * Confirms acceptance of the risks of connected third-party integrations.
+       */
+      is_risk_acknowledged: boolean;
+    }
+
+    /**
+     * Workflow webhook controls.
+     */
+    export interface WorkflowWebhooks {
+      /**
+       * IP addresses allowed to receive workflow webhooks.
+       */
+      allowed_ips?: Array<string>;
+
+      /**
+       * Webhook URLs allowed in the sandbox.
+       */
+      allowlisted_webhook_urls?: Array<string>;
+
+      /**
+       * Whether workflow webhook traffic is allowed or suppressed.
+       */
+      outbound_behavior?: 'SUPPRESS' | 'ALLOW';
+    }
+  }
+}
+
 /**
  * Company and administrator role used to enter a developer sandbox.
  */
@@ -821,6 +1085,7 @@ export declare namespace Sandboxes {
   export {
     type SandboxListResponse as SandboxListResponse,
     type SandboxCreateResponse as SandboxCreateResponse,
+    type SandboxRetrieveResponse as SandboxRetrieveResponse,
     type SandboxDeveloperSandboxEntryRolesResponse as SandboxDeveloperSandboxEntryRolesResponse,
     type SandboxListResponsesPageCursorURL as SandboxListResponsesPageCursorURL,
     type SandboxListParams as SandboxListParams,

package/src/resources/sites.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Custom sites hosted on Rippling
+ */
 export class Sites extends APIResource {
   /**
    * Retrieves sites that the user has view or edit access on. Optional query param