Class: Amocrm::Models::LeadUpdateParams::Body::Embedded::Contact::CustomFieldsValue

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/amocrm/models/lead_update_params.rb

Defined Under Namespace

Classes: Value

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: nil, custom_fields_values: nil, first_name: nil, last_name: nil, name: nil) ⇒ Object

Parameters:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/amocrm/models/lead_update_params.rb', line 216

class CustomFieldsValue < Amocrm::Internal::Type::BaseModel
  # @!attribute values
  #   Values for the field (multiple values allowed)
  #
  #   @return [Array<Amocrm::Models::LeadUpdateParams::Body::Embedded::Contact::CustomFieldsValue::Value>]
  required :values,
           -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateParams::Body::Embedded::Contact::CustomFieldsValue::Value] }

  # @!attribute field_code
  #   Field code (e.g. PHONE/EMAIL)
  #
  #   @return [String, nil]
  optional :field_code, String

  # @!attribute field_id
  #   Use either field_id or field_code (e.g. PHONE/EMAIL)
  #
  #   @return [Integer, nil]
  optional :field_id, Integer

  # @!method initialize(values:, field_code: nil, field_id: nil)
  #   @param values [Array<Amocrm::Models::LeadUpdateParams::Body::Embedded::Contact::CustomFieldsValue::Value>] Values for the field (multiple values allowed)
  #
  #   @param field_code [String] Field code (e.g. PHONE/EMAIL)
  #
  #   @param field_id [Integer] Use either field_id or field_code (e.g. PHONE/EMAIL)

  class Value < Amocrm::Internal::Type::BaseModel
    # @!attribute value
    #
    #   @return [String, Integer, Boolean]
    required :value,
             union: -> { Amocrm::LeadUpdateParams::Body::Embedded::Contact::CustomFieldsValue::Value::Value }

    # @!attribute enum_code
    #   Option code for list/select custom fields (if you use code instead of id)
    #
    #   @return [String, nil]
    optional :enum_code, String

    # @!attribute enum_id
    #   Option id for list/select custom fields (one of predefined options)
    #
    #   @return [Integer, nil]
    optional :enum_id, Integer

    # @!method initialize(value:, enum_code: nil, enum_id: nil)
    #   @param value [String, Integer, Boolean]
    #
    #   @param enum_code [String] Option code for list/select custom fields (if you use code instead of id)
    #
    #   @param enum_id [Integer] Option id for list/select custom fields (one of predefined options)

    # @see Amocrm::Models::LeadUpdateParams::Body::Embedded::Contact::CustomFieldsValue::Value#value
    module Value
      extend Amocrm::Internal::Type::Union

      variant String

      variant Integer

      variant Amocrm::Internal::Type::Boolean

      # @!method self.variants
      #   @return [Array(String, Integer, Boolean)]
    end
  end
end

Instance Attribute Details

#field_code ⇒ String?

Field code (e.g. PHONE/EMAIL)

Returns:

  • (String, nil) 


228
 
# File 'lib/amocrm/models/lead_update_params.rb', line 228

optional :field_code, String

#field_id ⇒ Integer?

Use either field_id or field_code (e.g. PHONE/EMAIL)

Returns:

  • (Integer, nil) 


234
 
# File 'lib/amocrm/models/lead_update_params.rb', line 234

optional :field_id, Integer

#values ⇒ Array<Amocrm::Models::LeadUpdateParams::Body::Embedded::Contact::CustomFieldsValue::Value>

Values for the field (multiple values allowed)

Returns:



221
222
 
# File 'lib/amocrm/models/lead_update_params.rb', line 221

required :values,
-> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateParams::Body::Embedded::Contact::CustomFieldsValue::Value] }