amocrm 0.3.0 → 0.5.0

data/rbi/amocrm/models.rbi

@@ -1,5 +1,305 @@
 # typed: strong
 
 module Amocrm
-  V4 = Amocrm::Models::V4
+  AccountGetParams = Amocrm::Models::AccountGetParams
+
+  CallCreateParams = Amocrm::Models::CallCreateParams
+
+  CatalogCreateParams = Amocrm::Models::CatalogCreateParams
+
+  CatalogElementCreateParams = Amocrm::Models::CatalogElementCreateParams
+
+  CatalogElementGetByIDParams = Amocrm::Models::CatalogElementGetByIDParams
+
+  CatalogElementListParams = Amocrm::Models::CatalogElementListParams
+
+  CatalogElementUpdateByIDParams =
+    Amocrm::Models::CatalogElementUpdateByIDParams
+
+  CatalogElementUpdateParams = Amocrm::Models::CatalogElementUpdateParams
+
+  CatalogGetByIDParams = Amocrm::Models::CatalogGetByIDParams
+
+  CatalogListParams = Amocrm::Models::CatalogListParams
+
+  CatalogUpdateByIDParams = Amocrm::Models::CatalogUpdateByIDParams
+
+  CatalogUpdateParams = Amocrm::Models::CatalogUpdateParams
+
+  CompanyCreateParams = Amocrm::Models::CompanyCreateParams
+
+  CompanyGetByIDParams = Amocrm::Models::CompanyGetByIDParams
+
+  CompanyListParams = Amocrm::Models::CompanyListParams
+
+  CompanyUpdateByIDParams = Amocrm::Models::CompanyUpdateByIDParams
+
+  CompanyUpdateParams = Amocrm::Models::CompanyUpdateParams
+
+  ContactChatLinkParams = Amocrm::Models::ContactChatLinkParams
+
+  ContactChatListParams = Amocrm::Models::ContactChatListParams
+
+  ContactCreateParams = Amocrm::Models::ContactCreateParams
+
+  ContactGetByIDParams = Amocrm::Models::ContactGetByIDParams
+
+  ContactListParams = Amocrm::Models::ContactListParams
+
+  ContactUpdateByIDParams = Amocrm::Models::ContactUpdateByIDParams
+
+  ContactUpdateParams = Amocrm::Models::ContactUpdateParams
+
+  CustomerBonusPointChangeParams =
+    Amocrm::Models::CustomerBonusPointChangeParams
+
+  CustomerCreateParams = Amocrm::Models::CustomerCreateParams
+
+  CustomerGetByIDParams = Amocrm::Models::CustomerGetByIDParams
+
+  CustomerListParams = Amocrm::Models::CustomerListParams
+
+  CustomerSegmentCreateParams = Amocrm::Models::CustomerSegmentCreateParams
+
+  CustomerSegmentDeleteByIDParams =
+    Amocrm::Models::CustomerSegmentDeleteByIDParams
+
+  CustomerSegmentGetByIDParams = Amocrm::Models::CustomerSegmentGetByIDParams
+
+  CustomerSegmentListParams = Amocrm::Models::CustomerSegmentListParams
+
+  CustomerSegmentUpdateByIDParams =
+    Amocrm::Models::CustomerSegmentUpdateByIDParams
+
+  CustomersModeSetModeParams = Amocrm::Models::CustomersModeSetModeParams
+
+  CustomerStatusCreateParams = Amocrm::Models::CustomerStatusCreateParams
+
+  CustomerStatusDeleteByIDParams =
+    Amocrm::Models::CustomerStatusDeleteByIDParams
+
+  CustomerStatusGetByIDParams = Amocrm::Models::CustomerStatusGetByIDParams
+
+  CustomerStatusListParams = Amocrm::Models::CustomerStatusListParams
+
+  CustomerStatusUpdateByIDParams =
+    Amocrm::Models::CustomerStatusUpdateByIDParams
+
+  CustomerTransactionCreateParams =
+    Amocrm::Models::CustomerTransactionCreateParams
+
+  CustomerTransactionDeleteByIDParams =
+    Amocrm::Models::CustomerTransactionDeleteByIDParams
+
+  CustomerTransactionListByCustomerParams =
+    Amocrm::Models::CustomerTransactionListByCustomerParams
+
+  CustomerTransactionListParams = Amocrm::Models::CustomerTransactionListParams
+
+  CustomerUpdateByIDParams = Amocrm::Models::CustomerUpdateByIDParams
+
+  CustomerUpdateParams = Amocrm::Models::CustomerUpdateParams
+
+  CustomFieldCreateParams = Amocrm::Models::CustomFieldCreateParams
+
+  CustomFieldDeleteByIDParams = Amocrm::Models::CustomFieldDeleteByIDParams
+
+  CustomFieldGetByIDParams = Amocrm::Models::CustomFieldGetByIDParams
+
+  CustomFieldGroupCreateParams = Amocrm::Models::CustomFieldGroupCreateParams
+
+  CustomFieldGroupDeleteByIDParams =
+    Amocrm::Models::CustomFieldGroupDeleteByIDParams
+
+  CustomFieldGroupGetByIDParams = Amocrm::Models::CustomFieldGroupGetByIDParams
+
+  CustomFieldGroupListParams = Amocrm::Models::CustomFieldGroupListParams
+
+  CustomFieldGroupUpdateByIDParams =
+    Amocrm::Models::CustomFieldGroupUpdateByIDParams
+
+  CustomFieldListParams = Amocrm::Models::CustomFieldListParams
+
+  CustomFieldUpdateByIDParams = Amocrm::Models::CustomFieldUpdateByIDParams
+
+  CustomFieldUpdateParams = Amocrm::Models::CustomFieldUpdateParams
+
+  EntityFollowerAddParams = Amocrm::Models::EntityFollowerAddParams
+
+  EntityFollowerListParams = Amocrm::Models::EntityFollowerListParams
+
+  EntityFollowerRemoveParams = Amocrm::Models::EntityFollowerRemoveParams
+
+  EntityLinkLinkByEntityParams = Amocrm::Models::EntityLinkLinkByEntityParams
+
+  EntityLinkLinkParams = Amocrm::Models::EntityLinkLinkParams
+
+  EntityLinkListByEntityParams = Amocrm::Models::EntityLinkListByEntityParams
+
+  EntityLinkListParams = Amocrm::Models::EntityLinkListParams
+
+  EntityLinkUnlinkByEntityParams =
+    Amocrm::Models::EntityLinkUnlinkByEntityParams
+
+  EntityLinkUnlinkParams = Amocrm::Models::EntityLinkUnlinkParams
+
+  EntityNoteCreateParams = Amocrm::Models::EntityNoteCreateParams
+
+  EntityNoteGetByIDParams = Amocrm::Models::EntityNoteGetByIDParams
+
+  EntityNoteListParams = Amocrm::Models::EntityNoteListParams
+
+  EntityNotePinParams = Amocrm::Models::EntityNotePinParams
+
+  EntityNotesByParentCreateByParentParams =
+    Amocrm::Models::EntityNotesByParentCreateByParentParams
+
+  EntityNotesByParentGetByParentIDParams =
+    Amocrm::Models::EntityNotesByParentGetByParentIDParams
+
+  EntityNotesByParentListByParentParams =
+    Amocrm::Models::EntityNotesByParentListByParentParams
+
+  EntityNotesByParentUpdateByParentIDParams =
+    Amocrm::Models::EntityNotesByParentUpdateByParentIDParams
+
+  EntityNotesByParentUpdateByParentParams =
+    Amocrm::Models::EntityNotesByParentUpdateByParentParams
+
+  EntityNoteUnpinParams = Amocrm::Models::EntityNoteUnpinParams
+
+  EntityNoteUpdateByIDParams = Amocrm::Models::EntityNoteUpdateByIDParams
+
+  EntityNoteUpdateParams = Amocrm::Models::EntityNoteUpdateParams
+
+  EventGetByIDParams = Amocrm::Models::EventGetByIDParams
+
+  EventListParams = Amocrm::Models::EventListParams
+
+  EventListTypesParams = Amocrm::Models::EventListTypesParams
+
+  LeadCreateComplexParams = Amocrm::Models::LeadCreateComplexParams
+
+  LeadCreateParams = Amocrm::Models::LeadCreateParams
+
+  LeadGetByIDParams = Amocrm::Models::LeadGetByIDParams
+
+  LeadListParams = Amocrm::Models::LeadListParams
+
+  LeadUpdateByIDParams = Amocrm::Models::LeadUpdateByIDParams
+
+  LeadUpdateParams = Amocrm::Models::LeadUpdateParams
+
+  PipelineCreateParams = Amocrm::Models::PipelineCreateParams
+
+  PipelineDeleteByIDParams = Amocrm::Models::PipelineDeleteByIDParams
+
+  PipelineGetByIDParams = Amocrm::Models::PipelineGetByIDParams
+
+  PipelineListParams = Amocrm::Models::PipelineListParams
+
+  PipelineStatusCreateParams = Amocrm::Models::PipelineStatusCreateParams
+
+  PipelineStatusDeleteByIDParams =
+    Amocrm::Models::PipelineStatusDeleteByIDParams
+
+  PipelineStatusGetByIDParams = Amocrm::Models::PipelineStatusGetByIDParams
+
+  PipelineStatusListParams = Amocrm::Models::PipelineStatusListParams
+
+  PipelineStatusUpdateByIDParams =
+    Amocrm::Models::PipelineStatusUpdateByIDParams
+
+  PipelineStatusUpdateParams = Amocrm::Models::PipelineStatusUpdateParams
+
+  PipelineUpdateByIDParams = Amocrm::Models::PipelineUpdateByIDParams
+
+  PipelineUpdateParams = Amocrm::Models::PipelineUpdateParams
+
+  RoleCreateParams = Amocrm::Models::RoleCreateParams
+
+  RoleDeleteByIDParams = Amocrm::Models::RoleDeleteByIDParams
+
+  RoleGetByIDParams = Amocrm::Models::RoleGetByIDParams
+
+  RoleListParams = Amocrm::Models::RoleListParams
+
+  RoleUpdateByIDParams = Amocrm::Models::RoleUpdateByIDParams
+
+  SalesbotRunParams = Amocrm::Models::SalesbotRunParams
+
+  ShortLinkCreateParams = Amocrm::Models::ShortLinkCreateParams
+
+  SourceCreateParams = Amocrm::Models::SourceCreateParams
+
+  SourceDeleteByIDParams = Amocrm::Models::SourceDeleteByIDParams
+
+  SourceDeleteParams = Amocrm::Models::SourceDeleteParams
+
+  SourceGetByIDParams = Amocrm::Models::SourceGetByIDParams
+
+  SourceListParams = Amocrm::Models::SourceListParams
+
+  SourceUpdateByIDParams = Amocrm::Models::SourceUpdateByIDParams
+
+  SourceUpdateParams = Amocrm::Models::SourceUpdateParams
+
+  TagCreateParams = Amocrm::Models::TagCreateParams
+
+  TagListParams = Amocrm::Models::TagListParams
+
+  TalkCloseParams = Amocrm::Models::TalkCloseParams
+
+  TalkGetByIDParams = Amocrm::Models::TalkGetByIDParams
+
+  TaskCreateParams = Amocrm::Models::TaskCreateParams
+
+  TaskGetByIDParams = Amocrm::Models::TaskGetByIDParams
+
+  TaskListParams = Amocrm::Models::TaskListParams
+
+  TaskUpdateByIDParams = Amocrm::Models::TaskUpdateByIDParams
+
+  TaskUpdateParams = Amocrm::Models::TaskUpdateParams
+
+  UnsortedLeadAcceptParams = Amocrm::Models::UnsortedLeadAcceptParams
+
+  UnsortedLeadCreateFormsParams = Amocrm::Models::UnsortedLeadCreateFormsParams
+
+  UnsortedLeadDeclineParams = Amocrm::Models::UnsortedLeadDeclineParams
+
+  UserCreateParams = Amocrm::Models::UserCreateParams
+
+  UserGetByIDParams = Amocrm::Models::UserGetByIDParams
+
+  UserListParams = Amocrm::Models::UserListParams
+
+  WebhookListParams = Amocrm::Models::WebhookListParams
+
+  WebhookSubscribeParams = Amocrm::Models::WebhookSubscribeParams
+
+  WebhookUnsubscribeParams = Amocrm::Models::WebhookUnsubscribeParams
+
+  WebsiteButtonConnectOnlineChatParams =
+    Amocrm::Models::WebsiteButtonConnectOnlineChatParams
+
+  WebsiteButtonCreateParams = Amocrm::Models::WebsiteButtonCreateParams
+
+  WebsiteButtonGetBySourceIDParams =
+    Amocrm::Models::WebsiteButtonGetBySourceIDParams
+
+  WebsiteButtonListParams = Amocrm::Models::WebsiteButtonListParams
+
+  WebsiteButtonUpdateParams = Amocrm::Models::WebsiteButtonUpdateParams
+
+  WidgetBotContinueContinueParams =
+    Amocrm::Models::WidgetBotContinueContinueParams
+
+  WidgetGetByCodeParams = Amocrm::Models::WidgetGetByCodeParams
+
+  WidgetInstallParams = Amocrm::Models::WidgetInstallParams
+
+  WidgetListParams = Amocrm::Models::WidgetListParams
+
+  WidgetUninstallParams = Amocrm::Models::WidgetUninstallParams
 end

