Class: HubSpotSDK::Models::Crm::SimplePublicObjectWithAssociations

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/crm/simple_public_object_with_associations.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:, archived:, created_at:, properties:, updated_at:, archived_at: nil, associations: nil, object_write_trace_id: nil, properties_with_history: nil, url: nil) ⇒ Object

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

Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.

Parameters:

  • id (String) —

    The unique ID of the object.

  • archived (Boolean) —

    Whether the object is archived.

  • created_at (Time) —

    The timestamp when the object was created, in ISO 8601 format.

  • properties (Hash{Symbol=>String, nil}) —

    Key value pairs representing the properties of the object.

  • updated_at (Time) —

    The timestamp when the object was last updated, in ISO 8601 format.

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

    The timestamp when the object was archived, in ISO 8601 format.

  • associations (Hash{Symbol=>HubSpotSDK::Models::Crm::CollectionResponseAssociatedID}) (defaults to: nil) —

    A list defining relationships with other objects.

  • object_write_trace_id (String) (defaults to: nil) —

    An identifier used for tracing the creation or update request of the object.

  • properties_with_history (Hash{Symbol=>Array<HubSpotSDK::Models::Crm::ValueWithTimestamp>}) (defaults to: nil) —

    Key-value pairs representing the properties of the object along with their histo

  • url (String) (defaults to: nil) —

    The URL on the API that provide direct navigation to the corresponding UI pages




# File 'lib/hubspot_sdk/models/crm/simple_public_object_with_associations.rb', line 74

Instance Attribute Details

#archived ⇒ Boolean

Whether the object is archived.

Returns:

  • (Boolean) 


17
 
# File 'lib/hubspot_sdk/models/crm/simple_public_object_with_associations.rb', line 17

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

#archived_at ⇒ Time?

The timestamp when the object was archived, in ISO 8601 format.

Returns:

  • (Time, nil) 


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

optional :archived_at, Time, api_name: :archivedAt

#associations ⇒ Hash{Symbol=>HubSpotSDK::Models::Crm::CollectionResponseAssociatedID}?

A list defining relationships with other objects.

Returns:



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

optional :associations,
-> { HubSpotSDK::Internal::Type::HashOf[HubSpotSDK::Crm::CollectionResponseAssociatedID] }

#created_at ⇒ Time

The timestamp when the object was created, in ISO 8601 format.

Returns:

  • (Time) 


23
 
# File 'lib/hubspot_sdk/models/crm/simple_public_object_with_associations.rb', line 23

required :created_at, Time, api_name: :createdAt

#id ⇒ String

The unique ID of the object.

Returns:

  • (String) 


11
 
# File 'lib/hubspot_sdk/models/crm/simple_public_object_with_associations.rb', line 11

required :id, String

#object_write_trace_id ⇒ String?

An identifier used for tracing the creation or update request of the object.

Returns:

  • (String, nil) 


54
 
# File 'lib/hubspot_sdk/models/crm/simple_public_object_with_associations.rb', line 54

optional :object_write_trace_id, String, api_name: :objectWriteTraceId

#properties ⇒ Hash{Symbol=>String, nil}

Key value pairs representing the properties of the object.

Returns:

  • (Hash{Symbol=>String, nil}) 


29
 
# File 'lib/hubspot_sdk/models/crm/simple_public_object_with_associations.rb', line 29

required :properties, HubSpotSDK::Internal::Type::HashOf[String, nil?: true]

#properties_with_history ⇒ Hash{Symbol=>Array<HubSpotSDK::Models::Crm::ValueWithTimestamp>}?

Key-value pairs representing the properties of the object along with their history.

Returns:



61
62
63
64
65
 
# File 'lib/hubspot_sdk/models/crm/simple_public_object_with_associations.rb', line 61

optional :properties_with_history,
-> {
  HubSpotSDK::Internal::Type::HashOf[HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::Crm::ValueWithTimestamp]]
},
api_name: :propertiesWithHistory

#updated_at ⇒ Time

The timestamp when the object was last updated, in ISO 8601 format.

Returns:

  • (Time) 


35
 
# File 'lib/hubspot_sdk/models/crm/simple_public_object_with_associations.rb', line 35

required :updated_at, Time, api_name: :updatedAt

#url ⇒ String?

The URL on the API that provide direct navigation to the corresponding UI pages for the connectors.

Returns:

  • (String, nil) 


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

optional :url, String