Package software.xdev.brevo.api

Class FilesApi

java.lang.Object

software.xdev.brevo.api.FilesApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class FilesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
FilesApi()
FilesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
List<FileData>	crmFilesGet(String entity, String entityIds, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort)	Get all files
List<FileData>	crmFilesGet(String entity, String entityIds, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort, Map<String,String> additionalHeaders)	Get all files
FileData	crmFilesIdDataGet(String id)	Get file details
FileData	crmFilesIdDataGet(String id, Map<String,String> additionalHeaders)	Get file details
void	crmFilesIdDelete(String id)	Delete a file
void	crmFilesIdDelete(String id, Map<String,String> additionalHeaders)	Delete a file
FileDownloadableLink	crmFilesIdGet(String id)	Download a file
FileDownloadableLink	crmFilesIdGet(String id, Map<String,String> additionalHeaders)	Download a file
FileData	crmFilesPost(File _file, String dealId, Long contactId, String companyId)	Upload a file
FileData	crmFilesPost(File _file, String dealId, Long contactId, String companyId, Map<String,String> additionalHeaders)	Upload a file
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FilesApi

public FilesApi()

FilesApi

public FilesApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

crmFilesGet

public List<FileData> crmFilesGet(String entity,
 String entityIds,
 Integer dateFrom,
 Integer dateTo,
 Long offset,
 Long limit,
 String sort)
                           throws ApiException

Get all files

Parameters:

entity - Filter by file entity type (optional)

entityIds - Filter by file entity IDs (optional)

dateFrom - dateFrom to date range filter type (timestamp in milliseconds) (optional)

dateTo - dateTo to date range filter type (timestamp in milliseconds) (optional)

offset - Index of the first document of the page (optional)

limit - Number of documents per page (optional, default to 50)

sort - Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)

Returns:

List<FileData>

Throws:

ApiException - if fails to make API call

crmFilesGet

public List<FileData> crmFilesGet(String entity,
 String entityIds,
 Integer dateFrom,
 Integer dateTo,
 Long offset,
 Long limit,
 String sort,
 Map<String,String> additionalHeaders)
                           throws ApiException

Get all files

Parameters:

entity - Filter by file entity type (optional)

entityIds - Filter by file entity IDs (optional)

dateFrom - dateFrom to date range filter type (timestamp in milliseconds) (optional)

dateTo - dateTo to date range filter type (timestamp in milliseconds) (optional)

offset - Index of the first document of the page (optional)

limit - Number of documents per page (optional, default to 50)

sort - Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<FileData>

Throws:

ApiException - if fails to make API call

crmFilesIdDataGet

public FileData crmFilesIdDataGet(String id)
                           throws ApiException

Get file details

Parameters:

id - File id to get file data. (required)

Returns:

FileData

Throws:

ApiException - if fails to make API call

crmFilesIdDataGet

public FileData crmFilesIdDataGet(String id,
 Map<String,String> additionalHeaders)
                           throws ApiException

Get file details

Parameters:

id - File id to get file data. (required)

additionalHeaders - additionalHeaders for this call

Returns:

FileData

Throws:

ApiException - if fails to make API call

crmFilesIdDelete

public void crmFilesIdDelete(String id)
                      throws ApiException

Delete a file

Parameters:

id - File id to delete. (required)

Throws:

ApiException - if fails to make API call

crmFilesIdDelete

public void crmFilesIdDelete(String id,
 Map<String,String> additionalHeaders)
                      throws ApiException

Delete a file

Parameters:

id - File id to delete. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

crmFilesIdGet

public FileDownloadableLink crmFilesIdGet(String id)
                                   throws ApiException

Download a file

Parameters:

id - File id to download. (required)

Returns:

FileDownloadableLink

Throws:

ApiException - if fails to make API call

crmFilesIdGet

public FileDownloadableLink crmFilesIdGet(String id,
 Map<String,String> additionalHeaders)
                                   throws ApiException

Download a file

Parameters:

id - File id to download. (required)

additionalHeaders - additionalHeaders for this call

Returns:

FileDownloadableLink

Throws:

ApiException - if fails to make API call

crmFilesPost

public FileData crmFilesPost(File _file,
 String dealId,
 Long contactId,
 String companyId)
                      throws ApiException

Upload a file

Parameters:

_file - File data to create a file. (required)

dealId - (optional)

contactId - (optional)

companyId - (optional)

Returns:

FileData

Throws:

ApiException - if fails to make API call

crmFilesPost

public FileData crmFilesPost(File _file,
 String dealId,
 Long contactId,
 String companyId,
 Map<String,String> additionalHeaders)
                      throws ApiException

Upload a file

Parameters:

_file - File data to create a file. (required)

dealId - (optional)

contactId - (optional)

companyId - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

FileData

Throws:

ApiException - if fails to make API call