Class: HubSpotSDK::Models::Crm::FlagResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/crm/flag_response.rb

Overview

See Also:

Defined Under Namespace

Modules: DefaultState, OverrideState

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(app_id:, default_state:, flag_name:, override_state: nil) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Crm::FlagResponse for more details.

Parameters:




# File 'lib/hubspot_sdk/models/crm/flag_response.rb', line 39

Instance Attribute Details

#app_id ⇒ Integer

The ID of the app

Returns:

  • (Integer) 


12
 
# File 'lib/hubspot_sdk/models/crm/flag_response.rb', line 12

required :app_id, Integer, api_name: :appId

#default_state ⇒ Symbol, HubSpotSDK::Models::Crm::FlagResponse::DefaultState

The flag state for any portal that doesn’t have an override value

Returns:



18
19
20
21
22
 
# File 'lib/hubspot_sdk/models/crm/flag_response.rb', line 18

required :default_state,
enum: -> {
  HubSpotSDK::Crm::FlagResponse::DefaultState
},
api_name: :defaultState

#flag_name ⇒ String

The name of the flag

Returns:

  • (String) 


28
 
# File 'lib/hubspot_sdk/models/crm/flag_response.rb', line 28

required :flag_name, String, api_name: :flagName

#override_state ⇒ Symbol, ...

An optional flag value that overrides all others for this flag name and app, including portal-level values

Returns:



35
36
37
 
# File 'lib/hubspot_sdk/models/crm/flag_response.rb', line 35

optional :override_state,
enum: -> { HubSpotSDK::Crm::FlagResponse::OverrideState },
api_name: :overrideState

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/hubspot_sdk/models/crm/flag_response.rb', line 61