Rippling: Create a package version from a manifest
Rippling restApi.createPackageVersionFromManifest: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.create_package_version_from_manifest
Provider route: POST /package-manifests/packages/{package_key}/versions/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["createPackageVersionFromManifest"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.createPackageVersionFromManifest(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.create_package_version_from_manifest(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.package_key | string | Required within parent | |
body | Model | Required within parent | Expand Create a package version from a manifest — request body — body |
Referenced models: Create a package version from a manifest — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get a package version — response body |
Referenced models: Get a package version — response body
Schemas
Section titled “Schemas”Get a package version — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
components | array | Optional | Components included in this version. Function identifiers provide valid post_install_function values. |
components[] | object | Each item | Additional keys: allowed |
components[].identifier | object | Required within parent | Additional keys: allowed |
components[].identifier.api_name | string | Optional | The portable API name. Present on FUNCTION identifiers; other component kinds may use different identity fields. |
components[].identifier.type | string | Required within parent | The component kind. FUNCTION identifies a packaged Function. |
created_at | string | Required within parent | Record creation date |
description | string | Optional | The description of the package version |
id | string | Required within parent | Identifier field |
is_published | boolean | Optional | Whether this package version has been published |
package_display_name | string | Optional | The display name of the parent package |
package_id | string | Optional | The ID of the parent package |
package_key | string | Optional | The package key of the parent package |
post_install_function | JSON | Optional | |
post_install_function (anyOf 1) | string | Alternative | The portable API name of a Function component included in this version. Find valid values in components entries with identifier.type equal to FUNCTION, using identifier.api_name. Set through PATCH on an unpublished version after adding the Function. Creation rejects this field. Null clears the hook and omission preserves it. Removing the Function clears the setting when the version is refreshed or copied. |
post_install_function (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | Record update date |
version_number | string | Required within parent | The semantic version number for this package version |
Create a package version from a manifest — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Optional package version description, independent of manifest metadata. |
description (anyOf 2) | null | Alternative | |
manifest | Model | Required within parent | Expand Create a package version from a manifest — request body — body manifest |
version_number | string | Required within parent | The semantic version number for the new draft version, for example 1.0.0. Minimum length: 1 |
Referenced models: Create a package version from a manifest — request body — body manifest
Create a package version from a manifest — request body — body manifest
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Complete desired package component snapshot from the SDK manifest. Additional keys: not allowed |
components | array | Required within parent | Complete desired component snapshot compiled from the Metadata SDK's defineManifest. Each entry requires its component type and full configuration for that type. An empty array creates an empty draft version; it cannot be published until components are added. |
components[] | object | Each item | |
components_to_delete | array | Optional | Must be omitted or an empty array. Versions are complete snapshots, so deletion instructions are rejected. Default: [] Maximum items: 0 |
components_to_delete[] | object | Each item | |
metadata | Model | Required within parent | Expand Export a package version manifest — response body — metadata |
Referenced models: Export a package version manifest — response body — metadata
Export a package version manifest — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Source metadata from the SDK's defineManifest, retained with the snapshot. Use an empty object when no metadata is needed; package identity is supplied separately. Additional keys: not allowed |
description | string | Optional | Optional description of the source manifest, independent of the version description. |
key | string | Optional | Optional source-manifest identifier, retained on download; not the package key. |
name | string | Optional | Optional source-manifest label, retained on download; does not rename the package. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.create_package_version_from_manifest. Catalog operation: create-package-version-from-manifest. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["packages.read-write"]
Provider entitlements: ["Unity_Packages_V2_Platform_API"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}