#import <EventSpotService.h>

Inheritance diagram for EventSpotService:

Class Methods
(HttpResponse *)	+ getEventCollectionWithAccessToken:withALimitOf:

(HttpResponse *)	+ addEventWithToken:andEvent:

(HttpResponse *)	+ getEventWithAccessToken:withEventId:

(HttpResponse *)	+ updateEventWithAccesToken:withEventId:andEvent:

(HttpResponse *)	+ patchEventWithAccesToken:withEventId:action:

(HttpResponse *)	+ getEventFeesCollectionWithAccessToken:withEventId:

(HttpResponse *)	+ addEventFeeWithToken:withEventId:andEventFee:

(HttpResponse *)	+ getEventFeeWithAccessToken:withEventId:andFeeId:

(HttpResponse *)	+ updateEventFeeWithAccesToken:withEventId:feeId:andEventFee:

(BOOL)	+ deleteEventFeeWithAccesToken:withEventId:andFeeId:errors:

(HttpResponse *)	+ getPromocodeCollectionWithAccessToken:withEventId:

(HttpResponse *)	+ addPromocodeWithAccesToken:withEventId:andPromocode:

(HttpResponse *)	+ getPromocodeWithAccessToken:withEventId:andPromocodeId:

(HttpResponse *)	+ updatePromocodeWithAccessToken:withEventId:andPromocodeId:andPromocode:

(BOOL)	+ deletePromocodeWithAccessToken:withEventId:andPromocodeId:errors:

(HttpResponse *)	+ getEventRegistrantCollectionWithAccessToken:withEventId:withALimitOf:

(HttpResponse *)	+ getEventRegistrantWithAccessToken:withEventId:andRegistrantId:

(HttpResponse *)	+ getEventItemCollectionWithAccessToken:withEventId:

(HttpResponse *)	+ addEventItemWithAccesToken:withEventId:andItem:

(HttpResponse *)	+ getEventItemWithAccessToken:withEventId:andItemId:

(HttpResponse *)	+ updateEventItemWithAccessToken:withEventId:itemId:andItem:

(BOOL)	+ deleteEventItemWithAccessToken:withEventId:andItemId:errors:

(HttpResponse *)	+ getEventItemAttributeCollectionWithAccessToken:withEventId:andItemId:

(HttpResponse *)	+ addEventItemAttributeWithAccesToken:withEventId:itemId:andItemAttribute:

(HttpResponse *)	+ getEventItemAttributeWithAccessToken:withEventId:itemId:andAttributeId:

(HttpResponse *)	+ updateEventItemAttributeWithAccessToken:withEventId:itemId:attributeId:andAttribute:

(BOOL)	+ deleteEventItemAttributeWithAccessToken:withEventId:itemId:andAttributeId:errors:

Method Documentation

+ (HttpResponse *) addEventFeeWithToken:	(NSString *)	accessToken
withEventId:	(NSString *)	eventId
andEventFee:	(EventFee *)	eventFee

Create a new fee for the event specified using the eventId path parameter, and a event fee object.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event fee to which we will add the fee
EventFee	*eventFee - the event fee that needs to be added

Returns: HttpResponse * - response containing either errors or data with the specific EventSpot fee created,

+ (HttpResponse *) addEventItemAttributeWithAccesToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
itemId:	(NSString *)	itemId
andItemAttribute:	(EventItemAttribute *)	itemAttribute

Create a new attribute for an event item; specify the event and item using the eventId and itemId path parameters.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event that containes the items you want
NSString	*itemId - Unique ID of the item whos parameters you want to update
EventItemAttribute	*itemAttribute - the event item attribute object that you want to add

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Item Attribute object

+ (HttpResponse *) addEventItemWithAccesToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andItem:	(EventItem *)	item

Create a new item for an event specified using the eventId path parameter.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to post the item to
EventItem	*item - the item that will get added

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Item added

+ (HttpResponse *) addEventWithToken:	(NSString *)	accessToken
andEvent:	(EventExtended *)	event

A new EventSpot event using a event extended object

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
EventExtended	*event - the event that needs to be added

Returns: HttpResponse * - response containing either errors or data with the specific EventSpot created, data contains Event type item

