Skip to content

Rippling: Create a new package version

Rippling restApi.createPackageVersions: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.create_package_versions

Provider route: POST /packages/{package_key}/versions/. Alter supplies the connection’s credentials and routing.

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"]["createPackageVersions"]>[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.createPackageVersions(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_versions(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.package_keystringRequired within parent
bodyModelOptionalExpand Create a new package version — request body — body

Referenced models: Create a new package version — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRoot
componentsarrayOptionalComponents included in this version. Function identifiers provide valid post_install_function values.
components[]objectEach itemAdditional keys: allowed
components[].identifierobjectRequired within parentAdditional keys: allowed
components[].identifier.api_namestringOptionalThe portable API name. Present on FUNCTION identifiers; other component kinds may use different identity fields.
components[].identifier.typestringRequired within parentThe component kind. FUNCTION identifies a packaged Function.
created_atstringRequired within parentRecord creation date
descriptionstringOptionalThe description of the package version
idstringRequired within parentIdentifier field
is_publishedbooleanOptionalWhether this package version has been published
package_display_namestringOptionalThe display name of the parent package
package_idstringOptionalThe ID of the parent package
package_keystringOptionalThe package key of the parent package
post_install_functionJSONOptional
post_install_function (anyOf 1)stringAlternativeThe 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)nullAlternative
updated_atstringRequired within parentRecord update date
version_numberstringRequired within parentThe semantic version number for this package version
Create a new package version — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalThe description of the package version
version_numberstringRequired within parentThe semantic version number for this package version

SDK function policy ID: rippling.rest_api.create_package_versions. Catalog operation: create-package-versions. 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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.