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

release: 0.4.0

Author: mokevnin

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.3.0"
+  ".": "0.4.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 3
+configured_endpoints: 140
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Famocrm-800f4ed7083bc38fd4ddc3fdb0b975c2ad3f95b7e0375ff64d31690a3a0d5d34.yml
 openapi_spec_hash: ee149ec82a8a54b8ba43f99fa8a53004
-config_hash: 31bb2daea76b891764ca31487bec6963
+config_hash: 653370ad5156cb2a5058450bd7897496

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)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    amocrm (0.3.0)
+    amocrm (0.4.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.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