Package io.voucherify.client.api

Class ManagementApi

java.lang.Object

io.voucherify.client.api.ManagementApi

public class ManagementApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ManagementApi()
ManagementApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ManagementProjectsUsersAssignResponseBody	assignUser(String projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody)	Assign User Assigns a user to a given project.
okhttp3.Call	assignUserAsync(String projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, ApiCallback<ManagementProjectsUsersAssignResponseBody> _callback)	Assign User (asynchronously) Assigns a user to a given project.
okhttp3.Call	assignUserCall(String projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody, ApiCallback _callback)	Build call for assignUser
ApiResponse<ManagementProjectsUsersAssignResponseBody>	assignUserWithHttpInfo(String projectId, ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody)	Assign User Assigns a user to a given project.
ManagementProjectsBrandingCreateResponseBody	createBrand(String projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody)	Create Brand Creates a new brand configuration.
okhttp3.Call	createBrandAsync(String projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, ApiCallback<ManagementProjectsBrandingCreateResponseBody> _callback)	Create Brand (asynchronously) Creates a new brand configuration.
okhttp3.Call	createBrandCall(String projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody, ApiCallback _callback)	Build call for createBrand
ApiResponse<ManagementProjectsBrandingCreateResponseBody>	createBrandWithHttpInfo(String projectId, ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody)	Create Brand Creates a new brand configuration.
ManagementProjectsCustomEventSchemasCreateResponseBody	createCustomEventSchema(String projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody)	Create Custom Event Schema Creates a custom event schema.
okhttp3.Call	createCustomEventSchemaAsync(String projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, ApiCallback<ManagementProjectsCustomEventSchemasCreateResponseBody> _callback)	Create Custom Event Schema (asynchronously) Creates a custom event schema.
okhttp3.Call	createCustomEventSchemaCall(String projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody, ApiCallback _callback)	Build call for createCustomEventSchema
ApiResponse<ManagementProjectsCustomEventSchemasCreateResponseBody>	createCustomEventSchemaWithHttpInfo(String projectId, ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody)	Create Custom Event Schema Creates a custom event schema.
ManagementProjectsMetadataSchemasCreateResponseBody	createMetadataSchema(String projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody)	Create Metadata Schema Creates a new metadata (custom attribute) schema.
okhttp3.Call	createMetadataSchemaAsync(String projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, ApiCallback<ManagementProjectsMetadataSchemasCreateResponseBody> _callback)	Create Metadata Schema (asynchronously) Creates a new metadata (custom attribute) schema.
okhttp3.Call	createMetadataSchemaCall(String projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody, ApiCallback _callback)	Build call for createMetadataSchema
ApiResponse<ManagementProjectsMetadataSchemasCreateResponseBody>	createMetadataSchemaWithHttpInfo(String projectId, ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody)	Create Metadata Schema Creates a new metadata (custom attribute) schema.
ManagementProjectsCreateResponseBody	createProject(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody)	Create Project Creates a new project.
okhttp3.Call	createProjectAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, ApiCallback<ManagementProjectsCreateResponseBody> _callback)	Create Project (asynchronously) Creates a new project.
okhttp3.Call	createProjectCall(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody, ApiCallback _callback)	Build call for createProject
ApiResponse<ManagementProjectsCreateResponseBody>	createProjectWithHttpInfo(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody)	Create Project Creates a new project.
ManagementProjectsStackingRulesCreateResponseBody	createStackingRules(String projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody)	Create Stacking Rules Overwrites the default stacking rules.
okhttp3.Call	createStackingRulesAsync(String projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, ApiCallback<ManagementProjectsStackingRulesCreateResponseBody> _callback)	Create Stacking Rules (asynchronously) Overwrites the default stacking rules.
okhttp3.Call	createStackingRulesCall(String projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody, ApiCallback _callback)	Build call for createStackingRules
ApiResponse<ManagementProjectsStackingRulesCreateResponseBody>	createStackingRulesWithHttpInfo(String projectId, ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody)	Create Stacking Rules Overwrites the default stacking rules.
ManagementProjectsWebhooksCreateResponseBody	createWebhook(String projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody)	Create Webhook Creates a new webhook configuration.
okhttp3.Call	createWebhookAsync(String projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, ApiCallback<ManagementProjectsWebhooksCreateResponseBody> _callback)	Create Webhook (asynchronously) Creates a new webhook configuration.
okhttp3.Call	createWebhookCall(String projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody, ApiCallback _callback)	Build call for createWebhook
ApiResponse<ManagementProjectsWebhooksCreateResponseBody>	createWebhookWithHttpInfo(String projectId, ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody)	Create Webhook Creates a new webhook configuration.
void	deleteBrand(String projectId, String brandingId)	Delete Brand Deletes permanently a brand configuration.
okhttp3.Call	deleteBrandAsync(String projectId, String brandingId, ApiCallback<Void> _callback)	Delete Brand (asynchronously) Deletes permanently a brand configuration.
okhttp3.Call	deleteBrandCall(String projectId, String brandingId, ApiCallback _callback)	Build call for deleteBrand
ApiResponse<Void>	deleteBrandWithHttpInfo(String projectId, String brandingId)	Delete Brand Deletes permanently a brand configuration.
void	deleteCustomEventSchema(String projectId, String customEventSchemaId)	Delete Custom Event Schema Deletes permanently the custom event schema with its custom properties (metadata).
okhttp3.Call	deleteCustomEventSchemaAsync(String projectId, String customEventSchemaId, ApiCallback<Void> _callback)	Delete Custom Event Schema (asynchronously) Deletes permanently the custom event schema with its custom properties (metadata).
okhttp3.Call	deleteCustomEventSchemaCall(String projectId, String customEventSchemaId, ApiCallback _callback)	Build call for deleteCustomEventSchema
ApiResponse<Void>	deleteCustomEventSchemaWithHttpInfo(String projectId, String customEventSchemaId)	Delete Custom Event Schema Deletes permanently the custom event schema with its custom properties (metadata).
void	deleteMetadataSchema(String projectId, String metadataSchemaId)	Delete Metadata Schema Deletes permanently the metadata schema.
okhttp3.Call	deleteMetadataSchemaAsync(String projectId, String metadataSchemaId, ApiCallback<Void> _callback)	Delete Metadata Schema (asynchronously) Deletes permanently the metadata schema.
okhttp3.Call	deleteMetadataSchemaCall(String projectId, String metadataSchemaId, ApiCallback _callback)	Build call for deleteMetadataSchema
ApiResponse<Void>	deleteMetadataSchemaWithHttpInfo(String projectId, String metadataSchemaId)	Delete Metadata Schema Deletes permanently the metadata schema.
void	deleteProject(String projectId)	Delete Project Deletes an existing project.
okhttp3.Call	deleteProjectAsync(String projectId, ApiCallback<Void> _callback)	Delete Project (asynchronously) Deletes an existing project.
okhttp3.Call	deleteProjectCall(String projectId, ApiCallback _callback)	Build call for deleteProject
ApiResponse<Void>	deleteProjectWithHttpInfo(String projectId)	Delete Project Deletes an existing project.
void	deleteStackingRules(String projectId, String stackingRulesId)	Delete Stacking Rules Deletes permanently the current settings for the stacking rules.
okhttp3.Call	deleteStackingRulesAsync(String projectId, String stackingRulesId, ApiCallback<Void> _callback)	Delete Stacking Rules (asynchronously) Deletes permanently the current settings for the stacking rules.
okhttp3.Call	deleteStackingRulesCall(String projectId, String stackingRulesId, ApiCallback _callback)	Build call for deleteStackingRules
ApiResponse<Void>	deleteStackingRulesWithHttpInfo(String projectId, String stackingRulesId)	Delete Stacking Rules Deletes permanently the current settings for the stacking rules.
void	deleteWebhook(String projectId, String webhookId)	Delete Webhook Deletes a webhook configuration.
okhttp3.Call	deleteWebhookAsync(String projectId, String webhookId, ApiCallback<Void> _callback)	Delete Webhook (asynchronously) Deletes a webhook configuration.
okhttp3.Call	deleteWebhookCall(String projectId, String webhookId, ApiCallback _callback)	Build call for deleteWebhook
ApiResponse<Void>	deleteWebhookWithHttpInfo(String projectId, String webhookId)	Delete Webhook Deletes a webhook configuration.
ApiClient	getApiClient()
ManagementProjectsBrandingGetResponseBody	getBrand(String projectId, String brandingId)	Get Brand Retrieves a brand configuration.
okhttp3.Call	getBrandAsync(String projectId, String brandingId, ApiCallback<ManagementProjectsBrandingGetResponseBody> _callback)	Get Brand (asynchronously) Retrieves a brand configuration.
okhttp3.Call	getBrandCall(String projectId, String brandingId, ApiCallback _callback)	Build call for getBrand
ApiResponse<ManagementProjectsBrandingGetResponseBody>	getBrandWithHttpInfo(String projectId, String brandingId)	Get Brand Retrieves a brand configuration.
String	getCustomBaseUrl()
ManagementProjectsCustomEventSchemasGetResponseBody	getCustomEventSchema(String projectId, String customEventSchemaId)	Get Custom Event Schema Retrieves a custom event schema.
okhttp3.Call	getCustomEventSchemaAsync(String projectId, String customEventSchemaId, ApiCallback<ManagementProjectsCustomEventSchemasGetResponseBody> _callback)	Get Custom Event Schema (asynchronously) Retrieves a custom event schema.
okhttp3.Call	getCustomEventSchemaCall(String projectId, String customEventSchemaId, ApiCallback _callback)	Build call for getCustomEventSchema
ApiResponse<ManagementProjectsCustomEventSchemasGetResponseBody>	getCustomEventSchemaWithHttpInfo(String projectId, String customEventSchemaId)	Get Custom Event Schema Retrieves a custom event schema.
int	getHostIndex()
ManagementProjectsMetadataSchemasGetResponseBody	getMetadataSchema1(String projectId, String metadataSchemaId)	Get Metadata Schema Retrieves a metadata schema.
okhttp3.Call	getMetadataSchema1Async(String projectId, String metadataSchemaId, ApiCallback<ManagementProjectsMetadataSchemasGetResponseBody> _callback)	Get Metadata Schema (asynchronously) Retrieves a metadata schema.
okhttp3.Call	getMetadataSchema1Call(String projectId, String metadataSchemaId, ApiCallback _callback)	Build call for getMetadataSchema1
ApiResponse<ManagementProjectsMetadataSchemasGetResponseBody>	getMetadataSchema1WithHttpInfo(String projectId, String metadataSchemaId)	Get Metadata Schema Retrieves a metadata schema.
ManagementProjectsGetResponseBody	getProject(String projectId)	Get Project Retrieves an existing project.
okhttp3.Call	getProjectAsync(String projectId, ApiCallback<ManagementProjectsGetResponseBody> _callback)	Get Project (asynchronously) Retrieves an existing project.
okhttp3.Call	getProjectCall(String projectId, ApiCallback _callback)	Build call for getProject
ApiResponse<ManagementProjectsGetResponseBody>	getProjectWithHttpInfo(String projectId)	Get Project Retrieves an existing project.
ManagementProjectsStackingRulesGetResponseBody	getStackingRules(String projectId, String stackingRulesId)	Get Stacking Rules Retrieves the stacking rules for the project.
okhttp3.Call	getStackingRulesAsync(String projectId, String stackingRulesId, ApiCallback<ManagementProjectsStackingRulesGetResponseBody> _callback)	Get Stacking Rules (asynchronously) Retrieves the stacking rules for the project.
okhttp3.Call	getStackingRulesCall(String projectId, String stackingRulesId, ApiCallback _callback)	Build call for getStackingRules
ApiResponse<ManagementProjectsStackingRulesGetResponseBody>	getStackingRulesWithHttpInfo(String projectId, String stackingRulesId)	Get Stacking Rules Retrieves the stacking rules for the project.
ManagementProjectsUsersGetUserResponseBody	getUser(String projectId, String userId)	Get User Retrieves the project users details.
okhttp3.Call	getUserAsync(String projectId, String userId, ApiCallback<ManagementProjectsUsersGetUserResponseBody> _callback)	Get User (asynchronously) Retrieves the project users details.
okhttp3.Call	getUserCall(String projectId, String userId, ApiCallback _callback)	Build call for getUser
ApiResponse<ManagementProjectsUsersGetUserResponseBody>	getUserWithHttpInfo(String projectId, String userId)	Get User Retrieves the project users details.
ManagementProjectsWebhooksGetResponseBody	getWebhook(String projectId, String webhookId)	Get Webhook Retrieves a webhook configuration.
okhttp3.Call	getWebhookAsync(String projectId, String webhookId, ApiCallback<ManagementProjectsWebhooksGetResponseBody> _callback)	Get Webhook (asynchronously) Retrieves a webhook configuration.
okhttp3.Call	getWebhookCall(String projectId, String webhookId, ApiCallback _callback)	Build call for getWebhook
ApiResponse<ManagementProjectsWebhooksGetResponseBody>	getWebhookWithHttpInfo(String projectId, String webhookId)	Get Webhook Retrieves a webhook configuration.
void	inviteUser(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody)	Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login.
okhttp3.Call	inviteUserAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, ApiCallback<Void> _callback)	Invite a New User (asynchronously) Sends an invitation to an email address that has not been used yet as a Voucherify user login.
okhttp3.Call	inviteUserCall(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody, ApiCallback _callback)	Build call for inviteUser
ApiResponse<Void>	inviteUserWithHttpInfo(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody)	Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login.
ManagementProjectsBrandingListResponseBody	listBrands(String projectId)	List Brands Lists all brand configurations.
okhttp3.Call	listBrandsAsync(String projectId, ApiCallback<ManagementProjectsBrandingListResponseBody> _callback)	List Brands (asynchronously) Lists all brand configurations.
okhttp3.Call	listBrandsCall(String projectId, ApiCallback _callback)	Build call for listBrands
ApiResponse<ManagementProjectsBrandingListResponseBody>	listBrandsWithHttpInfo(String projectId)	List Brands Lists all brand configurations.
ManagementProjectsCustomEventSchemasListResponseBody	listCustomEventSchemas(String projectId)	List Custom Event Schemas Lists all custom event schemas available in the project.
okhttp3.Call	listCustomEventSchemasAsync(String projectId, ApiCallback<ManagementProjectsCustomEventSchemasListResponseBody> _callback)	List Custom Event Schemas (asynchronously) Lists all custom event schemas available in the project.
okhttp3.Call	listCustomEventSchemasCall(String projectId, ApiCallback _callback)	Build call for listCustomEventSchemas
ApiResponse<ManagementProjectsCustomEventSchemasListResponseBody>	listCustomEventSchemasWithHttpInfo(String projectId)	List Custom Event Schemas Lists all custom event schemas available in the project.
ManagementProjectsMetadataSchemasListResponseBody	listMetadataSchemas1(String projectId)	List Metadata Schemas Lists all metadata schemas available in the project.
okhttp3.Call	listMetadataSchemas1Async(String projectId, ApiCallback<ManagementProjectsMetadataSchemasListResponseBody> _callback)	List Metadata Schemas (asynchronously) Lists all metadata schemas available in the project.
okhttp3.Call	listMetadataSchemas1Call(String projectId, ApiCallback _callback)	Build call for listMetadataSchemas1
ApiResponse<ManagementProjectsMetadataSchemasListResponseBody>	listMetadataSchemas1WithHttpInfo(String projectId)	List Metadata Schemas Lists all metadata schemas available in the project.
ManagementProjectsListResponseBody	listProjects()	List Projects Lists all projects for the organization.
okhttp3.Call	listProjectsAsync(ApiCallback<ManagementProjectsListResponseBody> _callback)	List Projects (asynchronously) Lists all projects for the organization.
okhttp3.Call	listProjectsCall(ApiCallback _callback)	Build call for listProjects
ApiResponse<ManagementProjectsListResponseBody>	listProjectsWithHttpInfo()	List Projects Lists all projects for the organization.
ManagementProjectsStackingRulesListResponseBody	listStackingRules(String projectId)	List Stacking Rules Lists all stacking rules.
okhttp3.Call	listStackingRulesAsync(String projectId, ApiCallback<ManagementProjectsStackingRulesListResponseBody> _callback)	List Stacking Rules (asynchronously) Lists all stacking rules.
okhttp3.Call	listStackingRulesCall(String projectId, ApiCallback _callback)	Build call for listStackingRules
ApiResponse<ManagementProjectsStackingRulesListResponseBody>	listStackingRulesWithHttpInfo(String projectId)	List Stacking Rules Lists all stacking rules.
ManagementProjectsUsersListResponseBody	listUsers(String projectId)	List Users Lists all users assigned to the project.
okhttp3.Call	listUsersAsync(String projectId, ApiCallback<ManagementProjectsUsersListResponseBody> _callback)	List Users (asynchronously) Lists all users assigned to the project.
okhttp3.Call	listUsersCall(String projectId, ApiCallback _callback)	Build call for listUsers
ApiResponse<ManagementProjectsUsersListResponseBody>	listUsersWithHttpInfo(String projectId)	List Users Lists all users assigned to the project.
ManagementProjectsWebhooksListResponseBody	listWebhooks(String projectId)	List Webhooks Lists all webhook configurations for the project.
okhttp3.Call	listWebhooksAsync(String projectId, ApiCallback<ManagementProjectsWebhooksListResponseBody> _callback)	List Webhooks (asynchronously) Lists all webhook configurations for the project.
okhttp3.Call	listWebhooksCall(String projectId, ApiCallback _callback)	Build call for listWebhooks
ApiResponse<ManagementProjectsWebhooksListResponseBody>	listWebhooksWithHttpInfo(String projectId)	List Webhooks Lists all webhook configurations for the project.
ManagementProjectsTemplatesCampaignsCopyCreateResponseBody	managementCopyCampaignTemplate(String projectId, String campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody)	Copy Campaign Template to a Project Copies a campaign template to another project.
okhttp3.Call	managementCopyCampaignTemplateAsync(String projectId, String campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, ApiCallback<ManagementProjectsTemplatesCampaignsCopyCreateResponseBody> _callback)	Copy Campaign Template to a Project (asynchronously) Copies a campaign template to another project.
okhttp3.Call	managementCopyCampaignTemplateCall(String projectId, String campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody, ApiCallback _callback)	Build call for managementCopyCampaignTemplate
ApiResponse<ManagementProjectsTemplatesCampaignsCopyCreateResponseBody>	managementCopyCampaignTemplateWithHttpInfo(String projectId, String campaignTemplateId, ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody)	Copy Campaign Template to a Project Copies a campaign template to another project.
ManagementProjectsTemplatesCampaignsListResponseBody	managementListCampaignTemplates(String projectId, Integer limit, String startingAfterId, ParameterTemplatesList order, Boolean includeTotal, ParameterFiltersListTemplates filters)	List Campaign Templates Lists all campaign templates available in the project.
okhttp3.Call	managementListCampaignTemplatesAsync(String projectId, Integer limit, String startingAfterId, ParameterTemplatesList order, Boolean includeTotal, ParameterFiltersListTemplates filters, ApiCallback<ManagementProjectsTemplatesCampaignsListResponseBody> _callback)	List Campaign Templates (asynchronously) Lists all campaign templates available in the project.
okhttp3.Call	managementListCampaignTemplatesCall(String projectId, Integer limit, String startingAfterId, ParameterTemplatesList order, Boolean includeTotal, ParameterFiltersListTemplates filters, ApiCallback _callback)	Build call for managementListCampaignTemplates
ApiResponse<ManagementProjectsTemplatesCampaignsListResponseBody>	managementListCampaignTemplatesWithHttpInfo(String projectId, Integer limit, String startingAfterId, ParameterTemplatesList order, Boolean includeTotal, ParameterFiltersListTemplates filters)	List Campaign Templates Lists all campaign templates available in the project.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	unassignUser(String projectId, String userId)	Unassign User Unassigns the user from the project.
okhttp3.Call	unassignUserAsync(String projectId, String userId, ApiCallback<Void> _callback)	Unassign User (asynchronously) Unassigns the user from the project.
okhttp3.Call	unassignUserCall(String projectId, String userId, ApiCallback _callback)	Build call for unassignUser
ApiResponse<Void>	unassignUserWithHttpInfo(String projectId, String userId)	Unassign User Unassigns the user from the project.
ManagementProjectsBrandingUpdateResponseBody	updateBrand(String projectId, String brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody)	Update Brand Updates a brand configuration.
okhttp3.Call	updateBrandAsync(String projectId, String brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, ApiCallback<ManagementProjectsBrandingUpdateResponseBody> _callback)	Update Brand (asynchronously) Updates a brand configuration.
okhttp3.Call	updateBrandCall(String projectId, String brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody, ApiCallback _callback)	Build call for updateBrand
ApiResponse<ManagementProjectsBrandingUpdateResponseBody>	updateBrandWithHttpInfo(String projectId, String brandingId, ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody)	Update Brand Updates a brand configuration.
ManagementProjectsCustomEventSchemasUpdateResponseBody	updateCustomEventSchema(String projectId, String customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody)	Update Custom Event Schema Updates a custom event schema.
okhttp3.Call	updateCustomEventSchemaAsync(String projectId, String customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, ApiCallback<ManagementProjectsCustomEventSchemasUpdateResponseBody> _callback)	Update Custom Event Schema (asynchronously) Updates a custom event schema.
okhttp3.Call	updateCustomEventSchemaCall(String projectId, String customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody, ApiCallback _callback)	Build call for updateCustomEventSchema
ApiResponse<ManagementProjectsCustomEventSchemasUpdateResponseBody>	updateCustomEventSchemaWithHttpInfo(String projectId, String customEventSchemaId, ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody)	Update Custom Event Schema Updates a custom event schema.
ManagementProjectsMetadataSchemasUpdateResponseBody	updateMetadataSchema(String projectId, String metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody)	Update Metadata Schema Updates a metadata schema.
okhttp3.Call	updateMetadataSchemaAsync(String projectId, String metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, ApiCallback<ManagementProjectsMetadataSchemasUpdateResponseBody> _callback)	Update Metadata Schema (asynchronously) Updates a metadata schema.
okhttp3.Call	updateMetadataSchemaCall(String projectId, String metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody, ApiCallback _callback)	Build call for updateMetadataSchema
ApiResponse<ManagementProjectsMetadataSchemasUpdateResponseBody>	updateMetadataSchemaWithHttpInfo(String projectId, String metadataSchemaId, ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody)	Update Metadata Schema Updates a metadata schema.
ManagementProjectsUpdateResponseBody	updateProject(String projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody)	Update Project Updates an existing project.
okhttp3.Call	updateProjectAsync(String projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, ApiCallback<ManagementProjectsUpdateResponseBody> _callback)	Update Project (asynchronously) Updates an existing project.
okhttp3.Call	updateProjectCall(String projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody, ApiCallback _callback)	Build call for updateProject
ApiResponse<ManagementProjectsUpdateResponseBody>	updateProjectWithHttpInfo(String projectId, ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody)	Update Project Updates an existing project.
ManagementProjectsStackingRulesUpdateResponseBody	updateStackingRules(String projectId, String stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody)	Update Stacking Rules Updates the stacking rules.
okhttp3.Call	updateStackingRulesAsync(String projectId, String stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, ApiCallback<ManagementProjectsStackingRulesUpdateResponseBody> _callback)	Update Stacking Rules (asynchronously) Updates the stacking rules.
okhttp3.Call	updateStackingRulesCall(String projectId, String stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody, ApiCallback _callback)	Build call for updateStackingRules
ApiResponse<ManagementProjectsStackingRulesUpdateResponseBody>	updateStackingRulesWithHttpInfo(String projectId, String stackingRulesId, ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody)	Update Stacking Rules Updates the stacking rules.
ManagementProjectsUsersUpdateRoleResponseBody	updateUser(String projectId, String userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody)	Update User Updates the users role.
okhttp3.Call	updateUserAsync(String projectId, String userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, ApiCallback<ManagementProjectsUsersUpdateRoleResponseBody> _callback)	Update User (asynchronously) Updates the users role.
okhttp3.Call	updateUserCall(String projectId, String userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody, ApiCallback _callback)	Build call for updateUser
ApiResponse<ManagementProjectsUsersUpdateRoleResponseBody>	updateUserWithHttpInfo(String projectId, String userId, ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody)	Update User Updates the users role.
ManagementProjectsWebhooksUpdateResponseBody	updateWebhook(String projectId, String webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody)	Update Webhook Updates a webhook configuration.
okhttp3.Call	updateWebhookAsync(String projectId, String webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, ApiCallback<ManagementProjectsWebhooksUpdateResponseBody> _callback)	Update Webhook (asynchronously) Updates a webhook configuration.
okhttp3.Call	updateWebhookCall(String projectId, String webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody, ApiCallback _callback)	Build call for updateWebhook
ApiResponse<ManagementProjectsWebhooksUpdateResponseBody>	updateWebhookWithHttpInfo(String projectId, String webhookId, ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody)	Update Webhook Updates a webhook configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

