Skip to content

Latest commit

 

History

History
429 lines (230 loc) · 13.1 KB

NewCampaign.md

File metadata and controls

429 lines (230 loc) · 13.1 KB

NewCampaign

Properties

Name Type Description Notes
Name Pointer to string A user-facing name for this campaign.
Description Pointer to string A detailed description of the campaign. [optional]
StartTime Pointer to time.Time Timestamp when the campaign will become active. [optional]
EndTime Pointer to time.Time Timestamp when the campaign will become inactive. [optional]
Attributes Pointer to map[string]interface{} Arbitrary properties associated with this campaign. [optional]
State Pointer to string A disabled or archived campaign is not evaluated for rules or coupons. [default to STATE_ENABLED]
ActiveRulesetId Pointer to int32 ID of Ruleset this campaign applies on customer session evaluation. [optional]
Tags Pointer to []string A list of tags for the campaign.
Features Pointer to []string The features enabled in this campaign.
CouponSettings Pointer to CodeGeneratorSettings [optional]
ReferralSettings Pointer to CodeGeneratorSettings [optional]
Limits Pointer to []LimitConfig The set of budget limits for this campaign.
CampaignGroups Pointer to []int32 The IDs of the campaign groups this campaign belongs to. [optional]
Type Pointer to string The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. [optional] [default to TYPE_ADVANCED]
LinkedStoreIds Pointer to []int32 A list of store IDs that you want to link to the campaign. Note: Campaigns with linked store IDs will only be evaluated when there is a customer session update that references a linked store. [optional]
EvaluationGroupId Pointer to int32 The ID of the campaign evaluation group the campaign belongs to. [optional]

Methods

GetName

