Class: GrowsurfRuby::Models::AffiliateInviteListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/growsurf_ruby/models/affiliate_invite_list_response.rb,
sig/growsurf_ruby/models/affiliate_invite_list_response.rbs

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign#list_affiliate_invites

Instance Attribute Summary collapse

Instance Method Summary collapse

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(invites:, total:, limit: nil, offset: nil) ⇒ Object

Parameters:

  • invites (Array<GrowsurfRuby::Models::AffiliateInvite>) —

    One page of the program's invites, newest first.

  • total (Integer) —

    Total number of invites matching the filter.

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

    The page size used.

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

    The offset this page started at.




# File 'lib/growsurf_ruby/models/affiliate_invite_list_response.rb', line 31

Instance Attribute Details

#invites ⇒ Array<GrowsurfRuby::Models::AffiliateInvite>

One page of the program's invites, newest first.

Parameters:

Returns:



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

required :invites, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::AffiliateInvite] }

#limit ⇒ Integer?

The page size used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :limit, Integer

#offset ⇒ Integer?

The offset this page started at.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :offset, Integer

#total ⇒ Integer

Total number of invites matching the filter.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :total, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


31
 
# File 'sig/growsurf_ruby/models/affiliate_invite_list_response.rbs', line 31

def to_hash: -> {