pipedrive-openapi-client 1.0.0

data/spec/api/pipelines_api_spec.rb

@@ -0,0 +1,152 @@
+=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::PipelinesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PipelinesApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::PipelinesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PipelinesApi' do
+    it 'should create an instance of PipelinesApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::PipelinesApi)
+    end
+  end
+
+  # unit tests for pipelines_get
+  # Get all pipelines
+  # Returns data about all pipelines
+  # @param [Hash] opts the optional parameters
+  # @return [GetAllPipelines]
+  describe 'pipelines_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 pipelines_id_conversion_statistics_get
+  # Get deals conversion rates in pipeline
+  # Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.
+  # @param id ID of the pipeline
+  # @param start_date Start of the period. Date in format of YYYY-MM-DD.
+  # @param end_date End of the period. Date in format of YYYY-MM-DD.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
+  # @return [GetDealsConversionRatesInPipeline]
+  describe 'pipelines_id_conversion_statistics_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 pipelines_id_deals_get
+  # Get deals in a pipeline
+  # Lists deals in a specific pipeline across all its stages
+  # @param id ID of the pipeline
+  # @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] :stage_id If supplied, only deals within the given stage will be returned.
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @option opts [NumberBoolean] :get_summary Whether to include summary of the pipeline in the additional_data or not.
+  # @option opts [String] :totals_convert_currency 3-letter currency code of any of the supported currencies. When supplied, per_stages_converted is returned inside deals_summary inside additional_data which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to 'default_currency' in which case users default currency is used. Only works when get_summary parameter flag is enabled.
+  # @return [GetStageDeals]
+  describe 'pipelines_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 pipelines_id_delete
+  # Delete a pipeline
+  # Marks a pipeline as deleted.
+  # @param id ID of the pipeline
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2009]
+  describe 'pipelines_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 pipelines_id_get
+  # Get one pipeline
+  # Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
+  # @param id ID of the pipeline
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :totals_convert_currency 3-letter currency code of any of the supported currencies. When supplied, per_stages_converted is returned in deals_summary which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to 'default_currency' in which case users default currency is used.
+  # @return [GetOnePipeline]
+  describe 'pipelines_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 pipelines_id_movement_statistics_get
+  # Get deals movements in pipeline
+  # Returns statistics for deals movements for given time period.
+  # @param id ID of the pipeline
+  # @param start_date Start of the period. Date in format of YYYY-MM-DD.
+  # @param end_date End of the period. Date in format of YYYY-MM-DD.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.
+  # @return [GetDealsMovementsInPipeline]
+  describe 'pipelines_id_movement_statistics_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 pipelines_id_put
+  # Edit a pipeline
+  # Updates pipeline properties
+  # @param id ID of the pipeline
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name The name of the Pipeline
+  # @option opts [NumberBoolean] :deal_probability 
+  # @option opts [Integer] :order_nr Defines the order of Pipelines. First order (order_nr=0) is the default Pipeline.
+  # @option opts [NumberBoolean] :active 
+  # @return [EditPipeline]
+  describe 'pipelines_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 pipelines_post
+  # Add a new pipeline
+  # Adds a new pipeline
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name The name of the Pipeline
+  # @option opts [NumberBoolean] :deal_probability 
+  # @option opts [Integer] :order_nr Defines the order of Pipelines. First order (order_nr=0) is the default Pipeline.
+  # @option opts [NumberBoolean] :active 
+  # @return [AddNewPipeline]
+  describe 'pipelines_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/product_fields_api_spec.rb