data/rbi/amocrm/resources/account.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Amocrm
+  module Resources
+    class Account
+      # Get account info.
+      sig do
+        params(
+          with: String,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::AccountGetResponse::Variants)
+      end
+      def get(
+        # Additional data to include (comma-separated).
+        with: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Amocrm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/amocrm/resources/calls.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Amocrm
+  module Resources
+    class Calls
+      # Add calls (batch).
+      sig do
+        params(
+          body: T::Array[Amocrm::CallCreateParams::Body::OrHash],
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CallCreateResponse::Variants)
+      end
+      def create(body:, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Amocrm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/amocrm/resources/catalog_elements.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module Amocrm
+  module Resources
+    class CatalogElements
+      # Create catalog elements.
+      sig do
+        params(
+          catalog_id: Integer,
+          body: T::Array[Amocrm::CatalogElementCreateParams::Body::OrHash],
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogElementCreateResponse::Variants)
+      end
+      def create(catalog_id, body:, request_options: {})
+      end
+
+      # Update catalog elements (batch).
+      sig do
+        params(
+          catalog_id: Integer,
+          body: T::Array[Amocrm::CatalogElementUpdateParams::Body::OrHash],
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogElementUpdateResponse::Variants)
+      end
+      def update(catalog_id, body:, request_options: {})
+      end
+
+      # Get catalog elements list.
+      sig do
+        params(
+          catalog_id: Integer,
+          filter: T.anything,
+          limit: Integer,
+          page: Integer,
+          query: Amocrm::CatalogElementListParams::Query::Variants,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogElementListResponse::Variants)
+      end
+      def list(
+        catalog_id,
+        filter: nil,
+        limit: nil,
+        page: nil,
+        query: nil,
+        request_options: {}
+      )
+      end
+
+      # Get catalog element by id.
+      sig do
+        params(
+          id: Integer,
+          catalog_id: Integer,
+          with: String,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogElementGetByIDResponse::Variants)
+      end
+      def get_by_id(
+        # Path param
+        id,
+        # Path param
+        catalog_id:,
+        # Query param: Additional data to include (comma-separated).
+        with: nil,
+        request_options: {}
+      )
+      end
+
+      # Update catalog element by id.
+      sig do
+        params(
+          id: Integer,
+          catalog_id: Integer,
+          custom_fields_values:
+            T::Array[
+              Amocrm::CatalogElementUpdateByIDParams::CustomFieldsValue::OrHash
+            ],
+          name: String,
+          request_id: String,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogElementUpdateByIDResponse::Variants)
+      end
+      def update_by_id(
+        # Path param
+        id,
+        # Path param
+        catalog_id:,
+        # Body param
+        custom_fields_values: nil,
+        # Body param
+        name: nil,
+        # Body param
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Amocrm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/amocrm/resources/catalogs.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Amocrm
+  module Resources
+    class Catalogs
+      # Create catalogs.
+      sig do
+        params(
+          body: T::Array[Amocrm::CatalogCreateParams::Body::OrHash],
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogCreateResponse::Variants)
+      end
+      def create(body:, request_options: {})
+      end
+
+      # Update catalogs (batch).
+      sig do
+        params(
+          body: T::Array[Amocrm::CatalogUpdateParams::Body::OrHash],
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogUpdateResponse::Variants)
+      end
+      def update(body:, request_options: {})
+      end
+
+      # Get catalogs list.
+      sig do
+        params(
+          limit: Integer,
+          page: Integer,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogListResponse::Variants)
+      end
+      def list(limit: nil, page: nil, request_options: {})
+      end
+
+      # Get catalog by id.
+      sig do
+        params(
+          id: Integer,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogGetByIDResponse::Variants)
+      end
+      def get_by_id(id, request_options: {})
+      end
+
+      # Update catalog by id.
+      sig do
+        params(
+          id: Integer,
+          can_add_elements: T::Boolean,
+          can_link_multiple: T::Boolean,
+          name: String,
+          request_id: String,
+          sort: Integer,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CatalogUpdateByIDResponse::Variants)
+      end
+      def update_by_id(
+        id,
+        can_add_elements: nil,
+        can_link_multiple: nil,
+        name: nil,
+        request_id: nil,
+        sort: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Amocrm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/amocrm/resources/companies.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module Amocrm
+  module Resources
+    class Companies
+      # Create companies.
+      sig do
+        params(
+          body: T::Array[Amocrm::CompanyCreateParams::Body::OrHash],
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CompanyCreateResponse::Variants)
+      end
+      def create(body:, request_options: {})
+      end
+
+      # Update companies (batch).
+      sig do
+        params(
+          body: T::Array[Amocrm::CompanyUpdateParams::Body::OrHash],
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CompanyUpdateResponse::Variants)
+      end
+      def update(body:, request_options: {})
+      end
+
+      # Get a list of companies (pagination, sorting, filtering).
+      sig do
+        params(
+          filter: T.anything,
+          limit: Integer,
+          order: T.anything,
+          page: Integer,
+          query: Amocrm::CompanyListParams::Query::Variants,
+          with: String,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CompanyListResponse::Variants)
+      end
+      def list(
+        # Filtering parameters
+        filter: nil,
+        # Pagination limit
+        limit: nil,
+        # Sorting, e.g. order[updated_at]=asc
+        order: nil,
+        # Pagination page
+        page: nil,
+        # Search by query string or id
+        query: nil,
+        # Expand related entities; comma-separated values
+        with: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a company by id.
+      sig do
+        params(
+          id: Integer,
+          with: String,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CompanyGetByIDResponse::Variants)
+      end
+      def get_by_id(
+        id,
+        # Expand related entities; comma-separated values
+        with: nil,
+        request_options: {}
+      )
+      end
+
+      # Update a company by id.
+      sig do
+        params(
+          id: Integer,
+          _embedded: Amocrm::CompanyUpdateByIDParams::Embedded::OrHash,
+          created_at: Integer,
+          created_by: Integer,
+          custom_fields_values:
+            T::Array[
+              Amocrm::CompanyUpdateByIDParams::CustomFieldsValue::OrHash
+            ],
+          name: String,
+          responsible_user_id: Integer,
+          tags_to_add:
+            T::Array[Amocrm::CompanyUpdateByIDParams::TagsToAdd::OrHash],
+          tags_to_delete:
+            T::Array[Amocrm::CompanyUpdateByIDParams::TagsToDelete::OrHash],
+          updated_at: Integer,
+          updated_by: Integer,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::CompanyUpdateByIDResponse::Variants)
+      end
+      def update_by_id(
+        id,
+        _embedded: nil,
+        created_at: nil,
+        created_by: nil,
+        # Custom fields payload
+        custom_fields_values: nil,
+        name: nil,
+        responsible_user_id: nil,
+        # Tags to attach
+        tags_to_add: nil,
+        # Tags to delete
+        tags_to_delete: nil,
+        updated_at: nil,
+        updated_by: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Amocrm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/amocrm/resources/contact_chats.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Amocrm
+  module Resources
+    class ContactChats
+      # Get list of linked chats.
+      sig do
+        params(
+          filter: T.anything,
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::ContactChatListResponse::Variants)
+      end
+      def list(filter: nil, request_options: {})
+      end
+
+      # Link chats to contacts.
+      sig do
+        params(
+          body: T::Array[Amocrm::ContactChatLinkParams::Body::OrHash],
+          request_options: Amocrm::RequestOptions::OrHash
+        ).returns(Amocrm::Models::ContactChatLinkResponse::Variants)
+      end
+      def link(body:, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: Amocrm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end