Class: Amocrm::Models::LeadUpdateByIDParams::Embedded

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

Defined Under Namespace

Classes: Company, Contact, Metadata, Source, Tag

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

Parameters:

  • id (Integer) (defaults to: nil)
  • name (String) (defaults to: nil) 


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/amocrm/models/lead_update_by_id_params.rb', line 116

class Embedded < Amocrm::Internal::Type::BaseModel
  # @!attribute companies
  #
  #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Company>, nil]
  optional :companies,
           -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::Embedded::Company] }

  # @!attribute contacts
  #
  #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Contact>, nil]
  optional :contacts,
           -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::Embedded::Contact] }

  # @!attribute metadata
  #
  #   @return [Amocrm::Models::LeadUpdateByIDParams::Embedded::Metadata, nil]
  optional :metadata, -> { Amocrm::LeadUpdateByIDParams::Embedded::Metadata }

  # @!attribute source
  #
  #   @return [Amocrm::Models::LeadUpdateByIDParams::Embedded::Source, nil]
  optional :source, -> { Amocrm::LeadUpdateByIDParams::Embedded::Source }

  # @!attribute tags
  #
  #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Tag>, nil]
  optional :tags, -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::Embedded::Tag] }

  # @!method initialize(companies: nil, contacts: nil, metadata: nil, source: nil, tags: nil)
  #   @param companies [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Company>]
  #   @param contacts [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Contact>]
  #   @param metadata [Amocrm::Models::LeadUpdateByIDParams::Embedded::Metadata]
  #   @param source [Amocrm::Models::LeadUpdateByIDParams::Embedded::Source]
  #   @param tags [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Tag>]

  class Company < Amocrm::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [Integer, nil]
    optional :id, Integer

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

    # @!method initialize(id: nil, name: nil)
    #   @param id [Integer]
    #   @param name [String]
  end

  class Contact < Amocrm::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [Integer, nil]
    optional :id, Integer

    # @!attribute custom_fields_values
    #   Custom fields payload (same as contact create API)
    #
    #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Contact::CustomFieldsValue>, nil]
    optional :custom_fields_values,
             -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::Embedded::Contact::CustomFieldsValue] }

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

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

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

    # @!method initialize(id: nil, custom_fields_values: nil, first_name: nil, last_name: nil, name: nil)
    #   @param id [Integer]
    #
    #   @param custom_fields_values [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Contact::CustomFieldsValue>] Custom fields payload (same as contact create API)
    #
    #   @param first_name [String]
    #
    #   @param last_name [String]
    #
    #   @param name [String]

    class CustomFieldsValue < Amocrm::Internal::Type::BaseModel
      # @!attribute values
      #   Values for the field (multiple values allowed)
      #
      #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Contact::CustomFieldsValue::Value>]
      required :values,
               -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::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::LeadUpdateByIDParams::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::LeadUpdateByIDParams::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::LeadUpdateByIDParams::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
  end

  # @see Amocrm::Models::LeadUpdateByIDParams::Embedded#metadata
  class Metadata < Amocrm::Internal::Type::BaseModel
    # @!attribute category
    #   Unsorted category
    #
    #   @return [Symbol, Amocrm::Models::LeadUpdateByIDParams::Embedded::Metadata::Category, nil]
    optional :category, enum: -> { Amocrm::LeadUpdateByIDParams::Embedded::Metadata::Category }

    # @!attribute form_id
    #   Form id in your system (string or numeric)
    #
    #   @return [String, Integer, nil]
    optional :form_id, union: -> { Amocrm::LeadUpdateByIDParams::Embedded::Metadata::FormID }

    # @!attribute form_name
    #   Form name (shown in amoCRM)
    #
    #   @return [String, nil]
    optional :form_name, String

    # @!attribute form_page
    #   Page URL where form lives
    #
    #   @return [String, nil]
    optional :form_page, String

    # @!attribute form_sent_at
    #   Unix timestamp (seconds) when the form was submitted
    #
    #   @return [Integer, nil]
    optional :form_sent_at, Integer

    # @!attribute form_type
    #   Form type code from amoCRM, use only if you know it
    #
    #   @return [Integer, nil]
    optional :form_type, Integer

    # @!attribute ip
    #   IP address of the submitter
    #
    #   @return [String, nil]
    optional :ip, String

    # @!attribute referer
    #   Referrer URL
    #
    #   @return [String, nil]
    optional :referer, String

    # @!attribute visitor_uid
    #   Visitor uid from tracking, if you have it
    #
    #   @return [String, nil]
    optional :visitor_uid, String

    # @!method initialize(category: nil, form_id: nil, form_name: nil, form_page: nil, form_sent_at: nil, form_type: nil, ip: nil, referer: nil, visitor_uid: nil)
    #   @param category [Symbol, Amocrm::Models::LeadUpdateByIDParams::Embedded::Metadata::Category] Unsorted category
    #
    #   @param form_id [String, Integer] Form id in your system (string or numeric)
    #
    #   @param form_name [String] Form name (shown in amoCRM)
    #
    #   @param form_page [String] Page URL where form lives
    #
    #   @param form_sent_at [Integer] Unix timestamp (seconds) when the form was submitted
    #
    #   @param form_type [Integer] Form type code from amoCRM, use only if you know it
    #
    #   @param ip [String] IP address of the submitter
    #
    #   @param referer [String] Referrer URL
    #
    #   @param visitor_uid [String] Visitor uid from tracking, if you have it

    # Unsorted category
    #
    # @see Amocrm::Models::LeadUpdateByIDParams::Embedded::Metadata#category
    module Category
      extend Amocrm::Internal::Type::Enum

      SIP = :sip
      FORMS = :forms
      CHATS = :chats
      MAIL = :mail

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # Form id in your system (string or numeric)
    #
    # @see Amocrm::Models::LeadUpdateByIDParams::Embedded::Metadata#form_id
    module FormID
      extend Amocrm::Internal::Type::Union

      variant String

      variant Integer

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

  # @see Amocrm::Models::LeadUpdateByIDParams::Embedded#source
  class Source < Amocrm::Internal::Type::BaseModel
    # @!attribute external_id
    #   External id in your system
    #
    #   @return [String, Integer, Boolean, nil]
    optional :external_id, union: -> { Amocrm::LeadUpdateByIDParams::Embedded::Source::ExternalID }

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

    # @!method initialize(external_id: nil, type: nil)
    #   @param external_id [String, Integer, Boolean] External id in your system
    #
    #   @param type [String] Source type

    # External id in your system
    #
    # @see Amocrm::Models::LeadUpdateByIDParams::Embedded::Source#external_id
    module ExternalID
      extend Amocrm::Internal::Type::Union

      variant String

      variant Integer

      variant Amocrm::Internal::Type::Boolean

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

  class Tag < Amocrm::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [Integer, nil]
    optional :id, Integer

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

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

    # @!method initialize(id: nil, color: nil, name: nil)
    #   @param id [Integer]
    #   @param color [String]
    #   @param name [String]
  end
