Class ApiProductsApi
java.lang.Object
org.wso2.am.integration.clients.publisher.api.v1.ApiProductsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateAPIProduct(APIProductDTO apIProductDTO) Create a New API Product This operation can be used to create a new API Product specifying the details of the API Product in the payload.okhttp3.CallcreateAPIProductAsync(APIProductDTO apIProductDTO, ApiCallback<APIProductDTO> _callback) Create a New API Product (asynchronously) This operation can be used to create a new API Product specifying the details of the API Product in the payload.okhttp3.CallcreateAPIProductCall(APIProductDTO apIProductDTO, ApiCallback _callback) Build call for createAPIProductcreateAPIProductWithHttpInfo(APIProductDTO apIProductDTO) Create a New API Product This operation can be used to create a new API Product specifying the details of the API Product in the payload.createNewAPIProductVersion(String newVersion, String apiProductId, Boolean defaultVersion) Create a New API Product Version This operation can be used to create a new version of an existing API Products.okhttp3.CallcreateNewAPIProductVersionAsync(String newVersion, String apiProductId, Boolean defaultVersion, ApiCallback<APIProductDTO> _callback) Create a New API Product Version (asynchronously) This operation can be used to create a new version of an existing API Products.okhttp3.CallcreateNewAPIProductVersionCall(String newVersion, String apiProductId, Boolean defaultVersion, ApiCallback _callback) Build call for createNewAPIProductVersioncreateNewAPIProductVersionWithHttpInfo(String newVersion, String apiProductId, Boolean defaultVersion) Create a New API Product Version This operation can be used to create a new version of an existing API Products.voiddeleteAPIProduct(String apiProductId, String ifMatch) Delete an API Product This operation can be used to delete an existing API Product proving the Id of the API Product.okhttp3.CalldeleteAPIProductAsync(String apiProductId, String ifMatch, ApiCallback<Void> _callback) Delete an API Product (asynchronously) This operation can be used to delete an existing API Product proving the Id of the API Product.okhttp3.CalldeleteAPIProductCall(String apiProductId, String ifMatch, ApiCallback _callback) Build call for deleteAPIProductdeleteAPIProductWithHttpInfo(String apiProductId, String ifMatch) Delete an API Product This operation can be used to delete an existing API Product proving the Id of the API Product.Retrieve/Search API Products This operation provides you a list of available API Products qualifying under a given search condition.okhttp3.CallgetAllAPIProductsAsync(Integer limit, Integer offset, String query, String accept, String ifNoneMatch, ApiCallback<APIProductListDTO> _callback) Retrieve/Search API Products (asynchronously) This operation provides you a list of available API Products qualifying under a given search condition.okhttp3.CallgetAllAPIProductsCall(Integer limit, Integer offset, String query, String accept, String ifNoneMatch, ApiCallback _callback) Build call for getAllAPIProductsgetAllAPIProductsWithHttpInfo(Integer limit, Integer offset, String query, String accept, String ifNoneMatch) Retrieve/Search API Products This operation provides you a list of available API Products qualifying under a given search condition.getAPIProduct(String apiProductId, String accept, String ifNoneMatch) Get Details of an API Product Using this operation, you can retrieve complete details of a single API Product.okhttp3.CallgetAPIProductAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<APIProductDTO> _callback) Get Details of an API Product (asynchronously) Using this operation, you can retrieve complete details of a single API Product.okhttp3.CallgetAPIProductCall(String apiProductId, String accept, String ifNoneMatch, ApiCallback _callback) Build call for getAPIProductgetAPIProductSwagger(String apiProductId, String accept, String ifNoneMatch) Get Swagger Definition This operation can be used to retrieve the swagger definition of an API.okhttp3.CallgetAPIProductSwaggerAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<String> _callback) Get Swagger Definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.okhttp3.CallgetAPIProductSwaggerCall(String apiProductId, String accept, String ifNoneMatch, ApiCallback _callback) Build call for getAPIProductSwaggergetAPIProductSwaggerWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) Get Swagger Definition This operation can be used to retrieve the swagger definition of an API.voidgetAPIProductThumbnail(String apiProductId, String accept, String ifNoneMatch) Get Thumbnail Image This operation can be used to download a thumbnail image of an API product.okhttp3.CallgetAPIProductThumbnailAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<Void> _callback) Get Thumbnail Image (asynchronously) This operation can be used to download a thumbnail image of an API product.okhttp3.CallgetAPIProductThumbnailCall(String apiProductId, String accept, String ifNoneMatch, ApiCallback _callback) Build call for getAPIProductThumbnailgetAPIProductThumbnailWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) Get Thumbnail Image This operation can be used to download a thumbnail image of an API product.getAPIProductWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) Get Details of an API Product Using this operation, you can retrieve complete details of a single API Product.getIsAPIProductOutdated(String apiProductId, String accept, String ifNoneMatch) Check Whether API Product is Outdated This operation can be used to retrieve the status indicating if an API Product is outdated due to updating of dependent APIs (This resource is not supported at the moment)okhttp3.CallgetIsAPIProductOutdatedAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<APIProductOutdatedStatusDTO> _callback) Check Whether API Product is Outdated (asynchronously) This operation can be used to retrieve the status indicating if an API Product is outdated due to updating of dependent APIs (This resource is not supported at the moment)okhttp3.CallgetIsAPIProductOutdatedCall(String apiProductId, String accept, String ifNoneMatch, ApiCallback _callback) Build call for getIsAPIProductOutdatedgetIsAPIProductOutdatedWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) Check Whether API Product is Outdated This operation can be used to retrieve the status indicating if an API Product is outdated due to updating of dependent APIs (This resource is not supported at the moment)voidsetApiClient(ApiClient apiClient) updateAPIProduct(String apiProductId, APIProductDTO apIProductDTO, String ifMatch) Update an API Product This operation can be used to update an existing API product.okhttp3.CallupdateAPIProductAsync(String apiProductId, APIProductDTO apIProductDTO, String ifMatch, ApiCallback<APIProductDTO> _callback) Update an API Product (asynchronously) This operation can be used to update an existing API product.okhttp3.CallupdateAPIProductCall(String apiProductId, APIProductDTO apIProductDTO, String ifMatch, ApiCallback _callback) Build call for updateAPIProductupdateAPIProductThumbnail(String apiProductId, File file, String ifMatch) Upload a Thumbnail Image This operation can be used to upload a thumbnail image of an API Product.okhttp3.CallupdateAPIProductThumbnailAsync(String apiProductId, File file, String ifMatch, ApiCallback<FileInfoDTO> _callback) Upload a Thumbnail Image (asynchronously) This operation can be used to upload a thumbnail image of an API Product.okhttp3.CallupdateAPIProductThumbnailCall(String apiProductId, File file, String ifMatch, ApiCallback _callback) Build call for updateAPIProductThumbnailupdateAPIProductThumbnailWithHttpInfo(String apiProductId, File file, String ifMatch) Upload a Thumbnail Image This operation can be used to upload a thumbnail image of an API Product.updateAPIProductWithHttpInfo(String apiProductId, APIProductDTO apIProductDTO, String ifMatch) Update an API Product This operation can be used to update an existing API product.
-
Constructor Details
-
ApiProductsApi
public ApiProductsApi() -
ApiProductsApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
createAPIProductCall
public okhttp3.Call createAPIProductCall(APIProductDTO apIProductDTO, ApiCallback _callback) throws ApiException Build call for createAPIProduct- Parameters:
apIProductDTO- API object that needs to be added (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
createAPIProduct
Create a New API Product This operation can be used to create a new API Product specifying the details of the API Product in the payload.- Parameters:
apIProductDTO- API object that needs to be added (required)- Returns:
- APIProductDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createAPIProductWithHttpInfo
public ApiResponse<APIProductDTO> createAPIProductWithHttpInfo(APIProductDTO apIProductDTO) throws ApiException Create a New API Product This operation can be used to create a new API Product specifying the details of the API Product in the payload.- Parameters:
apIProductDTO- API object that needs to be added (required)- Returns:
- ApiResponse<APIProductDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createAPIProductAsync
public okhttp3.Call createAPIProductAsync(APIProductDTO apIProductDTO, ApiCallback<APIProductDTO> _callback) throws ApiException Create a New API Product (asynchronously) This operation can be used to create a new API Product specifying the details of the API Product in the payload.- Parameters:
apIProductDTO- API object that needs to be added (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
createNewAPIProductVersionCall
public okhttp3.Call createNewAPIProductVersionCall(String newVersion, String apiProductId, Boolean defaultVersion, ApiCallback _callback) throws ApiException Build call for createNewAPIProductVersion- Parameters:
newVersion- Version of the new API Product. (required)apiProductId- **API Product ID** consisting of the **UUID** of the API Product. The combination of the provider, name and the version of the API Product is also accepted as a valid API Product ID. Should be formatted as **provider-name-version**. (required)defaultVersion- Specifies whether new API Product should be added as default version. (optional, default to false)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
createNewAPIProductVersion
public APIProductDTO createNewAPIProductVersion(String newVersion, String apiProductId, Boolean defaultVersion) throws ApiException Create a New API Product Version This operation can be used to create a new version of an existing API Products. The new version is specified as `newVersion` query parameter. New API Product will be in `CREATED` state.- Parameters:
newVersion- Version of the new API Product. (required)apiProductId- **API Product ID** consisting of the **UUID** of the API Product. The combination of the provider, name and the version of the API Product is also accepted as a valid API Product ID. Should be formatted as **provider-name-version**. (required)defaultVersion- Specifies whether new API Product should be added as default version. (optional, default to false)- Returns:
- APIProductDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createNewAPIProductVersionWithHttpInfo
public ApiResponse<APIProductDTO> createNewAPIProductVersionWithHttpInfo(String newVersion, String apiProductId, Boolean defaultVersion) throws ApiException Create a New API Product Version This operation can be used to create a new version of an existing API Products. The new version is specified as `newVersion` query parameter. New API Product will be in `CREATED` state.- Parameters:
newVersion- Version of the new API Product. (required)apiProductId- **API Product ID** consisting of the **UUID** of the API Product. The combination of the provider, name and the version of the API Product is also accepted as a valid API Product ID. Should be formatted as **provider-name-version**. (required)defaultVersion- Specifies whether new API Product should be added as default version. (optional, default to false)- Returns:
- ApiResponse<APIProductDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createNewAPIProductVersionAsync
public okhttp3.Call createNewAPIProductVersionAsync(String newVersion, String apiProductId, Boolean defaultVersion, ApiCallback<APIProductDTO> _callback) throws ApiException Create a New API Product Version (asynchronously) This operation can be used to create a new version of an existing API Products. The new version is specified as `newVersion` query parameter. New API Product will be in `CREATED` state.- Parameters:
newVersion- Version of the new API Product. (required)apiProductId- **API Product ID** consisting of the **UUID** of the API Product. The combination of the provider, name and the version of the API Product is also accepted as a valid API Product ID. Should be formatted as **provider-name-version**. (required)defaultVersion- Specifies whether new API Product should be added as default version. (optional, default to false)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
deleteAPIProductCall
public okhttp3.Call deleteAPIProductCall(String apiProductId, String ifMatch, ApiCallback _callback) throws ApiException Build call for deleteAPIProduct- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
deleteAPIProduct
Delete an API Product This operation can be used to delete an existing API Product proving the Id of the API Product.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteAPIProductWithHttpInfo
public ApiResponse<Void> deleteAPIProductWithHttpInfo(String apiProductId, String ifMatch) throws ApiException Delete an API Product This operation can be used to delete an existing API Product proving the Id of the API Product.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteAPIProductAsync
public okhttp3.Call deleteAPIProductAsync(String apiProductId, String ifMatch, ApiCallback<Void> _callback) throws ApiException Delete an API Product (asynchronously) This operation can be used to delete an existing API Product proving the Id of the API Product.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getAPIProductCall
public okhttp3.Call getAPIProductCall(String apiProductId, String accept, String ifNoneMatch, ApiCallback _callback) throws ApiException Build call for getAPIProduct- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAPIProduct
public APIProductDTO getAPIProduct(String apiProductId, String accept, String ifNoneMatch) throws ApiException Get Details of an API Product Using this operation, you can retrieve complete details of a single API Product. You need to provide the Id of the API to retrive it.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- APIProductDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIProductWithHttpInfo
public ApiResponse<APIProductDTO> getAPIProductWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) throws ApiException Get Details of an API Product Using this operation, you can retrieve complete details of a single API Product. You need to provide the Id of the API to retrive it.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<APIProductDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIProductAsync
public okhttp3.Call getAPIProductAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<APIProductDTO> _callback) throws ApiException Get Details of an API Product (asynchronously) Using this operation, you can retrieve complete details of a single API Product. You need to provide the Id of the API to retrive it.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getAPIProductSwaggerCall
public okhttp3.Call getAPIProductSwaggerCall(String apiProductId, String accept, String ifNoneMatch, ApiCallback _callback) throws ApiException Build call for getAPIProductSwagger- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAPIProductSwagger
public String getAPIProductSwagger(String apiProductId, String accept, String ifNoneMatch) throws ApiException Get Swagger Definition This operation can be used to retrieve the swagger definition of an API.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- String
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIProductSwaggerWithHttpInfo
public ApiResponse<String> getAPIProductSwaggerWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) throws ApiException Get Swagger Definition This operation can be used to retrieve the swagger definition of an API.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<String>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIProductSwaggerAsync
public okhttp3.Call getAPIProductSwaggerAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<String> _callback) throws ApiException Get Swagger Definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getAPIProductThumbnailCall
public okhttp3.Call getAPIProductThumbnailCall(String apiProductId, String accept, String ifNoneMatch, ApiCallback _callback) throws ApiException Build call for getAPIProductThumbnail- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAPIProductThumbnail
public void getAPIProductThumbnail(String apiProductId, String accept, String ifNoneMatch) throws ApiException Get Thumbnail Image This operation can be used to download a thumbnail image of an API product.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIProductThumbnailWithHttpInfo
public ApiResponse<Void> getAPIProductThumbnailWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) throws ApiException Get Thumbnail Image This operation can be used to download a thumbnail image of an API product.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAPIProductThumbnailAsync
public okhttp3.Call getAPIProductThumbnailAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<Void> _callback) throws ApiException Get Thumbnail Image (asynchronously) This operation can be used to download a thumbnail image of an API product.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getAllAPIProductsCall
public okhttp3.Call getAllAPIProductsCall(Integer limit, Integer offset, String query, String accept, String ifNoneMatch, ApiCallback _callback) throws ApiException Build call for getAllAPIProducts- Parameters:
limit- Maximum size of resource array to return. (optional, default to 25)offset- Starting point within the complete list of items qualified. (optional, default to 0)query- (optional)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getAllAPIProducts
public APIProductListDTO getAllAPIProducts(Integer limit, Integer offset, String query, String accept, String ifNoneMatch) throws ApiException Retrieve/Search API Products This operation provides you a list of available API Products qualifying under a given search condition. Each retrieved API Product is represented with a minimal amount of attributes. If you want to get complete details of an API Product, you need to use **Get details of an API Product** operation.- Parameters:
limit- Maximum size of resource array to return. (optional, default to 25)offset- Starting point within the complete list of items qualified. (optional, default to 0)query- (optional)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- APIProductListDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAllAPIProductsWithHttpInfo
public ApiResponse<APIProductListDTO> getAllAPIProductsWithHttpInfo(Integer limit, Integer offset, String query, String accept, String ifNoneMatch) throws ApiException Retrieve/Search API Products This operation provides you a list of available API Products qualifying under a given search condition. Each retrieved API Product is represented with a minimal amount of attributes. If you want to get complete details of an API Product, you need to use **Get details of an API Product** operation.- Parameters:
limit- Maximum size of resource array to return. (optional, default to 25)offset- Starting point within the complete list of items qualified. (optional, default to 0)query- (optional)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<APIProductListDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getAllAPIProductsAsync
public okhttp3.Call getAllAPIProductsAsync(Integer limit, Integer offset, String query, String accept, String ifNoneMatch, ApiCallback<APIProductListDTO> _callback) throws ApiException Retrieve/Search API Products (asynchronously) This operation provides you a list of available API Products qualifying under a given search condition. Each retrieved API Product is represented with a minimal amount of attributes. If you want to get complete details of an API Product, you need to use **Get details of an API Product** operation.- Parameters:
limit- Maximum size of resource array to return. (optional, default to 25)offset- Starting point within the complete list of items qualified. (optional, default to 0)query- (optional)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getIsAPIProductOutdatedCall
public okhttp3.Call getIsAPIProductOutdatedCall(String apiProductId, String accept, String ifNoneMatch, ApiCallback _callback) throws ApiException Build call for getIsAPIProductOutdated- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getIsAPIProductOutdated
public APIProductOutdatedStatusDTO getIsAPIProductOutdated(String apiProductId, String accept, String ifNoneMatch) throws ApiException Check Whether API Product is Outdated This operation can be used to retrieve the status indicating if an API Product is outdated due to updating of dependent APIs (This resource is not supported at the moment)- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- APIProductOutdatedStatusDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getIsAPIProductOutdatedWithHttpInfo
public ApiResponse<APIProductOutdatedStatusDTO> getIsAPIProductOutdatedWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) throws ApiException Check Whether API Product is Outdated This operation can be used to retrieve the status indicating if an API Product is outdated due to updating of dependent APIs (This resource is not supported at the moment)- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<APIProductOutdatedStatusDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getIsAPIProductOutdatedAsync
public okhttp3.Call getIsAPIProductOutdatedAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<APIProductOutdatedStatusDTO> _callback) throws ApiException Check Whether API Product is Outdated (asynchronously) This operation can be used to retrieve the status indicating if an API Product is outdated due to updating of dependent APIs (This resource is not supported at the moment)- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
updateAPIProductCall
public okhttp3.Call updateAPIProductCall(String apiProductId, APIProductDTO apIProductDTO, String ifMatch, ApiCallback _callback) throws ApiException Build call for updateAPIProduct- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)apIProductDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateAPIProduct
public APIProductDTO updateAPIProduct(String apiProductId, APIProductDTO apIProductDTO, String ifMatch) throws ApiException Update an API Product This operation can be used to update an existing API product. But the properties `name`, `provider` and `version` cannot be changed.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)apIProductDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- APIProductDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPIProductWithHttpInfo
public ApiResponse<APIProductDTO> updateAPIProductWithHttpInfo(String apiProductId, APIProductDTO apIProductDTO, String ifMatch) throws ApiException Update an API Product This operation can be used to update an existing API product. But the properties `name`, `provider` and `version` cannot be changed.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)apIProductDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<APIProductDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPIProductAsync
public okhttp3.Call updateAPIProductAsync(String apiProductId, APIProductDTO apIProductDTO, String ifMatch, ApiCallback<APIProductDTO> _callback) throws ApiException Update an API Product (asynchronously) This operation can be used to update an existing API product. But the properties `name`, `provider` and `version` cannot be changed.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)apIProductDTO- API object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
updateAPIProductThumbnailCall
public okhttp3.Call updateAPIProductThumbnailCall(String apiProductId, File file, String ifMatch, ApiCallback _callback) throws ApiException Build call for updateAPIProductThumbnail- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)file- Image to upload (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateAPIProductThumbnail
public FileInfoDTO updateAPIProductThumbnail(String apiProductId, File file, String ifMatch) throws ApiException Upload a Thumbnail Image This operation can be used to upload a thumbnail image of an API Product. The thumbnail to be uploaded should be given as a form data parameter `file`.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)file- Image to upload (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- FileInfoDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPIProductThumbnailWithHttpInfo
public ApiResponse<FileInfoDTO> updateAPIProductThumbnailWithHttpInfo(String apiProductId, File file, String ifMatch) throws ApiException Upload a Thumbnail Image This operation can be used to upload a thumbnail image of an API Product. The thumbnail to be uploaded should be given as a form data parameter `file`.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)file- Image to upload (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<FileInfoDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateAPIProductThumbnailAsync
public okhttp3.Call updateAPIProductThumbnailAsync(String apiProductId, File file, String ifMatch, ApiCallback<FileInfoDTO> _callback) throws ApiException Upload a Thumbnail Image (asynchronously) This operation can be used to upload a thumbnail image of an API Product. The thumbnail to be uploaded should be given as a form data parameter `file`.- Parameters:
apiProductId- **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)file- Image to upload (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-