amocrm 0.3.0 → 0.5.0

data/lib/amocrm/resources/entity_notes_by_parent.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Resources
+    class EntityNotesByParent
+      # Create notes for a specific entity.
+      #
+      # @overload create_by_parent(entity_id, entity_type:, body:, request_options: {})
+      #
+      # @param entity_id [Integer] Path param
+      #
+      # @param entity_type [Symbol, Amocrm::Models::EntityNotesByParentCreateByParentParams::EntityType] Path param
+      #
+      # @param body [Array<Amocrm::Models::EntityNotesByParentCreateByParentParams::Body>] Body param
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::EntityNotesByParentCreateByParentResponse::NoteCreateResponse, Amocrm::Models::EntityNotesByParentCreateByParentResponse::Problem]
+      #
+      # @see Amocrm::Models::EntityNotesByParentCreateByParentParams
+      def create_by_parent(entity_id, params)
+        parsed, options = Amocrm::EntityNotesByParentCreateByParentParams.dump_request(params)
+        entity_type =
+          parsed.delete(:entity_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :post,
+          path: ["api/v4/%1$s/%2$s/notes", entity_type, entity_id],
+          body: parsed[:body],
+          model: Amocrm::Models::EntityNotesByParentCreateByParentResponse,
+          options: options
+        )
+      end
+
+      # Get note by id for a specific entity.
+      #
+      # @overload get_by_parent_id(note_id, entity_type:, entity_id:, with: nil, request_options: {})
+      #
+      # @param note_id [Integer] Path param
+      #
+      # @param entity_type [Symbol, Amocrm::Models::EntityNotesByParentGetByParentIDParams::EntityType] Path param
+      #
+      # @param entity_id [Integer] Path param
+      #
+      # @param with [String] Query param
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::EntityNotesByParentGetByParentIDResponse::Note, Amocrm::Models::EntityNotesByParentGetByParentIDResponse::Problem]
+      #
+      # @see Amocrm::Models::EntityNotesByParentGetByParentIDParams
+      def get_by_parent_id(note_id, params)
+        parsed, options = Amocrm::EntityNotesByParentGetByParentIDParams.dump_request(params)
+        entity_type =
+          parsed.delete(:entity_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        entity_id =
+          parsed.delete(:entity_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["api/v4/%1$s/%2$s/notes/%3$s", entity_type, entity_id, note_id],
+          query: parsed,
+          model: Amocrm::Models::EntityNotesByParentGetByParentIDResponse,
+          options: options
+        )
+      end
+
+      # Get notes list for a specific entity.
+      #
+      # @overload list_by_parent(entity_id, entity_type:, filter: nil, limit: nil, page: nil, request_options: {})
+      #
+      # @param entity_id [Integer] Path param
+      #
+      # @param entity_type [Symbol, Amocrm::Models::EntityNotesByParentListByParentParams::EntityType] Path param
+      #
+      # @param filter [Object] Query param
+      #
+      # @param limit [Integer] Query param
+      #
+      # @param page [Integer] Query param
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::EntityNotesByParentListByParentResponse::NoteListResponse, Amocrm::Models::EntityNotesByParentListByParentResponse::Problem]
+      #
+      # @see Amocrm::Models::EntityNotesByParentListByParentParams
+      def list_by_parent(entity_id, params)
+        parsed, options = Amocrm::EntityNotesByParentListByParentParams.dump_request(params)
+        entity_type =
+          parsed.delete(:entity_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["api/v4/%1$s/%2$s/notes", entity_type, entity_id],
+          query: parsed,
+          model: Amocrm::Models::EntityNotesByParentListByParentResponse,
+          options: options
+        )
+      end
+
+      # Update notes for a specific entity (batch).
+      #
+      # @overload update_by_parent(entity_id, entity_type:, body:, request_options: {})
+      #
+      # @param entity_id [Integer] Path param
+      #
+      # @param entity_type [Symbol, Amocrm::Models::EntityNotesByParentUpdateByParentParams::EntityType] Path param
+      #
+      # @param body [Array<Amocrm::Models::EntityNotesByParentUpdateByParentParams::Body>] Body param
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::EntityNotesByParentUpdateByParentResponse::NoteCreateResponse, Amocrm::Models::EntityNotesByParentUpdateByParentResponse::Problem]
+      #
+      # @see Amocrm::Models::EntityNotesByParentUpdateByParentParams
+      def update_by_parent(entity_id, params)
+        parsed, options = Amocrm::EntityNotesByParentUpdateByParentParams.dump_request(params)
+        entity_type =
+          parsed.delete(:entity_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :patch,
+          path: ["api/v4/%1$s/%2$s/notes", entity_type, entity_id],
+          body: parsed[:body],
+          model: Amocrm::Models::EntityNotesByParentUpdateByParentResponse,
+          options: options
+        )
+      end
+
+      # Update note by id for a specific entity.
+      #
+      # @overload update_by_parent_id(note_id, entity_type:, body_entity_id: nil, note_type: nil, params: nil, updated_at: nil, updated_by: nil, request_options: {})
+      #
+      # @param note_id [Integer] Path param
+      #
+      # @param entity_type [Symbol, Amocrm::Models::EntityNotesByParentUpdateByParentIDParams::EntityType] Path param
+      #
+      # @param body_entity_id [Integer] Body param
+      #
+      # @param note_type [String] Body param
+      #
+      # @param params [Object] Body param
+      #
+      # @param updated_at [Integer] Body param
+      #
+      # @param updated_by [Integer] Body param
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::EntityNotesByParentUpdateByParentIDResponse::NoteCreateResponse, Amocrm::Models::EntityNotesByParentUpdateByParentIDResponse::Problem]
+      #
+      # @see Amocrm::Models::EntityNotesByParentUpdateByParentIDParams
+      def update_by_parent_id(note_id, params)
+        parsed, options = Amocrm::EntityNotesByParentUpdateByParentIDParams.dump_request(params)
+        entity_type =
+          parsed.delete(:entity_type) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        path_entity_id =
+          parsed.delete(:path_entity_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :patch,
+          path: ["api/v4/%1$s/%2$s/notes/%3$s", entity_type, path_entity_id, note_id],
+          body: parsed,
+          model: Amocrm::Models::EntityNotesByParentUpdateByParentIDResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Amocrm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/amocrm/resources/events.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Resources
+    class Events
+      # Get events list.
+      #
+      # @overload list(filter: nil, limit: nil, page: nil, with: nil, request_options: {})
+      #
+      # @param filter [Object]
+      # @param limit [Integer]
+      # @param page [Integer]
+      # @param with [String]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::EventListResponse::EventListResponse, Amocrm::Models::EventListResponse::Problem]
+      #
+      # @see Amocrm::Models::EventListParams
+      def list(params = {})
+        parsed, options = Amocrm::EventListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/v4/events",
+          query: parsed,
+          model: Amocrm::Models::EventListResponse,
+          options: options
+        )
+      end
+
+      # Get event by id.
+      #
+      # @overload get_by_id(id, with: nil, request_options: {})
+      #
+      # @param id [Integer]
+      # @param with [String]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::EventGetByIDResponse::Event, Amocrm::Models::EventGetByIDResponse::Problem]
+      #
+      # @see Amocrm::Models::EventGetByIDParams
+      def get_by_id(id, params = {})
+        parsed, options = Amocrm::EventGetByIDParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/v4/events/%1$s", id],
+          query: parsed,
+          model: Amocrm::Models::EventGetByIDResponse,
+          options: options
+        )
+      end
+
+      # Get event types.
+      #
+      # @overload list_types(language_code: nil, request_options: {})
+      #
+      # @param language_code [String]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::EventListTypesResponse::EventTypesResponse, Amocrm::Models::EventListTypesResponse::Problem]
+      #
+      # @see Amocrm::Models::EventListTypesParams
+      def list_types(params = {})
+        parsed, options = Amocrm::EventListTypesParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/v4/events/types",
+          query: parsed,
+          model: Amocrm::Models::EventListTypesResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Amocrm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/amocrm/resources/leads.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Resources
+    class Leads
+      # Create leads.
+      #
+      # @overload create(body:, request_options: {})
+      #
+      # @param body [Array<Amocrm::Models::LeadCreateParams::Body>]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::LeadCreateResponse::LeadCreateResponse, Amocrm::Models::LeadCreateResponse::Problem]
+      #
+      # @see Amocrm::Models::LeadCreateParams
+      def create(params)
+        parsed, options = Amocrm::LeadCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/v4/leads",
+          body: parsed[:body],
+          model: Amocrm::Models::LeadCreateResponse,
+          options: options
+        )
+      end
+
+      # Update leads (batch).
+      #
+      # @overload update(body:, request_options: {})
+      #
+      # @param body [Array<Amocrm::Models::LeadUpdateParams::Body>]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::LeadUpdateResponse::LeadUpdateResponse, Amocrm::Models::LeadUpdateResponse::Problem]
+      #
+      # @see Amocrm::Models::LeadUpdateParams
+      def update(params)
+        parsed, options = Amocrm::LeadUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: "api/v4/leads",
+          body: parsed[:body],
+          model: Amocrm::Models::LeadUpdateResponse,
+          options: options
+        )
+      end
+
+      # Get a list of leads (pagination, sorting, filtering).
+      #
+      # @overload list(filter: nil, limit: nil, order: nil, page: nil, query: nil, with: nil, request_options: {})
+      #
+      # @param filter [Object] Filtering parameters, see filters API
+      #
+      # @param limit [Integer] Pagination limit
+      #
+      # @param order [Object] Sorting, e.g. order[updated_at]=asc
+      #
+      # @param page [Integer] Pagination page
+      #
+      # @param query [String, Integer] Search by query string or id
+      #
+      # @param with [String] Expand related entities; comma-separated values
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::LeadListResponse::LeadListResponse, Amocrm::Models::LeadListResponse::Problem]
+      #
+      # @see Amocrm::Models::LeadListParams
+      def list(params = {})
+        parsed, options = Amocrm::LeadListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/v4/leads",
+          query: parsed,
+          model: Amocrm::Models::LeadListResponse,
+          options: options
+        )
+      end
+
+      # Create leads using the complex method (supports unsorted metadata).
+      #
+      # @overload create_complex(body:, request_options: {})
+      #
+      # @param body [Array<Amocrm::Models::LeadCreateComplexParams::Body>]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::LeadCreateComplexResponse::LeadComplexCreateResponse, Amocrm::Models::LeadCreateComplexResponse::Problem]
+      #
+      # @see Amocrm::Models::LeadCreateComplexParams
+      def create_complex(params)
+        parsed, options = Amocrm::LeadCreateComplexParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/v4/leads/complex",
+          body: parsed[:body],
+          model: Amocrm::Models::LeadCreateComplexResponse,
+          options: options
+        )
+      end
+
+      # Get a lead by id.
+      #
+      # @overload get_by_id(id, with: nil, request_options: {})
+      #
+      # @param id [Integer]
+      #
+      # @param with [String] Expand related entities; comma-separated values
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::LeadGetByIDResponse::Lead, Amocrm::Models::LeadGetByIDResponse::Problem]
+      #
+      # @see Amocrm::Models::LeadGetByIDParams
+      def get_by_id(id, params = {})
+        parsed, options = Amocrm::LeadGetByIDParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/v4/leads/%1$s", id],
+          query: parsed,
+          model: Amocrm::Models::LeadGetByIDResponse,
+          options: options
+        )
+      end
+
+      # Update a lead by id.
+      #
+      # @overload update_by_id(id, _embedded: nil, closed_at: nil, custom_fields_values: nil, group_id: nil, loss_reason_id: nil, name: nil, pipeline_id: nil, price: nil, responsible_user_id: nil, status_id: nil, tags_to_add: nil, tags_to_delete: nil, updated_at: nil, request_options: {})
+      #
+      # @param id [Integer]
+      #
+      # @param _embedded [Amocrm::Models::LeadUpdateByIDParams::Embedded]
+      #
+      # @param closed_at [Integer]
+      #
+      # @param custom_fields_values [Array<Amocrm::Models::LeadUpdateByIDParams::CustomFieldsValue>] Custom fields payload
+      #
+      # @param group_id [Integer]
+      #
+      # @param loss_reason_id [Integer]
+      #
+      # @param name [String]
+      #
+      # @param pipeline_id [Integer]
+      #
+      # @param price [Integer]
+      #
+      # @param responsible_user_id [Integer]
+      #
+      # @param status_id [Integer]
+      #
+      # @param tags_to_add [Array<Amocrm::Models::LeadUpdateByIDParams::TagsToAdd>] Tags to attach
+      #
+      # @param tags_to_delete [Array<Amocrm::Models::LeadUpdateByIDParams::TagsToDelete>] Tags to delete
+      #
+      # @param updated_at [Integer]
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::LeadUpdateByIDResponse::LeadUpdateResponse, Amocrm::Models::LeadUpdateByIDResponse::Problem]
+      #
+      # @see Amocrm::Models::LeadUpdateByIDParams
+      def update_by_id(id, params = {})
+        parsed, options = Amocrm::LeadUpdateByIDParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/v4/leads/%1$s", id],
+          body: parsed,
+          model: Amocrm::Models::LeadUpdateByIDResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Amocrm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/amocrm/resources/pipeline_statuses.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module Amocrm
+  module Resources
+    class PipelineStatuses
+      # Create statuses.
+      #
+      # @overload create(pipeline_id, body:, request_options: {})
+      #
+      # @param pipeline_id [Integer]
+      # @param body [Array<Amocrm::Models::PipelineStatusCreateParams::Body>]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::PipelineStatusCreateResponse::StatusCreateResponse, Amocrm::Models::PipelineStatusCreateResponse::Problem]
+      #
+      # @see Amocrm::Models::PipelineStatusCreateParams
+      def create(pipeline_id, params)
+        parsed, options = Amocrm::PipelineStatusCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["api/v4/leads/pipelines/%1$s/statuses", pipeline_id],
+          body: parsed[:body],
+          model: Amocrm::Models::PipelineStatusCreateResponse,
+          options: options
+        )
+      end
+
+      # Update statuses (batch).
+      #
+      # @overload update(pipeline_id, body:, request_options: {})
+      #
+      # @param pipeline_id [Integer]
+      # @param body [Array<Amocrm::Models::PipelineStatusUpdateParams::Body>]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::PipelineStatusUpdateResponse::StatusUpdateResponse, Amocrm::Models::PipelineStatusUpdateResponse::Problem]
+      #
+      # @see Amocrm::Models::PipelineStatusUpdateParams
+      def update(pipeline_id, params)
+        parsed, options = Amocrm::PipelineStatusUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/v4/leads/pipelines/%1$s/statuses", pipeline_id],
+          body: parsed[:body],
+          model: Amocrm::Models::PipelineStatusUpdateResponse,
+          options: options
+        )
+      end
+
+      # Get statuses for a pipeline.
+      #
+      # @overload list(pipeline_id, with: nil, request_options: {})
+      #
+      # @param pipeline_id [Integer]
+      #
+      # @param with [String] Expand related entities; comma-separated values (e.g. descriptions).
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::PipelineStatusListResponse::StatusListResponse, Amocrm::Models::PipelineStatusListResponse::Problem]
+      #
+      # @see Amocrm::Models::PipelineStatusListParams
+      def list(pipeline_id, params = {})
+        parsed, options = Amocrm::PipelineStatusListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["api/v4/leads/pipelines/%1$s/statuses", pipeline_id],
+          query: parsed,
+          model: Amocrm::Models::PipelineStatusListResponse,
+          options: options
+        )
+      end
+
+      # Delete status by id.
+      #
+      # @overload delete_by_id(id, pipeline_id:, request_options: {})
+      #
+      # @param id [Integer]
+      # @param pipeline_id [Integer]
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::PipelineStatusDeleteByIDResponse::EmptyResponse, Amocrm::Models::PipelineStatusDeleteByIDResponse::Problem]
+      #
+      # @see Amocrm::Models::PipelineStatusDeleteByIDParams
+      def delete_by_id(id, params)
+        parsed, options = Amocrm::PipelineStatusDeleteByIDParams.dump_request(params)
+        pipeline_id =
+          parsed.delete(:pipeline_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :delete,
+          path: ["api/v4/leads/pipelines/%1$s/statuses/%2$s", pipeline_id, id],
+          model: Amocrm::Models::PipelineStatusDeleteByIDResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Amocrm::Models::PipelineStatusGetByIDParams} for more details.
+      #
+      # Get status by id.
+      #
+      # @overload get_by_id(id, pipeline_id:, with: nil, request_options: {})
+      #
+      # @param id [Integer] Path param
+      #
+      # @param pipeline_id [Integer] Path param
+      #
+      # @param with [String] Query param: Expand related entities; comma-separated values (e.g. descriptions)
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::PipelineStatusGetByIDResponse::Status, Amocrm::Models::PipelineStatusGetByIDResponse::Problem]
+      #
+      # @see Amocrm::Models::PipelineStatusGetByIDParams
+      def get_by_id(id, params)
+        parsed, options = Amocrm::PipelineStatusGetByIDParams.dump_request(params)
+        pipeline_id =
+          parsed.delete(:pipeline_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["api/v4/leads/pipelines/%1$s/statuses/%2$s", pipeline_id, id],
+          query: parsed,
+          model: Amocrm::Models::PipelineStatusGetByIDResponse,
+          options: options
+        )
+      end
+
+      # Update status by id.
+      #
+      # @overload update_by_id(id, pipeline_id:, color: nil, descriptions: nil, name: nil, request_id: nil, sort: nil, request_options: {})
+      #
+      # @param id [Integer] Path param
+      #
+      # @param pipeline_id [Integer] Path param
+      #
+      # @param color [String] Body param
+      #
+      # @param descriptions [Array<Amocrm::Models::PipelineStatusUpdateByIDParams::Description>] Body param
+      #
+      # @param name [String] Body param
+      #
+      # @param request_id [String] Body param
+      #
+      # @param sort [Integer] Body param
+      #
+      # @param request_options [Amocrm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Amocrm::Models::PipelineStatusUpdateByIDResponse::StatusUpdateResponse, Amocrm::Models::PipelineStatusUpdateByIDResponse::Problem]
+      #
+      # @see Amocrm::Models::PipelineStatusUpdateByIDParams
+      def update_by_id(id, params)
+        parsed, options = Amocrm::PipelineStatusUpdateByIDParams.dump_request(params)
+        pipeline_id =
+          parsed.delete(:pipeline_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :patch,
+          path: ["api/v4/leads/pipelines/%1$s/statuses/%2$s", pipeline_id, id],
+          body: parsed,
+          model: Amocrm::Models::PipelineStatusUpdateByIDResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Amocrm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end