amocrm 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953688e737dbd47ad20302d617670f8e6e719896ebc97174d0d1e90388008fcd
-  data.tar.gz: 858c425ffcc05c3c2f61b75f4d0481fb0f3daa27461eb9b47ebccca47338a0d0
+  metadata.gz: f551215caefae3b529edfb52951947decfd86f55cb215d13dbab95c63e8b8237
+  data.tar.gz: 0aca7c2dc4dadeb3d9d714d45ca82fd0559e67e119be9454ce52211eed4bbb49
 SHA512:
-  metadata.gz: 9ade2d543faf32eef73ff10de52644776f4a01fff2ab270d2d8587dc38edc0421e5b9a48cae999b0ce340e0119272a448ef5b4298d22f873311162265a49476e
-  data.tar.gz: 751aed99a3da0659b98129161b649d5a76ec158a766b0a2e9eaed33a0242f6a72707c530683201c2d90b38382fcbe0aa5447033a177502db97ae3ce6ac9ad0b5
+  metadata.gz: 9383e015e32a4007fc1e3f7c8032bf76aec694d0d4f934c080eb96c6893c62f2d171f85a25cbcd273eb4e5f2cd8b7f70420c4200c76833c3ae9d1e26dd895df7
+  data.tar.gz: e772f3db93f83d5938743f589ff8d8649a73ea1771a773793165c472263b1340b15731c4a415649341e75bf15891b21ec70fcedc1ed6e70669c3d6b5300bc08f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.4.0 (2026-02-06)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/Hexlet/amocrm-ruby/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* **api:** api update ([4118f81](https://github.com/Hexlet/amocrm-ruby/commit/4118f81756e0b952424540319e78fe528882ecaa))
+
 ## 0.3.0 (2026-02-06)
 
 Full Changelog: [v0.2.0...v0.3.0](https://github.com/Hexlet/amocrm-ruby/compare/v0.2.0...v0.3.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "amocrm", "~> 0.3.0"
+gem "amocrm", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->
@@ -31,7 +31,7 @@ amocrm = Amocrm::Client.new(
   subdomain: "My-Subdomain"
 )
 
-response = amocrm.v4.leads.unsorted.create_forms(
+response = amocrm.v4.unsorted_leads_create_forms(
   body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}]
 )
 
@@ -44,7 +44,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  unsorted = amocrm.v4.leads.unsorted.create_forms(
+  v4 = amocrm.v4.unsorted_leads_create_forms(
     body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}]
   )
 rescue Amocrm::Errors::APIConnectionError => e
@@ -90,7 +90,7 @@ amocrm = Amocrm::Client.new(
 )
 
 # Or, configure per-request:
-amocrm.v4.leads.unsorted.create_forms(
+amocrm.v4.unsorted_leads_create_forms(
   body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}],
   request_options: {max_retries: 5}
 )
@@ -108,7 +108,7 @@ amocrm = Amocrm::Client.new(
 )
 
 # Or, configure per-request:
-amocrm.v4.leads.unsorted.create_forms(
+amocrm.v4.unsorted_leads_create_forms(
   body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}],
   request_options: {timeout: 5}
 )
@@ -142,7 +142,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 
 ```ruby
 response =
-  amocrm.v4.leads.unsorted.create_forms(
+  amocrm.v4.unsorted_leads_create_forms(
     body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}],
     request_options: {
       extra_query: {my_query_parameter: value},
@@ -189,10 +189,10 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-amocrm.v4.leads.unsorted.create_forms(
+amocrm.v4.unsorted_leads_create_forms(
   body: [
-    Amocrm::V4::Leads::UnsortedCreateFormsParams::Body.new(
-      metadata: Amocrm::V4::Leads::UnsortedCreateFormsParams::Body::Metadata.new,
+    Amocrm::V4UnsortedLeadsCreateFormsParams::Body.new(
+      metadata: Amocrm::V4UnsortedLeadsCreateFormsParams::Body::Metadata.new,
       source_name: "source_name",
       source_uid: "source_uid"
     )
@@ -204,21 +204,49 @@ Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-amocrm.v4.leads.unsorted.create_forms(
+amocrm.v4.unsorted_leads_create_forms(
   body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}]
 )
 
 # You can also splat a full Params class:
-params = Amocrm::V4::Leads::UnsortedCreateFormsParams.new(
+params = Amocrm::V4UnsortedLeadsCreateFormsParams.new(
   body: [
-    Amocrm::V4::Leads::UnsortedCreateFormsParams::Body.new(
-      metadata: Amocrm::V4::Leads::UnsortedCreateFormsParams::Body::Metadata.new,
+    Amocrm::V4UnsortedLeadsCreateFormsParams::Body.new(
+      metadata: Amocrm::V4UnsortedLeadsCreateFormsParams::Body::Metadata.new,
       source_name: "source_name",
       source_uid: "source_uid"
     )
   ]
 )
-amocrm.v4.leads.unsorted.create_forms(**params)
+amocrm.v4.unsorted_leads_create_forms(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :segments
+puts(Amocrm::V4CustomersModeSetModeParams::Mode::SEGMENTS)
+
+# Revealed type: `T.all(Amocrm::V4CustomersModeSetModeParams::Mode, Symbol)`
+T.reveal_type(Amocrm::V4CustomersModeSetModeParams::Mode::SEGMENTS)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+amocrm.v4.customers_mode_set_mode(
+  mode: Amocrm::V4CustomersModeSetModeParams::Mode::SEGMENTS,
+  # …
+)
+
+# Literal values are also permissible:
+amocrm.v4.customers_mode_set_mode(
+  mode: :segments,
+  # …
+)
 ```
 
 ## Versioning

