pipedrive-openapi-client 1.0.0

data/spec/api/files_api_spec.rb

@@ -0,0 +1,148 @@
+=begin
+#Pipedrive API v1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Pipedrive::FilesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FilesApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::FilesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FilesApi' do
+    it 'should create an instance of FilesApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::FilesApi)
+    end
+  end
+
+  # unit tests for files_get
+  # Get all files
+  # Returns data about all files.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @option opts [NumberBoolean] :include_deleted_files When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.
+  # @option opts [String] :sort Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.
+  # @return [GetAllFiles]
+  describe 'files_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for files_id_delete
+  # Delete a file
+  # Marks a file as deleted.
+  # @param id ID of the file
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteFile]
+  describe 'files_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for files_id_download_get
+  # Download one file
+  # Initializes a file download.
+  # @param id ID of the file
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'files_id_download_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for files_id_get
+  # Get one file
+  # Returns data about a specific file.
+  # @param id ID of the file
+  # @param [Hash] opts the optional parameters
+  # @return [GetOneFile]
+  describe 'files_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for files_id_put
+  # Update file details
+  # Updates the properties of a file.
+  # @param id ID of the file
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name Visible name of the file
+  # @option opts [String] :description Description of the file
+  # @return [UpdateFile]
+  describe 'files_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for files_post
+  # Add file
+  # Lets you upload a file and associate it with Deal, Person, Organization, Activity or Product. For more information on how to add a file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param file A single file, supplied in the multipart/form-data encoding and contained within the given boundaries.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :deal_id ID of the deal to associate file(s) with
+  # @option opts [Integer] :person_id ID of the person to associate file(s) with
+  # @option opts [Integer] :org_id ID of the organization to associate file(s) with
+  # @option opts [Integer] :product_id ID of the product to associate file(s) with
+  # @option opts [Integer] :activity_id ID of the activity to associate file(s) with
+  # @return [AddFile]
+  describe 'files_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for files_remote_link_post
+  # Link a remote file to an item
+  # Links an existing remote file (googledrive) to the item you supply. For more information on how to link a remote file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param item_type The item type
+  # @param item_id ID of the item to associate the file with
+  # @param remote_id The remote item id
+  # @param remote_location The location type to send the file to. Only googledrive is supported at the moment.
+  # @param [Hash] opts the optional parameters
+  # @return [LinkRemoteFileToItem]
+  describe 'files_remote_link_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for files_remote_post
+  # Create a remote file and link it to an item
+  # Creates a new empty file in the remote location (googledrive) that will be linked to the item you supply. For more information on how to add a remote file, see <a href=\"https://pipedrive.readme.io/docs/adding-a-remote-file\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param file_type The file type
+  # @param title The title of the file
+  # @param item_type The item type
+  # @param item_id ID of the item to associate the file with
+  # @param remote_location The location type to send the file to. Only googledrive is supported at the moment.
+  # @param [Hash] opts the optional parameters
+  # @return [CreateRemoteFileAndLinkItToItem]
+  describe 'files_remote_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/filters_api_spec.rb

