EventPromocode Class Reference

#import <EventPromocode.h>

Inheritance diagram for EventPromocode:

Instance Methods
(id)	- initWithDictionary:
(NSString *)	- JSON

Class Methods
(EventPromocode *)	+ promocodeWithDictionary:

Properties
NSString *	codeName
NSString *	codeType
double	discountAmount
int	discountPercentage
NSString *	discountScope
NSString *	discoutType
NSMutableArray *	feeIds
NSString *	promocodeId
BOOL	isPaused
int	quantityAvailable
int	quantityTotal
int	quantityUsed
NSString *	status
PromocodeDiscountScopeEnum *	promocodeDiscountScopeEnum
PromocodeDiscountTypeEnum *	promocodeDiscountTypeEnum
PromocodeCodeTypeEnum *	promocodeCodeTypeEnum
PromocodeStatusEnum *	promocodeStatusEnum

Method Documentation

- (id) initWithDictionary:

(NSDictionary *)

dictionary

Factory method to create a Event Promocode object from an dictionary

Parameters

NSDictionary

*dictionary - associative dictionary of initial properties to set

Returns

EventPromocode

- (NSString *) JSON

+ (EventPromocode *) promocodeWithDictionary:

(NSDictionary *)

dictionary

Property Documentation

- (NSString*) codeName

readwritenonatomicstrong

REQUIRED. Name of the promotional code visible to registrants, between 4 - 12 characters, cannot contain spaces or special character (_ is OK); each code_name must be unique

- (NSString*) codeType

readwritenonatomicstrong

REQUIRED. Type of promocode, valid values are found in PromocodeCodeTypeEnum

- (double) discountAmount

readwritenonatomicassign

Specifies a fixed discount amount, minimum of 0.01, is required when code_type = DISCOUNT, but not using discount_percent

- (int) discountPercentage

readwritenonatomicassign

Specifies a discount percentage, from 1% - 100%, is required when code_type = DISCOUNT, but not using discount_amount

- (NSString*) discountScope

readwritenonatomicstrong

Required when code_type = DISCOUNT; valid values in PromocodeDiscountScopeEnum class

- (NSString*) discoutType

readnonatomicstrong

Discount types; valid values in PromocodeDiscountTypeEnum class

- (NSMutableArray*) feeIds

readwritenonatomicstrong

Identifies the fees to which the promocode applies;

- (BOOL) isPaused

readwritenonatomicassign

REQUIRED. When set to true, promocode cannot be redeemed; when false, promocode can be redeemed; default = false.

- (PromocodeCodeTypeEnum*) promocodeCodeTypeEnum

readnonatomicstrong

Enumeration class that contains valid options for the code type element

- (PromocodeDiscountScopeEnum*) promocodeDiscountScopeEnum

readnonatomicstrong

Enumeration class that contains valid options for the discount scope element

- (PromocodeDiscountTypeEnum*) promocodeDiscountTypeEnum

readnonatomicstrong

Enumeration class that contains valid options for the discount type element

- (NSString*) promocodeId

readnonatomicstrong

Unique ID for the event promotional code

- (PromocodeStatusEnum*) promocodeStatusEnum

readnonatomicstrong

Enumeration class that contains valid options for the status element

- (int) quantityAvailable

readnonatomicassign

Number of promocodes available for redemption; -1 = unlimited

- (int) quantityTotal

readwritenonatomicassign

REQUIRED. Total number of promocodes available for redemption; -1 = unlimited.

- (int) quantityUsed

readnonatomicassign

Number of promocodes that have been redeemed; starts at 0

- (NSString*) status

readnonatomicstrong

Status of the promocode, valid values are found in PromocodeStatusEnum class

---

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

• /Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Components/EventSpot/EventPromocode.h
• /Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Components/EventSpot/EventPromocode.m