Class PackageService

Index

Constructors

Methods

deletePackageCreatedById getPackageConfiguration getPackageCreated getPackageCreatedById getPackageCreatedByIdDownload getPackageMigrationStatus postPackageByNameRunMigration postPackageCreated putPackageCreatedById

Constructors

constructor

new PackageService(): PackageService
Returns PackageService

Methods

`Static`deletePackageCreatedById

deletePackageCreatedById<ThrowOnError extends boolean = true>(
    options: Options<DeletePackageCreatedByIdData, ThrowOnError>,
): RequestResult<
    DeletePackageCreatedByIdResponses,
    DeletePackageCreatedByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a package.

Deletes a package identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeletePackageCreatedByIdData, ThrowOnError>
Returns RequestResult<
    DeletePackageCreatedByIdResponses,
    DeletePackageCreatedByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5573

`Static`getPackageConfiguration

getPackageConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetPackageConfigurationData, ThrowOnError>,
): RequestResult<
    GetPackageConfigurationResponses,
    GetPackageConfigurationErrors,
    ThrowOnError,
    "fields",
>
Gets the package configuration.

Gets the configuration settings for packages.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetPackageConfigurationData, ThrowOnError>
Returns RequestResult<
    GetPackageConfigurationResponses,
    GetPackageConfigurationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5515

`Static`getPackageCreated

getPackageCreated<ThrowOnError extends boolean = true>(
    options?: Options<GetPackageCreatedData, ThrowOnError>,
): RequestResult<
    GetPackageCreatedResponses,
    GetPackageCreatedErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of created packages.

Gets a paginated collection of all created packages.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetPackageCreatedData, ThrowOnError>
Returns RequestResult<
    GetPackageCreatedResponses,
    GetPackageCreatedErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5533

`Static`getPackageCreatedById

getPackageCreatedById<ThrowOnError extends boolean = true>(
    options: Options<GetPackageCreatedByIdData, ThrowOnError>,
): RequestResult<
    GetPackageCreatedByIdResponses,
    GetPackageCreatedByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a package.

Gets a package identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetPackageCreatedByIdData, ThrowOnError>
Returns RequestResult<
    GetPackageCreatedByIdResponses,
    GetPackageCreatedByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5591

`Static`getPackageCreatedByIdDownload

getPackageCreatedByIdDownload<ThrowOnError extends boolean = true>(
    options: Options<GetPackageCreatedByIdDownloadData, ThrowOnError>,
): RequestResult<
    GetPackageCreatedByIdDownloadResponses,
    GetPackageCreatedByIdDownloadErrors,
    ThrowOnError,
    "fields",
>
Downloads a created package.

Downloads the package file for the created package identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetPackageCreatedByIdDownloadData, ThrowOnError>
Returns RequestResult<
    GetPackageCreatedByIdDownloadResponses,
    GetPackageCreatedByIdDownloadErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5631

`Static`getPackageMigrationStatus

getPackageMigrationStatus<ThrowOnError extends boolean = true>(
    options?: Options<GetPackageMigrationStatusData, ThrowOnError>,
): RequestResult<
    GetPackageMigrationStatusResponses,
    GetPackageMigrationStatusErrors,
    ThrowOnError,
    "fields",
>
Gets all package migration statuses.

Gets a paginated collection of migration status for all installed packages.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetPackageMigrationStatusData, ThrowOnError>
Returns RequestResult<
    GetPackageMigrationStatusResponses,
    GetPackageMigrationStatusErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5649

`Static`postPackageByNameRunMigration

postPackageByNameRunMigration<ThrowOnError extends boolean = true>(
    options: Options<PostPackageByNameRunMigrationData, ThrowOnError>,
): RequestResult<
    PostPackageByNameRunMigrationResponses,
    PostPackageByNameRunMigrationErrors,
    ThrowOnError,
    "fields",
>
Runs pending package migrations.

Executes all pending package migrations to update the database schema.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostPackageByNameRunMigrationData, ThrowOnError>
Returns RequestResult<
    PostPackageByNameRunMigrationResponses,
    PostPackageByNameRunMigrationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5497

`Static`postPackageCreated

postPackageCreated<ThrowOnError extends boolean = true>(
    options?: Options<PostPackageCreatedData, ThrowOnError>,
): RequestResult<
    PostPackageCreatedResponses,
    PostPackageCreatedErrors,
    ThrowOnError,
    "fields",
