amocrm 0.3.0 → 0.5.0

data/lib/amocrm/models/lead_update_by_id_params.rb

@@ -0,0 +1,546 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::Leads#update_by_id
+    class LeadUpdateByIDParams < Amocrm::Internal::Type::BaseModel
+      extend Amocrm::Internal::Type::RequestParameters::Converter
+      include Amocrm::Internal::Type::RequestParameters
+
+      # @!attribute _embedded
+      #
+      #   @return [Amocrm::Models::LeadUpdateByIDParams::Embedded, nil]
+      optional :_embedded, -> { Amocrm::LeadUpdateByIDParams::Embedded }
+
+      # @!attribute closed_at
+      #
+      #   @return [Integer, nil]
+      optional :closed_at, Integer
+
+      # @!attribute custom_fields_values
+      #   Custom fields payload
+      #
+      #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::CustomFieldsValue>, nil]
+      optional :custom_fields_values,
+               -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::CustomFieldsValue] }
+
+      # @!attribute group_id
+      #
+      #   @return [Integer, nil]
+      optional :group_id, Integer
+
+      # @!attribute loss_reason_id
+      #
+      #   @return [Integer, nil]
+      optional :loss_reason_id, Integer
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute pipeline_id
+      #
+      #   @return [Integer, nil]
+      optional :pipeline_id, Integer
+
+      # @!attribute price
+      #
+      #   @return [Integer, nil]
+      optional :price, Integer
+
+      # @!attribute responsible_user_id
+      #
+      #   @return [Integer, nil]
+      optional :responsible_user_id, Integer
+
+      # @!attribute status_id
+      #
+      #   @return [Integer, nil]
+      optional :status_id, Integer
+
+      # @!attribute tags_to_add
+      #   Tags to attach
+      #
+      #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::TagsToAdd>, nil]
+      optional :tags_to_add, -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::TagsToAdd] }
+
+      # @!attribute tags_to_delete
+      #   Tags to delete
+      #
+      #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::TagsToDelete>, nil]
+      optional :tags_to_delete,
+               -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::TagsToDelete] }
+
+      # @!attribute updated_at
+      #
+      #   @return [Integer, nil]
+      optional :updated_at, Integer
+
+      # @!method initialize(_embedded: nil, closed_at: nil, custom_fields_values: nil, group_id: nil, loss_reason_id: nil, name: nil, pipeline_id: nil, price: nil, responsible_user_id: nil, status_id: nil, tags_to_add: nil, tags_to_delete: nil, updated_at: nil, request_options: {})
+      #   @param _embedded [Amocrm::Models::LeadUpdateByIDParams::Embedded]
+      #
+      #   @param closed_at [Integer]
+      #
+      #   @param custom_fields_values [Array<Amocrm::Models::LeadUpdateByIDParams::CustomFieldsValue>] Custom fields payload
+      #
+      #   @param group_id [Integer]
+      #
+      #   @param loss_reason_id [Integer]
+      #
+      #   @param name [String]
+      #
+      #   @param pipeline_id [Integer]
+      #
+      #   @param price [Integer]
+      #
+      #   @param responsible_user_id [Integer]
+      #
+      #   @param status_id [Integer]
+      #
+      #   @param tags_to_add [Array<Amocrm::Models::LeadUpdateByIDParams::TagsToAdd>] Tags to attach
+      #
+      #   @param tags_to_delete [Array<Amocrm::Models::LeadUpdateByIDParams::TagsToDelete>] Tags to delete
+      #
+      #   @param updated_at [Integer]
+      #
+      #   @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}]
+
+      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
+
+      class CustomFieldsValue < Amocrm::Internal::Type::BaseModel
+        # @!attribute values
+        #   Values for the field (multiple values allowed)
+        #
+        #   @return [Array<Amocrm::Models::LeadUpdateByIDParams::CustomFieldsValue::Value>]
+        required :values,
+                 -> { Amocrm::Internal::Type::ArrayOf[Amocrm::LeadUpdateByIDParams::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::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::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::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
+
+      class TagsToAdd < 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
+
+      class TagsToDelete < 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
+  end
+end

data/lib/amocrm/models/lead_update_by_id_response.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::Leads#update_by_id
+    module LeadUpdateByIDResponse
+      extend Amocrm::Internal::Type::Union
+
+      variant -> { Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse }
+
+      variant -> { Amocrm::Models::LeadUpdateByIDResponse::Problem }
+
+      class LeadUpdateResponse < Amocrm::Internal::Type::BaseModel
+        # @!attribute _embedded
+        #
+        #   @return [Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse::Embedded, nil]
+        optional :_embedded, -> { Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse::Embedded }
+
+        # @!attribute _links
+        #
+        #   @return [Object, nil]
+        optional :_links, Amocrm::Internal::Type::Unknown
+
+        # @!method initialize(_embedded: nil, _links: nil)
+        #   @param _embedded [Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse::Embedded]
+        #   @param _links [Object]
+
+        # @see Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse#_embedded
+        class Embedded < Amocrm::Internal::Type::BaseModel
+          # @!attribute leads
+          #
+          #   @return [Array<Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse::Embedded::Lead>, nil]
+          optional :leads,
+                   -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse::Embedded::Lead] }
+
+          # @!method initialize(leads: nil)
+          #   @param leads [Array<Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse::Embedded::Lead>]
+
+          class Lead < Amocrm::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [Integer, nil]
+            optional :id, Integer
+
+            # @!attribute _links
+            #
+            #   @return [Object, nil]
+            optional :_links, Amocrm::Internal::Type::Unknown
+
+            # @!attribute updated_at
+            #
+            #   @return [Integer, nil]
+            optional :updated_at, Integer
+
+            # @!method initialize(id: nil, _links: nil, updated_at: nil)
+            #   @param id [Integer]
+            #   @param _links [Object]
+            #   @param updated_at [Integer]
+          end
+        end
+      end
+
+      class Problem < Amocrm::Internal::Type::BaseModel
+        # @!attribute detail
+        #
+        #   @return [String, nil]
+        optional :detail, String
+
+        # @!attribute status
+        #
+        #   @return [Integer, nil]
+        optional :status, Integer
+
+        # @!attribute title
+        #
+        #   @return [String, nil]
+        optional :title, String
+
+        # @!attribute type
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!method initialize(detail: nil, status: nil, title: nil, type: nil)
+        #   @param detail [String]
+        #   @param status [Integer]
+        #   @param title [String]
+        #   @param type [String]
+      end
+
+      # @!method self.variants
+      #   @return [Array(Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse, Amocrm::Models::LeadUpdateByIDResponse::Problem)]
+    end
+  end
+end