end

Instance Attribute Details

#companies ⇒ Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Company>?

Returns:



120
121
 
# File 'lib/amocrm/models/lead_update_by_id_params.rb', line 120

optional :companies,
-> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::Embedded::Company] }

#contacts ⇒ Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Contact>?

Returns:



126
127
 
# File 'lib/amocrm/models/lead_update_by_id_params.rb', line 126

optional :contacts,
-> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::Embedded::Contact] }

#metadata ⇒ Amocrm::Models::LeadUpdateByIDParams::Embedded::Metadata?

Returns:



132
 
# File 'lib/amocrm/models/lead_update_by_id_params.rb', line 132

optional :metadata, -> { Amocrm::LeadUpdateByIDParams::Embedded::Metadata }

#source ⇒ Amocrm::Models::LeadUpdateByIDParams::Embedded::Source?

Returns:



137
 
# File 'lib/amocrm/models/lead_update_by_id_params.rb', line 137

optional :source, -> { Amocrm::LeadUpdateByIDParams::Embedded::Source }

#tags ⇒ Array<Amocrm::Models::LeadUpdateByIDParams::Embedded::Tag>?

Returns:



142
 
# File 'lib/amocrm/models/lead_update_by_id_params.rb', line 142

optional :tags, -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::Embedded::Tag] }

Class Method Details

.variants ⇒ Array(String, Integer, Boolean)

Returns:

  • (Array(String, Integer, Boolean)) 



# File 'lib/amocrm/models/lead_update_by_id_params.rb', line 269