amocrm 0.3.0 → 0.4.0

data/lib/amocrm/models/v4_companies_list_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::V4#companies_list
+    class V4CompaniesListParams < Amocrm::Internal::Type::BaseModel
+      extend Amocrm::Internal::Type::RequestParameters::Converter
+      include Amocrm::Internal::Type::RequestParameters
+
+      # @!attribute filter
+      #   Filtering parameters
+      #
+      #   @return [Object, nil]
+      optional :filter, Amocrm::Internal::Type::Unknown
+
+      # @!attribute limit
+      #   Pagination limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute order
+      #   Sorting, e.g. order[updated_at]=asc
+      #
+      #   @return [Object, nil]
+      optional :order, Amocrm::Internal::Type::Unknown
+
+      # @!attribute page
+      #   Pagination page
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute query
+      #   Search by query string or id
+      #
+      #   @return [String, Integer, nil]
+      optional :query, union: -> { Amocrm::V4CompaniesListParams::Query }
+
+      # @!attribute with
+      #   Expand related entities; comma-separated values
+      #
+      #   @return [String, nil]
+      optional :with, String
+
+      # @!method initialize(filter: nil, limit: nil, order: nil, page: nil, query: nil, with: nil, request_options: {})
+      #   @param filter [Object] Filtering parameters
+      #
+      #   @param limit [Integer] Pagination limit
+      #
+      #   @param order [Object] Sorting, e.g. order[updated_at]=asc
+      #
+      #   @param page [Integer] Pagination page
+      #
+      #   @param query [String, Integer] Search by query string or id
+      #
+      #   @param with [String] Expand related entities; comma-separated values
+      #
+      #   @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}]
+
+      # Search by query string or id
+      module Query
+        extend Amocrm::Internal::Type::Union
+
+        variant String
+
+        variant Integer
+
+        # @!method self.variants
+        #   @return [Array(String, Integer)]
+      end
+    end
+  end
+end

data/lib/amocrm/models/v4_companies_list_response.rb