data/lib/amocrm/client.rb

@@ -21,6 +21,9 @@ module Amocrm
     # @return [String]
     attr_reader :subdomain
 
+    # @return [Amocrm::Resources::V2]
+    attr_reader :v2
+
     # @return [Amocrm::Resources::V4]
     attr_reader :v4
 
@@ -78,6 +81,7 @@ module Amocrm
         max_retry_delay: max_retry_delay
       )
 
+      @v2 = Amocrm::Resources::V2.new(client: self)
       @v4 = Amocrm::Resources::V4.new(client: self)
     end
   end

data/lib/amocrm/internal/type/union.rb

@@ -6,14 +6,14 @@ module Amocrm
       # @api private
       #
       # @example
-      #   # `unsorted_accept_response` is a `Amocrm::Models::V4::Leads::UnsortedAcceptResponse`
-      #   case unsorted_accept_response
-      #   when Amocrm::Models::V4::Leads::UnsortedAcceptResponse::UnsortedAcceptResponse
-      #     puts(unsorted_accept_response._embedded)
-      #   when Amocrm::Models::V4::Leads::UnsortedAcceptResponse::Problem
-      #     puts(unsorted_accept_response.detail)
+      #   # `v2_salesbot_run_response` is a `Amocrm::Models::V2SalesbotRunResponse`
+      #   case v2_salesbot_run_response
+      #   when Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse
+      #     puts(v2_salesbot_run_response._links)
+      #   when Amocrm::Models::V2SalesbotRunResponse::Problem
+      #     puts(v2_salesbot_run_response.detail)
       #   else
-      #     puts(unsorted_accept_response)
+      #     puts(v2_salesbot_run_response)
       #   end
       module Union
         include Amocrm::Internal::Type::Converter

data/lib/amocrm/models/v2_salesbot_run_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::V2#salesbot_run
+    class V2SalesbotRunParams < Amocrm::Internal::Type::BaseModel
+      extend Amocrm::Internal::Type::RequestParameters::Converter
+      include Amocrm::Internal::Type::RequestParameters
+
+      # @!attribute body
+      #
+      #   @return [Array<Amocrm::Models::V2SalesbotRunParams::Body>]
+      required :body, -> { Amocrm::Internal::Type::ArrayOf[Amocrm::V2SalesbotRunParams::Body] }
+
+      # @!method initialize(body:, request_options: {})
+      #   @param body [Array<Amocrm::Models::V2SalesbotRunParams::Body>]
+      #   @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}]
+
+      class Body < Amocrm::Internal::Type::BaseModel
+        # @!attribute bot_id
+        #
+        #   @return [Integer]
+        required :bot_id, Integer
+
+        # @!attribute entity_id
+        #
+        #   @return [Integer]
+        required :entity_id, Integer
+
+        # @!attribute entity_type
+        #
+        #   @return [Integer]
+        required :entity_type, Integer
+
+        # @!method initialize(bot_id:, entity_id:, entity_type:)
+        #   @param bot_id [Integer]
+        #   @param entity_id [Integer]
+        #   @param entity_type [Integer]
+      end
+    end
+  end
+end

data/lib/amocrm/models/v2_salesbot_run_response.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::V2#salesbot_run
+    module V2SalesbotRunResponse
+      extend Amocrm::Internal::Type::Union
+
+      variant -> { Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse }
+
+      variant -> { Amocrm::Models::V2SalesbotRunResponse::Problem }
+
+      class SalesbotRunResponse < Amocrm::Internal::Type::BaseModel
+        # @!attribute _links
+        #
+        #   @return [Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse::Links, nil]
+        optional :_links, -> { Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse::Links }
+
+        # @!attribute success
+        #
+        #   @return [Boolean, nil]
+        optional :success, Amocrm::Internal::Type::Boolean
+
+        # @!method initialize(_links: nil, success: nil)
+        #   @param _links [Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse::Links]
+        #   @param success [Boolean]
+
+        # @see Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse#_links
+        class Links < Amocrm::Internal::Type::BaseModel
+          # @!attribute self_
+          #
+          #   @return [Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse::Links::Self, nil]
+          optional :self_,
+                   -> { Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse::Links::Self },
+                   api_name: :self
+
+          # @!method initialize(self_: nil)
+          #   @param self_ [Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse::Links::Self]
+
+          # @see Amocrm::Models::V2SalesbotRunResponse::SalesbotRunResponse::Links#self_
+          class Self < Amocrm::Internal::Type::BaseModel
+            # @!attribute href
+            #
+            #   @return [String, nil]
+            optional :href, String
+
+            # @!attribute method_
+            #
+            #   @return [String, nil]
+            optional :method_, String, api_name: :method
+
+            # @!method initialize(href: nil, method_: nil)
+            #   @param href [String]
+            #   @param method_ [String]
+          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::V2SalesbotRunResponse::SalesbotRunResponse, Amocrm::Models::V2SalesbotRunResponse::Problem)]
+    end
+  end
+end

data/lib/amocrm/models/v4_account_get_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::V4#account_get
+    class V4AccountGetParams < Amocrm::Internal::Type::BaseModel
+      extend Amocrm::Internal::Type::RequestParameters::Converter
+      include Amocrm::Internal::Type::RequestParameters
+
+      # @!attribute with
+      #   Additional data to include (comma-separated).
+      #
+      #   @return [String, nil]
+      optional :with, String
+
+      # @!method initialize(with: nil, request_options: {})
+      #   @param with [String] Additional data to include (comma-separated).
+      #
+      #   @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end