@@ -0,0 +1,107 @@
+=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::ProductFieldsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ProductFieldsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::ProductFieldsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProductFieldsApi' do
+    it 'should create an instance of ProductFieldsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::ProductFieldsApi)
+    end
+  end
+
+  # unit tests for product_fields_delete
+  # Delete multiple product fields in bulk
+  # Marks multiple fields as deleted.
+  # @param ids Comma-separated field IDs to delete
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteMultipleProductFieldsResponse]
+  describe 'product_fields_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 product_fields_get
+  # Get all product fields
+  # Returns data about all product fields
+  # @param [Hash] opts the optional parameters
+  # @return [GetAllProductFieldsResponse]
+  describe 'product_fields_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 product_fields_id_delete
+  # Delete a product field
+  # Marks a field as deleted. For more information on how to delete a custom field, see <a href=\"https://pipedrive.readme.io/docs/deleting-a-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param id ID of the Product Field
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteProductFieldResponse]
+  describe 'product_fields_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 product_fields_id_get
+  # Get one product field
+  # Returns data about a specific product field.
+  # @param id ID of the Product Field
+  # @param [Hash] opts the optional parameters
+  # @return [GetProductFieldResponse]
+  describe 'product_fields_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 product_fields_id_put
+  # Update a product field
+  # Updates a product field. See an example of updating custom fields’ values in <a href=\" https://pipedrive.readme.io/docs/updating-custom-field-value \" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param id ID of the Product Field
+  # @param [Hash] opts the optional parameters
+  # @option opts [BasicProductField] :basic_product_field 
+  # @return [GetProductFieldResponse]
+  describe 'product_fields_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 product_fields_post
+  # Add a new product field
+  # Adds a new product field. For more information on adding a new custom field, see <a href=\"https://pipedrive.readme.io/docs/adding-a-new-custom-field\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param [Hash] opts the optional parameters
+  # @option opts [NewProductField] :new_product_field 
+  # @return [GetProductFieldResponse]
+  describe 'product_fields_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/products_api_spec.rb

@@ -0,0 +1,213 @@
+=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::ProductsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ProductsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::ProductsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProductsApi' do
+    it 'should create an instance of ProductsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::ProductsApi)
+    end
+  end
+
+  # unit tests for products_find_get
+  # Find products by name
+  # <strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_search\">/v1/products/search</a> or <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> instead</strong>. <br> Returns data about the products that were found. If currency was set in request, prices in that currency are served back.
+  # @param term Search term to look for, minimum 3 characters.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :currency Currency code in which prices should be returned in. If omitted, prices in user's default currency will be returned.
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [FindProductsByNameResponse]
+  describe 'products_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 products_get
+  # Get all products
+  # Returns data about all products.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id If supplied, only products owned by the given user will be returned.
+  # @option opts [Integer] :filter_id ID of the filter to use
+  # @option opts [String] :first_char If supplied, only products whose name starts with the specified letter will be returned (case insensitive).
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [Product]
+  describe 'products_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 products_id_deals_get
+  # Get deals where a product is attached to
+  # Returns data about deals that have a product attached to.
+  # @param id ID of the product
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @option opts [String] :status Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
+  # @return [BasicDeal]
+  describe 'products_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 products_id_delete
+  # Delete a product
+  # Marks a product as deleted.
+  # @param id ID of the product
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'products_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 products_id_files_get
+  # List files attached to a product
+  # Lists files associated with a product.
+  # @param id ID of the product
+  # @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 [nil]
+  describe 'products_id_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 products_id_followers_follower_id_delete
+  # Delete a follower from a product
+  # Deletes a follower from a product.
+  # @param id ID of the product
+  # @param follower_id ID of the follower
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteProductFollowerResponse]
+  describe 'products_id_followers_follower_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 products_id_followers_get
+  # List followers of a product
+  # Lists the followers of a Product
+  # @param id ID of the product
+  # @param [Hash] opts the optional parameters
+  # @return [UserIDs]
+  describe 'products_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 products_id_followers_post
+  # Add a follower to a product
+  # Adds a follower to a product.
+  # @param id ID of the product
+  # @param [Hash] opts the optional parameters
+  # @option opts [InlineObject24] :inline_object24 
+  # @return [NewFollowerResponse]
+  describe 'products_id_followers_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 products_id_get
+  # Get one product
+  # Returns data about a specific product.
+  # @param id ID of the product
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'products_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 products_id_permitted_users_get
+  # List permitted users
+  # Lists users permitted to access a product.
+  # @param id ID of the product
+  # @param [Hash] opts the optional parameters
+  # @return [UserIDs]
+  describe 'products_id_permitted_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 products_id_put
+  # Update a product
+  # Updates product data.
+  # @param id ID of the product
+  # @param [Hash] opts the optional parameters
+  # @option opts [Product] :product 
+  # @return [Product]
+  describe 'products_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 products_post
+  # Add a product
+  # Adds a new product to the products inventory. For more information on how to add a product, see <a href=\"https://pipedrive.readme.io/docs/adding-a-product\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param [Hash] opts the optional parameters
+  # @option opts [UNKNOWN_BASE_TYPE] :unknown_base_type 
+  # @return [nil]
+  describe 'products_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 products_search_get
+  # Search products
+  # Searches all Products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> with a narrower OAuth scope.
+  # @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] :fields A comma-separated string array. The fields to perform the search from. Defaults to all of them.
+  # @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 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 'products_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