Class: WhopSDK::Models::ForumUpdateParams::BannerImage

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

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:) ⇒ BannerImage

The banner image displayed at the top of the forum page. Pass null to remove the existing banner.

Parameters:

  • id (String) —

    The ID of an existing file object.

  • id: (String) 


65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/whop_sdk/models/forum_update_params.rb', line 65

class BannerImage < WhopSDK::Internal::Type::BaseModel
  # @!attribute id
  #   The ID of an existing file object.
  #
  #   @return [String]
  required :id, String

  # @!method initialize(id:)
  #   The banner image displayed at the top of the forum page. Pass null to remove the
  #   existing banner.
  #
  #   @param id [String] The ID of an existing file object.
end

Instance Attribute Details

#id ⇒ String

The ID of an existing file object.

Parameters:

  • value (String)

Returns:

  • (String) 


70
 
# File 'lib/whop_sdk/models/forum_update_params.rb', line 70

required :id, String

Instance Method Details

#to_hash ⇒ { id: String }

Returns:

  • ({ id: String }) 


57
 
# File 'sig/whop_sdk/models/forum_update_params.rbs', line 57

def to_hash: -> { id: String }