Class TemporaryFileService

Index

Constructors

constructor

Methods

deleteTemporaryFileById getTemporaryFileById getTemporaryFileConfiguration postTemporaryFile

Constructors

constructor

new TemporaryFileService(): TemporaryFileService
Returns TemporaryFileService

Methods

`Static`deleteTemporaryFileById

deleteTemporaryFileById<ThrowOnError extends boolean = true>(
    options: Options<DeleteTemporaryFileByIdData, ThrowOnError>,
): RequestResult<
    DeleteTemporaryFileByIdResponses,
    DeleteTemporaryFileByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a temporary file.

Deletes a temporary file identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteTemporaryFileByIdData, ThrowOnError>
Returns RequestResult<
    DeleteTemporaryFileByIdResponses,
    DeleteTemporaryFileByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7439

`Static`getTemporaryFileById

getTemporaryFileById<ThrowOnError extends boolean = true>(
    options: Options<GetTemporaryFileByIdData, ThrowOnError>,
): RequestResult<
    GetTemporaryFileByIdResponses,
    GetTemporaryFileByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a temporary file.

Gets a temporary file identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetTemporaryFileByIdData, ThrowOnError>
Returns RequestResult<
    GetTemporaryFileByIdResponses,
    GetTemporaryFileByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7457

`Static`getTemporaryFileConfiguration

getTemporaryFileConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetTemporaryFileConfigurationData, ThrowOnError>,
): RequestResult<
    GetTemporaryFileConfigurationResponses,
    GetTemporaryFileConfigurationErrors,
    ThrowOnError,
    "fields",
>
Gets the temporary file configuration.

Gets the configuration settings for temporary files.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTemporaryFileConfigurationData, ThrowOnError>
Returns RequestResult<
    GetTemporaryFileConfigurationResponses,
    GetTemporaryFileConfigurationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7475

`Static`postTemporaryFile

postTemporaryFile<ThrowOnError extends boolean = true>(
    options?: Options<PostTemporaryFileData, ThrowOnError>,
): RequestResult<
    PostTemporaryFileResponses,
    PostTemporaryFileErrors,
    ThrowOnError,
    "fields",
>
Creates a temporary file.

Uploads and creates a temporary file that can be used in subsequent operations.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostTemporaryFileData, ThrowOnError>
Returns RequestResult<
    PostTemporaryFileResponses,
    PostTemporaryFileErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7416

Class TemporaryFileService

Index

Constructors

Methods

Constructors

constructor

Returns TemporaryFileService

Methods

`Static`deleteTemporaryFileById

Type Parameters

Parameters

Returns RequestResult<
    DeleteTemporaryFileByIdResponses,
    DeleteTemporaryFileByIdErrors,
    ThrowOnError,
    "fields",
>

`Static`getTemporaryFileById

Type Parameters

Parameters

Returns RequestResult<
    GetTemporaryFileByIdResponses,
    GetTemporaryFileByIdErrors,
    ThrowOnError,
    "fields",
>

`Static`getTemporaryFileConfiguration

Type Parameters

Parameters

Returns RequestResult<
    GetTemporaryFileConfigurationResponses,
    GetTemporaryFileConfigurationErrors,
    ThrowOnError,
    "fields",
>

`Static`postTemporaryFile

Type Parameters

Parameters

Returns RequestResult<
    PostTemporaryFileResponses,
    PostTemporaryFileErrors,
    ThrowOnError,
    "fields",
>

Settings

On This Page

Class TemporaryFileService

Index

Constructors

Methods

Constructors

constructor

Returns TemporaryFileService

Methods

StaticdeleteTemporaryFileById

Type Parameters

Parameters

Returns RequestResult< DeleteTemporaryFileByIdResponses, DeleteTemporaryFileByIdErrors, ThrowOnError, "fields",>

StaticgetTemporaryFileById

Type Parameters

Parameters

Returns RequestResult< GetTemporaryFileByIdResponses, GetTemporaryFileByIdErrors, ThrowOnError, "fields",>

StaticgetTemporaryFileConfiguration

Type Parameters

Parameters

Returns RequestResult< GetTemporaryFileConfigurationResponses, GetTemporaryFileConfigurationErrors, ThrowOnError, "fields",>

StaticpostTemporaryFile

Type Parameters

Parameters

Returns RequestResult< PostTemporaryFileResponses, PostTemporaryFileErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteTemporaryFileById

Returns RequestResult<
DeleteTemporaryFileByIdResponses,
DeleteTemporaryFileByIdErrors,
ThrowOnError,
"fields",
>

`Static`getTemporaryFileById

Returns RequestResult<
GetTemporaryFileByIdResponses,
GetTemporaryFileByIdErrors,
ThrowOnError,
"fields",
>

`Static`getTemporaryFileConfiguration

Returns RequestResult<
GetTemporaryFileConfigurationResponses,
GetTemporaryFileConfigurationErrors,
ThrowOnError,
"fields",
>

`Static`postTemporaryFile

Returns RequestResult<
PostTemporaryFileResponses,
PostTemporaryFileErrors,
ThrowOnError,
"fields",
>