@@ -0,0 +1,359 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::V4#companies_list
+    module V4CompaniesListResponse
+      extend Amocrm::Internal::Type::Union
+
+      variant -> { Amocrm::Models::V4CompaniesListResponse::CompanyListResponse }
+
+      variant -> { Amocrm::Models::V4CompaniesListResponse::Problem }
+
+      class CompanyListResponse < Amocrm::Internal::Type::BaseModel
+        # @!attribute _embedded
+        #
+        #   @return [Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded, nil]
+        optional :_embedded, -> { Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded }
+
+        # @!attribute _links
+        #
+        #   @return [Object, nil]
+        optional :_links, Amocrm::Internal::Type::Unknown
+
+        # @!attribute _page
+        #
+        #   @return [Integer, nil]
+        optional :_page, Integer
+
+        # @!method initialize(_embedded: nil, _links: nil, _page: nil)
+        #   @param _embedded [Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded]
+        #   @param _links [Object]
+        #   @param _page [Integer]
+
+        # @see Amocrm::Models::V4CompaniesListResponse::CompanyListResponse#_embedded
+        class Embedded < Amocrm::Internal::Type::BaseModel
+          # @!attribute companies
+          #
+          #   @return [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company>, nil]
+          optional :companies,
+                   -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company] }
+
+          # @!method initialize(companies: nil)
+          #   @param companies [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company>]
+
+          class Company < Amocrm::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [Integer, nil]
+            optional :id, Integer
+
+            # @!attribute _embedded
+            #
+            #   @return [Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded, nil]
+            optional :_embedded,
+                     -> { Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded }
+
+            # @!attribute _links
+            #
+            #   @return [Object, nil]
+            optional :_links, Amocrm::Internal::Type::Unknown
+
+            # @!attribute account_id
+            #
+            #   @return [Integer, nil]
+            optional :account_id, Integer
+
+            # @!attribute closest_task_at
+            #
+            #   @return [Integer, nil]
+            optional :closest_task_at, Integer
+
+            # @!attribute created_at
+            #
+            #   @return [Integer, nil]
+            optional :created_at, Integer
+
+            # @!attribute created_by
+            #
+            #   @return [Integer, nil]
+            optional :created_by, Integer
+
+            # @!attribute custom_fields_values
+            #
+            #   @return [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::CustomFieldsValue>, nil]
+            optional :custom_fields_values,
+                     -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::CustomFieldsValue] },
+                     nil?: true
+
+            # @!attribute group_id
+            #
+            #   @return [Integer, nil]
+            optional :group_id, Integer
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!attribute responsible_user_id
+            #
+            #   @return [Integer, nil]
+            optional :responsible_user_id, Integer
+
+            # @!attribute updated_at
+            #
+            #   @return [Integer, nil]
+            optional :updated_at, Integer
+
+            # @!attribute updated_by
+            #
+            #   @return [Integer, nil]
+            optional :updated_by, Integer
+
+            # @!method initialize(id: nil, _embedded: nil, _links: nil, account_id: nil, closest_task_at: nil, created_at: nil, created_by: nil, custom_fields_values: nil, group_id: nil, name: nil, responsible_user_id: nil, updated_at: nil, updated_by: nil)
+            #   @param id [Integer]
+            #   @param _embedded [Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded]
+            #   @param _links [Object]
+            #   @param account_id [Integer]
+            #   @param closest_task_at [Integer]
+            #   @param created_at [Integer]
+            #   @param created_by [Integer]
+            #   @param custom_fields_values [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::CustomFieldsValue>, nil]
+            #   @param group_id [Integer]
+            #   @param name [String]
+            #   @param responsible_user_id [Integer]
+            #   @param updated_at [Integer]
+            #   @param updated_by [Integer]
+
+            # @see Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company#_embedded
+            class Embedded < Amocrm::Internal::Type::BaseModel
+              # @!attribute catalog_elements
+              #
+              #   @return [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::CatalogElement>, nil]
+              optional :catalog_elements,
+                       -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::CatalogElement] }
+
+              # @!attribute contacts
+              #
+              #   @return [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Contact>, nil]
+              optional :contacts,
+                       -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Contact] }
+
+              # @!attribute customers
+              #
+              #   @return [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Customer>, nil]
+              optional :customers,
+                       -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Customer] }
+
+              # @!attribute leads
+              #
+              #   @return [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Lead>, nil]
+              optional :leads,
+                       -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Lead] }
+
+              # @!attribute tags
+              #
+              #   @return [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Tag>, nil]
+              optional :tags,
+                       -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Tag] }
+
+              # @!method initialize(catalog_elements: nil, contacts: nil, customers: nil, leads: nil, tags: nil)
+              #   @param catalog_elements [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::CatalogElement>]
+              #   @param contacts [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Contact>]
+              #   @param customers [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Customer>]
+              #   @param leads [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Lead>]
+              #   @param tags [Array<Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::Embedded::Tag>]
+
+              class CatalogElement < Amocrm::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer, nil]
+                optional :id, Integer
+
+                # @!attribute _links
+                #
+                #   @return [Object, nil]
+                optional :_links, Amocrm::Internal::Type::Unknown
+
+                # @!method initialize(id: nil, _links: nil)
+                #   @param id [Integer]
+                #   @param _links [Object]
+              end
+
+              class Contact < Amocrm::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer, nil]
+                optional :id, Integer
+
+                # @!attribute _links
+                #
+                #   @return [Object, nil]
+                optional :_links, Amocrm::Internal::Type::Unknown
+
+                # @!method initialize(id: nil, _links: nil)
+                #   @param id [Integer]
+                #   @param _links [Object]
+              end
+
+              class Customer < Amocrm::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer, nil]
+                optional :id, Integer
+
+                # @!attribute _links
+                #
+                #   @return [Object, nil]
+                optional :_links, Amocrm::Internal::Type::Unknown
+
+                # @!method initialize(id: nil, _links: nil)
+                #   @param id [Integer]
+                #   @param _links [Object]
+              end
+
+              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
+
+                # @!method initialize(id: nil, _links: nil)
+                #   @param id [Integer]
+                #   @param _links [Object]
+              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::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::CustomFieldsValue::Value>]
+              required :values,
+                       -> { Amocrm::Internal::Type::ArrayOf[Amocrm::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::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::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::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::Models::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::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::V4CompaniesListResponse::CompanyListResponse::Embedded::Company::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
+        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::V4CompaniesListResponse::CompanyListResponse, Amocrm::Models::V4CompaniesListResponse::Problem)]
+    end
+  end
+end