+ (HttpResponse *) addPromocodeWithAccesToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andPromocode:	(EventPromocode *)	promocode

Create a promotional code for an existing event (specified using eventId). Promotional codes can be: -a percentage discount off a fee or set of fees -a fixed discount amount off a fee -a special promotional fee available by entering the promo code

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to post the promocode to
EventPromocode	*promocode - the promocode that will get added

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Promocode item created

+ (BOOL) deleteEventFeeWithAccesToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andFeeId:	(NSString *)	feeId
errors:	(NSArray __autoreleasing )	errors

Delete an existing fee (specified by feeId) for an event (specified by eventId). An event is required to have a minimum of 1 fee. You cannot delete a fee if it is the only fee for the event specified.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to retrieve
NSString	*feeId - Unique ID of the event fee to delete

Returns: BOOL - returns if the delete opperation was succesfull or not

+ (BOOL) deleteEventItemAttributeWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
itemId:	(NSString *)	itemId
andAttributeId:	(NSString *)	attributeId
errors:	(NSArray __autoreleasing )	errors

Delete an existing event item attribute. Use the eventId, itemId, and attributeId path parameters to specify the attribute to delete.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event that containes the desired item
NSString	*itemId - Unique ID of the item whos parameters you want to retrieve
NSString	*attributeId - The specific attribute object you want to delete

Returns: BOOL - returns weather the delete option was succesfull or not

+ (BOOL) deleteEventItemWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andItemId:	(NSString *)	itemId
errors:	(NSArray __autoreleasing )	errors

Delete an event item by using the eventId and itemId path parameters to specify the event and item.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event that contains the desired item
NSString	*itemId - Unique ID of the item to delete

Returns: BOOL - returns weather the delete option was succesfull or not

+ (BOOL) deletePromocodeWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andPromocodeId:	(NSString *)	promocodeId
errors:	(NSArray __autoreleasing )	errors

Delete an existing promocode specified using the promocodeId path parameter.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to which the promocode belongs to
NSString	*promocodeId - Unique ID of the promocode to delete

Returns: BOOL - returns if the delete opperation was succesfull or not

+ (HttpResponse *) getEventCollectionWithAccessToken:	(NSString*)	accessToken
withALimitOf:	(int)	limit

Retrieve a list of all events in the user's account.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
int	limit - (optional) the number of elements to be returned, default 50;

Returns: HttpResponse * - response containing data and errors (if there are some), Result set containing array of Event items

+ (HttpResponse *) getEventFeesCollectionWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId

Retrieve all fees for the event fee specified by the eventId path parameter

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event fee to retrieve

Returns: HttpResponse * - response containing data and errors (if there are some),data contains array of Event Fee items

+ (HttpResponse *) getEventFeeWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andFeeId:	(NSString *)	feeId

Retrieve a specific fee for an event, specified using the eventId and feeId path parameters.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to retrieve
NSString	*feeId - Unique ID of the event fee to retrieve

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Fee item

+ (HttpResponse *) getEventItemAttributeCollectionWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andItemId:	(NSString *)	itemId

Retrieve all attributes for an event item. Specify the event and item using the eventId and itemId path parameters.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event that containes the desired item
NSString	*itemId - Unique ID of the item whos parameters you want to retrieve

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Item Attribute array of objects

+ (HttpResponse *) getEventItemAttributeWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
itemId:	(NSString *)	itemId
andAttributeId:	(NSString *)	attributeId

Retrieve a specific event item attribute usimg the eventId, itemId, and attributeId path parameters to specify the attribute.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event that containes the desired item
NSString	*itemId - Unique ID of the item whos parameters you want to retrieve
NSString	*attributeId - The specific attribute object you want to retrieve

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Item Attribute object

+ (HttpResponse *) getEventItemCollectionWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId

Retrieve a list of all items for an event specified using the eventId path parameter.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event which will have it's items returned

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Item array

+ (HttpResponse *) getEventItemWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andItemId:	(NSString *)	itemId

Retrieve an event item by using the eventId and itemId path parameters to specify the event and item.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event that contains the desired item
NSString	*itemId - Unique ID of the item to retrieve

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Item object

+ (HttpResponse *) getEventRegistrantCollectionWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
withALimitOf:	(int)	limit

