Class: HubSpotSDK::Models::Cms::InboundDBObjectType

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

Defined Under Namespace

Modules: MetaType, PermissioningType, Status, Visibility

Instance Attribute Summary collapse

Class Method 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:, create_date_property_name:, default_search_property_names:, deleted:, fully_qualified_name:, has_custom_properties:, has_default_properties:, has_external_object_ids:, has_owners:, has_pipelines:, indexed_for_filters_and_reports:, last_modified_property_name:, meta_type:, meta_type_id:, name:, object_type_id:, permissioning_type:, pipeline_property_name:, pipeline_stage_property_name:, required_properties:, restorable:, scope_mappings:, secondary_display_label_property_names:, access_scope_name: nil, created_at: nil, description: nil, integration_app_id: nil, janus_group: nil, owner_portal_id: nil, pipeline_close_date_property_name: nil, pipeline_time_to_close_property_name: nil, plural_form: nil, primary_display_label_property_name: nil, read_scope_name: nil, singular_form: nil, status: nil, visibility: nil, write_scope_name: nil) ⇒ Object

Parameters:

  • id (Integer)
  • allows_sensitive_properties (Boolean)
  • create_date_property_name (String)
  • default_search_property_names (Array<String>)
  • deleted (Boolean)
  • fully_qualified_name (String)
  • has_custom_properties (Boolean)
  • has_default_properties (Boolean)
  • has_external_object_ids (Boolean)
  • has_owners (Boolean)
  • has_pipelines (Boolean)
  • indexed_for_filters_and_reports (Boolean)
  • last_modified_property_name (String)
  • meta_type (Symbol, HubSpotSDK::Models::Cms::InboundDBObjectType::MetaType)
  • meta_type_id (Integer)
  • name (String)
  • object_type_id (String)
  • permissioning_type (Symbol, HubSpotSDK::Models::Cms::InboundDBObjectType::PermissioningType)
  • pipeline_property_name (String)
  • pipeline_stage_property_name (String)
  • required_properties (Array<String>)
  • restorable (Boolean)
  • scope_mappings (Array<HubSpotSDK::Models::Cms::ScopeMapping>)
  • secondary_display_label_property_names (Array<String>)
  • access_scope_name (String) (defaults to: nil)
  • created_at (Integer) (defaults to: nil)
  • description (String) (defaults to: nil)
  • integration_app_id (Integer) (defaults to: nil)
  • janus_group (String) (defaults to: nil)
  • owner_portal_id (Integer) (defaults to: nil)
  • pipeline_close_date_property_name (String) (defaults to: nil)
  • pipeline_time_to_close_property_name (String) (defaults to: nil)
  • plural_form (String) (defaults to: nil)
  • primary_display_label_property_name (String) (defaults to: nil)
  • read_scope_name (String) (defaults to: nil)
  • singular_form (String) (defaults to: nil)
  • status (Symbol, HubSpotSDK::Models::Cms::InboundDBObjectType::Status) (defaults to: nil)
  • visibility (Symbol, HubSpotSDK::Models::Cms::InboundDBObjectType::Visibility) (defaults to: nil)
  • write_scope_name (String) (defaults to: nil) 



# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 218

Instance Attribute Details

#access_scope_name ⇒ String?

Returns:

  • (String, nil) 


146
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 146

optional :access_scope_name, String, api_name: :accessScopeName

#allows_sensitive_properties ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 15

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

#create_date_property_name ⇒ String

Returns:

  • (String) 


22
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 22

required :create_date_property_name, String, api_name: :createDatePropertyName

#created_at ⇒ Integer?

Returns:

  • (Integer, nil) 


151
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 151

optional :created_at, Integer, api_name: :createdAt

#default_search_property_names ⇒ Array<String>

Returns:

  • (Array<String>) 


27
28
29
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 27

required :default_search_property_names,
HubSpotSDK::Internal::Type::ArrayOf[String],
api_name: :defaultSearchPropertyNames

#deleted ⇒ Boolean

Returns:

  • (Boolean) 


34
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 34

required :deleted, HubSpotSDK::Internal::Type::Boolean

#description ⇒ String?

Returns:

  • (String, nil) 


156
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 156

optional :description, String

#fully_qualified_name ⇒ String

Returns:

  • (String) 


39
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 39

required :fully_qualified_name, String, api_name: :fullyQualifiedName

#has_custom_properties ⇒ Boolean

Returns:

  • (Boolean) 


44
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 44

required :has_custom_properties, HubSpotSDK::Internal::Type::Boolean, api_name: :hasCustomProperties

#has_default_properties ⇒ Boolean

Returns:

  • (Boolean) 


49
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 49

required :has_default_properties, HubSpotSDK::Internal::Type::Boolean, api_name: :hasDefaultProperties

#has_external_object_ids ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 54

required :has_external_object_ids,
HubSpotSDK::Internal::Type::Boolean,
api_name: :hasExternalObjectIds