ManagementApi

public ManagementApi()

ManagementApi

public ManagementApi(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)

assignUserCall

public okhttp3.Call assignUserCall(String projectId,
 ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody,
 ApiCallback _callback)
                            throws ApiException

Build call for assignUser

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsUsersAssignRequestBody - Defines the user details. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

assignUser

public ManagementProjectsUsersAssignResponseBody assignUser(String projectId,
 ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody)
                                                     throws ApiException

Assign User Assigns a user to a given project. The user must be an existing user in Voucherify. 🚧 Correct Use of Data To avoid errors, use the role key with either id or login keys.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsUsersAssignRequestBody - Defines the user details. (optional)

Returns:

ManagementProjectsUsersAssignResponseBody

Throws:

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

assignUserWithHttpInfo

public ApiResponse<ManagementProjectsUsersAssignResponseBody> assignUserWithHttpInfo(String projectId,
 ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody)
                                                                              throws ApiException

Assign User Assigns a user to a given project. The user must be an existing user in Voucherify. 🚧 Correct Use of Data To avoid errors, use the role key with either id or login keys.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsUsersAssignRequestBody - Defines the user details. (optional)

Returns:

ApiResponse<ManagementProjectsUsersAssignResponseBody>

Throws:

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

assignUserAsync

public okhttp3.Call assignUserAsync(String projectId,
 ManagementProjectsUsersAssignRequestBody managementProjectsUsersAssignRequestBody,
 ApiCallback<ManagementProjectsUsersAssignResponseBody> _callback)
                             throws ApiException