data/lib/amocrm/models/v4_companies_update_by_id_params.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::V4#companies_update_by_id
+    class V4CompaniesUpdateByIDParams < Amocrm::Internal::Type::BaseModel
+      extend Amocrm::Internal::Type::RequestParameters::Converter
+      include Amocrm::Internal::Type::RequestParameters
+
+      # @!attribute _embedded
+      #
+      #   @return [Amocrm::Models::V4CompaniesUpdateByIDParams::Embedded, nil]
+      optional :_embedded, -> { Amocrm::V4CompaniesUpdateByIDParams::Embedded }
+
+      # @!attribute created_at
+      #
+      #   @return [Integer, nil]
+      optional :created_at, Integer
+
+      # @!attribute created_by
+      #
+      #   @return [Integer, nil]
+      optional :created_by, Integer
+
+      # @!attribute custom_fields_values
+      #   Custom fields payload
+      #
+      #   @return [Array<Amocrm::Models::V4CompaniesUpdateByIDParams::CustomFieldsValue>, nil]
+      optional :custom_fields_values,
+               -> { Amocrm::Internal::Type::ArrayOf[Amocrm::V4CompaniesUpdateByIDParams::CustomFieldsValue] }
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute responsible_user_id
+      #
+      #   @return [Integer, nil]
+      optional :responsible_user_id, Integer
+
+      # @!attribute tags_to_add
+      #   Tags to attach
+      #
+      #   @return [Array<Amocrm::Models::V4CompaniesUpdateByIDParams::TagsToAdd>, nil]
+      optional :tags_to_add,
+               -> { Amocrm::Internal::Type::ArrayOf[Amocrm::V4CompaniesUpdateByIDParams::TagsToAdd] }
+
+      # @!attribute tags_to_delete
+      #   Tags to delete
+      #
+      #   @return [Array<Amocrm::Models::V4CompaniesUpdateByIDParams::TagsToDelete>, nil]
+      optional :tags_to_delete,
+               -> { Amocrm::Internal::Type::ArrayOf[Amocrm::V4CompaniesUpdateByIDParams::TagsToDelete] }
+
+      # @!attribute updated_at
+      #
+      #   @return [Integer, nil]
+      optional :updated_at, Integer
+
+      # @!attribute updated_by
+      #
+      #   @return [Integer, nil]
+      optional :updated_by, Integer
+
+      # @!method initialize(_embedded: nil, created_at: nil, created_by: nil, custom_fields_values: nil, name: nil, responsible_user_id: nil, tags_to_add: nil, tags_to_delete: nil, updated_at: nil, updated_by: nil, request_options: {})
+      #   @param _embedded [Amocrm::Models::V4CompaniesUpdateByIDParams::Embedded]
+      #
+      #   @param created_at [Integer]
+      #
+      #   @param created_by [Integer]
+      #
+      #   @param custom_fields_values [Array<Amocrm::Models::V4CompaniesUpdateByIDParams::CustomFieldsValue>] Custom fields payload
+      #
+      #   @param name [String]
+      #
+      #   @param responsible_user_id [Integer]
+      #
+      #   @param tags_to_add [Array<Amocrm::Models::V4CompaniesUpdateByIDParams::TagsToAdd>] Tags to attach
+      #
+      #   @param tags_to_delete [Array<Amocrm::Models::V4CompaniesUpdateByIDParams::TagsToDelete>] Tags to delete
+      #
+      #   @param updated_at [Integer]
+      #
+      #   @param updated_by [Integer]
+      #
+      #   @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}]
+
+      class Embedded < Amocrm::Internal::Type::BaseModel
+        # @!attribute tags
+        #
+        #   @return [Array<Amocrm::Models::V4CompaniesUpdateByIDParams::Embedded::Tag>, nil]
+        optional :tags,
+                 -> { Amocrm::Internal::Type::ArrayOf[Amocrm::V4CompaniesUpdateByIDParams::Embedded::Tag] },
+                 nil?: true
+
+        # @!method initialize(tags: nil)
+        #   @param tags [Array<Amocrm::Models::V4CompaniesUpdateByIDParams::Embedded::Tag>, nil]
+
+        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::V4CompaniesUpdateByIDParams::CustomFieldsValue::Value>]
+        required :values,
+                 -> { Amocrm::Internal::Type::ArrayOf[Amocrm::V4CompaniesUpdateByIDParams::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::V4CompaniesUpdateByIDParams::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::V4CompaniesUpdateByIDParams::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::V4CompaniesUpdateByIDParams::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