Files
sdk/docs/MarketingEnrollment.md

7.7 KiB

MarketingEnrollment

Properties

Name Type Description Notes
Address Pointer to string Address is the normalized (lower-cased, trimmed) recipient. [optional]
Channel Pointer to string Channel is the delivery surface the steps go out on. [optional]
CurrentStep Pointer to int64 CurrentStep is the index of the step that sends next. [optional]
EnrolledAt Pointer to int64 EnrolledAt is unix seconds when the contact joined the walk, and orders the enrollment list (newest first). [optional]
Id Pointer to string ID is the server-assigned enrollment id ("enr_" + 128 random bits). [optional]
NextRunAt Pointer to int64 NextRunAt is the unix time the current step comes due; 0 once the walk has ended. It IS the schedule — durable in SQLite, so it survives restarts. [optional]
SequenceId Pointer to string SequenceID is the sequence being walked. [optional]
Status Pointer to string Status is active, completed or canceled. [optional]
UpdatedAt Pointer to int64 UpdatedAt is unix seconds of the last move: the drip engine writes it each time it advances the walk a step, completes it or cancels it. Together with Status it says when the walk last did anything, which is how a stalled enrollment is told from a finished one. [optional]

Methods

NewMarketingEnrollment

func NewMarketingEnrollment() *MarketingEnrollment

NewMarketingEnrollment instantiates a new MarketingEnrollment object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewMarketingEnrollmentWithDefaults

func NewMarketingEnrollmentWithDefaults() *MarketingEnrollment

NewMarketingEnrollmentWithDefaults instantiates a new MarketingEnrollment object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetAddress

func (o *MarketingEnrollment) GetAddress() string

GetAddress returns the Address field if non-nil, zero value otherwise.

GetAddressOk

func (o *MarketingEnrollment) GetAddressOk() (*string, bool)

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

SetAddress

func (o *MarketingEnrollment) SetAddress(v string)

SetAddress sets Address field to given value.

HasAddress

func (o *MarketingEnrollment) HasAddress() bool

HasAddress returns a boolean if a field has been set.

GetChannel

func (o *MarketingEnrollment) GetChannel() string

GetChannel returns the Channel field if non-nil, zero value otherwise.

GetChannelOk

func (o *MarketingEnrollment) GetChannelOk() (*string, bool)

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

SetChannel

func (o *MarketingEnrollment) SetChannel(v string)

SetChannel sets Channel field to given value.

HasChannel

func (o *MarketingEnrollment) HasChannel() bool

HasChannel returns a boolean if a field has been set.

GetCurrentStep

func (o *MarketingEnrollment) GetCurrentStep() int64

GetCurrentStep returns the CurrentStep field if non-nil, zero value otherwise.

GetCurrentStepOk

func (o *MarketingEnrollment) GetCurrentStepOk() (*int64, bool)

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

SetCurrentStep

func (o *MarketingEnrollment) SetCurrentStep(v int64)

SetCurrentStep sets CurrentStep field to given value.

HasCurrentStep

func (o *MarketingEnrollment) HasCurrentStep() bool

HasCurrentStep returns a boolean if a field has been set.

GetEnrolledAt

func (o *MarketingEnrollment) GetEnrolledAt() int64

GetEnrolledAt returns the EnrolledAt field if non-nil, zero value otherwise.

GetEnrolledAtOk

func (o *MarketingEnrollment) GetEnrolledAtOk() (*int64, bool)

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

SetEnrolledAt

func (o *MarketingEnrollment) SetEnrolledAt(v int64)

SetEnrolledAt sets EnrolledAt field to given value.

HasEnrolledAt

func (o *MarketingEnrollment) HasEnrolledAt() bool

HasEnrolledAt returns a boolean if a field has been set.

GetId

func (o *MarketingEnrollment) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *MarketingEnrollment) GetIdOk() (*string, bool)

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

SetId

func (o *MarketingEnrollment) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *MarketingEnrollment) HasId() bool

HasId returns a boolean if a field has been set.

GetNextRunAt

func (o *MarketingEnrollment) GetNextRunAt() int64

GetNextRunAt returns the NextRunAt field if non-nil, zero value otherwise.

GetNextRunAtOk

func (o *MarketingEnrollment) GetNextRunAtOk() (*int64, bool)

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

SetNextRunAt

func (o *MarketingEnrollment) SetNextRunAt(v int64)

SetNextRunAt sets NextRunAt field to given value.

HasNextRunAt

func (o *MarketingEnrollment) HasNextRunAt() bool

HasNextRunAt returns a boolean if a field has been set.

GetSequenceId

func (o *MarketingEnrollment) GetSequenceId() string

GetSequenceId returns the SequenceId field if non-nil, zero value otherwise.

GetSequenceIdOk

func (o *MarketingEnrollment) GetSequenceIdOk() (*string, bool)

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

SetSequenceId

func (o *MarketingEnrollment) SetSequenceId(v string)

SetSequenceId sets SequenceId field to given value.

HasSequenceId

func (o *MarketingEnrollment) HasSequenceId() bool

HasSequenceId returns a boolean if a field has been set.

GetStatus

func (o *MarketingEnrollment) GetStatus() string

GetStatus returns the Status field if non-nil, zero value otherwise.

GetStatusOk

func (o *MarketingEnrollment) GetStatusOk() (*string, bool)

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

SetStatus

func (o *MarketingEnrollment) SetStatus(v string)

SetStatus sets Status field to given value.

HasStatus

func (o *MarketingEnrollment) HasStatus() bool

HasStatus returns a boolean if a field has been set.

GetUpdatedAt

func (o *MarketingEnrollment) GetUpdatedAt() int64

GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.

GetUpdatedAtOk

func (o *MarketingEnrollment) GetUpdatedAtOk() (*int64, bool)

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

SetUpdatedAt

func (o *MarketingEnrollment) SetUpdatedAt(v int64)

SetUpdatedAt sets UpdatedAt field to given value.

HasUpdatedAt

func (o *MarketingEnrollment) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

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