func (o *NewCampaign) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *NewCampaign) GetNameOk() (string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasName

func (o *NewCampaign) HasName() bool

HasName returns a boolean if a field has been set.

SetName

func (o *NewCampaign) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

GetDescription

func (o *NewCampaign) GetDescription() string

GetDescription returns the Description field if non-nil, zero value otherwise.

GetDescriptionOk

func (o *NewCampaign) GetDescriptionOk() (string, bool)

GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasDescription

func (o *NewCampaign) HasDescription() bool

HasDescription returns a boolean if a field has been set.

SetDescription

func (o *NewCampaign) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

GetStartTime

func (o *NewCampaign) GetStartTime() time.Time

GetStartTime returns the StartTime field if non-nil, zero value otherwise.

GetStartTimeOk

func (o *NewCampaign) GetStartTimeOk() (time.Time, bool)

GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasStartTime

func (o *NewCampaign) HasStartTime() bool

HasStartTime returns a boolean if a field has been set.

SetStartTime

func (o *NewCampaign) SetStartTime(v time.Time)

SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field.

GetEndTime

func (o *NewCampaign) GetEndTime() time.Time

GetEndTime returns the EndTime field if non-nil, zero value otherwise.

GetEndTimeOk

func (o *NewCampaign) GetEndTimeOk() (time.Time, bool)

GetEndTimeOk returns a tuple with the EndTime field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasEndTime

func (o *NewCampaign) HasEndTime() bool

HasEndTime returns a boolean if a field has been set.

SetEndTime

func (o *NewCampaign) SetEndTime(v time.Time)

SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field.

GetAttributes

func (o *NewCampaign) GetAttributes() map[string]interface{}

GetAttributes returns the Attributes field if non-nil, zero value otherwise.

GetAttributesOk

func (o *NewCampaign) GetAttributesOk() (map[string]interface{}, bool)

GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasAttributes

func (o *NewCampaign) HasAttributes() bool

HasAttributes returns a boolean if a field has been set.

SetAttributes

func (o *NewCampaign) SetAttributes(v map[string]interface{})

SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field.

GetState

func (o *NewCampaign) GetState() string

GetState returns the State field if non-nil, zero value otherwise.

GetStateOk

func (o *NewCampaign) GetStateOk() (string, bool)

GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasState

func (o *NewCampaign) HasState() bool

HasState returns a boolean if a field has been set.

SetState

func (o *NewCampaign) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

GetActiveRulesetId

func (o *NewCampaign) GetActiveRulesetId() int32

GetActiveRulesetId returns the ActiveRulesetId field if non-nil, zero value otherwise.

GetActiveRulesetIdOk

func (o *NewCampaign) GetActiveRulesetIdOk() (int32, bool)

GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasActiveRulesetId

func (o *NewCampaign) HasActiveRulesetId() bool

HasActiveRulesetId returns a boolean if a field has been set.

SetActiveRulesetId

func (o *NewCampaign) SetActiveRulesetId(v int32)

SetActiveRulesetId gets a reference to the given int32 and assigns it to the ActiveRulesetId field.

GetTags

func (o *NewCampaign) GetTags() []string

GetTags returns the Tags field if non-nil, zero value otherwise.

GetTagsOk

func (o *NewCampaign) GetTagsOk() ([]string, bool)

GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasTags

func (o *NewCampaign) HasTags() bool

HasTags returns a boolean if a field has been set.

SetTags

func (o *NewCampaign) SetTags(v []string)

SetTags gets a reference to the given []string and assigns it to the Tags field.

GetFeatures

func (o *NewCampaign) GetFeatures() []string

GetFeatures returns the Features field if non-nil, zero value otherwise.

GetFeaturesOk

func (o *NewCampaign) GetFeaturesOk() ([]string, bool)

GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasFeatures

func (o *NewCampaign) HasFeatures() bool

HasFeatures returns a boolean if a field has been set.

SetFeatures

func (o *NewCampaign) SetFeatures(v []string)

SetFeatures gets a reference to the given []string and assigns it to the Features field.

GetCouponSettings

func (o *NewCampaign) GetCouponSettings() CodeGeneratorSettings

GetCouponSettings returns the CouponSettings field if non-nil, zero value otherwise.

GetCouponSettingsOk

func (o *NewCampaign) GetCouponSettingsOk() (CodeGeneratorSettings, bool)

GetCouponSettingsOk returns a tuple with the CouponSettings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasCouponSettings

func (o *NewCampaign) HasCouponSettings() bool

HasCouponSettings returns a boolean if a field has been set.

SetCouponSettings

func (o *NewCampaign) SetCouponSettings(v CodeGeneratorSettings)

SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field.

GetReferralSettings

func (o *NewCampaign) GetReferralSettings() CodeGeneratorSettings

GetReferralSettings returns the ReferralSettings field if non-nil, zero value otherwise.

GetReferralSettingsOk

func (o *NewCampaign) GetReferralSettingsOk() (CodeGeneratorSettings, bool)

GetReferralSettingsOk returns a tuple with the ReferralSettings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasReferralSettings

func (o *NewCampaign) HasReferralSettings() bool

HasReferralSettings returns a boolean if a field has been set.

SetReferralSettings

func (o *NewCampaign) SetReferralSettings(v CodeGeneratorSettings)

SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field.

GetLimits

func (o *NewCampaign) GetLimits() []LimitConfig

GetLimits returns the Limits field if non-nil, zero value otherwise.

GetLimitsOk

func (o *NewCampaign) GetLimitsOk() ([]LimitConfig, bool)

GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasLimits

func (o *NewCampaign) HasLimits() bool

HasLimits returns a boolean if a field has been set.

SetLimits

func (o *NewCampaign) SetLimits(v []LimitConfig)

SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field.

GetCampaignGroups

func (o *NewCampaign) GetCampaignGroups() []int32

GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise.

GetCampaignGroupsOk

func (o *NewCampaign) GetCampaignGroupsOk() ([]int32, bool)

GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasCampaignGroups

func (o *NewCampaign) HasCampaignGroups() bool

HasCampaignGroups returns a boolean if a field has been set.

SetCampaignGroups

func (o *NewCampaign) SetCampaignGroups(v []int32)

SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field.

GetType

func (o *NewCampaign) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *NewCampaign) GetTypeOk() (string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasType

func (o *NewCampaign) HasType() bool

HasType returns a boolean if a field has been set.

SetType

func (o *NewCampaign) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

GetLinkedStoreIds

func (o *NewCampaign) GetLinkedStoreIds() []int32

GetLinkedStoreIds returns the LinkedStoreIds field if non-nil, zero value otherwise.

GetLinkedStoreIdsOk

func (o *NewCampaign) GetLinkedStoreIdsOk() ([]int32, bool)

GetLinkedStoreIdsOk returns a tuple with the LinkedStoreIds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasLinkedStoreIds

func (o *NewCampaign) HasLinkedStoreIds() bool

HasLinkedStoreIds returns a boolean if a field has been set.

SetLinkedStoreIds

func (o *NewCampaign) SetLinkedStoreIds(v []int32)

SetLinkedStoreIds gets a reference to the given []int32 and assigns it to the LinkedStoreIds field.

GetEvaluationGroupId

func (o *NewCampaign) GetEvaluationGroupId() int32

GetEvaluationGroupId returns the EvaluationGroupId field if non-nil, zero value otherwise.

GetEvaluationGroupIdOk

func (o *NewCampaign) GetEvaluationGroupIdOk() (int32, bool)

GetEvaluationGroupIdOk returns a tuple with the EvaluationGroupId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasEvaluationGroupId

func (o *NewCampaign) HasEvaluationGroupId() bool

HasEvaluationGroupId returns a boolean if a field has been set.

SetEvaluationGroupId

func (o *NewCampaign) SetEvaluationGroupId(v int32)

SetEvaluationGroupId gets a reference to the given int32 and assigns it to the EvaluationGroupId field.

[Back to Model list] [Back to API list] [Back to README]