Class: Amocrm::Models::CustomFieldCreateParams::Body

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/amocrm/models/custom_field_create_params.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(name:, type:, code: nil, enums: nil, group_id: nil, is_deletable: nil, is_multiple: nil, is_required: nil, is_visible: nil, request_id: nil, settings: nil, sort: nil) ⇒ Object

Parameters:

  • name (String)
  • type (String)
  • 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)
  • request_id (String) (defaults to: nil)

    Client-side request id

  • settings (Object) (defaults to: nil)
  • sort (Integer) (defaults to: nil)


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/amocrm/models/custom_field_create_params.rb', line 25

class Body < Amocrm::Internal::Type::BaseModel
  # @!attribute name
  #
  #   @return [String]
  required :name, String

  # @!attribute type
  #
  #   @return [String]
  required :type, String

  # @!attribute code
  #
  #   @return [String, nil]
  optional :code, String

  # @!attribute enums
  #
  #   @return [Array<Object>, nil]
  optional :enums, Amocrm::Internal::Type::ArrayOf[Amocrm::Internal::Type::Unknown]

  # @!attribute group_id
  #
  #   @return [Integer, nil]
  optional :group_id, Integer

  # @!attribute is_deletable
  #
  #   @return [Boolean, nil]
  optional :is_deletable, Amocrm::Internal::Type::Boolean

  # @!attribute is_multiple
  #
  #   @return [Boolean, nil]
  optional :is_multiple, Amocrm::Internal::Type::Boolean

  # @!attribute is_required
  #
  #   @return [Boolean, nil]
  optional :is_required, Amocrm::Internal::Type::Boolean

  # @!attribute is_visible
  #
  #   @return [Boolean, nil]
  optional :is_visible, Amocrm::Internal::Type::Boolean

  # @!attribute request_id
  #   Client-side request id
  #
  #   @return [String, nil]
  optional :request_id, String

  # @!attribute settings
  #
  #   @return [Object, nil]
  optional :settings, Amocrm::Internal::Type::Unknown

  # @!attribute sort
  #
  #   @return [Integer, nil]
  optional :sort, Integer

  # @!method initialize(name:, type:, code: nil, enums: nil, group_id: nil, is_deletable: nil, is_multiple: nil, is_required: nil, is_visible: nil, request_id: nil, settings: nil, sort: nil)
  #   @param name [String]
  #
  #   @param type [String]
  #
  #   @param code [String]
  #
  #   @param enums [Array<Object>]
  #
  #   @param group_id [Integer]
  #
  #   @param is_deletable [Boolean]
  #
  #   @param is_multiple [Boolean]
  #
  #   @param is_required [Boolean]
  #
  #   @param is_visible [Boolean]
  #
  #   @param request_id [String] Client-side request id
  #
  #   @param settings [Object]
  #
  #   @param sort [Integer]
end

Instance Attribute Details

#codeString?

Returns:

  • (String, nil)


39
# File 'lib/amocrm/models/custom_field_create_params.rb', line 39

optional :code, String

#enumsArray<Object>?

Returns:

  • (Array<Object>, nil)


44
# File 'lib/amocrm/models/custom_field_create_params.rb', line 44

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

#group_idInteger?

Returns:

  • (Integer, nil)


49
# File 'lib/amocrm/models/custom_field_create_params.rb', line 49

optional :group_id, Integer

#is_deletableBoolean?

Returns:

  • (Boolean, nil)


54
# File 'lib/amocrm/models/custom_field_create_params.rb', line 54

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

#is_multipleBoolean?

Returns:

  • (Boolean, nil)


59
# File 'lib/amocrm/models/custom_field_create_params.rb', line 59

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

#is_requiredBoolean?

Returns:

  • (Boolean, nil)


64
# File 'lib/amocrm/models/custom_field_create_params.rb', line 64

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

#is_visibleBoolean?

Returns:

  • (Boolean, nil)


69
# File 'lib/amocrm/models/custom_field_create_params.rb', line 69

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

#nameString

Returns:

  • (String)


29
# File 'lib/amocrm/models/custom_field_create_params.rb', line 29

required :name, String

#request_idString?

Client-side request id

Returns:

  • (String, nil)


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

optional :request_id, String

#settingsObject?

Returns:

  • (Object, nil)


80
# File 'lib/amocrm/models/custom_field_create_params.rb', line 80

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

#sortInteger?

Returns:

  • (Integer, nil)


85
# File 'lib/amocrm/models/custom_field_create_params.rb', line 85

optional :sort, Integer

#typeString

Returns:

  • (String)


34
# File 'lib/amocrm/models/custom_field_create_params.rb', line 34

required :type, String