Class ContentApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createOrUpdate createOrUpdateWithHttpInfo createWithHttpInfo download downloadWithHttpInfo

Constructors

constructor

new ContentApi(configuration, requestFactory?, responseProcessor?): ContentApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: ContentApiRequestFactory
- OptionalresponseProcessor: ContentApiResponseProcessor
Returns ContentApi
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:15

Methods

archiveWithHttpInfo

archiveWithHttpInfo(environment, path, _options?): Promise<HttpInfo<void>>
Deletes the file at the specified path in the specified environment. Delete a file
Parameters
- environment: string
  The environment of the file ("draft" or "published").
- path: string
  The file system location of the file.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:29

create

create(environment, path, file?, _options?): Promise<AssetFileMetadata>
Creates a file at the specified path in the specified environment. Accepts multipart/form-data content type. Throws an error if a file already exists at the specified path. Create a file
Parameters
- environment: string
  The environment of the file ("draft" or "published").
- path: string
  The file system location of the file.
- Optionalfile: HttpFile
- Optional_options: PromiseConfigurationOptions
Returns Promise<AssetFileMetadata>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:100

createOrUpdate

createOrUpdate(environment, path, file?, _options?): Promise<AssetFileMetadata>
Upserts a file at the specified path in the specified environment. Accepts multipart/form-data content type. Create or update a file
Parameters
- environment: string
  The environment of the file ("draft" or "published").
- path: string
  The file system location of the file.
- Optionalfile: HttpFile
- Optional_options: PromiseConfigurationOptions
Returns Promise<AssetFileMetadata>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:148

createOrUpdateWithHttpInfo

createOrUpdateWithHttpInfo(environment, path, file?, _options?): Promise<HttpInfo<AssetFileMetadata>>
Upserts a file at the specified path in the specified environment. Accepts multipart/form-data content type. Create or update a file
Parameters
- environment: string
  The environment of the file ("draft" or "published").
- path: string
  The file system location of the file.
- Optionalfile: HttpFile
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<AssetFileMetadata>>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:124

createWithHttpInfo

createWithHttpInfo(environment, path, file?, _options?): Promise<HttpInfo<AssetFileMetadata>>
Creates a file at the specified path in the specified environment. Accepts multipart/form-data content type. Throws an error if a file already exists at the specified path. Create a file
Parameters
- environment: string
  The environment of the file ("draft" or "published").
- path: string
  The file system location of the file.
- Optionalfile: HttpFile
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<AssetFileMetadata>>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:76

download

download(environment, path, _options?): Promise<HttpFile>
Downloads the byte contents of the file at the specified path in the specified environment. Download a file
Parameters
- environment: string
  The environment of the file ("draft" or "published").
- path: string
  The file system location of the file.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpFile>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:194

downloadWithHttpInfo

downloadWithHttpInfo(environment, path, _options?): Promise<HttpInfo<HttpFile>>
Downloads the byte contents of the file at the specified path in the specified environment. Download a file
Parameters
- environment: string
  The environment of the file ("draft" or "published").
- path: string
  The file system location of the file.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<HttpFile>>
- Defined in codegen/cms/source_code/types/PromiseAPI.ts:171

Class ContentApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ContentApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<AssetFileMetadata>

createOrUpdate

Parameters

Returns Promise<AssetFileMetadata>

createOrUpdateWithHttpInfo

Parameters

Returns Promise<HttpInfo<AssetFileMetadata>>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<AssetFileMetadata>>

download

Parameters

Returns Promise<HttpFile>

downloadWithHttpInfo

Parameters

Returns Promise<HttpInfo<HttpFile>>

Settings

On This Page