Class: GrowsurfRuby::Models::AffiliateInvite

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• GrowsurfRuby::Models::AffiliateInvite

Defined in:

lib/growsurf_ruby/models/affiliate_invite.rb,
sig/growsurf_ruby/models/affiliate_invite.rbs

Overview

See Also:

• GrowsurfRuby::Resources::Campaign#create_affiliate_invite

Defined Under Namespace

Modules: Status

Instance Attribute Summary

• #accepted_at ⇒ Integer^?

  When the invite was accepted, in Unix milliseconds.

• #created_at ⇒ Integer^?

  When the invite was created, in Unix milliseconds.

• #email ⇒ String^?

  Invitee email address.

• #expires_at ⇒ Integer^?

  When the emailed accept link stops working, in Unix milliseconds.

• #first_name ⇒ String^?

  Invitee first name, when provided.

• #id ⇒ String^?

  Invite ID.

• #last_name ⇒ String^?

  Invitee last name, when provided.

• #last_sent_at ⇒ Integer^?

  When the invite email was last sent, in Unix milliseconds.

• #revoked_at ⇒ Integer^?

  When the invite was revoked, in Unix milliseconds.

• #status ⇒ Symbol, ...

  The invite's lifecycle state.

Instance Method Summary

• #initialize(accepted_at: nil, created_at: nil, email: nil, expires_at: nil, first_name: nil, id: nil, last_name: nil, last_sent_at: nil, revoked_at: nil, status: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see AffiliateInvite for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(accepted_at: nil, created_at: nil, email: nil, expires_at: nil, first_name: nil, id: nil, last_name: nil, last_sent_at: nil, revoked_at: nil, status: nil) ⇒ Object

Some parameter documentations has been truncated, see GrowsurfRuby::Models::AffiliateInvite for more details.

Parameters:

• accepted_at (Integer, nil) (defaults to: nil) —

  When the invite was accepted, in Unix milliseconds. null until accepted.

• created_at (Integer) (defaults to: nil) —

  When the invite was created, in Unix milliseconds.

• email (String) (defaults to: nil) —

  Invitee email address.

• expires_at (Integer) (defaults to: nil) —

  When the emailed accept link stops working, in Unix milliseconds.

• first_name (String, nil) (defaults to: nil) —

  Invitee first name, when provided.

• id (String) (defaults to: nil) —

  Invite ID.

• last_name (String, nil) (defaults to: nil) —

  Invitee last name, when provided.

• last_sent_at (Integer) (defaults to: nil) —

  When the invite email was last sent, in Unix milliseconds.

• revoked_at (Integer, nil) (defaults to: nil) —

  When the invite was revoked, in Unix milliseconds. null unless revoked.

• status (Symbol, GrowsurfRuby::Models::AffiliateInvite::Status) (defaults to: nil) —

  The invite's lifecycle state. Accepting a pending invite enrolls the invitee as

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 68

Instance Attribute Details

#accepted_at ⇒ Integer^?

When the invite was accepted, in Unix milliseconds. null until accepted.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 11

optional :accepted_at, Integer, api_name: :acceptedAt, nil?: true

#created_at ⇒ Integer^?

When the invite was created, in Unix milliseconds.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 17

optional :created_at, Integer, api_name: :createdAt

#email ⇒ String^?

Invitee email address.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 23

optional :email, String

#expires_at ⇒ Integer^?

When the emailed accept link stops working, in Unix milliseconds.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 29

optional :expires_at, Integer, api_name: :expiresAt

#first_name ⇒ String^?

Invitee first name, when provided.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 35

optional :first_name, String, api_name: :firstName, nil?: true

#id ⇒ String^?

Invite ID.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 41

optional :id, String

#last_name ⇒ String^?

Invitee last name, when provided.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 47

optional :last_name, String, api_name: :lastName, nil?: true

#last_sent_at ⇒ Integer^?

When the invite email was last sent, in Unix milliseconds.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 53

optional :last_sent_at, Integer, api_name: :lastSentAt

#revoked_at ⇒ Integer^?

When the invite was revoked, in Unix milliseconds. null unless revoked.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 59

optional :revoked_at, Integer, api_name: :revokedAt, nil?: true

#status ⇒ Symbol, ...

The invite's lifecycle state. Accepting a pending invite enrolls the invitee as an approved affiliate.

Returns:

• (Symbol, GrowsurfRuby::Models::AffiliateInvite::Status, nil)

# File 'lib/growsurf_ruby/models/affiliate_invite.rb', line 66

optional :status, enum: -> { GrowsurfRuby::AffiliateInvite::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/growsurf_ruby/models/affiliate_invite.rbs', line 65

def to_hash: -> {