amocrm 0.6.1 → 0.6.2

data/rbi/amocrm/models/entity_notes_by_parent_list_by_parent_response.rbi

@@ -186,16 +186,29 @@ module Amocrm
             sig { params(is_pinned: T::Boolean).void }
             attr_writer :is_pinned
 
-            sig { returns(T.nilable(String)) }
+            sig { returns(T.nilable(Amocrm::NoteType::TaggedSymbol)) }
             attr_reader :note_type
 
-            sig { params(note_type: String).void }
+            sig { params(note_type: Amocrm::NoteType::OrSymbol).void }
             attr_writer :note_type
 
-            sig { returns(T.nilable(T.anything)) }
+            sig { returns(T.nilable(Amocrm::NoteParams::Variants)) }
             attr_reader :params
 
-            sig { params(params: T.anything).void }
+            sig do
+              params(
+                params:
+                  T.any(
+                    Amocrm::NoteParams::Common::OrHash,
+                    Amocrm::NoteParams::Call::OrHash,
+                    Amocrm::NoteParams::ServiceMessage::OrHash,
+                    Amocrm::NoteParams::MessageCashier::OrHash,
+                    Amocrm::NoteParams::Geolocation::OrHash,
+                    Amocrm::NoteParams::Sms::OrHash,
+                    Amocrm::NoteParams::Attachment::OrHash
+                  )
+              ).void
+            end
             attr_writer :params
 
             sig { returns(T.nilable(Integer)) }
@@ -226,8 +239,17 @@ module Amocrm
                 entity_id: Integer,
                 group_id: Integer,
                 is_pinned: T::Boolean,
-                note_type: String,
-                params: T.anything,
+                note_type: Amocrm::NoteType::OrSymbol,
+                params:
+                  T.any(
+                    Amocrm::NoteParams::Common::OrHash,
+                    Amocrm::NoteParams::Call::OrHash,
+                    Amocrm::NoteParams::ServiceMessage::OrHash,
+                    Amocrm::NoteParams::MessageCashier::OrHash,
+                    Amocrm::NoteParams::Geolocation::OrHash,
+                    Amocrm::NoteParams::Sms::OrHash,
+                    Amocrm::NoteParams::Attachment::OrHash
+                  ),
                 responsible_user_id: Integer,
                 updated_at: Integer,
                 updated_by: Integer
@@ -261,8 +283,17 @@ module Amocrm
                   entity_id: Integer,
                   group_id: Integer,
                   is_pinned: T::Boolean,
-                  note_type: String,
-                  params: T.anything,
+                  note_type: Amocrm::NoteType::OrSymbol,
+                  params:
+                    T.any(
+                      Amocrm::NoteParams::Common::OrHash,
+                      Amocrm::NoteParams::Call::OrHash,
+                      Amocrm::NoteParams::ServiceMessage::OrHash,
+                      Amocrm::NoteParams::MessageCashier::OrHash,
+                      Amocrm::NoteParams::Geolocation::OrHash,
+                      Amocrm::NoteParams::Sms::OrHash,
+                      Amocrm::NoteParams::Attachment::OrHash
+                    ),
                   responsible_user_id: Integer,
                   updated_at: Integer,
                   updated_by: Integer

data/rbi/amocrm/models/entity_notes_by_parent_update_by_parent_id_params.rbi

@@ -33,16 +33,29 @@ module Amocrm
       sig { params(body_entity_id: Integer).void }
       attr_writer :body_entity_id
 
-      sig { returns(T.nilable(String)) }
+      sig { returns(T.nilable(Amocrm::NoteType::OrSymbol)) }
       attr_reader :note_type
 
-      sig { params(note_type: String).void }
+      sig { params(note_type: Amocrm::NoteType::OrSymbol).void }
       attr_writer :note_type
 
-      sig { returns(T.nilable(T.anything)) }
+      sig { returns(T.nilable(Amocrm::NoteParams::Variants)) }
       attr_reader :params
 