#has_owners ⇒ Boolean

Returns:

  • (Boolean) 


61
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 61

required :has_owners, HubSpotSDK::Internal::Type::Boolean, api_name: :hasOwners

#has_pipelines ⇒ Boolean

Returns:

  • (Boolean) 


66
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 66

required :has_pipelines, HubSpotSDK::Internal::Type::Boolean, api_name: :hasPipelines

#id ⇒ Integer

Returns:

  • (Integer) 


10
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 10

required :id, Integer

#indexed_for_filters_and_reports ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 71

required :indexed_for_filters_and_reports,
HubSpotSDK::Internal::Type::Boolean,
api_name: :indexedForFiltersAndReports

#integration_app_id ⇒ Integer?

Returns:

  • (Integer, nil) 


161
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 161

optional :integration_app_id, Integer, api_name: :integrationAppId

#janus_group ⇒ String?

Returns:

  • (String, nil) 


166
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 166

optional :janus_group, String, api_name: :janusGroup

#last_modified_property_name ⇒ String

Returns:

  • (String) 


78
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 78

required :last_modified_property_name, String, api_name: :lastModifiedPropertyName

#meta_type ⇒ Symbol, HubSpotSDK::Models::Cms::InboundDBObjectType::MetaType

Returns:



83
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 83

required :meta_type, enum: -> { HubSpotSDK::Cms::InboundDBObjectType::MetaType }, api_name: :metaType

#meta_type_id ⇒ Integer

Returns:

  • (Integer) 


88
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 88

required :meta_type_id, Integer, api_name: :metaTypeId

#name ⇒ String

Returns:

  • (String) 


93
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 93

required :name, String

#object_type_id ⇒ String

Returns:

  • (String) 


98
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 98

required :object_type_id, String, api_name: :objectTypeId

#owner_portal_id ⇒ Integer?

Returns:

  • (Integer, nil) 


171
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 171

optional :owner_portal_id, Integer, api_name: :ownerPortalId

#permissioning_type ⇒ Symbol, HubSpotSDK::Models::Cms::InboundDBObjectType::PermissioningType

Returns:



103
104
105
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 103

required :permissioning_type,
enum: -> { HubSpotSDK::Cms::InboundDBObjectType::PermissioningType },
api_name: :permissioningType

#pipeline_close_date_property_name ⇒ String?

Returns:

  • (String, nil) 


176
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 176

optional :pipeline_close_date_property_name, String, api_name: :pipelineCloseDatePropertyName

#pipeline_property_name ⇒ String

Returns:

  • (String) 


110
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 110

required :pipeline_property_name, String, api_name: :pipelinePropertyName

#pipeline_stage_property_name ⇒ String

Returns:

  • (String) 


115
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 115

required :pipeline_stage_property_name, String, api_name: :pipelineStagePropertyName

#pipeline_time_to_close_property_name ⇒ String?

Returns:

  • (String, nil) 


181
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 181

optional :pipeline_time_to_close_property_name, String, api_name: :pipelineTimeToClosePropertyName

#plural_form ⇒ String?

Returns:

  • (String, nil) 


186
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 186

optional :plural_form, String, api_name: :pluralForm

#primary_display_label_property_name ⇒ String?

Returns:

  • (String, nil) 


191
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 191

optional :primary_display_label_property_name, String, api_name: :primaryDisplayLabelPropertyName

#read_scope_name ⇒ String?

Returns:

  • (String, nil) 


196
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 196

optional :read_scope_name, String, api_name: :readScopeName

#required_properties ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 120

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

#restorable ⇒ Boolean

Returns:

  • (Boolean) 


127
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 127

required :restorable, HubSpotSDK::Internal::Type::Boolean

#scope_mappings ⇒ Array<HubSpotSDK::Models::Cms::ScopeMapping>

Returns:



132
133
134
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 132

required :scope_mappings,
-> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::Cms::ScopeMapping] },
api_name: :scopeMappings

#secondary_display_label_property_names ⇒ Array<String>

Returns:

  • (Array<String>) 


139
140
141
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 139

required :secondary_display_label_property_names,
HubSpotSDK::Internal::Type::ArrayOf[String],
api_name: :secondaryDisplayLabelPropertyNames

#singular_form ⇒ String?

Returns:

  • (String, nil) 


201
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 201

optional :singular_form, String, api_name: :singularForm

#status ⇒ Symbol, ...

Returns:



206
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 206

optional :status, enum: -> { HubSpotSDK::Cms::InboundDBObjectType::Status }

#visibility ⇒ Symbol, ...

Returns:



211
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 211

optional :visibility, enum: -> { HubSpotSDK::Cms::InboundDBObjectType::Visibility }

#write_scope_name ⇒ String?

Returns:

  • (String, nil) 


216
 
# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 216

optional :write_scope_name, String, api_name: :writeScopeName

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/hubspot_sdk/models/cms/inbound_db_object_type.rb', line 273