Package com.aboutyou.cloud.adminapi.service

Class CampaignService

java.lang.Object

com.aboutyou.cloud.adminapi.service.AbstractService

com.aboutyou.cloud.adminapi.service.CampaignService

public class CampaignService
extends AbstractService

Constructor Summary

Constructors

Constructor	Description
CampaignService(HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
ApiCollection<Campaign>	all(java.lang.String shopKey)
ApiCollection<Campaign>	all(java.lang.String shopKey, ApiOptions options)
ApiCollection<ProductVariantCampaignReduction>	allReductions(java.lang.String shopKey, java.lang.Integer campaignId)
ApiCollection<ProductVariantCampaignReduction>	allReductions(java.lang.String shopKey, java.lang.Integer campaignId, ApiOptions options)
Campaign	create(java.lang.String shopKey, Campaign model)
Campaign	create(java.lang.String shopKey, Campaign model, ApiOptions options)
java.util.Map<java.lang.String,java.lang.Object>	createOrUpdateCustomData(Identifier campaignId, java.util.Map<java.lang.String,java.lang.Object> model)
java.util.Map<java.lang.String,java.lang.Object>	createOrUpdateCustomData(Identifier campaignId, java.util.Map<java.lang.String,java.lang.Object> model, ApiOptions options)
java.util.Map<java.lang.String,java.lang.Object>	createOrUpdateCustomDataForKey(Identifier campaignId, java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> model)
java.util.Map<java.lang.String,java.lang.Object>	createOrUpdateCustomDataForKey(Identifier campaignId, java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> model, ApiOptions options)
void	delete(java.lang.String shopKey, java.lang.Integer campaignId)
void	delete(java.lang.String shopKey, java.lang.Integer campaignId, ApiOptions options)
void	deleteCustomData(Identifier campaignId)
void	deleteCustomData(Identifier campaignId, ApiOptions options)
void	deleteCustomDataForKey(Identifier campaignId, java.lang.String key)
void	deleteCustomDataForKey(Identifier campaignId, java.lang.String key, ApiOptions options)
void	deleteReductions(java.lang.String shopKey, java.lang.Integer campaignId)
void	deleteReductions(java.lang.String shopKey, java.lang.Integer campaignId, ApiOptions options)
Campaign	get(java.lang.String shopKey, java.lang.Integer campaignId)
Campaign	get(java.lang.String shopKey, java.lang.Integer campaignId, ApiOptions options)
java.util.Map<java.lang.String,java.lang.Object>	getCustomData(Identifier campaignId)
java.util.Map<java.lang.String,java.lang.Object>	getCustomData(Identifier campaignId, ApiOptions options)
java.util.Map<java.lang.String,java.lang.Object>	getCustomDataForKey(Identifier campaignId, java.lang.String key)
java.util.Map<java.lang.String,java.lang.Object>	getCustomDataForKey(Identifier campaignId, java.lang.String key, ApiOptions options)
Campaign	update(java.lang.String shopKey, java.lang.Integer campaignId, Campaign model)
Campaign	update(java.lang.String shopKey, java.lang.Integer campaignId, Campaign model, ApiOptions options)
void	updateOrCreateProductReductions(java.lang.String shopKey, java.lang.Integer campaignId, java.util.List<ProductCampaignReduction> model)
void	updateOrCreateProductReductions(java.lang.String shopKey, java.lang.Integer campaignId, java.util.List<ProductCampaignReduction> model, ApiOptions options)
void	updateOrCreateVariantReductions(java.lang.String shopKey, java.lang.Integer campaignId, java.util.List<ProductVariantCampaignReduction> model)
void	updateOrCreateVariantReductions(java.lang.String shopKey, java.lang.Integer campaignId, java.util.List<ProductVariantCampaignReduction> model, ApiOptions options)

Methods inherited from class com.aboutyou.cloud.adminapi.service.AbstractService

request, request, requestCollection, requestCollection, resolvePath

Methods inherited from class java.lang.Object

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

Constructor Detail

CampaignService

public CampaignService(HttpClient httpClient)

Method Detail

create

public Campaign create(java.lang.String shopKey,
                       Campaign model)
                throws ApiErrorException,
                       ConnectionException

Throws:

ApiErrorException

ConnectionException

create

public Campaign create(java.lang.String shopKey,
                       Campaign model,
                       ApiOptions options)
                throws ApiErrorException,
                       ConnectionException

Throws:

ApiErrorException

ConnectionException

all

public ApiCollection<Campaign> all(java.lang.String shopKey)
                            throws ApiErrorException,
                                   ConnectionException

Throws:

ApiErrorException

ConnectionException

all

public ApiCollection<Campaign> all(java.lang.String shopKey,
                                   ApiOptions options)
                            throws ApiErrorException,
                                   ConnectionException

Throws:

ApiErrorException

ConnectionException

get

public Campaign get(java.lang.String shopKey,
                    java.lang.Integer campaignId)
             throws ApiErrorException,
                    ConnectionException

Throws:

ApiErrorException

ConnectionException

get

public Campaign get(java.lang.String shopKey,
                    java.lang.Integer campaignId,
                    ApiOptions options)
             throws ApiErrorException,
                    ConnectionException

Throws:

ApiErrorException

ConnectionException

update

public Campaign update(java.lang.String shopKey,
                       java.lang.Integer campaignId,
                       Campaign model)
                throws ApiErrorException,
                       ConnectionException

Throws:

ApiErrorException

ConnectionException

update

public Campaign update(java.lang.String shopKey,
                       java.lang.Integer campaignId,
                       Campaign model,
                       ApiOptions options)
                throws ApiErrorException,
                       ConnectionException

Throws:

ApiErrorException

ConnectionException

delete

public void delete(java.lang.String shopKey,
                   java.lang.Integer campaignId)
            throws ApiErrorException,
                   ConnectionException

Throws:

ApiErrorException

ConnectionException

delete

public void delete(java.lang.String shopKey,
                   java.lang.Integer campaignId,
                   ApiOptions options)
            throws ApiErrorException,
                   ConnectionException

Throws:

ApiErrorException

ConnectionException

updateOrCreateVariantReductions

public void updateOrCreateVariantReductions(java.lang.String shopKey,
                                            java.lang.Integer campaignId,
                                            java.util.List<ProductVariantCampaignReduction> model)
                                     throws ApiErrorException,
                                            ConnectionException

Throws:

ApiErrorException

ConnectionException

updateOrCreateVariantReductions

public void updateOrCreateVariantReductions(java.lang.String shopKey,
                                            java.lang.Integer campaignId,
                                            java.util.List<ProductVariantCampaignReduction> model,
                                            ApiOptions options)
                                     throws ApiErrorException,
                                            ConnectionException

Throws:

ApiErrorException

ConnectionException

updateOrCreateProductReductions

public void updateOrCreateProductReductions(java.lang.String shopKey,
                                            java.lang.Integer campaignId,
                                            java.util.List<ProductCampaignReduction> model)
                                     throws ApiErrorException,
                                            ConnectionException

Throws:

ApiErrorException

ConnectionException

updateOrCreateProductReductions

public void updateOrCreateProductReductions(java.lang.String shopKey,
                                            java.lang.Integer campaignId,
                                            java.util.List<ProductCampaignReduction> model,
                                            ApiOptions options)
                                     throws ApiErrorException,
                                            ConnectionException

Throws:

ApiErrorException

ConnectionException

allReductions

public ApiCollection<ProductVariantCampaignReduction> allReductions(java.lang.String shopKey,
                                                                    java.lang.Integer campaignId)
                                                             throws ApiErrorException,
                                                                    ConnectionException

Throws:

ApiErrorException

ConnectionException

allReductions

public ApiCollection<ProductVariantCampaignReduction> allReductions(java.lang.String shopKey,
                                                                    java.lang.Integer campaignId,
                                                                    ApiOptions options)
                                                             throws ApiErrorException,
                                                                    ConnectionException

Throws:

ApiErrorException

ConnectionException

deleteReductions

public void deleteReductions(java.lang.String shopKey,
                             java.lang.Integer campaignId)
                      throws ApiErrorException,
                             ConnectionException

Throws:

ApiErrorException

ConnectionException

deleteReductions

public void deleteReductions(java.lang.String shopKey,
                             java.lang.Integer campaignId,
                             ApiOptions options)
                      throws ApiErrorException,
                             ConnectionException

Throws:

ApiErrorException

ConnectionException

createOrUpdateCustomData

public java.util.Map<java.lang.String,java.lang.Object> createOrUpdateCustomData(Identifier campaignId,
                                                                                       java.util.Map<java.lang.String,java.lang.Object> model)
                                                                                throws ApiErrorException,
                                                                                       ConnectionException

Throws:

ApiErrorException

ConnectionException

createOrUpdateCustomData

public java.util.Map<java.lang.String,java.lang.Object> createOrUpdateCustomData(Identifier campaignId,
                                                                                       java.util.Map<java.lang.String,java.lang.Object> model,
                                                                                       ApiOptions options)
                                                                                throws ApiErrorException,
                                                                                       ConnectionException

Throws:

ApiErrorException

ConnectionException

deleteCustomData

public void deleteCustomData(Identifier campaignId)
                      throws ApiErrorException,
                             ConnectionException

Throws:

ApiErrorException

ConnectionException

deleteCustomData

public void deleteCustomData(Identifier campaignId,
                             ApiOptions options)
                      throws ApiErrorException,
                             ConnectionException

Throws:

ApiErrorException

ConnectionException

getCustomData

public java.util.Map<java.lang.String,java.lang.Object> getCustomData(Identifier campaignId)
                                                                     throws ApiErrorException,
                                                                            ConnectionException

Throws:

ApiErrorException

ConnectionException

getCustomData

public java.util.Map<java.lang.String,java.lang.Object> getCustomData(Identifier campaignId,
                                                                            ApiOptions options)
                                                                     throws ApiErrorException,
                                                                            ConnectionException

Throws:

ApiErrorException

ConnectionException

createOrUpdateCustomDataForKey

public java.util.Map<java.lang.String,java.lang.Object> createOrUpdateCustomDataForKey(Identifier campaignId,
                                                                                             java.lang.String key,
                                                                                             java.util.Map<java.lang.String,java.lang.Object> model)
                                                                                      throws ApiErrorException,
                                                                                             ConnectionException

Throws:

ApiErrorException

ConnectionException

createOrUpdateCustomDataForKey

public java.util.Map<java.lang.String,java.lang.Object> createOrUpdateCustomDataForKey(Identifier campaignId,
                                                                                             java.lang.String key,
                                                                                             java.util.Map<java.lang.String,java.lang.Object> model,
                                                                                             ApiOptions options)
                                                                                      throws ApiErrorException,
                                                                                             ConnectionException

Throws:

ApiErrorException

ConnectionException

deleteCustomDataForKey

public void deleteCustomDataForKey(Identifier campaignId,
                                   java.lang.String key)
                            throws ApiErrorException,
                                   ConnectionException

Throws:

ApiErrorException

ConnectionException

deleteCustomDataForKey

public void deleteCustomDataForKey(Identifier campaignId,
                                   java.lang.String key,
                                   ApiOptions options)
                            throws ApiErrorException,
                                   ConnectionException

Throws:

ApiErrorException

ConnectionException

getCustomDataForKey

public java.util.Map<java.lang.String,java.lang.Object> getCustomDataForKey(Identifier campaignId,
                                                                                  java.lang.String key)
                                                                           throws ApiErrorException,
                                                                                  ConnectionException

Throws:

ApiErrorException

ConnectionException

getCustomDataForKey

public java.util.Map<java.lang.String,java.lang.Object> getCustomDataForKey(Identifier campaignId,
                                                                                  java.lang.String key,
                                                                                  ApiOptions options)
                                                                           throws ApiErrorException,
                                                                                  ConnectionException

Throws:

ApiErrorException

ConnectionException