Assign User (asynchronously) Assigns a user to a given project. The user must be an existing user in Voucherify. 🚧 Correct Use of Data To avoid errors, use the role key with either id or login keys.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsUsersAssignRequestBody - Defines the user details. (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

createBrandCall

public okhttp3.Call createBrandCall(String projectId,
 ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody,
 ApiCallback _callback)
                             throws ApiException

Build call for createBrand

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsBrandingCreateRequestBody - Defines a brand configuration. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createBrand

public ManagementProjectsBrandingCreateResponseBody createBrand(String projectId,
 ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody)
                                                         throws ApiException

Create Brand Creates a new brand configuration. You can have only one brand configured for a project. 📘 White Labelling The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsBrandingCreateRequestBody - Defines a brand configuration. (optional)

Returns:

ManagementProjectsBrandingCreateResponseBody

Throws:

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

createBrandWithHttpInfo

public ApiResponse<ManagementProjectsBrandingCreateResponseBody> createBrandWithHttpInfo(String projectId,
 ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody)
                                                                                  throws ApiException

Create Brand Creates a new brand configuration. You can have only one brand configured for a project. 📘 White Labelling The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsBrandingCreateRequestBody - Defines a brand configuration. (optional)

Returns:

ApiResponse<ManagementProjectsBrandingCreateResponseBody>

Throws:

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

createBrandAsync

public okhttp3.Call createBrandAsync(String projectId,
 ManagementProjectsBrandingCreateRequestBody managementProjectsBrandingCreateRequestBody,
 ApiCallback<ManagementProjectsBrandingCreateResponseBody> _callback)
                              throws ApiException

Create Brand (asynchronously) Creates a new brand configuration. You can have only one brand configured for a project. 📘 White Labelling The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsBrandingCreateRequestBody - Defines a brand configuration. (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

createCustomEventSchemaCall

public okhttp3.Call createCustomEventSchemaCall(String projectId,
 ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody,
 ApiCallback _callback)
                                         throws ApiException

Build call for createCustomEventSchema

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsCustomEventSchemasCreateRequestBody - Defines the custom event schema. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createCustomEventSchema

public ManagementProjectsCustomEventSchemasCreateResponseBody createCustomEventSchema(String projectId,
 ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody)
                                                                               throws ApiException

Create Custom Event Schema Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata). 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsCustomEventSchemasCreateRequestBody - Defines the custom event schema. (optional)

Returns:

ManagementProjectsCustomEventSchemasCreateResponseBody

Throws:

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

createCustomEventSchemaWithHttpInfo

public ApiResponse<ManagementProjectsCustomEventSchemasCreateResponseBody> createCustomEventSchemaWithHttpInfo(String projectId,
 ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody)
                                                                                                        throws ApiException

Create Custom Event Schema Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata). 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsCustomEventSchemasCreateRequestBody - Defines the custom event schema. (optional)

Returns:

ApiResponse<ManagementProjectsCustomEventSchemasCreateResponseBody>

Throws:

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

createCustomEventSchemaAsync

public okhttp3.Call createCustomEventSchemaAsync(String projectId,
 ManagementProjectsCustomEventSchemasCreateRequestBody managementProjectsCustomEventSchemasCreateRequestBody,
 ApiCallback<ManagementProjectsCustomEventSchemasCreateResponseBody> _callback)
                                          throws ApiException