>
Creates a new package.

Creates a new package with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostPackageCreatedData, ThrowOnError>
Returns RequestResult<
    PostPackageCreatedResponses,
    PostPackageCreatedErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5551

`Static`putPackageCreatedById

putPackageCreatedById<ThrowOnError extends boolean = true>(
    options: Options<PutPackageCreatedByIdData, ThrowOnError>,
): RequestResult<
    PutPackageCreatedByIdResponses,
    PutPackageCreatedByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a package.

Updates a package identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutPackageCreatedByIdData, ThrowOnError>
Returns RequestResult<
    PutPackageCreatedByIdResponses,
    PutPackageCreatedByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5609

Class PackageService

Index

Constructors

Methods

Constructors

constructor

Returns PackageService

Methods

StaticdeletePackageCreatedById

Type Parameters

Parameters

Returns RequestResult< DeletePackageCreatedByIdResponses, DeletePackageCreatedByIdErrors, ThrowOnError, "fields",>

StaticgetPackageConfiguration

Type Parameters

Parameters

Returns RequestResult< GetPackageConfigurationResponses, GetPackageConfigurationErrors, ThrowOnError, "fields",>

StaticgetPackageCreated

Type Parameters

Parameters

Returns RequestResult< GetPackageCreatedResponses, GetPackageCreatedErrors, ThrowOnError, "fields",>

StaticgetPackageCreatedById

Type Parameters

Parameters

Returns RequestResult< GetPackageCreatedByIdResponses, GetPackageCreatedByIdErrors, ThrowOnError, "fields",>

StaticgetPackageCreatedByIdDownload

Type Parameters

Parameters

Returns RequestResult< GetPackageCreatedByIdDownloadResponses, GetPackageCreatedByIdDownloadErrors, ThrowOnError, "fields",>

StaticgetPackageMigrationStatus

Type Parameters

Parameters

Returns RequestResult< GetPackageMigrationStatusResponses, GetPackageMigrationStatusErrors, ThrowOnError, "fields",>

StaticpostPackageByNameRunMigration

Type Parameters

Parameters

Returns RequestResult< PostPackageByNameRunMigrationResponses, PostPackageByNameRunMigrationErrors, ThrowOnError, "fields",>

StaticpostPackageCreated

Type Parameters

Parameters

Returns RequestResult< PostPackageCreatedResponses, PostPackageCreatedErrors, ThrowOnError, "fields",>

StaticputPackageCreatedById

Type Parameters

Parameters

Returns RequestResult< PutPackageCreatedByIdResponses, PutPackageCreatedByIdErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deletePackageCreatedById

Returns RequestResult<
DeletePackageCreatedByIdResponses,
DeletePackageCreatedByIdErrors,
ThrowOnError,
"fields",
>

`Static`getPackageConfiguration

Returns RequestResult<
GetPackageConfigurationResponses,
GetPackageConfigurationErrors,
ThrowOnError,
"fields",
>

`Static`getPackageCreated

Returns RequestResult<
GetPackageCreatedResponses,
GetPackageCreatedErrors,
ThrowOnError,
"fields",
>

`Static`getPackageCreatedById

Returns RequestResult<
GetPackageCreatedByIdResponses,
GetPackageCreatedByIdErrors,
ThrowOnError,
"fields",
>

`Static`getPackageCreatedByIdDownload

Returns RequestResult<
GetPackageCreatedByIdDownloadResponses,
GetPackageCreatedByIdDownloadErrors,
ThrowOnError,
"fields",
>

`Static`getPackageMigrationStatus

Returns RequestResult<
GetPackageMigrationStatusResponses,
GetPackageMigrationStatusErrors,
ThrowOnError,
"fields",
>

`Static`postPackageByNameRunMigration

Returns RequestResult<
PostPackageByNameRunMigrationResponses,
PostPackageByNameRunMigrationErrors,
ThrowOnError,
"fields",
>

`Static`postPackageCreated

Returns RequestResult<
PostPackageCreatedResponses,
PostPackageCreatedErrors,
ThrowOnError,
"fields",
>

`Static`putPackageCreatedById

Returns RequestResult<
PutPackageCreatedByIdResponses,
PutPackageCreatedByIdErrors,
ThrowOnError,
"fields",
>