Class: Amocrm::Models::CustomFieldUpdateByIDParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/amocrm/models/custom_field_update_by_id_params.rb,
sig/amocrm/models/custom_field_update_by_id_params.rbs

Overview

See Also:

  • Amocrm::Resources::CustomFields#update_by_id

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(entity_type:, id:, code: nil, enums: nil, group_id: nil, is_deletable: nil, is_multiple: nil, is_required: nil, is_visible: nil, name: nil, settings: nil, sort: nil, type: nil, request_options: {}) ⇒ Object

Parameters:

  • entity_type (String)
  • id (Integer)
  • code (String) (defaults to: nil)
  • enums (Array<Object>) (defaults to: nil)
  • group_id (Integer) (defaults to: nil)
  • is_deletable (Boolean) (defaults to: nil)
  • is_multiple (Boolean) (defaults to: nil)
  • is_required (Boolean) (defaults to: nil)
  • is_visible (Boolean) (defaults to: nil)
  • name (String) (defaults to: nil)
  • settings (Object) (defaults to: nil)
  • sort (Integer) (defaults to: nil)
  • type (String) (defaults to: nil)
  • request_options (Amocrm::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 75

Instance Attribute Details

#code ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


23
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 23

optional :code, String

#entity_type ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 13

required :entity_type, String

#enums ⇒ Array<Object>?

Parameters:

  • (::Array[top])

Returns:

  • (Array<Object>, nil) 


28
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 28

optional :enums, Amocrm::Internal::Type::ArrayOf[Amocrm::Internal::Type::Unknown]

#group_id ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


33
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 33

optional :group_id, Integer

#id ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


18
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 18

required :id, Integer

#is_deletable ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 38

optional :is_deletable, Amocrm::Internal::Type::Boolean

#is_multiple ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


43
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 43

optional :is_multiple, Amocrm::Internal::Type::Boolean

#is_required ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


48
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 48

optional :is_required, Amocrm::Internal::Type::Boolean

#is_visible ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


53
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 53

optional :is_visible, Amocrm::Internal::Type::Boolean

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


58
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 58

optional :name, String

#settings ⇒ Object?

Parameters:

  • (top)

Returns:

  • (Object, nil) 


63
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 63

optional :settings, Amocrm::Internal::Type::Unknown

#sort ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


68
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 68

optional :sort, Integer

#type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


73
 
# File 'lib/amocrm/models/custom_field_update_by_id_params.rb', line 73

optional :type, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


90
 
# File 'sig/amocrm/models/custom_field_update_by_id_params.rbs', line 90

def to_hash: -> {