Package io.voucherify.client.api

Class MetadataSchemasApi

java.lang.Object

io.voucherify.client.api.MetadataSchemasApi

public class MetadataSchemasApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MetadataSchemasApi()
MetadataSchemasApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
MetadataSchemasGetResponseBody	getMetadataSchema(String resource)	Get Metadata Schema Retrieves a metadata schema per resource type.
okhttp3.Call	getMetadataSchemaAsync(String resource, ApiCallback<MetadataSchemasGetResponseBody> _callback)	Get Metadata Schema (asynchronously) Retrieves a metadata schema per resource type.
okhttp3.Call	getMetadataSchemaCall(String resource, ApiCallback _callback)	Build call for getMetadataSchema
ApiResponse<MetadataSchemasGetResponseBody>	getMetadataSchemaWithHttpInfo(String resource)	Get Metadata Schema Retrieves a metadata schema per resource type.
MetadataSchemasListResponseBody	listMetadataSchemas()	List Metadata Schemas Retrieve metadata schema definitions.
okhttp3.Call	listMetadataSchemasAsync(ApiCallback<MetadataSchemasListResponseBody> _callback)	List Metadata Schemas (asynchronously) Retrieve metadata schema definitions.
okhttp3.Call	listMetadataSchemasCall(ApiCallback _callback)	Build call for listMetadataSchemas
ApiResponse<MetadataSchemasListResponseBody>	listMetadataSchemasWithHttpInfo()	List Metadata Schemas Retrieve metadata schema definitions.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Details

MetadataSchemasApi

public MetadataSchemasApi()

MetadataSchemasApi

public MetadataSchemasApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getMetadataSchemaCall

public okhttp3.Call getMetadataSchemaCall(String resource,
 ApiCallback _callback)
                                   throws ApiException

Build call for getMetadataSchema

Parameters:

resource - There is an infinite number of possibilities for retrieving metadata schemas by the resource type because you can define custom metadata schemas. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMetadataSchema

public MetadataSchemasGetResponseBody getMetadataSchema(String resource)
                                                 throws ApiException

Get Metadata Schema Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](https://support.voucherify.io/article/99-schema-validation-metadata#add-metadata), provide its name in the resource field to retrieve its details. 📘 Management API If you have Management API enabled, you can also use the Get Metadata Schemas endpoint to retrieve a metadata schema using its ID.

Parameters:

resource - There is an infinite number of possibilities for retrieving metadata schemas by the resource type because you can define custom metadata schemas. (required)

Returns:

MetadataSchemasGetResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMetadataSchemaWithHttpInfo

public ApiResponse<MetadataSchemasGetResponseBody> getMetadataSchemaWithHttpInfo(String resource)
                                                                          throws ApiException

Get Metadata Schema Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](https://support.voucherify.io/article/99-schema-validation-metadata#add-metadata), provide its name in the resource field to retrieve its details. 📘 Management API If you have Management API enabled, you can also use the Get Metadata Schemas endpoint to retrieve a metadata schema using its ID.

Parameters:

resource - There is an infinite number of possibilities for retrieving metadata schemas by the resource type because you can define custom metadata schemas. (required)

Returns:

ApiResponse<MetadataSchemasGetResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMetadataSchemaAsync

public okhttp3.Call getMetadataSchemaAsync(String resource,
 ApiCallback<MetadataSchemasGetResponseBody> _callback)
                                    throws ApiException

Get Metadata Schema (asynchronously) Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](https://support.voucherify.io/article/99-schema-validation-metadata#add-metadata), provide its name in the resource field to retrieve its details. 📘 Management API If you have Management API enabled, you can also use the Get Metadata Schemas endpoint to retrieve a metadata schema using its ID.

Parameters:

resource - There is an infinite number of possibilities for retrieving metadata schemas by the resource type because you can define custom metadata schemas. (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

listMetadataSchemasCall

public okhttp3.Call listMetadataSchemasCall(ApiCallback _callback)
                                     throws ApiException

Build call for listMetadataSchemas

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listMetadataSchemas

public MetadataSchemasListResponseBody listMetadataSchemas()
                                                    throws ApiException

List Metadata Schemas Retrieve metadata schema definitions. 📘 Management API If you have Management API enabled, you can also use the List Metadata Schemas endpoint to list all metadata schemas.

Returns:

MetadataSchemasListResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listMetadataSchemasWithHttpInfo

public ApiResponse<MetadataSchemasListResponseBody> listMetadataSchemasWithHttpInfo()
                                                                             throws ApiException

List Metadata Schemas Retrieve metadata schema definitions. 📘 Management API If you have Management API enabled, you can also use the List Metadata Schemas endpoint to list all metadata schemas.

Returns:

ApiResponse<MetadataSchemasListResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

listMetadataSchemasAsync

public okhttp3.Call listMetadataSchemasAsync(ApiCallback<MetadataSchemasListResponseBody> _callback)
                                      throws ApiException

List Metadata Schemas (asynchronously) Retrieve metadata schema definitions. 📘 Management API If you have Management API enabled, you can also use the List Metadata Schemas endpoint to list all metadata schemas.

Parameters:

_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