pipedrive-openapi-client 1.0.0

data/spec/api/user_connections_api_spec.rb

@@ -0,0 +1,46 @@
+=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::UserConnectionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UserConnectionsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::UserConnectionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UserConnectionsApi' do
+    it 'should create an instance of UserConnectionsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::UserConnectionsApi)
+    end
+  end
+
+  # unit tests for user_connections_get
+  # Get all user connections
+  # Returns data about all connections for authorized user.
+  # @param [Hash] opts the optional parameters
+  # @return [UserConnections]
+  describe 'user_connections_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/user_settings_api_spec.rb

@@ -0,0 +1,46 @@
+=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::UserSettingsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UserSettingsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::UserSettingsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UserSettingsApi' do
+    it 'should create an instance of UserSettingsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::UserSettingsApi)
+    end
+  end
+
+  # unit tests for user_settings_get
+  # List settings of an authorized user
+  # List settings of an authorized user. Example response contains a shortened list of settings.
+  # @param [Hash] opts the optional parameters
+  # @return [UserSettings]
+  describe 'user_settings_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/users_api_spec.rb

@@ -0,0 +1,210 @@
+=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::UsersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UsersApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::UsersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsersApi' do
+    it 'should create an instance of UsersApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::UsersApi)
+    end
+  end
+
+  # unit tests for users_find_get
+  # Find users by name
+  # Finds users by their name.
+  # @param term Search term to look for
+  # @param [Hash] opts the optional parameters
+  # @option opts [NumberBooleanDefault0] :search_by_email When enabled, term will only be matched against email addresses of users. Default: false
+  # @return [Users]
+  describe 'users_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 users_get
+  # Get all users
+  # Returns data about all users within the company
+  # @param [Hash] opts the optional parameters
+  # @return [Users]
+  describe '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 users_id_blacklisted_emails_get
+  # List blacklisted email addresses of a user
+  # Lists blacklisted email addresses of a specific user. Blacklisted emails are such that will not get synced in to Pipedrive when using the built-in Mailbox.
+  # @param id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'users_id_blacklisted_emails_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 users_id_blacklisted_emails_post
+  # Add blacklisted email address for a user
+  # Add blacklisted email address for a specific user.
+  # @param id ID of the user
+  # @param address Email address to blacklist (can contain \\\\\\\\* for wildcards, e.g. \\\\\\\\*@example.com, or john\\\\\\\\*@ex\\\\\\\\*.com)
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'users_id_blacklisted_emails_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 users_id_followers_get
+  # List followers of a user
+  # Lists followers of a specific user.
+  # @param id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [UserIDs]
+  describe 'users_id_followers_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 users_id_get
+  # Get one user
+  # Returns data about a specific user within the company
+  # @param id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [User]
+  describe 'users_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 users_id_permissions_get
+  # List user permissions
+  # List aggregated permissions over all assigned permission sets for a user
+  # @param id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'users_id_permissions_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 users_id_put
+  # Update user details
+  # Updates the properties of a user. Currently, only active_flag can be updated.
+  # @param id ID of the user
+  # @param active_flag Whether the user is active or not. false = Not activated, true = Activated
+  # @param [Hash] opts the optional parameters
+  # @return [User]
+  describe 'users_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 users_id_role_assignments_delete
+  # Delete a role assignment
+  # Delete a role assignment for a user
+  # @param id ID of the user
+  # @param role_id ID of the role
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'users_id_role_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 users_id_role_assignments_get
+  # List role assignments
+  # List role assignments for a user
+  # @param id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'users_id_role_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 users_id_role_assignments_post
+  # Add role assignment
+  # Add role assignment for a user
+  # @param id ID of the user
+  # @param role_id ID of the role
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'users_id_role_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 users_id_role_settings_get
+  # List user role settings
+  # List settings of user's assigned role
+  # @param id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'users_id_role_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 users_me_get
+  # Get current user data
+  # Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the 'locale' property means 'Date and number format' in the Pipedrive settings, not the chosen language.
+  # @param [Hash] opts the optional parameters
+  # @return [UserMe]
+  describe 'users_me_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 users_post
+  # Add a new user
+  # Adds a new user to the company, returns the ID upon success.
+  # @param name Name of the user
+  # @param email Email of the user
+  # @param active_flag Whether the user is active or not. false = Not activated, true = Activated
+  # @param [Hash] opts the optional parameters
+  # @return [User]
+  describe 'users_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/webhooks_api_spec.rb

@@ -0,0 +1,75 @@
+=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::WebhooksApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'WebhooksApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::WebhooksApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WebhooksApi' do
+    it 'should create an instance of WebhooksApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::WebhooksApi)
+    end
+  end
+
+  # unit tests for webhooks_get
+  # Get all webhooks
+  # Returns data about all webhooks of a company.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'webhooks_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 webhooks_id_delete
+  # Delete existing webhook
+  # Deletes the specified webhook.
+  # @param id The ID of the webhook to delete
+  # @param [Hash] opts the optional parameters
+  # @return [BaseResponse]
+  describe 'webhooks_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 webhooks_post
+  # Create a new webhook
+  # Creates a new webhook and returns its details. Note that specifying an event which triggers the webhook combines 2 parameters - 'event_action' and 'event_object'. E.g., use '\\*.\\*' for getting notifications about all events, 'added.deal' for any newly added deals, 'deleted.persons' for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\">https://pipedrive.readme.io/docs/guide-for-webhooks</a> for more details.
+  # @param subscription_url A full, valid, publicly accessible URL. Determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the subscription_url.
+  # @param event_action Type of action to receive notifications about. Wildcard will match all supported actions.
+  # @param event_object Type of object to receive notifications about. Wildcard will match all supported objects.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id The ID of the user this webhook will be authorized with. If not set, current authorized user will be used. Note that this does not filter only certain user's events — rather, this specifies the user's permissions under which each event is checked. Events about objects the selected user is not entitled to access are not sent. If you want to receive notifications for all events, a top-level admin user should be used.
+  # @option opts [String] :http_auth_user HTTP basic auth username of the subscription URL endpoint (if required).
+  # @option opts [String] :http_auth_password HTTP basic auth password of the subscription URL endpoint (if required).
+  # @return [Object]
+  describe 'webhooks_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_client_spec.rb

@@ -0,0 +1,188 @@
+=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'
+
+describe Pipedrive::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Pipedrive.configure { |c| c.host = 'http://example.com' }
+          expect(Pipedrive::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Pipedrive.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Pipedrive::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Pipedrive.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Pipedrive::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Pipedrive.configure { |c| c.base_path = 'v4/dog' }
+          expect(Pipedrive::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Pipedrive.configure { |c| c.base_path = '/v4/dog' }
+          expect(Pipedrive::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Pipedrive.configure { |c| c.base_path = nil }
+          expect(Pipedrive::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = Pipedrive::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = Pipedrive::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = Pipedrive::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = Pipedrive::ApiClient.new
+      # _model = Pipedrive::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { Pipedrive::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { Pipedrive::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { Pipedrive::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { Pipedrive::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { Pipedrive::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end