amocrm 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953688e737dbd47ad20302d617670f8e6e719896ebc97174d0d1e90388008fcd
-  data.tar.gz: 858c425ffcc05c3c2f61b75f4d0481fb0f3daa27461eb9b47ebccca47338a0d0
+  metadata.gz: de81b8e9eea16505e62605261294414cfeaa34a64c106fb7b32e8ed7440c86f7
+  data.tar.gz: 1e3c5480c2421d6fd2a64b1cd86c961bd483ecb7b7d958f4b8a41d676d195467
 SHA512:
-  metadata.gz: 9ade2d543faf32eef73ff10de52644776f4a01fff2ab270d2d8587dc38edc0421e5b9a48cae999b0ce340e0119272a448ef5b4298d22f873311162265a49476e
-  data.tar.gz: 751aed99a3da0659b98129161b649d5a76ec158a766b0a2e9eaed33a0242f6a72707c530683201c2d90b38382fcbe0aa5447033a177502db97ae3ce6ac9ad0b5
+  metadata.gz: d93f496737acc252f1abc66a149628830023bade36389bf68c93cb6523ecc4e95c72912c33314365bf200376256bcbdf99e6db2a160a9b9ea62da223c38d5918
+  data.tar.gz: caed3f26edffb1727290ca3421975633a424b1872e865934e819871c6087eb77dd2ceb3d5ddae4155ee77cbd1b9cd00b77b66196e2f0206e8b2fcde2ced8a588

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.5.0 (2026-02-06)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/Hexlet/amocrm-ruby/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** api update ([394a28c](https://github.com/Hexlet/amocrm-ruby/commit/394a28c2bc632950ccdfd8d7a2ca0fef58549f24))
+* **api:** api update ([735e1d4](https://github.com/Hexlet/amocrm-ruby/commit/735e1d40cd345fd9c29c368a965d312c7b7870e3))
+
+## 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.5.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.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(
+  unsorted_lead = amocrm.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.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.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.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.unsorted_leads.create_forms(
   body: [
-    Amocrm::V4::Leads::UnsortedCreateFormsParams::Body.new(
-      metadata: Amocrm::V4::Leads::UnsortedCreateFormsParams::Body::Metadata.new,
+    Amocrm::UnsortedLeadCreateFormsParams::Body.new(
+      metadata: Amocrm::UnsortedLeadCreateFormsParams::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.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::UnsortedLeadCreateFormsParams.new(
   body: [
-    Amocrm::V4::Leads::UnsortedCreateFormsParams::Body.new(
-      metadata: Amocrm::V4::Leads::UnsortedCreateFormsParams::Body::Metadata.new,
+    Amocrm::UnsortedLeadCreateFormsParams::Body.new(
+      metadata: Amocrm::UnsortedLeadCreateFormsParams::Body::Metadata.new,
       source_name: "source_name",
       source_uid: "source_uid"
     )
   ]
 )
-amocrm.v4.leads.unsorted.create_forms(**params)
+amocrm.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::CustomersModeSetModeParams::Mode::SEGMENTS)
+
+# Revealed type: `T.all(Amocrm::CustomersModeSetModeParams::Mode, Symbol)`
+T.reveal_type(Amocrm::CustomersModeSetModeParams::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.customers_mode.set_mode(
+  mode: Amocrm::CustomersModeSetModeParams::Mode::SEGMENTS,
+  # …
+)
+
+# Literal values are also permissible:
+amocrm.customers_mode.set_mode(
+  mode: :segments,
+  # …
+)
 ```
 
 ## Versioning

data/lib/amocrm/client.rb

@@ -21,8 +21,113 @@ module Amocrm
     # @return [String]
     attr_reader :subdomain
 
-    # @return [Amocrm::Resources::V4]
-    attr_reader :v4
+    # @return [Amocrm::Resources::Account]
+    attr_reader :account
+
+    # @return [Amocrm::Resources::Calls]
+    attr_reader :calls
+
+    # @return [Amocrm::Resources::CatalogElements]
+    attr_reader :catalog_elements
+
+    # @return [Amocrm::Resources::Catalogs]
+    attr_reader :catalogs
+
+    # @return [Amocrm::Resources::Companies]
+    attr_reader :companies
+
+    # @return [Amocrm::Resources::ContactChats]
+    attr_reader :contact_chats
+
+    # @return [Amocrm::Resources::Contacts]
+    attr_reader :contacts
+
+    # @return [Amocrm::Resources::CustomFieldGroups]
+    attr_reader :custom_field_groups
+
+    # @return [Amocrm::Resources::CustomFields]
+    attr_reader :custom_fields
+
+    # @return [Amocrm::Resources::CustomerBonusPoints]
+    attr_reader :customer_bonus_points
+
+    # @return [Amocrm::Resources::CustomerSegments]
+    attr_reader :customer_segments
+
+    # @return [Amocrm::Resources::CustomerStatuses]
+    attr_reader :customer_statuses
+
+    # @return [Amocrm::Resources::CustomerTransactions]
+    attr_reader :customer_transactions
+
+    # @return [Amocrm::Resources::Customers]
+    attr_reader :customers
+
+    # @return [Amocrm::Resources::CustomersMode]
+    attr_reader :customers_mode
+
+    # @return [Amocrm::Resources::EntityFollowers]
+    attr_reader :entity_followers
+
+    # @return [Amocrm::Resources::EntityLinks]
+    attr_reader :entity_links
+
+    # @return [Amocrm::Resources::EntityNotes]
+    attr_reader :entity_notes
+
+    # @return [Amocrm::Resources::EntityNotesByParent]
+    attr_reader :entity_notes_by_parent
+
+    # @return [Amocrm::Resources::Events]
+    attr_reader :events
+
+    # @return [Amocrm::Resources::Leads]
+    attr_reader :leads
+
+    # @return [Amocrm::Resources::PipelineStatuses]
+    attr_reader :pipeline_statuses
+
+    # @return [Amocrm::Resources::Pipelines]
+    attr_reader :pipelines
+
+    # @return [Amocrm::Resources::Roles]
+    attr_reader :roles
+
+    # @return [Amocrm::Resources::Salesbot]
+    attr_reader :salesbot
+
+    # @return [Amocrm::Resources::ShortLinks]
+    attr_reader :short_links
+
+    # @return [Amocrm::Resources::Sources]
+    attr_reader :sources
+
+    # @return [Amocrm::Resources::Tags]
+    attr_reader :tags
+
+    # @return [Amocrm::Resources::Talks]
+    attr_reader :talks
+
+    # @return [Amocrm::Resources::Tasks]
+    attr_reader :tasks
+
+    # @return [Amocrm::Resources::UnsortedLeads]
+    attr_reader :unsorted_leads
+
+    # @return [Amocrm::Resources::Users]
+    attr_reader :users
+
+    # @return [Amocrm::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # @return [Amocrm::Resources::WebsiteButtons]
+    attr_reader :website_buttons
+
+    # @return [Amocrm::Resources::WidgetBotContinue]
+    attr_reader :widget_bot_continue
+
+    # @return [Amocrm::Resources::Widgets]
+    attr_reader :widgets
 
     # @api private
     #
@@ -78,7 +183,42 @@ module Amocrm
         max_retry_delay: max_retry_delay
       )
 
-      @v4 = Amocrm::Resources::V4.new(client: self)
+      @account = Amocrm::Resources::Account.new(client: self)
+      @calls = Amocrm::Resources::Calls.new(client: self)
+      @catalog_elements = Amocrm::Resources::CatalogElements.new(client: self)
+      @catalogs = Amocrm::Resources::Catalogs.new(client: self)
+      @companies = Amocrm::Resources::Companies.new(client: self)
+      @contact_chats = Amocrm::Resources::ContactChats.new(client: self)
+      @contacts = Amocrm::Resources::Contacts.new(client: self)
+      @custom_field_groups = Amocrm::Resources::CustomFieldGroups.new(client: self)
+      @custom_fields = Amocrm::Resources::CustomFields.new(client: self)
+      @customer_bonus_points = Amocrm::Resources::CustomerBonusPoints.new(client: self)
+      @customer_segments = Amocrm::Resources::CustomerSegments.new(client: self)
+      @customer_statuses = Amocrm::Resources::CustomerStatuses.new(client: self)
+      @customer_transactions = Amocrm::Resources::CustomerTransactions.new(client: self)
+      @customers = Amocrm::Resources::Customers.new(client: self)
+      @customers_mode = Amocrm::Resources::CustomersMode.new(client: self)
+      @entity_followers = Amocrm::Resources::EntityFollowers.new(client: self)
+      @entity_links = Amocrm::Resources::EntityLinks.new(client: self)
+      @entity_notes = Amocrm::Resources::EntityNotes.new(client: self)
+      @entity_notes_by_parent = Amocrm::Resources::EntityNotesByParent.new(client: self)
+      @events = Amocrm::Resources::Events.new(client: self)
+      @leads = Amocrm::Resources::Leads.new(client: self)
+      @pipeline_statuses = Amocrm::Resources::PipelineStatuses.new(client: self)
+      @pipelines = Amocrm::Resources::Pipelines.new(client: self)
+      @roles = Amocrm::Resources::Roles.new(client: self)
+      @salesbot = Amocrm::Resources::Salesbot.new(client: self)
+      @short_links = Amocrm::Resources::ShortLinks.new(client: self)
+      @sources = Amocrm::Resources::Sources.new(client: self)
+      @tags = Amocrm::Resources::Tags.new(client: self)
+      @talks = Amocrm::Resources::Talks.new(client: self)
+      @tasks = Amocrm::Resources::Tasks.new(client: self)
+      @unsorted_leads = Amocrm::Resources::UnsortedLeads.new(client: self)
+      @users = Amocrm::Resources::Users.new(client: self)
+      @webhooks = Amocrm::Resources::Webhooks.new(client: self)
+      @website_buttons = Amocrm::Resources::WebsiteButtons.new(client: self)
+      @widget_bot_continue = Amocrm::Resources::WidgetBotContinue.new(client: self)
+      @widgets = Amocrm::Resources::Widgets.new(client: self)
     end
   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)
+      #   # `account_get_response` is a `Amocrm::Models::AccountGetResponse`
+      #   case account_get_response
+      #   when Amocrm::Models::AccountGetResponse::AccountInfo
+      #     puts(account_get_response.id)
+      #   when Amocrm::Models::AccountGetResponse::Problem
+      #     puts(account_get_response.detail)
       #   else
-      #     puts(unsorted_accept_response)
+      #     puts(account_get_response)
       #   end
       module Union
         include Amocrm::Internal::Type::Converter

data/lib/amocrm/models/account_get_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Models
+    # @see Amocrm::Resources::Account#get
+    class AccountGetParams < 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