Constructor Detail

• FilesApi

  FilesApi()

• FilesApi

  FilesApi(ApiClient apiClient)

Method Detail

• getApiClient

   ApiClient getApiClient()

• setApiClient

   void setApiClient(ApiClient apiClient)

• createFile

   ModelFile createFile(Long sectionId, String path, File attachment, Boolean downloadable, String contentType)

  Create File Create file within the 3scale CMS

  Parameters:

  sectionId - Unique identifier for a `Section` (required)

  path - The path from which the file is retrieved from the 3scale Developer Portal.

  attachment - The full contents of the file (required)

  downloadable - Flag indicating whether the file will be returned from the Developer Portal with headers indicating it is intended to be downloaded (optional, default to false)

  contentType - The mime-type describing type of content.

  Returns:

  ModelFile

• createFile

   ModelFile createFile(Long sectionId, String path, File attachment, Boolean downloadable, String contentType, Map<String, String> additionalHeaders)

  Create File Create file within the 3scale CMS

  Parameters:

  sectionId - Unique identifier for a `Section` (required)

  path - The path from which the file is retrieved from the 3scale Developer Portal.

  attachment - The full contents of the file (required)

  downloadable - Flag indicating whether the file will be returned from the Developer Portal with headers indicating it is intended to be downloaded (optional, default to false)

  contentType - The mime-type describing type of content.

  additionalHeaders - additionalHeaders for this call

  Returns:

  ModelFile

• deleteFile

   void deleteFile(Long fileId)

  Delete File Delete a file from 3scale CMS

  Parameters:

  fileId - (required)

• deleteFile

   void deleteFile(Long fileId, Map<String, String> additionalHeaders)

  Delete File Delete a file from 3scale CMS

  Parameters:

  fileId - (required)

  additionalHeaders - additionalHeaders for this call

• getFile

   ModelFile getFile(Long fileId)

  Get File Get a file descriptor

  Parameters:

  fileId - (required)

  Returns:

  ModelFile

• getFile

   ModelFile getFile(Long fileId, Map<String, String> additionalHeaders)

  Get File Get a file descriptor

  Parameters:

  fileId - (required)

  additionalHeaders - additionalHeaders for this call

  Returns:

  ModelFile

• listFiles

   FileList listFiles(Integer page, Integer perPage, Long sectionId)

  List Files List files held within the 3scale CMS

  Parameters:

  page - The number for the page of results to retrieve, starting from page 1; defaults to 1 (optional, default to 1)

  perPage - The number of items to retrieve per page of results; defaults to 20 (optional, default to 20)

  sectionId - The section to query for files (hidden option in CMS API) (optional)

  Returns:

  FileList

• listFiles

   FileList listFiles(Integer page, Integer perPage, Long sectionId, Map<String, String> additionalHeaders)

  List Files List files held within the 3scale CMS

  Parameters:

  page - The number for the page of results to retrieve, starting from page 1; defaults to 1 (optional, default to 1)

  perPage - The number of items to retrieve per page of results; defaults to 20 (optional, default to 20)

  sectionId - The section to query for files (hidden option in CMS API) (optional)

  additionalHeaders - additionalHeaders for this call

  Returns:

  FileList

• readProviderSettings

   WrappedProviderAccount readProviderSettings()

  Read 3scale Provider Settings Read 3scale Provider (Tenant) settings; particularly related to the developer portal. *Note:* This is technically part of 3scale's Account Management API, but is used to determine the location and access-token for retrieving file content, so it is tagged with `Files`.

  Returns:

  WrappedProviderAccount

• readProviderSettings

   WrappedProviderAccount readProviderSettings(Map<String, String> additionalHeaders)

  Read 3scale Provider Settings Read 3scale Provider (Tenant) settings; particularly related to the developer portal. *Note:* This is technically part of 3scale's Account Management API, but is used to determine the location and access-token for retrieving file content, so it is tagged with `Files`.

  Parameters:

  additionalHeaders - additionalHeaders for this call

  Returns:

  WrappedProviderAccount

• updateFile

   ModelFile updateFile(Long fileId, Long sectionId, String path, Boolean downloadable, File attachment, String contentType)

  Update File Update an existing file

  Parameters:

  fileId - (required)

  sectionId - Unique identifier for a `Section` (optional)

  path - The path from which the file is retrieved from the 3scale Developer Portal.

  downloadable - Flag indicating whether the file will be returned from the Developer Portal with headers indicating it is intended to be downloaded (optional, default to false)

  attachment - The full contents of the file (optional)

  contentType - The mime-type describing type of content.

  Returns:

  ModelFile

• updateFile

   ModelFile updateFile(Long fileId, Long sectionId, String path, Boolean downloadable, File attachment, String contentType, Map<String, String> additionalHeaders)

  Update File Update an existing file

  Parameters:

  fileId - (required)

  sectionId - Unique identifier for a `Section` (optional)

  path - The path from which the file is retrieved from the 3scale Developer Portal.

  downloadable - Flag indicating whether the file will be returned from the Developer Portal with headers indicating it is intended to be downloaded (optional, default to false)

  attachment - The full contents of the file (optional)

  contentType - The mime-type describing type of content.

  additionalHeaders - additionalHeaders for this call

  Returns:

  ModelFile