Class: WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/accounts/preference_update_params.rb,
sig/whop_sdk/models/accounts/preference_update_params.rbs

Defined Under Namespace

Classes: Backup, Primary

Instance Attribute Summary collapse

Class Method 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(primary:, backup: nil) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods for more details.

How the account pays for Whop Ads spend. primary is charged first; backup covers the charge when the primary fails.

Parameters:



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
 
# File 'lib/whop_sdk/models/accounts/preference_update_params.rb', line 33

class AdsPaymentMethods < WhopSDK::Internal::Type::BaseModel
  # @!attribute primary
  #
  #   @return [WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary]
  required :primary, -> { WhopSDK::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary }

  # @!attribute backup
  #   Optional when the primary is `platform_balance`; omitting it removes any
  #   configured card. Required (as `platform_balance`) when the primary is `card`.
  #
  #   @return [WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup, nil]
  optional :backup, -> { WhopSDK::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup }

  # @!method initialize(primary:, backup: nil)
  #   Some parameter documentations has been truncated, see
  #   {WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods} for more
  #   details.
  #
  #   How the account pays for Whop Ads spend. `primary` is charged first; `backup`
  #   covers the charge when the primary fails.
  #
  #   @param primary [WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary]
  #
  #   @param backup [WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup] Optional when the primary is `platform_balance`; omitting it removes any configu

  # @see WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods#primary
  class Primary < WhopSDK::Internal::Type::BaseModel
    # @!attribute type
    #   The funding source kind.
    #
    #   @return [Symbol, WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary::Type]
    required :type, enum: -> { WhopSDK::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary::Type }

    # @!attribute id
    #   The funding source ID: a Whop balance (`ldgr_`) for `platform_balance`, or a
    #   payment method (`payt_`) for `card`. Optional for `platform_balance` — defaults
    #   to the account's default Whop balance. Required for `card`.
    #
    #   @return [String, nil]
    optional :id, String

    # @!method initialize(type:, id: nil)
    #   Some parameter documentations has been truncated, see
    #   {WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary}
    #   for more details.
    #
    #   @param type [Symbol, WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary::Type] The funding source kind.
    #
    #   @param id [String] The funding source ID: a Whop balance (`ldgr_`) for `platform_balance`, or a pay

    # The funding source kind.
    #
    # @see WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary#type
    module Type
      extend WhopSDK::Internal::Type::Enum

      PLATFORM_BALANCE = :platform_balance
      CARD = :card

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

  # @see WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods#backup
  class Backup < WhopSDK::Internal::Type::BaseModel
    # @!attribute type
    #   The funding source kind.
    #
    #   @return [Symbol, WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup::Type]
    required :type, enum: -> { WhopSDK::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup::Type }

    # @!attribute id
    #   The funding source ID: a Whop balance (`ldgr_`) for `platform_balance`, or a
    #   payment method (`payt_`) for `card`. Optional for `platform_balance` — defaults
    #   to the account's default Whop balance. Required for `card`.
    #
    #   @return [String, nil]
    optional :id, String

    # @!method initialize(type:, id: nil)
    #   Some parameter documentations has been truncated, see
    #   {WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup}
    #   for more details.
    #
    #   Optional when the primary is `platform_balance`; omitting it removes any
    #   configured card. Required (as `platform_balance`) when the primary is `card`.
    #
    #   @param type [Symbol, WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup::Type] The funding source kind.
    #
    #   @param id [String] The funding source ID: a Whop balance (`ldgr_`) for `platform_balance`, or a pay

    # The funding source kind.
    #
    # @see WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup#type
    module Type
      extend WhopSDK::Internal::Type::Enum

      PLATFORM_BALANCE = :platform_balance
      CARD = :card

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

Instance Attribute Details

#backup ⇒ WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup?

Optional when the primary is platform_balance; omitting it removes any configured card. Required (as platform_balance) when the primary is card.

Returns:



44
 
# File 'lib/whop_sdk/models/accounts/preference_update_params.rb', line 44

optional :backup, -> { WhopSDK::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Backup }

#primary ⇒ WhopSDK::Models::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary

Parameters:

  • value (WhopSDK::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary)

Returns:



37
 
# File 'lib/whop_sdk/models/accounts/preference_update_params.rb', line 37

required :primary, -> { WhopSDK::Accounts::PreferenceUpdateParams::AdsPaymentMethods::Primary }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/accounts/preference_update_params.rb', line 92

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


55
 
# File 'sig/whop_sdk/models/accounts/preference_update_params.rbs', line 55

def to_hash: -> {