-      sig { params(params: T.anything).void }
+      sig do
+        params(
+          params:
+            T.any(
+              Amocrm::NoteParams::Common::OrHash,
+              Amocrm::NoteParams::Call::OrHash,
+              Amocrm::NoteParams::ServiceMessage::OrHash,
+              Amocrm::NoteParams::MessageCashier::OrHash,
+              Amocrm::NoteParams::Geolocation::OrHash,
+              Amocrm::NoteParams::Sms::OrHash,
+              Amocrm::NoteParams::Attachment::OrHash
+            )
+        ).void
+      end
       attr_writer :params
 
       sig { returns(T.nilable(Integer)) }
@@ -64,8 +77,17 @@ module Amocrm
           path_entity_id: Integer,
           note_id: Integer,
           body_entity_id: Integer,
-          note_type: String,
-          params: T.anything,
+          note_type: Amocrm::NoteType::OrSymbol,
+          params:
+            T.any(
+              Amocrm::NoteParams::Common::OrHash,
+              Amocrm::NoteParams::Call::OrHash,
+              Amocrm::NoteParams::ServiceMessage::OrHash,
+              Amocrm::NoteParams::MessageCashier::OrHash,
+              Amocrm::NoteParams::Geolocation::OrHash,
+              Amocrm::NoteParams::Sms::OrHash,
+              Amocrm::NoteParams::Attachment::OrHash
+            ),
           updated_at: Integer,
           updated_by: Integer,
           request_options: Amocrm::RequestOptions::OrHash
@@ -92,8 +114,17 @@ module Amocrm
             path_entity_id: Integer,
             note_id: Integer,
             body_entity_id: Integer,
-            note_type: String,
-            params: T.anything,
+            note_type: Amocrm::NoteType::OrSymbol,
+            params:
+              T.any(
+                Amocrm::NoteParams::Common::OrHash,
+                Amocrm::NoteParams::Call::OrHash,
+                Amocrm::NoteParams::ServiceMessage::OrHash,
+                Amocrm::NoteParams::MessageCashier::OrHash,
+                Amocrm::NoteParams::Geolocation::OrHash,
+                Amocrm::NoteParams::Sms::OrHash,
+                Amocrm::NoteParams::Attachment::OrHash
+              ),
             updated_at: Integer,
             updated_by: Integer,
             request_options: Amocrm::RequestOptions

data/rbi/amocrm/models/entity_notes_by_parent_update_by_parent_params.rbi

@@ -122,16 +122,29 @@ module Amocrm
         sig { params(entity_id: Integer).void }
         attr_writer :entity_id
 
-        sig { returns(T.nilable(String)) }
+        sig { returns(T.nilable(Amocrm::NoteType::OrSymbol)) }
         attr_reader :note_type
 
-        sig { params(note_type: String).void }
+        sig { params(note_type: Amocrm::NoteType::OrSymbol).void }
         attr_writer :note_type
 
-        sig { returns(T.nilable(T.anything)) }
+        sig { returns(T.nilable(Amocrm::NoteParams::Variants)) }
         attr_reader :params
 
-        sig { params(params: T.anything).void }
+        sig do
+          params(
+            params:
+              T.any(
+                Amocrm::NoteParams::Common::OrHash,
+                Amocrm::NoteParams::Call::OrHash,
+                Amocrm::NoteParams::ServiceMessage::OrHash,
+                Amocrm::NoteParams::MessageCashier::OrHash,
+                Amocrm::NoteParams::Geolocation::OrHash,
+                Amocrm::NoteParams::Sms::OrHash,
+                Amocrm::NoteParams::Attachment::OrHash
+              )
+          ).void
+        end
         attr_writer :params
 
         sig { returns(T.nilable(Integer)) }
@@ -150,8 +163,17 @@ module Amocrm
           params(
             id: Integer,
             entity_id: Integer,
-            note_type: String,
-            params: T.anything,
+            note_type: Amocrm::NoteType::OrSymbol,
+            params:
+              T.any(
+                Amocrm::NoteParams::Common::OrHash,
+                Amocrm::NoteParams::Call::OrHash,
+                Amocrm::NoteParams::ServiceMessage::OrHash,
+                Amocrm::NoteParams::MessageCashier::OrHash,
+                Amocrm::NoteParams::Geolocation::OrHash,
+                Amocrm::NoteParams::Sms::OrHash,
+                Amocrm::NoteParams::Attachment::OrHash
+              ),
             updated_at: Integer,
             updated_by: Integer
           ).returns(T.attached_class)
