Class: HubSpotSDK::Models::Crm::ObjectSchema

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/crm/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

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

Parameters:

  • id (String) —

    A unique ID for this schema’s object type. Will be defined as meta-type-{uniqu

  • allows_sensitive_properties (Boolean)
  • archived (Boolean)
  • associations (Array<HubSpotSDK::Models::AssociationDefinition>) —

    Associations defined for a given object type.

  • fully_qualified_name (String) —

    An assigned unique ID for the object, including portal ID and object name.

  • labels (HubSpotSDK::Models::ObjectTypeDefinitionLabels)
  • name (String) —

    A unique name for the schema’s object type.

  • object_type_id (String)
  • properties (Array<HubSpotSDK::Models::Crm::Property>) —

    Properties defined for this object type.

  • required_properties (Array<String>) —

    The names of properties that should be required when creating an object of t

  • searchable_properties (Array<String>) —

    Names of properties that will be indexed for this object type in by HubSpot’s pr

  • secondary_display_properties (Array<String>) —

    The names of secondary properties for this object. These will be displayed as se

  • created_at (Time) (defaults to: nil) —

    When the object schema was created.

  • created_by_user_id (Integer) (defaults to: nil)
  • description (String) (defaults to: nil)
  • primary_display_property (String) (defaults to: nil) —

    The name of the primary property for this object. This will be displayed as prim

  • updated_at (Time) (defaults to: nil) —

    When the object schema was last updated.

  • updated_by_user_id (Integer) (defaults to: nil) 



# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 122

Instance Attribute Details

#allows_sensitive_properties ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 18

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

#archived ⇒ Boolean

Returns:

  • (Boolean) 


25
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 25

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

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

Associations defined for a given object type.

Returns:



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

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

#created_at ⇒ Time?

When the object schema was created.

Returns:

  • (Time, nil) 


92
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 92

optional :created_at, Time, api_name: :createdAt

#created_by_user_id ⇒ Integer?

Returns:

  • (Integer, nil) 


97
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 97

optional :created_by_user_id, Integer, api_name: :createdByUserId

#description ⇒ String?

Returns:

  • (String, nil) 


102
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 102

optional :description, String

#fully_qualified_name ⇒ String

An assigned unique ID for the object, including portal ID and object name.

Returns:

  • (String) 


37
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 37

required :fully_qualified_name, String, api_name: :fullyQualifiedName

#id ⇒ String

A unique ID for this schema’s object type. Will be defined as meta-type-ID.

Returns:

  • (String) 


13
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 13

required :id, String

#labels ⇒ HubSpotSDK::Models::ObjectTypeDefinitionLabels

Returns:



42
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 42

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

#name ⇒ String

A unique name for the schema’s object type.

Returns:

  • (String) 


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

required :name, String

#object_type_id ⇒ String

Returns:

  • (String) 


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

required :object_type_id, String, api_name: :objectTypeId

#primary_display_property ⇒ String?

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.

Returns:

  • (String, nil) 


109
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 109

optional :primary_display_property, String, api_name: :primaryDisplayProperty

#properties ⇒ Array<HubSpotSDK::Models::Crm::Property>

Properties defined for this object type.

Returns:



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

required :properties, -> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::Crm::Property] }

#required_properties ⇒ Array<String>

The names of properties that should be required when creating an object of this type.

Returns:

  • (Array<String>) 


66
67
68
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 66

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

#searchable_properties ⇒ Array<String>

Names of properties that will be indexed for this object type in by HubSpot’s product search.

Returns:

  • (Array<String>) 


75
76
77
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 75

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

#secondary_display_properties ⇒ Array<String>

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.

Returns:

  • (Array<String>) 


84
85
86
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 84

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

#updated_at ⇒ Time?

When the object schema was last updated.

Returns:

  • (Time, nil) 


115
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 115

optional :updated_at, Time, api_name: :updatedAt

#updated_by_user_id ⇒ Integer?

Returns:

  • (Integer, nil) 


120
 
# File 'lib/hubspot_sdk/models/crm/object_schema.rb', line 120

optional :updated_by_user_id, Integer, api_name: :updatedByUserId