pipedrive-openapi-client 1.0.0

data/spec/api/recents_api_spec.rb

@@ -0,0 +1,50 @@
+=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::RecentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RecentsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::RecentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RecentsApi' do
+    it 'should create an instance of RecentsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::RecentsApi)
+    end
+  end
+
+  # unit tests for recents_get
+  # Get recents
+  # Returns data about all recent changes occured after given timestamp.
+  # @param since_timestamp Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :items Multiple selection of item types to include in query (optional)
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'recents_get 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/roles_api_spec.rb

@@ -0,0 +1,169 @@
+=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::RolesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RolesApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::RolesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RolesApi' do
+    it 'should create an instance of RolesApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::RolesApi)
+    end
+  end
+
+  # unit tests for roles_get
+  # Get all roles
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [GetRoles]
+  describe 'roles_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 roles_id_assignments_delete
+  # Delete a role assignment
+  # Delete assignment from a role
+  # @param id ID of the role
+  # @param user_id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteRoleAssignment]
+  describe 'roles_id_assignments_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 roles_id_assignments_get
+  # List role assignments
+  # List assignments for a role
+  # @param id ID of the role
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [GetRoleAssignments]
+  describe 'roles_id_assignments_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 roles_id_assignments_post
+  # Add role assignment
+  # Add assignment for a role
+  # @param id ID of the role
+  # @param user_id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [PostRoleAssignment]
+  describe 'roles_id_assignments_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 roles_id_delete
+  # Delete a role
+  # @param id ID of the role
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteRole]
+  describe 'roles_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 roles_id_get
+  # Get one role
+  # @param id ID of the role
+  # @param [Hash] opts the optional parameters
+  # @return [GetRole]
+  describe 'roles_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 roles_id_put
+  # Update role details
+  # @param id ID of the role
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :parent_role_id The ID of the parent Role
+  # @option opts [String] :name The name of the Role
+  # @return [PutRole]
+  describe 'roles_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 roles_id_roles_get
+  # List role sub-roles
+  # @param id ID of the role
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [GetRoleSubroles]
+  describe 'roles_id_roles_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 roles_id_settings_get
+  # List role settings
+  # @param id ID of the role
+  # @param [Hash] opts the optional parameters
+  # @return [GetRoleSettings]
+  describe 'roles_id_settings_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 roles_id_settings_post
+  # Add or update role setting
+  # @param id ID of the role
+  # @param setting_key 
+  # @param value Possible values for default_visibility settings: 0...1.
+  # @param [Hash] opts the optional parameters
+  # @return [PostRoleSettings]
+  describe 'roles_id_settings_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 roles_post
+  # Add a role
+  # @param [Hash] opts the optional parameters
+  # @return [PostRoles]
+  describe 'roles_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/search_results_api_spec.rb

@@ -0,0 +1,70 @@
+=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::SearchResultsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SearchResultsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::SearchResultsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SearchResultsApi' do
+    it 'should create an instance of SearchResultsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::SearchResultsApi)
+    end
+  end
+
+  # unit tests for search_results_field_get
+  # Perform a search using a specific field value
+  # <strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch_field\">/v1/itemSearch/field</a> instead</strong>. <br>  Performs a search from a specific field's values. Results can be either the distinct values of the field (useful for searching autocomplete field values), or actual items IDs (deals, persons, organizations or products).
+  # @param term Search term to look for, minimum 2 characters.
+  # @param field_type Type of the field to perform the search from.
+  # @param field_key Key of the field to search from. Field key can be obtained by fetching the list of fields using any of fields API GET methods (dealFields, personFields, ..).
+  # @param [Hash] opts the optional parameters
+  # @option opts [NumberBoolean] :exact_match When enabled, only full exact matches against the given term are returned. By default, term can be present anywhere in the resulting field values to be considered a match. The minimum 2 character limit for the term is discarded when exact_match is enabled.
+  # @option opts [String] :return_field_key Name of the field in search results from which the search was performed. When omitted, 'value' will be used. You may want to set this parameter to match the field_key.
+  # @option opts [NumberBoolean] :return_item_ids Whether to return matching items IDs in search results. When omitted or set to 0, only distinct values of the searched field are returned. When enabled, the return_field_key parameter is ignored and the results include the searched field as its own key.
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'search_results_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 search_results_get
+  # Perform a search
+  # <strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> instead</strong>. <br> Performs a search across the account and returns SearchResults.
+  # @param term Search term to look for, minimum 2 characters.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :item_type Search for items of exact type. If omitted, all types of items are searched.
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @option opts [NumberBoolean] :exact_match When enabled, only full exact matches against the given term are returned. The minimum 2 character limit for the term is discarded when exact_match is enabled. It will only work if search term is 30 characters or less.
+  # @return [nil]
+  describe 'search_results_get 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/stages_api_spec.rb

