Class: HubSpotSDK::Models::ObjectTypeDefinition

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/object_type_definition.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(id:, allows_sensitive_properties:, archived:, fully_qualified_name:, labels:, name:, object_type_id:, required_properties:, searchable_properties:, secondary_display_properties:, created_at: nil, description: nil, portal_id: nil, primary_display_property: nil, updated_at: nil) ⇒ Object

Parameters:

  • id (String)
  • allows_sensitive_properties (Boolean)
  • archived (Boolean)
  • fully_qualified_name (String)
  • labels (HubSpotSDK::Models::ObjectTypeDefinitionLabels)
  • name (String)
  • object_type_id (String)
  • required_properties (Array<String>)
  • searchable_properties (Array<String>)
  • secondary_display_properties (Array<String>)
  • created_at (Time) (defaults to: nil)
  • description (String) (defaults to: nil)
  • portal_id (Integer) (defaults to: nil)
  • primary_display_property (String) (defaults to: nil)
  • updated_at (Time) (defaults to: nil) 



# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 89

Instance Attribute Details

#allows_sensitive_properties ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#archived ⇒ Boolean

Returns:

  • (Boolean) 


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

required :archived, HubSpotSDK::Internal::Type::Boolean

#created_at ⇒ Time?

Returns:

  • (Time, nil) 


67
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 67

optional :created_at, Time, api_name: :createdAt

#description ⇒ String?

Returns:

  • (String, nil) 


72
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 72

optional :description, String

#fully_qualified_name ⇒ String

Returns:

  • (String) 


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

required :fully_qualified_name, String, api_name: :fullyQualifiedName

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#labels ⇒ HubSpotSDK::Models::ObjectTypeDefinitionLabels

Returns:



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

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

#name ⇒ String

Returns:

  • (String) 


36
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 36

required :name, String

#object_type_id ⇒ String

Returns:

  • (String) 


41
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 41

required :object_type_id, String, api_name: :objectTypeId

#portal_id ⇒ Integer?

Returns:

  • (Integer, nil) 


77
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 77

optional :portal_id, Integer, api_name: :portalId

#primary_display_property ⇒ String?

Returns:

  • (String, nil) 


82
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 82

optional :primary_display_property, String, api_name: :primaryDisplayProperty

#required_properties ⇒ Array<String>

Returns:

  • (Array<String>) 


46
47
48
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 46

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

#searchable_properties ⇒ Array<String>

Returns:

  • (Array<String>) 


53
54
55
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 53

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

#secondary_display_properties ⇒ Array<String>

Returns:

  • (Array<String>) 


60
61
62
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 60

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

#updated_at ⇒ Time?

Returns:

  • (Time, nil) 


87
 
# File 'lib/hubspot_sdk/models/object_type_definition.rb', line 87

optional :updated_at, Time, api_name: :updatedAt