@@ -0,0 +1,117 @@
+=begin
+#Pipedrive API v1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Pipedrive::FiltersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FiltersApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::FiltersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FiltersApi' do
+    it 'should create an instance of FiltersApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::FiltersApi)
+    end
+  end
+
+  # unit tests for filters_delete
+  # Delete multiple filters in bulk
+  # Marks multiple filters as deleted.
+  # @param ids Comma-separated filter IDs to delete
+  # @param [Hash] opts the optional parameters
+  # @return [BaseResponse]
+  describe 'filters_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for filters_get
+  # Get all filters
+  # Returns data about all filters.
+  # @param [Hash] opts the optional parameters
+  # @option opts [FilterType] :type The types of filters to fetch
+  # @return [BaseResponse]
+  describe 'filters_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for filters_helpers_get
+  # Get all filter helpers
+  # Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/#!/Filters/post_filters\">add</a> or <a href=\"/docs/api/v1/#!/Filters/put_filters_id\">update</a> filters. For more information on how filter’s helpers can be used, see <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'filters_helpers_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for filters_id_delete
+  # Delete a filter
+  # Marks a filter as deleted.
+  # @param [Hash] opts the optional parameters
+  # @return [BaseResponse]
+  describe 'filters_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for filters_id_get
+  # Get one filter
+  # Returns data about a specific filter. Note that this also returns the condition lines of the filter.
+  # @param id The ID of the filter
+  # @param [Hash] opts the optional parameters
+  # @return [BaseResponse]
+  describe 'filters_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for filters_id_put
+  # Update filter
+  # Updates an existing filter.
+  # @param [Hash] opts the optional parameters
+  # @option opts [InlineObject13] :inline_object13 
+  # @return [nil]
+  describe 'filters_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for filters_post
+  # Add a new filter
+  # Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information on how to add a new filter, see <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param [Hash] opts the optional parameters
+  # @option opts [InlineObject12] :inline_object12 
+  # @return [BaseResponse]
+  describe 'filters_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/global_messages_api_spec.rb

@@ -0,0 +1,59 @@
+=begin
+#Pipedrive API v1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Pipedrive::GlobalMessagesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'GlobalMessagesApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::GlobalMessagesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GlobalMessagesApi' do
+    it 'should create an instance of GlobalMessagesApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::GlobalMessagesApi)
+    end
+  end
+
+  # unit tests for global_messages_get
+  # Get global messages
+  # Returns data about global messages to display for the authorized user.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number of messages to get from 1 to 100. The message number 1 is returned by default.
+  # @return [GlobalMessageGet]
+  describe 'global_messages_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for global_messages_id_delete
+  # Dismiss a global message
+  # Removes global message from being shown, if message is dismissible
+  # @param id ID of global message to be dismissed.
+  # @param [Hash] opts the optional parameters
+  # @return [GlobalMessageDelete]
+  describe 'global_messages_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/goals_api_spec.rb

@@ -0,0 +1,114 @@
+=begin
+#Pipedrive API v1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Pipedrive::GoalsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'GoalsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::GoalsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GoalsApi' do
+    it 'should create an instance of GoalsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::GoalsApi)
+    end
+  end
+
+  # unit tests for goals_find_get
+  # Find goals
+  # Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :type_name Type of the goal. If provided, everyone's goals will be returned.
+  # @option opts [String] :title Title of the goal.
+  # @option opts [Boolean] :is_active Whether goal is active or not.
+  # @option opts [Integer] :assignee_id ID of the user who's goal to fetch. When omitted, only your goals will be returned.
+  # @option opts [String] :assignee_type Type of the goal's assignee. If provided, everyone's goals will be returned.
+  # @option opts [Float] :expected_outcome_target Numeric value of the outcome. If provided, everyone's goals will be returned.
+  # @option opts [String] :expected_outcome_tracking_metric Tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.
+  # @option opts [Integer] :expected_outcome_currency_id Numeric ID of the goal's currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone's goals will be returned.
+  # @option opts [Integer] :type_params_pipeline_id ID of the pipeline or `null` for all pipelines. If provided, everyone's goals will be returned.
+  # @option opts [Integer] :type_params_stage_id ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone's goals will be returned.
+  # @option opts [Integer] :type_params_activity_type_id ID of the activity type. Applicable to only `activities_completed` or `activities_added` types of goals. If provided, everyone's goals will be returned.
+  # @option opts [Date] :period_start Start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
+  # @option opts [Date] :period_end End date of the period for which to find goals. Date in format of YYYY-MM-DD.
+  # @return [nil]
+  describe 'goals_find_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for goals_id_delete
+  # Delete existing goal
+  # Marks goal as deleted.
+  # @param id ID of the goal to be deleted.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'goals_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for goals_id_put
+  # Update existing goal
+  # Updates existing goal.
+  # @param id ID of the goal to be updated.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :title Title of the goal.
+  # @option opts [Object] :assignee Who is this goal assigned to. It requires the following JSON structure: { \\\"id\\\": \\\"1\\\", \\\"type\\\": \\\"person\\\" }. `type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.
+  # @option opts [Object] :type Type of the goal. It requires the following JSON structure: { \\\"name\\\": \\\"deals_started\\\", \\\"params\\\": { \\\"pipeline_id\\\": 1 } }. Type can be one of: `deals_won`,`deals_progressed`,`activities_completed`,`activities_added` or `deals_started`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.
+  # @option opts [Object] :expected_outcome Expected outcome of the goal. Expected outcome can be tracked either by `quantity` or by `sum`. It requires the following JSON structure: { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"quantity\\\" } or { \\\"target\\\": \\\"50\\\", \\\"tracking_metric\\\": \\\"sum\\\", \\\"currency_id\\\": 1 }. `currency_id` should only be added to `sum` type of goals.
+  # @option opts [Object] :duration Date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD.
+  # @option opts [String] :interval Date when the goal starts and ends. It requires the following JSON structure: { \\\"start\\\": \\\"2019-01-01\\\", \\\"end\\\": \\\"2022-12-31\\\" }. Date in format of YYYY-MM-DD.
+  # @return [nil]
+  describe 'goals_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for goals_id_results_get
+  # Get result of a goal
+  # Gets progress of a goal for specified period.
+  # @param id ID of the goal that the results are looked for.
+  # @param period_start Start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD.
+  # @param period_end End date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'goals_id_results_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for goals_post
+  # Add a new goal
+  # Adds a new goal.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'goals_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/item_search_api_spec.rb

