Class: HubSpotSDK::Models::Cms::ObjectSchema

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

Overview

See Also:

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:, associations:, fully_qualified_name:, labels:, name:, object_type_id:, properties:, required_properties:, searchable_properties:, secondary_display_properties:, created_at: nil, created_by_user_id: nil, description: nil, primary_display_property: nil, updated_at: nil, updated_by_user_id: nil) ⇒ Object

Parameters:

  • id (String)
  • allows_sensitive_properties (Boolean)
  • archived (Boolean)
  • associations (Array<HubSpotSDK::Models::AssociationDefinition>)
  • fully_qualified_name (String)
  • labels (HubSpotSDK::Models::ObjectTypeDefinitionLabels)
  • name (String)
  • object_type_id (String)
  • properties (Array<HubSpotSDK::Models::Cms::Property1>)
  • required_properties (Array<String>)
  • searchable_properties (Array<String>)
  • secondary_display_properties (Array<String>)
  • created_at (Time) (defaults to: nil)
  • created_by_user_id (Integer) (defaults to: nil)
  • description (String) (defaults to: nil)
  • primary_display_property (String) (defaults to: nil)
  • updated_at (Time) (defaults to: nil)
  • updated_by_user_id (Integer) (defaults to: nil) 



# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 106

Instance Attribute Details

#allows_sensitive_properties ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 16

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

#archived ⇒ Boolean

Returns:

  • (Boolean) 


23
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 23

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

#associations ⇒ Array<HubSpotSDK::Models::AssociationDefinition>

Returns:



28
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 28

required :associations, -> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::AssociationDefinition] }

#created_at ⇒ Time?

Returns:

  • (Time, nil) 


79
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 79

optional :created_at, Time, api_name: :createdAt

#created_by_user_id ⇒ Integer?

Returns:

  • (Integer, nil) 


84
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 84

optional :created_by_user_id, Integer, api_name: :createdByUserId

#description ⇒ String?

Returns:

  • (String, nil) 


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

optional :description, String

#fully_qualified_name ⇒ String

Returns:

  • (String) 


33
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 33

required :fully_qualified_name, String, api_name: :fullyQualifiedName

#id ⇒ String

Returns:

  • (String) 


11
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 11

required :id, String

#labels ⇒ HubSpotSDK::Models::ObjectTypeDefinitionLabels

Returns:



38
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 38

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

#name ⇒ String

Returns:

  • (String) 


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

required :name, String

#object_type_id ⇒ String

Returns:

  • (String) 


48
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 48

required :object_type_id, String, api_name: :objectTypeId

#primary_display_property ⇒ String?

Returns:

  • (String, nil) 


94
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 94

optional :primary_display_property, String, api_name: :primaryDisplayProperty

#properties ⇒ Array<HubSpotSDK::Models::Cms::Property1>

Returns:



53
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 53

required :properties, -> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::Cms::Property1] }

#required_properties ⇒ Array<String>

Returns:

  • (Array<String>) 


58
59
60
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 58

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

#searchable_properties ⇒ Array<String>

Returns:

  • (Array<String>) 


65
66
67
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 65

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

#secondary_display_properties ⇒ Array<String>

Returns:

  • (Array<String>) 


72
73
74
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 72

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

#updated_at ⇒ Time?

Returns:

  • (Time, nil) 


99
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 99

optional :updated_at, Time, api_name: :updatedAt

#updated_by_user_id ⇒ Integer?

Returns:

  • (Integer, nil) 


104
 
# File 'lib/hubspot_sdk/models/cms/object_schema.rb', line 104

optional :updated_by_user_id, Integer, api_name: :updatedByUserId