Class: GrowsurfRuby::Models::ParticipantCommissionList::Commission

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/growsurf_ruby/models/participant_commission_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:, created_at:, currency_iso:, referred_id:, referrer_id:, sale_amount:, status:, amount_in_campaign_currency: nil, approved_at: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, fx_error: nil, hold_duration: nil, paid_at: nil, payout_queued_at: nil, provider: nil, reversed_at: nil, sale_amount_amount_in_campaign_currency: nil) ⇒ Object

Parameters:

  • id (String)
  • amount (Integer)
  • created_at (Integer)
  • currency_iso (String)
  • referred_id (String)
  • referrer_id (String)
  • sale_amount (Integer)
  • status (Symbol, GrowsurfRuby::Models::ParticipantCommissionList::Commission::Status)
  • amount_in_campaign_currency (Integer, nil) (defaults to: nil)
  • approved_at (Integer) (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)
  • fx_error (String, nil) (defaults to: nil)
  • hold_duration (Integer, nil) (defaults to: nil)
  • paid_at (Integer) (defaults to: nil)
  • payout_queued_at (Integer) (defaults to: nil)
  • provider (String, nil) (defaults to: nil)
  • reversed_at (Integer) (defaults to: nil)
  • sale_amount_amount_in_campaign_currency (Integer, 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/growsurf_ruby/models/participant_commission_list.rb', line 28

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

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

  # @!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 referred_id
  #
  #   @return [String]
  required :referred_id, String, api_name: :referredId

  # @!attribute referrer_id
  #
  #   @return [String]
  required :referrer_id, String, api_name: :referrerId

  # @!attribute sale_amount
  #
  #   @return [Integer]
  required :sale_amount, Integer, api_name: :saleAmount

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

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

  # @!attribute approved_at
  #
  #   @return [Integer, nil]
  optional :approved_at, Integer, api_name: :approvedAt

  # @!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 fx_error
  #
  #   @return [String, nil]
  optional :fx_error, String, api_name: :fxError, nil?: true

  # @!attribute hold_duration
  #
  #   @return [Integer, nil]
  optional :hold_duration, Integer, api_name: :holdDuration, nil?: true

  # @!attribute paid_at
  #
  #   @return [Integer, nil]
  optional :paid_at, Integer, api_name: :paidAt

  # @!attribute payout_queued_at
  #
  #   @return [Integer, nil]
  optional :payout_queued_at, Integer, api_name: :payoutQueuedAt

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

  # @!attribute reversed_at
  #
  #   @return [Integer, nil]
  optional :reversed_at, Integer, api_name: :reversedAt

  # @!attribute sale_amount_amount_in_campaign_currency
  #
  #   @return [Integer, nil]
  optional :sale_amount_amount_in_campaign_currency,
           Integer,
           api_name: :saleAmountAmountInCampaignCurrency,
           nil?: true

  # @!method initialize(id:, amount:, created_at:, currency_iso:, referred_id:, referrer_id:, sale_amount:, status:, amount_in_campaign_currency: nil, approved_at: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, fx_error: nil, hold_duration: nil, paid_at: nil, payout_queued_at: nil, provider: nil, reversed_at: nil, sale_amount_amount_in_campaign_currency: nil)
  #   @param id [String]
  #   @param amount [Integer]
  #   @param created_at [Integer]
  #   @param currency_iso [String]
  #   @param referred_id [String]
  #   @param referrer_id [String]
  #   @param sale_amount [Integer]
  #   @param status [Symbol, GrowsurfRuby::Models::ParticipantCommissionList::Commission::Status]
  #   @param amount_in_campaign_currency [Integer, nil]
  #   @param approved_at [Integer]
  #   @param campaign_currency_iso [String, nil]
  #   @param exchange_rate [Float, nil]
  #   @param exchange_rate_at [Integer]
  #   @param fx_error [String, nil]
  #   @param hold_duration [Integer, nil]
  #   @param paid_at [Integer]
  #   @param payout_queued_at [Integer]
  #   @param provider [String, nil]
  #   @param reversed_at [Integer]
  #   @param sale_amount_amount_in_campaign_currency [Integer, nil]

  # @see GrowsurfRuby::Models::ParticipantCommissionList::Commission#status
  module Status
    extend GrowsurfRuby::Internal::Type::Enum

    PENDING = :PENDING
    APPROVED = :APPROVED
    PAID = :PAID
    REVERSED = :REVERSED
    DELETED = :DELETED

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

Instance Attribute Details

#amount ⇒ Integer

Returns:

  • (Integer) 


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

required :amount, Integer

#amount_in_campaign_currency ⇒ Integer?

Returns:

  • (Integer, nil) 


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

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

#approved_at ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :approved_at, Integer, api_name: :approvedAt

#campaign_currency_iso ⇒ String?

Returns:

  • (String, nil) 


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

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

#created_at ⇒ Integer

Returns:

  • (Integer) 


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

required :created_at, Integer, api_name: :createdAt

#currency_iso ⇒ String

Returns:

  • (String) 


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

required :currency_iso, String, api_name: :currencyISO

#exchange_rate ⇒ Float?

Returns:

  • (Float, nil) 


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

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

#exchange_rate_at ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :exchange_rate_at, Integer, api_name: :exchangeRateAt

#fx_error ⇒ String?

Returns:

  • (String, nil) 


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

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

#hold_duration ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :hold_duration, Integer, api_name: :holdDuration, nil?: true

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

Returns:

  • (Integer, nil) 


107
 
# File 'lib/growsurf_ruby/models/participant_commission_list.rb', line 107

optional :paid_at, Integer, api_name: :paidAt

#payout_queued_at ⇒ Integer?

Returns:

  • (Integer, nil) 


112
 
# File 'lib/growsurf_ruby/models/participant_commission_list.rb', line 112

optional :payout_queued_at, Integer, api_name: :payoutQueuedAt

#provider ⇒ String?

Returns:

  • (String, nil) 


117
 
# File 'lib/growsurf_ruby/models/participant_commission_list.rb', line 117

optional :provider, String, nil?: true

#referred_id ⇒ String

Returns:

  • (String) 


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

required :referred_id, String, api_name: :referredId

#referrer_id ⇒ String

Returns:

  • (String) 


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

required :referrer_id, String, api_name: :referrerId

#reversed_at ⇒ Integer?

Returns:

  • (Integer, nil) 


122
 
# File 'lib/growsurf_ruby/models/participant_commission_list.rb', line 122

optional :reversed_at, Integer, api_name: :reversedAt

#sale_amount ⇒ Integer

Returns:

  • (Integer) 


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

required :sale_amount, Integer, api_name: :saleAmount

#sale_amount_amount_in_campaign_currency ⇒ Integer?

Returns:

  • (Integer, nil) 


127
128
129
130
 
# File 'lib/growsurf_ruby/models/participant_commission_list.rb', line 127

optional :sale_amount_amount_in_campaign_currency,
Integer,
api_name: :saleAmountAmountInCampaignCurrency,
nil?: true

#status ⇒ Symbol, GrowsurfRuby::Models::ParticipantCommissionList::Commission::Status

Returns:



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

required :status, enum: -> { GrowsurfRuby::ParticipantCommissionList::Commission::Status }