Class: HubSpotSDK::Models::PropertyCreate

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::PropertyCreate

Defined in:

lib/hubspot_sdk/models/property_create.rb

Direct Known Subclasses

Cms::MediaBridgeCreatePropertyParams, Crm::PropertyCreateParams

Defined Under Namespace

Modules: DataSensitivity, FieldType, NumberDisplayHint, Type

Instance Attribute Summary

• #calculation_formula ⇒ String^?
• #currency_property_name ⇒ String^?
• #data_sensitivity ⇒ Symbol, ...
• #description ⇒ String^?
• #display_order ⇒ Integer^?
• #external_options ⇒ Boolean^?
• #field_type ⇒ Symbol, HubSpotSDK::Models::PropertyCreate::FieldType
• #form_field ⇒ Boolean^?
• #group_name ⇒ String
• #has_unique_value ⇒ Boolean^?
• #hidden ⇒ Boolean^?
• #label ⇒ String
• #name ⇒ String
• #number_display_hint ⇒ Symbol, ...
• #options ⇒ Array<HubSpotSDK::Models::OptionInput>^?
• #referenced_object_type ⇒ String^?
• #show_currency_symbol ⇒ Boolean^?
• #type ⇒ Symbol, HubSpotSDK::Models::PropertyCreate::Type

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(field_type:, group_name:, label:, name:, type:, calculation_formula: nil, currency_property_name: nil, data_sensitivity: nil, description: nil, display_order: nil, external_options: nil, form_field: nil, has_unique_value: nil, hidden: nil, number_display_hint: nil, options: nil, referenced_object_type: nil, show_currency_symbol: nil) ⇒ Object constructor

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(field_type:, group_name:, label:, name:, type:, calculation_formula: nil, currency_property_name: nil, data_sensitivity: nil, description: nil, display_order: nil, external_options: nil, form_field: nil, has_unique_value: nil, hidden: nil, number_display_hint: nil, options: nil, referenced_object_type: nil, show_currency_symbol: nil) ⇒ Object

Parameters:

• field_type (Symbol, HubSpotSDK::Models::PropertyCreate::FieldType)
• group_name (String)
• label (String)
• name (String)
• type (Symbol, HubSpotSDK::Models::PropertyCreate::Type)
• calculation_formula (String) (defaults to: nil)
• currency_property_name (String) (defaults to: nil)
• data_sensitivity (Symbol, HubSpotSDK::Models::PropertyCreate::DataSensitivity) (defaults to: nil)
• description (String) (defaults to: nil)
• display_order (Integer) (defaults to: nil)
• external_options (Boolean) (defaults to: nil)
• form_field (Boolean) (defaults to: nil)
• has_unique_value (Boolean) (defaults to: nil)
• hidden (Boolean) (defaults to: nil)
• number_display_hint (Symbol, HubSpotSDK::Models::PropertyCreate::NumberDisplayHint) (defaults to: nil)
• options (Array<HubSpotSDK::Models::OptionInput>) (defaults to: nil)
• referenced_object_type (String) (defaults to: nil)
• show_currency_symbol (Boolean) (defaults to: nil)

# File 'lib/hubspot_sdk/models/property_create.rb', line 100

Instance Attribute Details

#calculation_formula ⇒ String^?

Returns:

• (String, nil)

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

optional :calculation_formula, String, api_name: :calculationFormula

#currency_property_name ⇒ String^?

Returns:

• (String, nil)

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

optional :currency_property_name, String, api_name: :currencyPropertyName

#data_sensitivity ⇒ Symbol, ...

Returns:

• (Symbol, HubSpotSDK::Models::PropertyCreate::DataSensitivity, nil)

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

optional :data_sensitivity,
enum: -> { HubSpotSDK::PropertyCreate::DataSensitivity },
api_name: :dataSensitivity

#description ⇒ String^?

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/property_create.rb', line 51

optional :description, String

#display_order ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/property_create.rb', line 56

optional :display_order, Integer, api_name: :displayOrder

#external_options ⇒ Boolean^?

Returns:

• (Boolean, nil)

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

optional :external_options, HubSpotSDK::Internal::Type::Boolean, api_name: :externalOptions

#field_type ⇒ Symbol, HubSpotSDK::Models::PropertyCreate::FieldType

Returns:

• (Symbol, HubSpotSDK::Models::PropertyCreate::FieldType)

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

required :field_type, enum: -> { HubSpotSDK::PropertyCreate::FieldType }, api_name: :fieldType

#form_field ⇒ Boolean^?

Returns:

• (Boolean, nil)

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

optional :form_field, HubSpotSDK::Internal::Type::Boolean, api_name: :formField

#group_name ⇒ String

Returns:

• (String)

# File 'lib/hubspot_sdk/models/property_create.rb', line 14

required :group_name, String, api_name: :groupName

#has_unique_value ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/hubspot_sdk/models/property_create.rb', line 71

optional :has_unique_value, HubSpotSDK::Internal::Type::Boolean, api_name: :hasUniqueValue

#hidden ⇒ Boolean^?

Returns:

• (Boolean, nil)

# File 'lib/hubspot_sdk/models/property_create.rb', line 76

optional :hidden, HubSpotSDK::Internal::Type::Boolean

#label ⇒ String

Returns:

• (String)

# File 'lib/hubspot_sdk/models/property_create.rb', line 19

required :label, String

#name ⇒ String

Returns:

• (String)

# File 'lib/hubspot_sdk/models/property_create.rb', line 24

required :name, String

#number_display_hint ⇒ Symbol, ...

Returns:

• (Symbol, HubSpotSDK::Models::PropertyCreate::NumberDisplayHint, nil)

# File 'lib/hubspot_sdk/models/property_create.rb', line 81

optional :number_display_hint,
enum: -> { HubSpotSDK::PropertyCreate::NumberDisplayHint },
api_name: :numberDisplayHint

#options ⇒ Array<HubSpotSDK::Models::OptionInput>^?

Returns:

• (Array<HubSpotSDK::Models::OptionInput>, nil)

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

optional :options, -> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::OptionInput] }

#referenced_object_type ⇒ String^?

Returns:

• (String, nil)

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

optional :referenced_object_type, String, api_name: :referencedObjectType

#show_currency_symbol ⇒ Boolean^?

Returns:

• (Boolean, nil)

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

optional :show_currency_symbol, HubSpotSDK::Internal::Type::Boolean, api_name: :showCurrencySymbol

#type ⇒ Symbol, HubSpotSDK::Models::PropertyCreate::Type

Returns:

• (Symbol, HubSpotSDK::Models::PropertyCreate::Type)

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

required :type, enum: -> { HubSpotSDK::PropertyCreate::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/hubspot_sdk/models/property_create.rb', line 137