Merge pull request #6 from Hexlet/release-please--branches--main--changes--next

release: 0.2.0

Author: mokevnin

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.2"
+  ".": "0.2.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 3
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Famocrm-1e3996435299c13cb597cf42c7be5e8083535346edd559ce68ab44beb754751a.yml
-openapi_spec_hash: ec32cbb57936365b46a2daf7626590d5
-config_hash: e01761a134b02efe7127582e0ad9cc0d
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Famocrm-800f4ed7083bc38fd4ddc3fdb0b975c2ad3f95b7e0375ff64d31690a3a0d5d34.yml
+openapi_spec_hash: ee149ec82a8a54b8ba43f99fa8a53004
+config_hash: 217a521823c76d5a758440ebbe1fbf4b

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.0 (2026-02-06)
+
+Full Changelog: [v0.1.2...v0.2.0](https://github.com/Hexlet/amocrm-ruby/compare/v0.1.2...v0.2.0)
+
+### Features
+
+* **api:** api update ([c47313c](https://github.com/Hexlet/amocrm-ruby/commit/c47313c8d4d72d7fa64f8ae3492f1474287132e6))
+
 ## 0.1.2 (2026-02-04)
 
 Full Changelog: [v0.1.1...v0.1.2](https://github.com/Hexlet/amocrm-ruby/compare/v0.1.1...v0.1.2)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    amocrm (0.1.2)
+    amocrm (0.2.0)
       cgi
       connection_pool
 

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.1.2"
+gem "amocrm", "~> 0.2.0"
 ```
 
 <!-- x-release-please-end -->
@@ -26,7 +26,7 @@ gem "amocrm", "~> 0.1.2"
 require "bundler/setup"
 require "amocrm"
 
-amocrm = Amocrm::Client.new(api_key: "My API Key")
+amocrm = Amocrm::Client.new(token: "My Token", subdomain: "My-Subdomain")
 
 response = amocrm.v4.leads.unsorted.create_forms(
   body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}]
@@ -83,7 +83,8 @@ You can use the `max_retries` option to configure or disable this:
 # Configure the default for all requests:
 amocrm = Amocrm::Client.new(
   max_retries: 0, # default is 2
-  api_key: "My API Key"
+  token: "My Token",
+  subdomain: "My-Subdomain"
 )
 
 # Or, configure per-request:
@@ -101,7 +102,8 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 # Configure the default for all requests:
 amocrm = Amocrm::Client.new(
   timeout: nil, # default is 60
-  api_key: "My API Key"
+  token: "My Token",
+  subdomain: "My-Subdomain"
 )
 
 # Or, configure per-request:

lib/amocrm/client.rb

@@ -16,14 +16,19 @@ class Client < Amocrm::Internal::Transport::BaseClient
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
     # @return [String]
-    attr_reader :api_key
+    attr_reader :token
+
+    # @return [String]
+    attr_reader :subdomain
 
     # @return [Amocrm::Resources::V4]
     attr_reader :v4
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param api_key [String, nil] Defaults to `ENV["AMOCRM_API_KEY"]`
+    # @param token [String, nil] Defaults to `ENV["AMOCRM_AUTH_TOKEN"]`
+    #
+    # @param subdomain [String, nil] Defaults to `ENV["AMOCRM_SUBDOMAIN"]`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["AMOCRM_BASE_URL"]`
@@ -36,20 +41,25 @@ class Client < Amocrm::Internal::Transport::BaseClient
     #
     # @param max_retry_delay [Float]
     def initialize(
-      api_key: ENV["AMOCRM_API_KEY"],
+      token: ENV["AMOCRM_AUTH_TOKEN"],
+      subdomain: ENV["AMOCRM_SUBDOMAIN"],
       base_url: ENV["AMOCRM_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
-      base_url ||= "https://{subdomain}.amocrm.ru"
+      base_url ||= "https://#{subdomain}.amocrm.ru"
 
-      if api_key.nil?
-        raise ArgumentError.new("api_key is required, and can be set via environ: \"AMOCRM_API_KEY\"")
+      if token.nil?
+        raise ArgumentError.new("token is required, and can be set via environ: \"AMOCRM_AUTH_TOKEN\"")
+      end
+      if subdomain.nil?
+        raise ArgumentError.new("subdomain is required, and can be set via environ: \"AMOCRM_SUBDOMAIN\"")
       end
 
-      @api_key = api_key.to_s
+      @token = token.to_s
+      @subdomain = subdomain.to_s
 
       super(
         base_url: base_url,

lib/amocrm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Amocrm
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

rbi/amocrm/client.rbi

@@ -11,15 +11,19 @@ module Amocrm
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
     sig { returns(String) }
-    attr_reader :api_key
+    attr_reader :token
+
+    sig { returns(String) }
+    attr_reader :subdomain
 
     sig { returns(Amocrm::Resources::V4) }
     attr_reader :v4
 
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
-        api_key: T.nilable(String),
+        token: T.nilable(String),
+        subdomain: T.nilable(String),
         base_url: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
@@ -28,8 +32,10 @@ module Amocrm
       ).returns(T.attached_class)
     end
     def self.new(
-      # Defaults to `ENV["AMOCRM_API_KEY"]`
-      api_key: ENV["AMOCRM_API_KEY"],
+      # Defaults to `ENV["AMOCRM_AUTH_TOKEN"]`
+      token: ENV["AMOCRM_AUTH_TOKEN"],
+      # Defaults to `ENV["AMOCRM_SUBDOMAIN"]`
+      subdomain: ENV["AMOCRM_SUBDOMAIN"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["AMOCRM_BASE_URL"]`
       base_url: ENV["AMOCRM_BASE_URL"],

sig/amocrm/client.rbs

@@ -8,12 +8,15 @@ module Amocrm
 
     DEFAULT_MAX_RETRY_DELAY: Float
 
-    attr_reader api_key: String
+    attr_reader token: String
+
+    attr_reader subdomain: String
 
     attr_reader v4: Amocrm::Resources::V4
 
     def initialize: (
-      ?api_key: String?,
+      ?token: String?,
+      ?subdomain: String?,
       ?base_url: String?,
       ?max_retries: Integer,
       ?timeout: Float,

test/amocrm/client_test.rb

@@ -37,7 +37,7 @@ def test_raises_on_missing_non_nullable_opts
   def test_client_default_request_default_retry_attempts
     stub_request(:post, "http://localhost/api/v4/leads/unsorted/forms").to_return_json(status: 500, body: {})
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -51,7 +51,13 @@ def test_client_default_request_default_retry_attempts
   def test_client_given_request_default_retry_attempts
     stub_request(:post, "http://localhost/api/v4/leads/unsorted/forms").to_return_json(status: 500, body: {})
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 3)
+    amocrm =
+      Amocrm::Client.new(
+        base_url: "http://localhost",
+        token: "My Token",
+        subdomain: "My-Subdomain",
+        max_retries: 3
+      )
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -65,7 +71,7 @@ def test_client_given_request_default_retry_attempts
   def test_client_default_request_given_retry_attempts
     stub_request(:post, "http://localhost/api/v4/leads/unsorted/forms").to_return_json(status: 500, body: {})
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -80,7 +86,13 @@ def test_client_default_request_given_retry_attempts
   def test_client_given_request_given_retry_attempts
     stub_request(:post, "http://localhost/api/v4/leads/unsorted/forms").to_return_json(status: 500, body: {})
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 3)
+    amocrm =
+      Amocrm::Client.new(
+        base_url: "http://localhost",
+        token: "My Token",
+        subdomain: "My-Subdomain",
+        max_retries: 3
+      )
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -99,7 +111,13 @@ def test_client_retry_after_seconds
       body: {}
     )
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1)
+    amocrm =
+      Amocrm::Client.new(
+        base_url: "http://localhost",
+        token: "My Token",
+        subdomain: "My-Subdomain",
+        max_retries: 1
+      )
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -118,7 +136,13 @@ def test_client_retry_after_date
       body: {}
     )
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1)
+    amocrm =
+      Amocrm::Client.new(
+        base_url: "http://localhost",
+        token: "My Token",
+        subdomain: "My-Subdomain",
+        max_retries: 1
+      )
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       Thread.current.thread_variable_set(:time_now, Time.now)
@@ -139,7 +163,13 @@ def test_client_retry_after_ms
       body: {}
     )
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1)
+    amocrm =
+      Amocrm::Client.new(
+        base_url: "http://localhost",
+        token: "My Token",
+        subdomain: "My-Subdomain",
+        max_retries: 1
+      )
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -154,7 +184,7 @@ def test_client_retry_after_ms
   def test_retry_count_header
     stub_request(:post, "http://localhost/api/v4/leads/unsorted/forms").to_return_json(status: 500, body: {})
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -170,7 +200,7 @@ def test_retry_count_header
   def test_omit_retry_count_header
     stub_request(:post, "http://localhost/api/v4/leads/unsorted/forms").to_return_json(status: 500, body: {})
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -187,7 +217,7 @@ def test_omit_retry_count_header
   def test_overwrite_retry_count_header
     stub_request(:post, "http://localhost/api/v4/leads/unsorted/forms").to_return_json(status: 500, body: {})
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::InternalServerError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -210,7 +240,7 @@ def test_client_redirect_307
       headers: {"location" => "/redirected"}
     )
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::APIConnectionError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -242,7 +272,7 @@ def test_client_redirect_303
       headers: {"location" => "/redirected"}
     )
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::APIConnectionError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -269,7 +299,7 @@ def test_client_redirect_auth_keep_same_origin
       headers: {"location" => "/redirected"}
     )
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::APIConnectionError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -299,7 +329,7 @@ def test_client_redirect_auth_strip_cross_origin
       headers: {"location" => "https://example.com/redirected"}
     )
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     assert_raises(Amocrm::Errors::APIConnectionError) do
       amocrm.v4.leads.unsorted.create_forms(
@@ -317,7 +347,7 @@ def test_client_redirect_auth_strip_cross_origin
   def test_default_headers
     stub_request(:post, "http://localhost/api/v4/leads/unsorted/forms").to_return_json(status: 200, body: {})
 
-    amocrm = Amocrm::Client.new(base_url: "http://localhost", api_key: "My API Key")
+    amocrm = Amocrm::Client.new(base_url: "http://localhost", token: "My Token", subdomain: "My-Subdomain")
 
     amocrm.v4.leads.unsorted.create_forms(
       body: [{metadata: {}, source_name: "source_name", source_uid: "source_uid"}]