@@ -0,0 +1,72 @@
+=begin
+#Pipedrive API v1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Pipedrive::ItemSearchApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ItemSearchApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::ItemSearchApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ItemSearchApi' do
+    it 'should create an instance of ItemSearchApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::ItemSearchApi)
+    end
+  end
+
+  # unit tests for item_search_field_get
+  # Perform a search using a specific field from an item type
+  # Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (Deals, Persons, Organizations or Products).
+  # @param term The search term to look for. Minimum 2 characters (or 1 if using exact_match).
+  # @param field_type The type of the field to perform the search from
+  # @param field_key The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.).
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :exact_match When enabled, only full exact matches against the given term are returned. The search <b>is</b> case sensitive.
+  # @option opts [Boolean] :return_item_ids Whether to return the IDs of the matching items or not. When not set or set to 0 or false, only distinct values of the searched field are returned. When set to 1 or true, the ID of each found item is returned.
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [BaseResponse]
+  describe 'item_search_field_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for item_search_get
+  # Perform a search from multiple item types
+  # Performs a search from your choice of item types and fields.
+  # @param term The search term to look for. Minimum 2 characters (or 1 if using exact_match).
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :item_types A comma-separated string array. The type of items to perform the search from. Defaults to all.
+  # @option opts [String] :fields A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>custom_fields, notes, title</td></tr> <tr><td>Person</td><td>custom_fields, email, name, notes, phone</td></tr> <tr><td>Organization</td><td>address, custom_fields, name, notes</td></tr> <tr><td>Product</td><td>code, custom_fields, name</td></tr> <tr><td>Lead</td><td>email, organization_name, person_name, phone, title</td></tr> <tr><td>File</td><td>name</td></tr> <tr><td>Mail attachment</td><td>name</td></tr> </table>
+  # @option opts [Boolean] :search_for_related_items When enabled, the response will include up to 100 newest related Deals for each found Person and Organization and up to 100 newest related Persons for each found Organization.
+  # @option opts [Boolean] :exact_match When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
+  # @option opts [String] :include_fields A comma-separated string array. Supports including optional fields in the results which are not provided by default.
+  # @option opts [Integer] :start Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
+  # @option opts [Integer] :limit Items shown per page
+  # @return [BaseResponse]
+  describe 'item_search_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end