Class: HubSpotSDK::Models::ObjectTypeDefinitionPatch

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

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(clear_description:, allows_sensitive_properties: nil, description: nil, labels: nil, primary_display_property: nil, required_properties: nil, restorable: nil, searchable_properties: nil, secondary_display_properties: nil) ⇒ Object

Parameters:

  • clear_description (Boolean)
  • allows_sensitive_properties (Boolean) (defaults to: nil)
  • description (String) (defaults to: nil)
  • labels (HubSpotSDK::Models::ObjectTypeDefinitionLabels) (defaults to: nil)
  • primary_display_property (String) (defaults to: nil)
  • required_properties (Array<String>) (defaults to: nil)
  • restorable (Boolean) (defaults to: nil)
  • searchable_properties (Array<String>) (defaults to: nil)
  • secondary_display_properties (Array<String>) (defaults to: nil)


# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 59

Instance Attribute Details

#allows_sensitive_propertiesBoolean?

Returns:

  • (Boolean, nil)


14
15
16
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 14

optional :allows_sensitive_properties,
HubSpotSDK::Internal::Type::Boolean,
api_name: :allowsSensitiveProperties

#clear_descriptionBoolean

Returns:

  • (Boolean)


9
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 9

required :clear_description, HubSpotSDK::Internal::Type::Boolean, api_name: :clearDescription

#descriptionString?

Returns:

  • (String, nil)


21
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 21

optional :description, String

#labelsHubSpotSDK::Models::ObjectTypeDefinitionLabels?



26
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 26

optional :labels, -> { HubSpotSDK::ObjectTypeDefinitionLabels }

#primary_display_propertyString?

Returns:

  • (String, nil)


31
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 31

optional :primary_display_property, String, api_name: :primaryDisplayProperty

#required_propertiesArray<String>?

Returns:

  • (Array<String>, nil)


36
37
38
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 36

optional :required_properties,
HubSpotSDK::Internal::Type::ArrayOf[String],
api_name: :requiredProperties

#restorableBoolean?

Returns:

  • (Boolean, nil)


43
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 43

optional :restorable, HubSpotSDK::Internal::Type::Boolean

#searchable_propertiesArray<String>?

Returns:

  • (Array<String>, nil)


48
49
50
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 48

optional :searchable_properties,
HubSpotSDK::Internal::Type::ArrayOf[String],
api_name: :searchableProperties

#secondary_display_propertiesArray<String>?

Returns:

  • (Array<String>, nil)


55
56
57
# File 'lib/hubspot_sdk/models/object_type_definition_patch.rb', line 55

optional :secondary_display_properties,
HubSpotSDK::Internal::Type::ArrayOf[String],
api_name: :secondaryDisplayProperties