Class: GrowsurfRuby::Models::ParticipantPayoutList::Payout

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/growsurf_ruby/models/participant_payout_list.rb

Defined Under Namespace

Modules: Status

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(id:, amount:, commission_ids:, created_at:, currency_iso:, participant_id:, status:, amount_in_campaign_currency: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, failed_at: nil, fx_error: nil, issued_at: nil, provider: nil) ⇒ Object

Parameters:

  • id (String)
  • amount (Integer)
  • commission_ids (Array<String>)
  • created_at (Integer)
  • currency_iso (String)
  • participant_id (String)
  • status (Symbol, GrowsurfRuby::Models::ParticipantPayoutList::Payout::Status)
  • amount_in_campaign_currency (Integer, nil) (defaults to: nil)
  • campaign_currency_iso (String, nil) (defaults to: nil)
  • exchange_rate (Float, nil) (defaults to: nil)
  • exchange_rate_at (Integer) (defaults to: nil)
  • failed_at (Integer) (defaults to: nil)
  • fx_error (String, nil) (defaults to: nil)
  • issued_at (Integer) (defaults to: nil)
  • provider (String, nil) (defaults to: nil) 


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 28

class Payout < GrowsurfRuby::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute amount
  #
  #   @return [Integer]
  required :amount, Integer

  # @!attribute commission_ids
  #
  #   @return [Array<String>]
  required :commission_ids, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :commissionIds

  # @!attribute created_at
  #
  #   @return [Integer]
  required :created_at, Integer, api_name: :createdAt

  # @!attribute currency_iso
  #
  #   @return [String]
  required :currency_iso, String, api_name: :currencyISO

  # @!attribute participant_id
  #
  #   @return [String]
  required :participant_id, String, api_name: :participantId

  # @!attribute status
  #
  #   @return [Symbol, GrowsurfRuby::Models::ParticipantPayoutList::Payout::Status]
  required :status, enum: -> { GrowsurfRuby::ParticipantPayoutList::Payout::Status }

  # @!attribute amount_in_campaign_currency
  #
  #   @return [Integer, nil]
  optional :amount_in_campaign_currency, Integer, api_name: :amountInCampaignCurrency, nil?: true

  # @!attribute campaign_currency_iso
  #
  #   @return [String, nil]
  optional :campaign_currency_iso, String, api_name: :campaignCurrencyISO, nil?: true

  # @!attribute exchange_rate
  #
  #   @return [Float, nil]
  optional :exchange_rate, Float, api_name: :exchangeRate, nil?: true

  # @!attribute exchange_rate_at
  #
  #   @return [Integer, nil]
  optional :exchange_rate_at, Integer, api_name: :exchangeRateAt

  # @!attribute failed_at
  #
  #   @return [Integer, nil]
  optional :failed_at, Integer, api_name: :failedAt

  # @!attribute fx_error
  #
  #   @return [String, nil]
  optional :fx_error, String, api_name: :fxError, nil?: true

  # @!attribute issued_at
  #
  #   @return [Integer, nil]
  optional :issued_at, Integer, api_name: :issuedAt

  # @!attribute provider
  #
  #   @return [String, nil]
  optional :provider, String, nil?: true

  # @!method initialize(id:, amount:, commission_ids:, created_at:, currency_iso:, participant_id:, status:, amount_in_campaign_currency: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, failed_at: nil, fx_error: nil, issued_at: nil, provider: nil)
  #   @param id [String]
  #   @param amount [Integer]
  #   @param commission_ids [Array<String>]
  #   @param created_at [Integer]
  #   @param currency_iso [String]
  #   @param participant_id [String]
  #   @param status [Symbol, GrowsurfRuby::Models::ParticipantPayoutList::Payout::Status]
  #   @param amount_in_campaign_currency [Integer, nil]
  #   @param campaign_currency_iso [String, nil]
  #   @param exchange_rate [Float, nil]
  #   @param exchange_rate_at [Integer]
  #   @param failed_at [Integer]
  #   @param fx_error [String, nil]
  #   @param issued_at [Integer]
  #   @param provider [String, nil]

  # @see GrowsurfRuby::Models::ParticipantPayoutList::Payout#status
  module Status
    extend GrowsurfRuby::Internal::Type::Enum

    UPCOMING = :UPCOMING
    QUEUED = :QUEUED
    ISSUED = :ISSUED
    FAILED = :FAILED

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#amount ⇒ Integer

Returns:

  • (Integer) 


37
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 37

required :amount, Integer

#amount_in_campaign_currency ⇒ Integer?

Returns:

  • (Integer, nil) 


67
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 67

optional :amount_in_campaign_currency, Integer, api_name: :amountInCampaignCurrency, nil?: true

#campaign_currency_iso ⇒ String?

Returns:

  • (String, nil) 


72
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 72

optional :campaign_currency_iso, String, api_name: :campaignCurrencyISO, nil?: true

#commission_ids ⇒ Array<String>

Returns:

  • (Array<String>) 


42
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 42

required :commission_ids, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :commissionIds

#created_at ⇒ Integer

Returns:

  • (Integer) 


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

required :created_at, Integer, api_name: :createdAt

#currency_iso ⇒ String

Returns:

  • (String) 


52
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 52

required :currency_iso, String, api_name: :currencyISO

#exchange_rate ⇒ Float?

Returns:

  • (Float, nil) 


77
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 77

optional :exchange_rate, Float, api_name: :exchangeRate, nil?: true

#exchange_rate_at ⇒ Integer?

Returns:

  • (Integer, nil) 


82
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 82

optional :exchange_rate_at, Integer, api_name: :exchangeRateAt

#failed_at ⇒ Integer?

Returns:

  • (Integer, nil) 


87
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 87

optional :failed_at, Integer, api_name: :failedAt

#fx_error ⇒ String?

Returns:

  • (String, nil) 


92
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 92

optional :fx_error, String, api_name: :fxError, nil?: true

#id ⇒ String

Returns:

  • (String) 


32
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 32

required :id, String

#issued_at ⇒ Integer?

Returns:

  • (Integer, nil) 


97
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 97

optional :issued_at, Integer, api_name: :issuedAt

#participant_id ⇒ String

Returns:

  • (String) 


57
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 57

required :participant_id, String, api_name: :participantId

#provider ⇒ String?

Returns:

  • (String, nil) 


102
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 102

optional :provider, String, nil?: true

#status ⇒ Symbol, GrowsurfRuby::Models::ParticipantPayoutList::Payout::Status

Returns:



62
 
# File 'lib/growsurf_ruby/models/participant_payout_list.rb', line 62

required :status, enum: -> { GrowsurfRuby::ParticipantPayoutList::Payout::Status }