@@ -172,8 +194,17 @@ module Amocrm
             {
               id: Integer,
               entity_id: Integer,
-              note_type: String,
-              params: T.anything,
+              note_type: Amocrm::NoteType::OrSymbol,
+              params:
+                T.any(
+                  Amocrm::NoteParams::Common::OrHash,
+                  Amocrm::NoteParams::Call::OrHash,
+                  Amocrm::NoteParams::ServiceMessage::OrHash,
+                  Amocrm::NoteParams::MessageCashier::OrHash,
+                  Amocrm::NoteParams::Geolocation::OrHash,
+                  Amocrm::NoteParams::Sms::OrHash,
+                  Amocrm::NoteParams::Attachment::OrHash
+                ),
               updated_at: Integer,
               updated_by: Integer
             }

data/rbi/amocrm/models/note_params.rbi

@@ -0,0 +1,374 @@
+# typed: strong
+
+module Amocrm
+  module Models
+    # Параметры примечания: состав зависит от его типа (`note_type`).
+    module NoteParams
+      extend Amocrm::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Amocrm::NoteParams::Call,
+            Amocrm::NoteParams::Geolocation,
+            Amocrm::NoteParams::Attachment,
+            Amocrm::NoteParams::MessageCashier,
+            Amocrm::NoteParams::ServiceMessage,
+            Amocrm::NoteParams::Sms,
+            Amocrm::NoteParams::Common
+          )
+        end
+
+      class Call < Amocrm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Amocrm::NoteParams::Call, Amocrm::Internal::AnyHash)
+          end
+
+        # Уникальный идентификатор звонка.
+        sig { returns(String) }
+        attr_accessor :uniq
+
+        # Длительность звонка в секундах.
+        sig { returns(Integer) }
+        attr_accessor :duration
+
+        # Источник звонка.
+        sig { returns(String) }
+        attr_accessor :source
+
+        # Ссылка на запись звонка.
+        sig { returns(String) }
+        attr_accessor :link
+
+        # Номер телефона.
+        sig { returns(String) }
+        attr_accessor :phone
+
+        # Ответственный за звонок: имя или ID пользователя.
+        sig { returns(Amocrm::NoteParams::Call::CallResponsible::Variants) }
+        attr_accessor :call_responsible
+
+        sig do
+          params(
+            uniq: String,
+            duration: Integer,
+            source: String,
+            link: String,
+            phone: String,
+            call_responsible:
+              Amocrm::NoteParams::Call::CallResponsible::Variants
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Уникальный идентификатор звонка.
+          uniq:,
+          # Длительность звонка в секундах.
+          duration:,
+          # Источник звонка.
+          source:,
+          # Ссылка на запись звонка.
+          link:,
+          # Номер телефона.
+          phone:,
+          # Ответственный за звонок: имя или ID пользователя.
+          call_responsible:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              uniq: String,
+              duration: Integer,
+              source: String,
+              link: String,
+              phone: String,
+              call_responsible:
+                Amocrm::NoteParams::Call::CallResponsible::Variants
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Ответственный за звонок: имя или ID пользователя.
+        module CallResponsible
+          extend Amocrm::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, Integer) }
+
+          sig do
+            override.returns(
+              T::Array[Amocrm::NoteParams::Call::CallResponsible::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+
+      class Geolocation < Amocrm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Amocrm::NoteParams::Geolocation, Amocrm::Internal::AnyHash)
+          end
+
+        # Текст примечания.
+        sig { returns(String) }
+        attr_accessor :text
+
+        # Адрес.
+        sig { returns(String) }
+        attr_accessor :address
+
+        # Долгота.
+        sig { returns(String) }
+        attr_accessor :longitude
+
+        # Широта.
+        sig { returns(String) }
+        attr_accessor :latitude
+
+        sig do
+          params(
+            text: String,
+            address: String,
+            longitude: String,
+            latitude: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Текст примечания.
+          text:,
+          # Адрес.
+          address:,
+          # Долгота.
+          longitude:,
+          # Широта.
+          latitude:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              text: String,
+              address: String,
+              longitude: String,
+              latitude: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Attachment < Amocrm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Amocrm::NoteParams::Attachment, Amocrm::Internal::AnyHash)
+          end
+
+        # UUID файла.
+        sig { returns(String) }
+        attr_accessor :file_uuid
+
+        # Название файла, которое отображается в примечании.
+        sig { returns(String) }
+        attr_accessor :file_name
+
+        # Версия файла; без неё берётся последняя.
+        sig { returns(T.nilable(String)) }
+        attr_reader :version_uuid
+
+        sig { params(version_uuid: String).void }
+        attr_writer :version_uuid
+
+        sig do
+          params(
+            file_uuid: String,
+            file_name: String,
+            version_uuid: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # UUID файла.
+          file_uuid:,
+          # Название файла, которое отображается в примечании.
+          file_name:,
+          # Версия файла; без неё берётся последняя.
+          version_uuid: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { file_uuid: String, file_name: String, version_uuid: String }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class MessageCashier < Amocrm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Amocrm::NoteParams::MessageCashier, Amocrm::Internal::AnyHash)
+          end
+
+        # Статус сообщения.
+        sig do
+          returns(Amocrm::NoteParams::MessageCashier::Status::TaggedSymbol)
+        end
+        attr_accessor :status
+
+        # Текст примечания.
+        sig { returns(String) }
+        attr_accessor :text
+
+        sig do
+          params(
+            status: Amocrm::NoteParams::MessageCashier::Status::OrSymbol,
+            text: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Статус сообщения.
+          status:,
+          # Текст примечания.
+          text:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              status: Amocrm::NoteParams::MessageCashier::Status::TaggedSymbol,
+              text: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Статус сообщения кассиру.
+        module Status
+          extend Amocrm::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Amocrm::NoteParams::MessageCashier::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREATED =
+            T.let(
+              :created,
+              Amocrm::NoteParams::MessageCashier::Status::TaggedSymbol
+            )
+          SHOWN =
+            T.let(
+              :shown,
+              Amocrm::NoteParams::MessageCashier::Status::TaggedSymbol
+            )
+          CANCELED =
+            T.let(
+              :canceled,
+              Amocrm::NoteParams::MessageCashier::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Amocrm::NoteParams::MessageCashier::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class ServiceMessage < Amocrm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Amocrm::NoteParams::ServiceMessage, Amocrm::Internal::AnyHash)
+          end
+
+        # Название сервиса.
+        sig { returns(String) }
+        attr_accessor :service
+
+        # Текст примечания.
+        sig { returns(String) }
+        attr_accessor :text
+
+        sig { params(service: String, text: String).returns(T.attached_class) }
+        def self.new(
+          # Название сервиса.
+          service:,
+          # Текст примечания.
+          text:
+        )
+        end
+
+        sig { override.returns({ service: String, text: String }) }
+        def to_hash
+        end
+      end
+
+      class Sms < Amocrm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Amocrm::NoteParams::Sms, Amocrm::Internal::AnyHash)
+          end
+
+        # Текст сообщения.
+        sig { returns(String) }
+        attr_accessor :text
+
+        # Номер телефона.
+        sig { returns(String) }
+        attr_accessor :phone
+
+        sig { params(text: String, phone: String).returns(T.attached_class) }
+        def self.new(
+          # Текст сообщения.
+          text:,
+          # Номер телефона.
+          phone:
+        )
+        end
+
+        sig { override.returns({ text: String, phone: String }) }
+        def to_hash
+        end
+      end
+
+      class Common < Amocrm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Amocrm::NoteParams::Common, Amocrm::Internal::AnyHash)
+          end
+
+        # Текст примечания.
+        sig { returns(String) }
+        attr_accessor :text
+
+        sig { params(text: String).returns(T.attached_class) }
+        def self.new(
+          # Текст примечания.
+          text:
+        )
+        end
+
+        sig { override.returns({ text: String }) }
+        def to_hash
+        end
+      end
+
+      sig { override.returns(T::Array[Amocrm::NoteParams::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/amocrm/models/note_type.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module Amocrm
+  module Models
+    # Тип примечания.
+    module NoteType
+      extend Amocrm::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Amocrm::NoteType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      COMMON = T.let(:common, Amocrm::NoteType::TaggedSymbol)
+      CALL_IN = T.let(:call_in, Amocrm::NoteType::TaggedSymbol)
+      CALL_OUT = T.let(:call_out, Amocrm::NoteType::TaggedSymbol)
+      SERVICE_MESSAGE = T.let(:service_message, Amocrm::NoteType::TaggedSymbol)
+      MESSAGE_CASHIER = T.let(:message_cashier, Amocrm::NoteType::TaggedSymbol)
+      GEOLOCATION = T.let(:geolocation, Amocrm::NoteType::TaggedSymbol)
+      SMS_IN = T.let(:sms_in, Amocrm::NoteType::TaggedSymbol)
+      SMS_OUT = T.let(:sms_out, Amocrm::NoteType::TaggedSymbol)
+      EXTENDED_SERVICE_MESSAGE =
+        T.let(:extended_service_message, Amocrm::NoteType::TaggedSymbol)
+      ATTACHMENT = T.let(:attachment, Amocrm::NoteType::TaggedSymbol)
+
+      sig { override.returns(T::Array[Amocrm::NoteType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/amocrm/models.rbi

@@ -190,6 +190,10 @@ module Amocrm
 
   LeadUpdateParams = Amocrm::Models::LeadUpdateParams
 
+  NoteParams = Amocrm::Models::NoteParams
+
+  NoteType = Amocrm::Models::NoteType
+
   PipelineCreateParams = Amocrm::Models::PipelineCreateParams
 
   PipelineDeleteByIDParams = Amocrm::Models::PipelineDeleteByIDParams

data/rbi/amocrm/resources/entity_notes.rbi

@@ -92,8 +92,17 @@ module Amocrm
           id: Integer,
           entity_type: Amocrm::EntityNoteUpdateByIDParams::EntityType::OrSymbol,
           entity_id: Integer,
-          note_type: String,
-          params: T.anything,
+          note_type: Amocrm::NoteType::OrSymbol,
+          params:
+            T.any(
+              Amocrm::NoteParams::Common::OrHash,
+              Amocrm::NoteParams::Call::OrHash,
+              Amocrm::NoteParams::ServiceMessage::OrHash,
+              Amocrm::NoteParams::MessageCashier::OrHash,
+              Amocrm::NoteParams::Geolocation::OrHash,
+              Amocrm::NoteParams::Sms::OrHash,
+              Amocrm::NoteParams::Attachment::OrHash
+            ),
           updated_at: Integer,
           updated_by: Integer,
           request_options: Amocrm::RequestOptions::OrHash

data/rbi/amocrm/resources/entity_notes_by_parent.rbi

@@ -117,8 +117,17 @@ module Amocrm
           entity_type:
             Amocrm::EntityNotesByParentUpdateByParentIDParams::EntityType::OrSymbol,
           body_entity_id: Integer,
-          note_type: String,
-          params: T.anything,
+          note_type: Amocrm::NoteType::OrSymbol,
+          params:
+            T.any(
+              Amocrm::NoteParams::Common::OrHash,
+              Amocrm::NoteParams::Call::OrHash,
+              Amocrm::NoteParams::ServiceMessage::OrHash,
+              Amocrm::NoteParams::MessageCashier::OrHash,
+              Amocrm::NoteParams::Geolocation::OrHash,
+              Amocrm::NoteParams::Sms::OrHash,
+              Amocrm::NoteParams::Attachment::OrHash
+            ),
           updated_at: Integer,
           updated_by: Integer,
           request_options: Amocrm::RequestOptions::OrHash