Retrieve a list of all registrants for the event specified using the event_id path parameter.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event from which all registrants are returned
int	limit - (optional) the number of elements to be returned, default 50;

Returns: HttpResponse * - response containing data and errors (if there are some), data contains EventRegistrant item array

+ (HttpResponse *) getEventRegistrantWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andRegistrantId:	(NSString *)	registrantId

Retrieve detailed information about a specific registrant (specified by registrantId) for an event (specified by eventId).

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event from which all registrants are returned
NSString	*registrantId - Unique ID of the registrant to retrieve

Returns: HttpResponse * - response containing data and errors (if there are some), data contains EventRegistrantExtended item

+ (HttpResponse *) getEventWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId

Retrieve an event specified by the eventId path parameter

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to retrieve

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Extended type item

+ (HttpResponse *) getPromocodeCollectionWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId

Retrieve all promocodes for an event specified by the eventId path parameter.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event which will have it's promocodes returned

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Promocode item array

+ (HttpResponse *) getPromocodeWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andPromocodeId:	(NSString *)	promocodeId

Retrieve a specific promotional code for an event; use the promocodeId and eventId path parameters to specify the code and event.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to which the promocode belongs to
NSString	*promocodeId - Unique ID of the promocode to retrieve

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Promocode item

+ (HttpResponse *) patchEventWithAccesToken:	(NSString *)	accessToken
withEventId:	(NSString *)	eventId
action:	(EventPatch *)	patch

The API uses the PATCH method to publish or cancel an event by only changing the value of the event's status property:

Publishing an event changes status from DRAFT to ACTIVE
Cancelling an event changes status from ACTIVE to CANCELLED

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to patch

Returns: HttpResponse * - response containing either errors or data with the updated EventSpot, data contains Event Extended type item

+ (HttpResponse *) updateEventFeeWithAccesToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
feeId:	(NSString *)	feeId
andEventFee:	(EventFee *)	eventFee

Update an existing fee (specify using feeId) for an event specified by eventId.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to retrieve
NSString	*feeId - Unique ID of the event fee to update
EventFee	*eventFee - the event fee that needs to be updated

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Fee item that was updated

+ (HttpResponse *) updateEventItemAttributeWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
itemId:	(NSString *)	itemId
attributeId:	(NSString *)	attributeId
andAttribute:	(EventItemAttribute *)	itemAttribute

Update an existing item attribute by specifying the eventId, itemId, and attributeId path parameters.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event that containes the desired item
NSString	*itemId - Unique ID of the item whos parameters you want to retrieve
NSString	*attributeId - The specific attribute object you want to retrieve
EventItemAttribute	*itemAttribute - the event item attribute object that you want to update to

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Item Attribute that was updated

+ (HttpResponse *) updateEventItemWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
itemId:	(NSString *)	itemId
andItem:	(EventItem *)	item

Update an existing event item; specify the event and the item using the eventId and itemId path parameters.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event that contains the desired item
NSString	*itemId - Unique ID of the item to retrieve
EventItem	*item - the item that will get updated

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Item that was updated

+ (HttpResponse *) updateEventWithAccesToken:	(NSString *)	accessToken
withEventId:	(NSString *)	eventId
andEvent:	(EventExtended *)	event

Update an existing event by using the eventId path parameter.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to update
EventExtended	*event - the event that needs to be updated

Returns: HttpResponse * - response containing either errors or data with the updated EventSpot, data contains Event type item

+ (HttpResponse *) updatePromocodeWithAccessToken:	(NSString*)	accessToken
withEventId:	(NSString *)	eventId
andPromocodeId:	(NSString *)	promocodeId
andPromocode:	(EventPromocode *)	promocode

Update an existing promocode for an event; specify the code and event using the eventId and promocodeId path parameters.

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*eventId - Unique ID of the event to which the promocode belongs to
NSString	*promocodeId - Unique ID of the promocode to update
EventPromocode	*promocode - the promocode that will be updated

Returns: HttpResponse * - response containing data and errors (if there are some), data contains Event Promocode item updated

The documentation for this class was generated from the following files:

/Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Services/EventSpotService.h
/Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Services/EventSpotService.m

Class Methods

Method Documentation