Create Custom Event Schema (asynchronously) Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata). 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsCustomEventSchemasCreateRequestBody - Defines the custom event schema. (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

createMetadataSchemaCall

public okhttp3.Call createMetadataSchemaCall(String projectId,
 ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody,
 ApiCallback _callback)
                                      throws ApiException

Build call for createMetadataSchema

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsMetadataSchemasCreateRequestBody - Defines the metadata schema. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createMetadataSchema

public ManagementProjectsMetadataSchemasCreateResponseBody createMetadataSchema(String projectId,
 ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody)
                                                                         throws ApiException

Create Metadata Schema Creates a new metadata (custom attribute) schema. The schema consists of a set of key-value pairs to customize Voucherify resources. You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object cannot include another nested object. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsMetadataSchemasCreateRequestBody - Defines the metadata schema. (optional)

Returns:

ManagementProjectsMetadataSchemasCreateResponseBody

Throws:

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

createMetadataSchemaWithHttpInfo

public ApiResponse<ManagementProjectsMetadataSchemasCreateResponseBody> createMetadataSchemaWithHttpInfo(String projectId,
 ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody)
                                                                                                  throws ApiException

Create Metadata Schema Creates a new metadata (custom attribute) schema. The schema consists of a set of key-value pairs to customize Voucherify resources. You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object cannot include another nested object. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsMetadataSchemasCreateRequestBody - Defines the metadata schema. (optional)

Returns:

ApiResponse<ManagementProjectsMetadataSchemasCreateResponseBody>

Throws:

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

createMetadataSchemaAsync

public okhttp3.Call createMetadataSchemaAsync(String projectId,
 ManagementProjectsMetadataSchemasCreateRequestBody managementProjectsMetadataSchemasCreateRequestBody,
 ApiCallback<ManagementProjectsMetadataSchemasCreateResponseBody> _callback)
                                       throws ApiException

Create Metadata Schema (asynchronously) Creates a new metadata (custom attribute) schema. The schema consists of a set of key-value pairs to customize Voucherify resources. You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object cannot include another nested object. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsMetadataSchemasCreateRequestBody - Defines the metadata schema. (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

createProjectCall

public okhttp3.Call createProjectCall(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody,
 ApiCallback _callback)
                               throws ApiException

Build call for createProject

Parameters:

managementProjectsCreateRequestBody - Define project details. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createProject

public ManagementProjectsCreateResponseBody createProject(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody)
                                                   throws ApiException

Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default.

Parameters:

managementProjectsCreateRequestBody - Define project details. (optional)

Returns:

ManagementProjectsCreateResponseBody

Throws:

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

createProjectWithHttpInfo

public ApiResponse<ManagementProjectsCreateResponseBody> createProjectWithHttpInfo(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody)
                                                                            throws ApiException

Create Project Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default.

Parameters:

managementProjectsCreateRequestBody - Define project details. (optional)

Returns:

ApiResponse<ManagementProjectsCreateResponseBody>

Throws:

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

createProjectAsync

public okhttp3.Call createProjectAsync(ManagementProjectsCreateRequestBody managementProjectsCreateRequestBody,
 ApiCallback<ManagementProjectsCreateResponseBody> _callback)
                                throws ApiException

Create Project (asynchronously) Creates a new project. You can add users, specify the cluster, timezone, currency, and other details. All owners are added to the project by default.

Parameters:

managementProjectsCreateRequestBody - Define project details. (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

createStackingRulesCall

public okhttp3.Call createStackingRulesCall(String projectId,
 ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody,
 ApiCallback _callback)
                                     throws ApiException

Build call for createStackingRules

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsStackingRulesCreateRequestBody - Defines the stacking rule parameters. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createStackingRules

public ManagementProjectsStackingRulesCreateResponseBody createStackingRules(String projectId,
 ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody)
                                                                      throws ApiException

Create Stacking Rules Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use Update Stacking Rules endpoint to change the rules. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsStackingRulesCreateRequestBody - Defines the stacking rule parameters. (optional)

Returns:

ManagementProjectsStackingRulesCreateResponseBody

Throws:

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

createStackingRulesWithHttpInfo

public ApiResponse<ManagementProjectsStackingRulesCreateResponseBody> createStackingRulesWithHttpInfo(String projectId,
 ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody)
                                                                                               throws ApiException

Create Stacking Rules Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use Update Stacking Rules endpoint to change the rules. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsStackingRulesCreateRequestBody - Defines the stacking rule parameters. (optional)

Returns:

ApiResponse<ManagementProjectsStackingRulesCreateResponseBody>

Throws:

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

createStackingRulesAsync

public okhttp3.Call createStackingRulesAsync(String projectId,
 ManagementProjectsStackingRulesCreateRequestBody managementProjectsStackingRulesCreateRequestBody,
 ApiCallback<ManagementProjectsStackingRulesCreateResponseBody> _callback)
                                      throws ApiException

Create Stacking Rules (asynchronously) Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use Update Stacking Rules endpoint to change the rules. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsStackingRulesCreateRequestBody - Defines the stacking rule parameters. (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

createWebhookCall

public okhttp3.Call createWebhookCall(String projectId,
 ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody,
 ApiCallback _callback)
                               throws ApiException

Build call for createWebhook

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsWebhooksCreateRequestBody - Defines a webhook configuration. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createWebhook

public ManagementProjectsWebhooksCreateResponseBody createWebhook(String projectId,
 ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody)
                                                           throws ApiException

Create Webhook Creates a new webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-01 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsWebhooksCreateRequestBody - Defines a webhook configuration. (optional)

Returns:

ManagementProjectsWebhooksCreateResponseBody

Throws:

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

createWebhookWithHttpInfo

public ApiResponse<ManagementProjectsWebhooksCreateResponseBody> createWebhookWithHttpInfo(String projectId,
 ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody)
                                                                                    throws ApiException

Create Webhook Creates a new webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-01 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsWebhooksCreateRequestBody - Defines a webhook configuration. (optional)

Returns:

ApiResponse<ManagementProjectsWebhooksCreateResponseBody>

Throws:

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

createWebhookAsync

public okhttp3.Call createWebhookAsync(String projectId,
 ManagementProjectsWebhooksCreateRequestBody managementProjectsWebhooksCreateRequestBody,
 ApiCallback<ManagementProjectsWebhooksCreateResponseBody> _callback)
                                throws ApiException

Create Webhook (asynchronously) Creates a new webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-01 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsWebhooksCreateRequestBody - Defines a webhook configuration. (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

deleteBrandCall

public okhttp3.Call deleteBrandCall(String projectId,
 String brandingId,
 ApiCallback _callback)
                             throws ApiException

Build call for deleteBrand

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteBrand

public void deleteBrand(String projectId,
 String brandingId)
                 throws ApiException

Delete Brand Deletes permanently a brand configuration.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

Throws:

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

deleteBrandWithHttpInfo

public ApiResponse<Void> deleteBrandWithHttpInfo(String projectId,
 String brandingId)
                                          throws ApiException

Delete Brand Deletes permanently a brand configuration.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteBrandAsync

public okhttp3.Call deleteBrandAsync(String projectId,
 String brandingId,
 ApiCallback<Void> _callback)
                              throws ApiException

Delete Brand (asynchronously) Deletes permanently a brand configuration.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (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

deleteCustomEventSchemaCall

public okhttp3.Call deleteCustomEventSchemaCall(String projectId,
 String customEventSchemaId,
 ApiCallback _callback)
                                         throws ApiException

Build call for deleteCustomEventSchema

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCustomEventSchema

public void deleteCustomEventSchema(String projectId,
 String customEventSchemaId)
                             throws ApiException

Delete Custom Event Schema Deletes permanently the custom event schema with its custom properties (metadata). 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

Throws:

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

deleteCustomEventSchemaWithHttpInfo

public ApiResponse<Void> deleteCustomEventSchemaWithHttpInfo(String projectId,
 String customEventSchemaId)
                                                      throws ApiException

Delete Custom Event Schema Deletes permanently the custom event schema with its custom properties (metadata). 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteCustomEventSchemaAsync

public okhttp3.Call deleteCustomEventSchemaAsync(String projectId,
 String customEventSchemaId,
 ApiCallback<Void> _callback)
                                          throws ApiException

Delete Custom Event Schema (asynchronously) Deletes permanently the custom event schema with its custom properties (metadata). 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (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

deleteMetadataSchemaCall

public okhttp3.Call deleteMetadataSchemaCall(String projectId,
 String metadataSchemaId,
 ApiCallback _callback)
                                      throws ApiException

Build call for deleteMetadataSchema

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteMetadataSchema

public void deleteMetadataSchema(String projectId,
 String metadataSchemaId)
                          throws ApiException

Delete Metadata Schema Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the Update Metadata Schema endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the Create Metadata Schema endpoint. 🚧 Metadata Purging This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain. If you want to purge metadata from the entities: 1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the Update Metadata Schema endpoint. 2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema. 3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note: - This is an asynchronous action. You will be notified when it has been completed. - You cannot purge metadata for the Redemption and Publication schemas. 4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

Throws:

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

deleteMetadataSchemaWithHttpInfo

public ApiResponse<Void> deleteMetadataSchemaWithHttpInfo(String projectId,
 String metadataSchemaId)
                                                   throws ApiException

Delete Metadata Schema Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the Update Metadata Schema endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the Create Metadata Schema endpoint. 🚧 Metadata Purging This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain. If you want to purge metadata from the entities: 1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the Update Metadata Schema endpoint. 2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema. 3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note: - This is an asynchronous action. You will be notified when it has been completed. - You cannot purge metadata for the Redemption and Publication schemas. 4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteMetadataSchemaAsync

public okhttp3.Call deleteMetadataSchemaAsync(String projectId,
 String metadataSchemaId,
 ApiCallback<Void> _callback)
                                       throws ApiException

Delete Metadata Schema (asynchronously) Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the Update Metadata Schema endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the Create Metadata Schema endpoint. 🚧 Metadata Purging This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain. If you want to purge metadata from the entities: 1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the Update Metadata Schema endpoint. 2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema. 3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note: - This is an asynchronous action. You will be notified when it has been completed. - You cannot purge metadata for the Redemption and Publication schemas. 4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (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

deleteProjectCall

public okhttp3.Call deleteProjectCall(String projectId,
 ApiCallback _callback)
                               throws ApiException

Build call for deleteProject

Parameters:

projectId - Provide the unique identifier of the project. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteProject

public void deleteProject(String projectId)
                   throws ApiException

Delete Project Deletes an existing project. The users currently using the deleted project will be automatically logged out. 🚧 Sandbox Project The sandbox project cannot be deleted.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Throws:

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

deleteProjectWithHttpInfo

public ApiResponse<Void> deleteProjectWithHttpInfo(String projectId)
                                            throws ApiException

Delete Project Deletes an existing project. The users currently using the deleted project will be automatically logged out. 🚧 Sandbox Project The sandbox project cannot be deleted.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteProjectAsync

public okhttp3.Call deleteProjectAsync(String projectId,
 ApiCallback<Void> _callback)
                                throws ApiException

Delete Project (asynchronously) Deletes an existing project. The users currently using the deleted project will be automatically logged out. 🚧 Sandbox Project The sandbox project cannot be deleted.

Parameters:

projectId - Provide the unique identifier of the project. (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

deleteStackingRulesCall

public okhttp3.Call deleteStackingRulesCall(String projectId,
 String stackingRulesId,
 ApiCallback _callback)
                                     throws ApiException

Build call for deleteStackingRules

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteStackingRules

public void deleteStackingRules(String projectId,
 String stackingRulesId)
                         throws ApiException

Delete Stacking Rules Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

Throws:

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

deleteStackingRulesWithHttpInfo

public ApiResponse<Void> deleteStackingRulesWithHttpInfo(String projectId,
 String stackingRulesId)
                                                  throws ApiException

Delete Stacking Rules Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteStackingRulesAsync

public okhttp3.Call deleteStackingRulesAsync(String projectId,
 String stackingRulesId,
 ApiCallback<Void> _callback)
                                      throws ApiException

Delete Stacking Rules (asynchronously) Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (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

deleteWebhookCall

public okhttp3.Call deleteWebhookCall(String projectId,
 String webhookId,
 ApiCallback _callback)
                               throws ApiException

Build call for deleteWebhook

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteWebhook

public void deleteWebhook(String projectId,
 String webhookId)
                   throws ApiException

Delete Webhook Deletes a webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

Throws:

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

deleteWebhookWithHttpInfo

public ApiResponse<Void> deleteWebhookWithHttpInfo(String projectId,
 String webhookId)
                                            throws ApiException

Delete Webhook Deletes a webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteWebhookAsync

public okhttp3.Call deleteWebhookAsync(String projectId,
 String webhookId,
 ApiCallback<Void> _callback)
                                throws ApiException

Delete Webhook (asynchronously) Deletes a webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (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

getBrandCall

public okhttp3.Call getBrandCall(String projectId,
 String brandingId,
 ApiCallback _callback)
                          throws ApiException

Build call for getBrand

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getBrand

public ManagementProjectsBrandingGetResponseBody getBrand(String projectId,
 String brandingId)
                                                   throws ApiException

Get Brand Retrieves a brand configuration.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

Returns:

ManagementProjectsBrandingGetResponseBody

Throws:

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

getBrandWithHttpInfo

public ApiResponse<ManagementProjectsBrandingGetResponseBody> getBrandWithHttpInfo(String projectId,
 String brandingId)
                                                                            throws ApiException

Get Brand Retrieves a brand configuration.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

Returns:

ApiResponse<ManagementProjectsBrandingGetResponseBody>

Throws:

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

getBrandAsync

public okhttp3.Call getBrandAsync(String projectId,
 String brandingId,
 ApiCallback<ManagementProjectsBrandingGetResponseBody> _callback)
                           throws ApiException

Get Brand (asynchronously) Retrieves a brand configuration.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (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

getCustomEventSchemaCall

public okhttp3.Call getCustomEventSchemaCall(String projectId,
 String customEventSchemaId,
 ApiCallback _callback)
                                      throws ApiException

Build call for getCustomEventSchema

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCustomEventSchema

public ManagementProjectsCustomEventSchemasGetResponseBody getCustomEventSchema(String projectId,
 String customEventSchemaId)
                                                                         throws ApiException

Get Custom Event Schema Retrieves a custom event schema. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

Returns:

ManagementProjectsCustomEventSchemasGetResponseBody

Throws:

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

getCustomEventSchemaWithHttpInfo

public ApiResponse<ManagementProjectsCustomEventSchemasGetResponseBody> getCustomEventSchemaWithHttpInfo(String projectId,
 String customEventSchemaId)
                                                                                                  throws ApiException

Get Custom Event Schema Retrieves a custom event schema. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

Returns:

ApiResponse<ManagementProjectsCustomEventSchemasGetResponseBody>

Throws:

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

getCustomEventSchemaAsync

public okhttp3.Call getCustomEventSchemaAsync(String projectId,
 String customEventSchemaId,
 ApiCallback<ManagementProjectsCustomEventSchemasGetResponseBody> _callback)
                                       throws ApiException

Get Custom Event Schema (asynchronously) Retrieves a custom event schema. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (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

getMetadataSchema1Call

public okhttp3.Call getMetadataSchema1Call(String projectId,
 String metadataSchemaId,
 ApiCallback _callback)
                                    throws ApiException

Build call for getMetadataSchema1

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMetadataSchema1

public ManagementProjectsMetadataSchemasGetResponseBody getMetadataSchema1(String projectId,
 String metadataSchemaId)
                                                                    throws ApiException

Get Metadata Schema Retrieves a metadata schema. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

Returns:

ManagementProjectsMetadataSchemasGetResponseBody

Throws:

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

getMetadataSchema1WithHttpInfo

public ApiResponse<ManagementProjectsMetadataSchemasGetResponseBody> getMetadataSchema1WithHttpInfo(String projectId,
 String metadataSchemaId)
                                                                                             throws ApiException

Get Metadata Schema Retrieves a metadata schema. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

Returns:

ApiResponse<ManagementProjectsMetadataSchemasGetResponseBody>

Throws:

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

getMetadataSchema1Async

public okhttp3.Call getMetadataSchema1Async(String projectId,
 String metadataSchemaId,
 ApiCallback<ManagementProjectsMetadataSchemasGetResponseBody> _callback)
                                     throws ApiException

Get Metadata Schema (asynchronously) Retrieves a metadata schema. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (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

getProjectCall

public okhttp3.Call getProjectCall(String projectId,
 ApiCallback _callback)
                            throws ApiException

Build call for getProject

Parameters:

projectId - Provide the unique identifier of the project. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getProject

public ManagementProjectsGetResponseBody getProject(String projectId)
                                             throws ApiException

Get Project Retrieves an existing project.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ManagementProjectsGetResponseBody

Throws:

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

getProjectWithHttpInfo

public ApiResponse<ManagementProjectsGetResponseBody> getProjectWithHttpInfo(String projectId)
                                                                      throws ApiException

Get Project Retrieves an existing project.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ApiResponse<ManagementProjectsGetResponseBody>

Throws:

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

getProjectAsync

public okhttp3.Call getProjectAsync(String projectId,
 ApiCallback<ManagementProjectsGetResponseBody> _callback)
                             throws ApiException

Get Project (asynchronously) Retrieves an existing project.

Parameters:

projectId - Provide the unique identifier of the project. (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

getStackingRulesCall

public okhttp3.Call getStackingRulesCall(String projectId,
 String stackingRulesId,
 ApiCallback _callback)
                                  throws ApiException

Build call for getStackingRules

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getStackingRules

public ManagementProjectsStackingRulesGetResponseBody getStackingRules(String projectId,
 String stackingRulesId)
                                                                throws ApiException

Get Stacking Rules Retrieves the stacking rules for the project. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

Returns:

ManagementProjectsStackingRulesGetResponseBody

Throws:

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

getStackingRulesWithHttpInfo

public ApiResponse<ManagementProjectsStackingRulesGetResponseBody> getStackingRulesWithHttpInfo(String projectId,
 String stackingRulesId)
                                                                                         throws ApiException

Get Stacking Rules Retrieves the stacking rules for the project. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

Returns:

ApiResponse<ManagementProjectsStackingRulesGetResponseBody>

Throws:

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

getStackingRulesAsync

public okhttp3.Call getStackingRulesAsync(String projectId,
 String stackingRulesId,
 ApiCallback<ManagementProjectsStackingRulesGetResponseBody> _callback)
                                   throws ApiException

Get Stacking Rules (asynchronously) Retrieves the stacking rules for the project. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (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

getUserCall

public okhttp3.Call getUserCall(String projectId,
 String userId,
 ApiCallback _callback)
                         throws ApiException

Build call for getUser

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUser

public ManagementProjectsUsersGetUserResponseBody getUser(String projectId,
 String userId)
                                                   throws ApiException

Get User Retrieves the project users details.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

Returns:

ManagementProjectsUsersGetUserResponseBody

Throws:

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

getUserWithHttpInfo

public ApiResponse<ManagementProjectsUsersGetUserResponseBody> getUserWithHttpInfo(String projectId,
 String userId)
                                                                            throws ApiException

Get User Retrieves the project users details.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

Returns:

ApiResponse<ManagementProjectsUsersGetUserResponseBody>

Throws:

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

getUserAsync

public okhttp3.Call getUserAsync(String projectId,
 String userId,
 ApiCallback<ManagementProjectsUsersGetUserResponseBody> _callback)
                          throws ApiException

Get User (asynchronously) Retrieves the project users details.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (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

getWebhookCall

public okhttp3.Call getWebhookCall(String projectId,
 String webhookId,
 ApiCallback _callback)
                            throws ApiException

Build call for getWebhook

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getWebhook

public ManagementProjectsWebhooksGetResponseBody getWebhook(String projectId,
 String webhookId)
                                                     throws ApiException

Get Webhook Retrieves a webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

Returns:

ManagementProjectsWebhooksGetResponseBody

Throws:

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

getWebhookWithHttpInfo

public ApiResponse<ManagementProjectsWebhooksGetResponseBody> getWebhookWithHttpInfo(String projectId,
 String webhookId)
                                                                              throws ApiException

Get Webhook Retrieves a webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

Returns:

ApiResponse<ManagementProjectsWebhooksGetResponseBody>

Throws:

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

getWebhookAsync

public okhttp3.Call getWebhookAsync(String projectId,
 String webhookId,
 ApiCallback<ManagementProjectsWebhooksGetResponseBody> _callback)
                             throws ApiException

Get Webhook (asynchronously) Retrieves a webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (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

inviteUserCall

public okhttp3.Call inviteUserCall(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody,
 ApiCallback _callback)
                            throws ApiException

Build call for inviteUser

Parameters:

managementProjectsUsersInviteCreateRequestBody - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

inviteUser

public void inviteUser(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody)
                throws ApiException

Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles.

Parameters:

managementProjectsUsersInviteCreateRequestBody - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional)

Throws:

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

inviteUserWithHttpInfo

public ApiResponse<Void> inviteUserWithHttpInfo(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody)
                                         throws ApiException

Invite a New User Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles.

Parameters:

managementProjectsUsersInviteCreateRequestBody - Defines the details of the invitation, the project, and roles to which the user will be assigned. (optional)

Returns:

ApiResponse<Void>

Throws:

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

inviteUserAsync

public okhttp3.Call inviteUserAsync(ManagementProjectsUsersInviteCreateRequestBody managementProjectsUsersInviteCreateRequestBody,
 ApiCallback<Void> _callback)
                             throws ApiException

Invite a New User (asynchronously) Sends an invitation to an email address that has not been used yet as a Voucherify user login. You can specify the projects to which the invited user will be assigned and define their roles.

Parameters:

managementProjectsUsersInviteCreateRequestBody - Defines the details of the invitation, the project, and roles to which the user will be assigned. (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

listBrandsCall

public okhttp3.Call listBrandsCall(String projectId,
 ApiCallback _callback)
                            throws ApiException

Build call for listBrands

Parameters:

projectId - Provide the unique identifier of the project. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listBrands

public ManagementProjectsBrandingListResponseBody listBrands(String projectId)
                                                      throws ApiException

List Brands Lists all brand configurations. Because a project can have only one brand, it always returns a list with one item. This endpoint can be used to retrieve the brand configuration created with the Voucherify Dashboard and the ID.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ManagementProjectsBrandingListResponseBody

Throws:

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

listBrandsWithHttpInfo

public ApiResponse<ManagementProjectsBrandingListResponseBody> listBrandsWithHttpInfo(String projectId)
                                                                               throws ApiException

List Brands Lists all brand configurations. Because a project can have only one brand, it always returns a list with one item. This endpoint can be used to retrieve the brand configuration created with the Voucherify Dashboard and the ID.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ApiResponse<ManagementProjectsBrandingListResponseBody>

Throws:

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

listBrandsAsync

public okhttp3.Call listBrandsAsync(String projectId,
 ApiCallback<ManagementProjectsBrandingListResponseBody> _callback)
                             throws ApiException

List Brands (asynchronously) Lists all brand configurations. Because a project can have only one brand, it always returns a list with one item. This endpoint can be used to retrieve the brand configuration created with the Voucherify Dashboard and the ID.

Parameters:

projectId - Provide the unique identifier of the project. (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

listCustomEventSchemasCall

public okhttp3.Call listCustomEventSchemasCall(String projectId,
 ApiCallback _callback)
                                        throws ApiException

Build call for listCustomEventSchemas

Parameters:

projectId - Provide the unique identifier of the project. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listCustomEventSchemas

public ManagementProjectsCustomEventSchemasListResponseBody listCustomEventSchemas(String projectId)
                                                                            throws ApiException

List Custom Event Schemas Lists all custom event schemas available in the project. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ManagementProjectsCustomEventSchemasListResponseBody

Throws:

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

listCustomEventSchemasWithHttpInfo

public ApiResponse<ManagementProjectsCustomEventSchemasListResponseBody> listCustomEventSchemasWithHttpInfo(String projectId)
                                                                                                     throws ApiException

List Custom Event Schemas Lists all custom event schemas available in the project. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ApiResponse<ManagementProjectsCustomEventSchemasListResponseBody>

Throws:

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

listCustomEventSchemasAsync

public okhttp3.Call listCustomEventSchemasAsync(String projectId,
 ApiCallback<ManagementProjectsCustomEventSchemasListResponseBody> _callback)
                                         throws ApiException

List Custom Event Schemas (asynchronously) Lists all custom event schemas available in the project. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (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

listMetadataSchemas1Call

public okhttp3.Call listMetadataSchemas1Call(String projectId,
 ApiCallback _callback)
                                      throws ApiException

Build call for listMetadataSchemas1

Parameters:

projectId - Provide the unique identifier of the project. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listMetadataSchemas1

public ManagementProjectsMetadataSchemasListResponseBody listMetadataSchemas1(String projectId)
                                                                       throws ApiException

List Metadata Schemas Lists all metadata schemas available in the project. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ManagementProjectsMetadataSchemasListResponseBody

Throws:

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

listMetadataSchemas1WithHttpInfo

public ApiResponse<ManagementProjectsMetadataSchemasListResponseBody> listMetadataSchemas1WithHttpInfo(String projectId)
                                                                                                throws ApiException

List Metadata Schemas Lists all metadata schemas available in the project. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ApiResponse<ManagementProjectsMetadataSchemasListResponseBody>

Throws:

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

listMetadataSchemas1Async

public okhttp3.Call listMetadataSchemas1Async(String projectId,
 ApiCallback<ManagementProjectsMetadataSchemasListResponseBody> _callback)
                                       throws ApiException

List Metadata Schemas (asynchronously) Lists all metadata schemas available in the project. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (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

listProjectsCall

public okhttp3.Call listProjectsCall(ApiCallback _callback)
                              throws ApiException

Build call for listProjects

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listProjects

public ManagementProjectsListResponseBody listProjects()
                                                throws ApiException

List Projects Lists all projects for the organization. The endpoint does not require any query parameters.

Returns:

ManagementProjectsListResponseBody

Throws:

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

listProjectsWithHttpInfo

public ApiResponse<ManagementProjectsListResponseBody> listProjectsWithHttpInfo()
                                                                         throws ApiException

List Projects Lists all projects for the organization. The endpoint does not require any query parameters.

Returns:

ApiResponse<ManagementProjectsListResponseBody>

Throws:

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

listProjectsAsync

public okhttp3.Call listProjectsAsync(ApiCallback<ManagementProjectsListResponseBody> _callback)
                               throws ApiException

List Projects (asynchronously) Lists all projects for the organization. The endpoint does not require any query parameters.

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

listStackingRulesCall

public okhttp3.Call listStackingRulesCall(String projectId,
 ApiCallback _callback)
                                   throws ApiException

Build call for listStackingRules

Parameters:

projectId - Provide the unique identifier of the project. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listStackingRules

public ManagementProjectsStackingRulesListResponseBody listStackingRules(String projectId)
                                                                  throws ApiException

List Stacking Rules Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the Get Stacking Rules or Update Stacking Rules endpoints. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ManagementProjectsStackingRulesListResponseBody

Throws:

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

listStackingRulesWithHttpInfo

public ApiResponse<ManagementProjectsStackingRulesListResponseBody> listStackingRulesWithHttpInfo(String projectId)
                                                                                           throws ApiException

List Stacking Rules Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the Get Stacking Rules or Update Stacking Rules endpoints. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ApiResponse<ManagementProjectsStackingRulesListResponseBody>

Throws:

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

listStackingRulesAsync

public okhttp3.Call listStackingRulesAsync(String projectId,
 ApiCallback<ManagementProjectsStackingRulesListResponseBody> _callback)
                                    throws ApiException

List Stacking Rules (asynchronously) Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the Get Stacking Rules or Update Stacking Rules endpoints. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (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

listUsersCall

public okhttp3.Call listUsersCall(String projectId,
 ApiCallback _callback)
                           throws ApiException

Build call for listUsers

Parameters:

projectId - Provide the unique identifier of the project. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listUsers

public ManagementProjectsUsersListResponseBody listUsers(String projectId)
                                                  throws ApiException

List Users Lists all users assigned to the project.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ManagementProjectsUsersListResponseBody

Throws:

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

listUsersWithHttpInfo

public ApiResponse<ManagementProjectsUsersListResponseBody> listUsersWithHttpInfo(String projectId)
                                                                           throws ApiException

List Users Lists all users assigned to the project.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ApiResponse<ManagementProjectsUsersListResponseBody>

Throws:

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

listUsersAsync

public okhttp3.Call listUsersAsync(String projectId,
 ApiCallback<ManagementProjectsUsersListResponseBody> _callback)
                            throws ApiException

List Users (asynchronously) Lists all users assigned to the project.

Parameters:

projectId - Provide the unique identifier of the project. (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

listWebhooksCall

public okhttp3.Call listWebhooksCall(String projectId,
 ApiCallback _callback)
                              throws ApiException

Build call for listWebhooks

Parameters:

projectId - Provide the unique identifier of the project. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listWebhooks

public ManagementProjectsWebhooksListResponseBody listWebhooks(String projectId)
                                                        throws ApiException

List Webhooks Lists all webhook configurations for the project. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ManagementProjectsWebhooksListResponseBody

Throws:

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

listWebhooksWithHttpInfo

public ApiResponse<ManagementProjectsWebhooksListResponseBody> listWebhooksWithHttpInfo(String projectId)
                                                                                 throws ApiException

List Webhooks Lists all webhook configurations for the project. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

Returns:

ApiResponse<ManagementProjectsWebhooksListResponseBody>

Throws:

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

listWebhooksAsync

public okhttp3.Call listWebhooksAsync(String projectId,
 ApiCallback<ManagementProjectsWebhooksListResponseBody> _callback)
                               throws ApiException

List Webhooks (asynchronously) Lists all webhook configurations for the project. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (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

managementCopyCampaignTemplateCall

public okhttp3.Call managementCopyCampaignTemplateCall(String projectId,
 String campaignTemplateId,
 ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody,
 ApiCallback _callback)
                                                throws ApiException

Build call for managementCopyCampaignTemplate

Parameters:

projectId - Provide the unique identifier of the project. (required)

campaignTemplateId - Provide the unique identifier of the campaign template. (required)

managementProjectsTemplatesCampaignsCopyCreateRequestBody - Determines the details about the template in the destination project as well as the destination project itself. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

managementCopyCampaignTemplate

public ManagementProjectsTemplatesCampaignsCopyCreateResponseBody managementCopyCampaignTemplate(String projectId,
 String campaignTemplateId,
 ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody)
                                                                                          throws ApiException

Copy Campaign Template to a Project Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

projectId - Provide the unique identifier of the project. (required)

campaignTemplateId - Provide the unique identifier of the campaign template. (required)

managementProjectsTemplatesCampaignsCopyCreateRequestBody - Determines the details about the template in the destination project as well as the destination project itself. (optional)

Returns:

ManagementProjectsTemplatesCampaignsCopyCreateResponseBody

Throws:

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

managementCopyCampaignTemplateWithHttpInfo

public ApiResponse<ManagementProjectsTemplatesCampaignsCopyCreateResponseBody> managementCopyCampaignTemplateWithHttpInfo(String projectId,
 String campaignTemplateId,
 ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody)
                                                                                                                   throws ApiException

Copy Campaign Template to a Project Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

projectId - Provide the unique identifier of the project. (required)

campaignTemplateId - Provide the unique identifier of the campaign template. (required)

managementProjectsTemplatesCampaignsCopyCreateRequestBody - Determines the details about the template in the destination project as well as the destination project itself. (optional)

Returns:

ApiResponse<ManagementProjectsTemplatesCampaignsCopyCreateResponseBody>

Throws:

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

managementCopyCampaignTemplateAsync

public okhttp3.Call managementCopyCampaignTemplateAsync(String projectId,
 String campaignTemplateId,
 ManagementProjectsTemplatesCampaignsCopyCreateRequestBody managementProjectsTemplatesCampaignsCopyCreateRequestBody,
 ApiCallback<ManagementProjectsTemplatesCampaignsCopyCreateResponseBody> _callback)
                                                 throws ApiException

Copy Campaign Template to a Project (asynchronously) Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

projectId - Provide the unique identifier of the project. (required)

campaignTemplateId - Provide the unique identifier of the campaign template. (required)

managementProjectsTemplatesCampaignsCopyCreateRequestBody - Determines the details about the template in the destination project as well as the destination project itself. (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

managementListCampaignTemplatesCall

public okhttp3.Call managementListCampaignTemplatesCall(String projectId,
 Integer limit,
 String startingAfterId,
 ParameterTemplatesList order,
 Boolean includeTotal,
 ParameterFiltersListTemplates filters,
 ApiCallback _callback)
                                                 throws ApiException

Build call for managementListCampaignTemplates

Parameters:

projectId - Provide the unique identifier of the project. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

startingAfterId - A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

includeTotal - If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. (optional)

filters - Filters for listing templates. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

managementListCampaignTemplates

public ManagementProjectsTemplatesCampaignsListResponseBody managementListCampaignTemplates(String projectId,
 Integer limit,
 String startingAfterId,
 ParameterTemplatesList order,
 Boolean includeTotal,
 ParameterFiltersListTemplates filters)
                                                                                     throws ApiException

List Campaign Templates Lists all campaign templates available in the project. 👍 List Campaign Templates This endpoint works in the same way as the List Campaign Templates endpoint. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

projectId - Provide the unique identifier of the project. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

startingAfterId - A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

includeTotal - If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. (optional)

filters - Filters for listing templates. (optional)

Returns:

ManagementProjectsTemplatesCampaignsListResponseBody

Throws:

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

managementListCampaignTemplatesWithHttpInfo

public ApiResponse<ManagementProjectsTemplatesCampaignsListResponseBody> managementListCampaignTemplatesWithHttpInfo(String projectId,
 Integer limit,
 String startingAfterId,
 ParameterTemplatesList order,
 Boolean includeTotal,
 ParameterFiltersListTemplates filters)
                                                                                                              throws ApiException

List Campaign Templates Lists all campaign templates available in the project. 👍 List Campaign Templates This endpoint works in the same way as the List Campaign Templates endpoint. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

projectId - Provide the unique identifier of the project. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

startingAfterId - A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

includeTotal - If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. (optional)

filters - Filters for listing templates. (optional)

Returns:

ApiResponse<ManagementProjectsTemplatesCampaignsListResponseBody>

Throws:

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

managementListCampaignTemplatesAsync

public okhttp3.Call managementListCampaignTemplatesAsync(String projectId,
 Integer limit,
 String startingAfterId,
 ParameterTemplatesList order,
 Boolean includeTotal,
 ParameterFiltersListTemplates filters,
 ApiCallback<ManagementProjectsTemplatesCampaignsListResponseBody> _callback)
                                                  throws ApiException

List Campaign Templates (asynchronously) Lists all campaign templates available in the project. 👍 List Campaign Templates This endpoint works in the same way as the List Campaign Templates endpoint. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

projectId - Provide the unique identifier of the project. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

startingAfterId - A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

includeTotal - If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. (optional)

filters - Filters for listing templates. (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

unassignUserCall

public okhttp3.Call unassignUserCall(String projectId,
 String userId,
 ApiCallback _callback)
                              throws ApiException

Build call for unassignUser

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

unassignUser

public void unassignUser(String projectId,
 String userId)
                  throws ApiException

Unassign User Unassigns the user from the project. If the user is currently logged in, they are automatically logged out. If the user is assigned to only one project, they cannot be unassigned from that project.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

Throws:

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

unassignUserWithHttpInfo

public ApiResponse<Void> unassignUserWithHttpInfo(String projectId,
 String userId)
                                           throws ApiException

Unassign User Unassigns the user from the project. If the user is currently logged in, they are automatically logged out. If the user is assigned to only one project, they cannot be unassigned from that project.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

Returns:

ApiResponse<Void>

Throws:

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

unassignUserAsync

public okhttp3.Call unassignUserAsync(String projectId,
 String userId,
 ApiCallback<Void> _callback)
                               throws ApiException

Unassign User (asynchronously) Unassigns the user from the project. If the user is currently logged in, they are automatically logged out. If the user is assigned to only one project, they cannot be unassigned from that project.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (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

updateBrandCall

public okhttp3.Call updateBrandCall(String projectId,
 String brandingId,
 ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody,
 ApiCallback _callback)
                             throws ApiException

Build call for updateBrand

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

managementProjectsBrandingUpdateRequestBody - Defines the brand configuration to be updated. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateBrand

public ManagementProjectsBrandingUpdateResponseBody updateBrand(String projectId,
 String brandingId,
 ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody)
                                                         throws ApiException

Update Brand Updates a brand configuration. Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged. 📘 White Labelling The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

managementProjectsBrandingUpdateRequestBody - Defines the brand configuration to be updated. (optional)

Returns:

ManagementProjectsBrandingUpdateResponseBody

Throws:

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

updateBrandWithHttpInfo

public ApiResponse<ManagementProjectsBrandingUpdateResponseBody> updateBrandWithHttpInfo(String projectId,
 String brandingId,
 ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody)
                                                                                  throws ApiException

Update Brand Updates a brand configuration. Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged. 📘 White Labelling The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

managementProjectsBrandingUpdateRequestBody - Defines the brand configuration to be updated. (optional)

Returns:

ApiResponse<ManagementProjectsBrandingUpdateResponseBody>

Throws:

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

updateBrandAsync

public okhttp3.Call updateBrandAsync(String projectId,
 String brandingId,
 ManagementProjectsBrandingUpdateRequestBody managementProjectsBrandingUpdateRequestBody,
 ApiCallback<ManagementProjectsBrandingUpdateResponseBody> _callback)
                              throws ApiException

Update Brand (asynchronously) Updates a brand configuration. Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged. 📘 White Labelling The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.

Parameters:

projectId - Provide the unique identifier of the project. (required)

brandingId - Provide the unique identifier of the brand configuration. (required)

managementProjectsBrandingUpdateRequestBody - Defines the brand configuration to be updated. (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

updateCustomEventSchemaCall

public okhttp3.Call updateCustomEventSchemaCall(String projectId,
 String customEventSchemaId,
 ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody,
 ApiCallback _callback)
                                         throws ApiException

Build call for updateCustomEventSchema

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

managementProjectsCustomEventSchemasUpdateRequestBody - Defines the custom event schema to be updated. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateCustomEventSchema

public ManagementProjectsCustomEventSchemasUpdateResponseBody updateCustomEventSchema(String projectId,
 String customEventSchemaId,
 ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody)
                                                                               throws ApiException

Update Custom Event Schema Updates a custom event schema. With this request, you can: - Add a non-existing property to a custom event schema. - Update an existing property. In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged. 👍 Additional Notes - You can change the type of an existing property, e.g. from string to number. - You can remove a custom property with this endpoint by providing deleted: true in the request. However, you cannot permanently remove an event definition or its property with this endpoint. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

managementProjectsCustomEventSchemasUpdateRequestBody - Defines the custom event schema to be updated. (optional)

Returns:

ManagementProjectsCustomEventSchemasUpdateResponseBody

Throws:

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

updateCustomEventSchemaWithHttpInfo

public ApiResponse<ManagementProjectsCustomEventSchemasUpdateResponseBody> updateCustomEventSchemaWithHttpInfo(String projectId,
 String customEventSchemaId,
 ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody)
                                                                                                        throws ApiException

Update Custom Event Schema Updates a custom event schema. With this request, you can: - Add a non-existing property to a custom event schema. - Update an existing property. In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged. 👍 Additional Notes - You can change the type of an existing property, e.g. from string to number. - You can remove a custom property with this endpoint by providing deleted: true in the request. However, you cannot permanently remove an event definition or its property with this endpoint. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

managementProjectsCustomEventSchemasUpdateRequestBody - Defines the custom event schema to be updated. (optional)

Returns:

ApiResponse<ManagementProjectsCustomEventSchemasUpdateResponseBody>

Throws:

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

updateCustomEventSchemaAsync

public okhttp3.Call updateCustomEventSchemaAsync(String projectId,
 String customEventSchemaId,
 ManagementProjectsCustomEventSchemasUpdateRequestBody managementProjectsCustomEventSchemasUpdateRequestBody,
 ApiCallback<ManagementProjectsCustomEventSchemasUpdateResponseBody> _callback)
                                          throws ApiException

Update Custom Event Schema (asynchronously) Updates a custom event schema. With this request, you can: - Add a non-existing property to a custom event schema. - Update an existing property. In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged. 👍 Additional Notes - You can change the type of an existing property, e.g. from string to number. - You can remove a custom property with this endpoint by providing deleted: true in the request. However, you cannot permanently remove an event definition or its property with this endpoint. 📘 Custom Event Documentation Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.

Parameters:

projectId - Provide the unique identifier of the project. (required)

customEventSchemaId - Provide the unique identifier of the custom event schema. (required)

managementProjectsCustomEventSchemasUpdateRequestBody - Defines the custom event schema to be updated. (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

updateMetadataSchemaCall

public okhttp3.Call updateMetadataSchemaCall(String projectId,
 String metadataSchemaId,
 ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody,
 ApiCallback _callback)
                                      throws ApiException

Build call for updateMetadataSchema

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

managementProjectsMetadataSchemasUpdateRequestBody - Defines the metadata schema to be updated. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateMetadataSchema

public ManagementProjectsMetadataSchemasUpdateResponseBody updateMetadataSchema(String projectId,
 String metadataSchemaId,
 ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody)
                                                                         throws ApiException

Update Metadata Schema Updates a metadata schema. With this request, you can: - Add a non-existing attribute definition to the metadata schema. - Update an existing attribute definition by overwriting its current values. In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged. However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted. 👍 Additional Notes - You cannot change the type of an existing schema, e.g. from string to number. - You can remove a definition with this endpoint by providing deleted: true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

managementProjectsMetadataSchemasUpdateRequestBody - Defines the metadata schema to be updated. (optional)

Returns:

ManagementProjectsMetadataSchemasUpdateResponseBody

Throws:

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

updateMetadataSchemaWithHttpInfo

public ApiResponse<ManagementProjectsMetadataSchemasUpdateResponseBody> updateMetadataSchemaWithHttpInfo(String projectId,
 String metadataSchemaId,
 ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody)
                                                                                                  throws ApiException

Update Metadata Schema Updates a metadata schema. With this request, you can: - Add a non-existing attribute definition to the metadata schema. - Update an existing attribute definition by overwriting its current values. In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged. However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted. 👍 Additional Notes - You cannot change the type of an existing schema, e.g. from string to number. - You can remove a definition with this endpoint by providing deleted: true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

managementProjectsMetadataSchemasUpdateRequestBody - Defines the metadata schema to be updated. (optional)

Returns:

ApiResponse<ManagementProjectsMetadataSchemasUpdateResponseBody>

Throws:

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

updateMetadataSchemaAsync

public okhttp3.Call updateMetadataSchemaAsync(String projectId,
 String metadataSchemaId,
 ManagementProjectsMetadataSchemasUpdateRequestBody managementProjectsMetadataSchemasUpdateRequestBody,
 ApiCallback<ManagementProjectsMetadataSchemasUpdateResponseBody> _callback)
                                       throws ApiException

Update Metadata Schema (asynchronously) Updates a metadata schema. With this request, you can: - Add a non-existing attribute definition to the metadata schema. - Update an existing attribute definition by overwriting its current values. In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged. However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted. 👍 Additional Notes - You cannot change the type of an existing schema, e.g. from string to number. - You can remove a definition with this endpoint by providing deleted: true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint. 📘 Metadata Documentation Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

metadataSchemaId - Provide the unique identifier of the metadata schema. (required)

managementProjectsMetadataSchemasUpdateRequestBody - Defines the metadata schema to be updated. (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

updateProjectCall

public okhttp3.Call updateProjectCall(String projectId,
 ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody,
 ApiCallback _callback)
                               throws ApiException

Build call for updateProject

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsUpdateRequestBody - Define the project details to be updated. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateProject

public ManagementProjectsUpdateResponseBody updateProject(String projectId,
 ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody)
                                                   throws ApiException

Update Project Updates an existing project. You can add or modify settings for timezone, currency, notifications, and other details. Only the fields sent in the request will be updated.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsUpdateRequestBody - Define the project details to be updated. (optional)

Returns:

ManagementProjectsUpdateResponseBody

Throws:

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

updateProjectWithHttpInfo

public ApiResponse<ManagementProjectsUpdateResponseBody> updateProjectWithHttpInfo(String projectId,
 ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody)
                                                                            throws ApiException

Update Project Updates an existing project. You can add or modify settings for timezone, currency, notifications, and other details. Only the fields sent in the request will be updated.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsUpdateRequestBody - Define the project details to be updated. (optional)

Returns:

ApiResponse<ManagementProjectsUpdateResponseBody>

Throws:

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

updateProjectAsync

public okhttp3.Call updateProjectAsync(String projectId,
 ManagementProjectsUpdateRequestBody managementProjectsUpdateRequestBody,
 ApiCallback<ManagementProjectsUpdateResponseBody> _callback)
                                throws ApiException

Update Project (asynchronously) Updates an existing project. You can add or modify settings for timezone, currency, notifications, and other details. Only the fields sent in the request will be updated.

Parameters:

projectId - Provide the unique identifier of the project. (required)

managementProjectsUpdateRequestBody - Define the project details to be updated. (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

updateStackingRulesCall

public okhttp3.Call updateStackingRulesCall(String projectId,
 String stackingRulesId,
 ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody,
 ApiCallback _callback)
                                     throws ApiException

Build call for updateStackingRules

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

managementProjectsStackingRulesUpdateRequestBody - Defines the stacking rules to be updated. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateStackingRules

public ManagementProjectsStackingRulesUpdateResponseBody updateStackingRules(String projectId,
 String stackingRulesId,
 ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody)
                                                                      throws ApiException

Update Stacking Rules Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

managementProjectsStackingRulesUpdateRequestBody - Defines the stacking rules to be updated. (optional)

Returns:

ManagementProjectsStackingRulesUpdateResponseBody

Throws:

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

updateStackingRulesWithHttpInfo

public ApiResponse<ManagementProjectsStackingRulesUpdateResponseBody> updateStackingRulesWithHttpInfo(String projectId,
 String stackingRulesId,
 ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody)
                                                                                               throws ApiException

Update Stacking Rules Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

managementProjectsStackingRulesUpdateRequestBody - Defines the stacking rules to be updated. (optional)

Returns:

ApiResponse<ManagementProjectsStackingRulesUpdateResponseBody>

Throws:

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

updateStackingRulesAsync

public okhttp3.Call updateStackingRulesAsync(String projectId,
 String stackingRulesId,
 ManagementProjectsStackingRulesUpdateRequestBody managementProjectsStackingRulesUpdateRequestBody,
 ApiCallback<ManagementProjectsStackingRulesUpdateResponseBody> _callback)
                                      throws ApiException

Update Stacking Rules (asynchronously) Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request. 📘 Stacking Rules Documentation Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.

Parameters:

projectId - Provide the unique identifier of the project. (required)

stackingRulesId - Provide the unique identifier of the stacking rules. (required)

managementProjectsStackingRulesUpdateRequestBody - Defines the stacking rules to be updated. (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

updateUserCall

public okhttp3.Call updateUserCall(String projectId,
 String userId,
 ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody,
 ApiCallback _callback)
                            throws ApiException

Build call for updateUser

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

managementProjectsUsersUpdateRoleRequestBody - Defines the users new role. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateUser

public ManagementProjectsUsersUpdateRoleResponseBody updateUser(String projectId,
 String userId,
 ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody)
                                                         throws ApiException

Update User Updates the users role.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

managementProjectsUsersUpdateRoleRequestBody - Defines the users new role. (optional)

Returns:

ManagementProjectsUsersUpdateRoleResponseBody

Throws:

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

updateUserWithHttpInfo

public ApiResponse<ManagementProjectsUsersUpdateRoleResponseBody> updateUserWithHttpInfo(String projectId,
 String userId,
 ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody)
                                                                                  throws ApiException

Update User Updates the users role.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

managementProjectsUsersUpdateRoleRequestBody - Defines the users new role. (optional)

Returns:

ApiResponse<ManagementProjectsUsersUpdateRoleResponseBody>

Throws:

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

updateUserAsync

public okhttp3.Call updateUserAsync(String projectId,
 String userId,
 ManagementProjectsUsersUpdateRoleRequestBody managementProjectsUsersUpdateRoleRequestBody,
 ApiCallback<ManagementProjectsUsersUpdateRoleResponseBody> _callback)
                             throws ApiException

Update User (asynchronously) Updates the users role.

Parameters:

projectId - Provide the unique identifier of the project. (required)

userId - Provide the unique identifier of the user. Alternatively, provide the users login. (required)

managementProjectsUsersUpdateRoleRequestBody - Defines the users new role. (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

updateWebhookCall

public okhttp3.Call updateWebhookCall(String projectId,
 String webhookId,
 ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody,
 ApiCallback _callback)
                               throws ApiException

Build call for updateWebhook

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

managementProjectsWebhooksUpdateRequestBody - Defines the webhook configuration to be updated. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateWebhook

public ManagementProjectsWebhooksUpdateResponseBody updateWebhook(String projectId,
 String webhookId,
 ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody)
                                                           throws ApiException

Update Webhook Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

managementProjectsWebhooksUpdateRequestBody - Defines the webhook configuration to be updated. (optional)

Returns:

ManagementProjectsWebhooksUpdateResponseBody

Throws:

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

updateWebhookWithHttpInfo

public ApiResponse<ManagementProjectsWebhooksUpdateResponseBody> updateWebhookWithHttpInfo(String projectId,
 String webhookId,
 ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody)
                                                                                    throws ApiException

Update Webhook Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

managementProjectsWebhooksUpdateRequestBody - Defines the webhook configuration to be updated. (optional)

Returns:

ApiResponse<ManagementProjectsWebhooksUpdateResponseBody>

Throws:

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

updateWebhookAsync

public okhttp3.Call updateWebhookAsync(String projectId,
 String webhookId,
 ManagementProjectsWebhooksUpdateRequestBody managementProjectsWebhooksUpdateRequestBody,
 ApiCallback<ManagementProjectsWebhooksUpdateResponseBody> _callback)
                                throws ApiException

Update Webhook (asynchronously) Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration. 📘 Webhook Documentation Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.

Parameters:

projectId - Provide the unique identifier of the project. (required)

webhookId - Provide the unique identifier of the webhook configuration. (required)

managementProjectsWebhooksUpdateRequestBody - Defines the webhook configuration to be updated. (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