@@ -0,0 +1,123 @@
+=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::StagesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'StagesApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::StagesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of StagesApi' do
+    it 'should create an instance of StagesApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::StagesApi)
+    end
+  end
+
+  # unit tests for stages_delete
+  # Delete multiple stages in bulk
+  # Marks multiple stages as deleted.
+  # @param ids Comma-separated stage IDs to delete
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20010]
+  describe 'stages_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 stages_get
+  # Get all stages
+  # Returns data about all stages.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :pipeline_id The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.
+  # @return [GetStages]
+  describe 'stages_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 stages_id_deals_get
+  # Get deals in a stage
+  # Lists deals in a specific stage.
+  # @param id ID of the stage
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :filter_id If supplied, only deals matching the given filter will be returned.
+  # @option opts [Integer] :user_id If supplied, filter_id will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
+  # @option opts [NumberBoolean] :everyone If supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned.
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [GetStageDeals]
+  describe 'stages_id_deals_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 stages_id_delete
+  # Delete a stage
+  # Marks a stage as deleted.
+  # @param id ID of the stage
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20011]
+  describe 'stages_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 stages_id_get
+  # Get one stage
+  # Returns data about a specific stage.
+  # @param id ID of the stage
+  # @param [Hash] opts the optional parameters
+  # @return [GetOneStage]
+  describe 'stages_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 stages_id_put
+  # Update stage details
+  # Updates the properties of a stage.
+  # @param id ID of the stage
+  # @param [Hash] opts the optional parameters
+  # @return [GetAddUpdateStage]
+  describe 'stages_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 stages_post
+  # Add a new stage
+  # Adds a new stage, returns the ID upon success.
+  # @param [Hash] opts the optional parameters
+  # @return [GetAddUpdateStage]
+  describe 'stages_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/teams_api_spec.rb

@@ -0,0 +1,140 @@
+=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::TeamsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TeamsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::TeamsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TeamsApi' do
+    it 'should create an instance of TeamsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::TeamsApi)
+    end
+  end
+
+  # unit tests for teams_get
+  # Get all teams
+  # Returns data about teams within the company
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :order_by Field name to sort returned teams by
+  # @option opts [NumberBooleanDefault0] :skip_users When enabled, the teams will not include IDs of member users
+  # @return [Teams]
+  describe 'teams_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 teams_id_get
+  # Get a single team
+  # Returns data about a specific team
+  # @param id ID of the team
+  # @param [Hash] opts the optional parameters
+  # @option opts [NumberBooleanDefault0] :skip_users When enabled, the teams will not include IDs of member users
+  # @return [Teams]
+  describe 'teams_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 teams_id_put
+  # Update a team
+  # Updates an existing team and returns the updated object
+  # @param id ID of the team
+  # @param [Hash] opts the optional parameters
+  # @return [Teams]
+  describe 'teams_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 teams_id_users_delete
+  # Delete users from a team
+  # Deletes users from an existing team
+  # @param id ID of the team
+  # @param users List of User IDs
+  # @param [Hash] opts the optional parameters
+  # @return [UserIDs]
+  describe 'teams_id_users_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 teams_id_users_get
+  # Get all users in a team
+  # Returns list of all user IDs within a team
+  # @param id ID of the team
+  # @param [Hash] opts the optional parameters
+  # @return [UserIDs]
+  describe 'teams_id_users_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 teams_id_users_post
+  # Add users to a team
+  # Adds users to an existing team
+  # @param id ID of the team
+  # @param users List of User IDs
+  # @param [Hash] opts the optional parameters
+  # @return [UserIDs]
+  describe 'teams_id_users_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 teams_post
+  # Add a new team
+  # Adds a new team to the company and returns the created object
+  # @param name The Team name
+  # @param manager_id The Team manager ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :description The Team description
+  # @option opts [Array] :users IDs of the Users that belong to the Team
+  # @return [Teams]
+  describe 'teams_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 teams_user_id_get
+  # Get all teams of a user
+  # Returns data about all teams which have specified user as a member
+  # @param id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :order_by Field name to sort returned teams by
+  # @option opts [NumberBooleanDefault0] :skip_users When enabled, the teams will not include IDs of member users
+  # @return [Teams]
+  describe 'teams_user_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end