pipedrive-openapi-client 1.0.0

data/spec/api/deal_fields_api_spec.rb

@@ -0,0 +1,109 @@
+=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::DealFieldsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DealFieldsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::DealFieldsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DealFieldsApi' do
+    it 'should create an instance of DealFieldsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::DealFieldsApi)
+    end
+  end
+
+  # unit tests for deal_fields_delete
+  # Delete multiple deal fields in bulk
+  # Marks multiple fields as deleted.
+  # @param ids Comma-separated field IDs to delete
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'deal_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 deal_fields_get
+  # Get all deal fields
+  # Returns data about all fields deals can have
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'deal_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 deal_fields_id_delete
+  # Delete a deal 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 field
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'deal_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 deal_fields_id_get
+  # Get one deal field
+  # Returns data about a specific deal field.
+  # @param id ID of the field
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'deal_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 deal_fields_id_put
+  # Update a deal field
+  # Updates a deal 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 field
+  # @param name Name of the field
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :options When field_type is either set or enum, possible options must be supplied as a JSON-encoded sequential array, for example: [\\\"red\\\",\\\"blue\\\",\\\"lilac\\\"]
+  # @return [nil]
+  describe 'deal_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 deal_fields_post
+  # Add a new deal field
+  # Adds a new deal 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
+  # @return [nil]
+  describe 'deal_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/deals_api_spec.rb

@@ -0,0 +1,439 @@
+=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::DealsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DealsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::DealsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DealsApi' do
+    it 'should create an instance of DealsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::DealsApi)
+    end
+  end
+
+  # unit tests for deals_delete
+  # Delete multiple deals in bulk
+  # Marks multiple deals as deleted.
+  # @param ids Comma-separated IDs that will be deleted
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteMultipleDeals]
+  describe 'deals_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 deals_find_get
+  # Find deals by name
+  # <strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_search\">/v1/deals/search</a> or <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> instead</strong>. <br> Searches all deals by their title.
+  # @param term Search term to look for
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :person_id ID of the person the Deal is associated with.
+  # @option opts [Integer] :org_id ID of the organization the Deal is associated with.
+  # @return [GetDealsByName]
+  describe 'deals_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 deals_get
+  # Get all deals
+  # Returns all deals. For more information on how to get all deals, see <a href=\"https://pipedrive.readme.io/docs/getting-all-deals\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id If supplied, only deals matching the given user will be returned.
+  # @option opts [Integer] :filter_id ID of the filter to use
+  # @option opts [Integer] :stage_id If supplied, only deals within the given stage will be returned.
+  # @option opts [String] :status Only fetch deals with specific status. If omitted, all not deleted deals are fetched.
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @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).
+  # @option opts [NumberBoolean] :owned_by_you When supplied, only deals owned by you are returned. However filter_id takes precedence over owned_by_you when both are supplied.
+  # @return [GetDeals]
+  describe '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 deals_id_activities_get
+  # List activities associated with a deal
+  # Lists activities associated with a deal.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @option opts [NumberBoolean] :done Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
+  # @option opts [String] :exclude A comma-separated string of activity IDs to exclude from result
+  # @return [nil]
+  describe 'deals_id_activities_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 deals_id_delete
+  # Delete a deal
+  # Marks a deal as deleted.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteDeal]
+  describe 'deals_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 deals_id_duplicate_post
+  # Duplicate deal
+  # Duplicate a deal
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @return [GetDuplicatedDeal]
+  describe 'deals_id_duplicate_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 deals_id_files_get
+  # List files attached to a deal
+  # Lists files associated with a deal.
+  # @param id ID of the deal
+  # @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 'deals_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 deals_id_flow_get
+  # List updates about a deal
+  # Lists updates about a deal.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @option opts [String] :all_changes Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
+  # @option opts [String] :items A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)
+  # @return [nil]
+  describe 'deals_id_flow_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 deals_id_followers_follower_id_delete
+  # Delete a follower from a deal
+  # Deletes a follower from a deal.
+  # @param id ID of the deal
+  # @param follower_id ID of the follower
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteDealFollower]
+  describe 'deals_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 deals_id_followers_get
+  # List followers of a deal
+  # Lists the followers of a deal.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'deals_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 deals_id_followers_post
+  # Add a follower to a deal
+  # Adds a follower to a deal.
+  # @param id ID of the deal
+  # @param user_id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [AddedDealFollower]
+  describe 'deals_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 deals_id_get
+  # Get details of a deal
+  # Returns details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the 'key' value of dealFields. For more information on how to get all details of a deal, see <a href=\"https://pipedrive.readme.io/docs/getting-details-of-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @return [GetDeal]
+  describe 'deals_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 deals_id_mail_messages_get
+  # List mail messages associated with a deal
+  # Lists mail messages associated with a deal.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'deals_id_mail_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 deals_id_merge_put
+  # Merge two deals
+  # Merges a deal with another deal. For more information on how to merge two deals, see <a href=\"https://pipedrive.readme.io/docs/merging-two-deals\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param id ID of the deal
+  # @param merge_with_id ID of the deal that the deal will be merged with
+  # @param [Hash] opts the optional parameters
+  # @return [GetMergedDeal]
+  describe 'deals_id_merge_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 deals_id_participants_deal_participant_id_delete
+  # Delete a participant from a deal
+  # Deletes a participant from a deal.
+  # @param id ID of the deal
+  # @param deal_participant_id ID of the deal participant
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteDealParticipant]
+  describe 'deals_id_participants_deal_participant_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 deals_id_participants_get
+  # List participants of a deal
+  # Lists participants associated with a deal.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'deals_id_participants_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 deals_id_participants_post
+  # Add a participant to a deal
+  # Adds a participant to a deal.
+  # @param id ID of the deal
+  # @param person_id ID of the person
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'deals_id_participants_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 deals_id_permitted_users_get
+  # List permitted users
+  # List users permitted to access a deal
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'deals_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 deals_id_persons_get
+  # List all persons associated with a deal
+  # Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'deals_id_persons_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 deals_id_products_get
+  # List products attached to a deal
+  # Lists products attached to a deal.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @option opts [NumberBoolean] :include_product_data Whether to fetch product data along with each attached product (1) or not (0, default).
+  # @return [nil]
+  describe 'deals_id_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 deals_id_products_post
+  # Add a product to the deal, eventually creating a new item called a deal-product
+  # Adds a product to the deal.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @option opts [NewDealProduct] :new_deal_product 
+  # @return [GetAddProductAttachementDetails]
+  describe 'deals_id_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 deals_id_products_product_attachment_id_delete
+  # Delete an attached product from a deal
+  # Deletes a product attachment from a deal, using the product_attachment_id.
+  # @param id ID of the deal
+  # @param product_attachment_id Product attachment ID. This is returned as product_attachment_id after attaching a product to a deal or as id when listing the products attached to a deal.
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteDealProduct]
+  describe 'deals_id_products_product_attachment_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 deals_id_products_product_attachment_id_put
+  # Update product attachment details of the deal-product (a product already attached to a deal)
+  # Updates product attachment details.
+  # @param id ID of the deal
+  # @param product_attachment_id ID of the deal-product (the ID of the product attached to the deal)
+  # @param [Hash] opts the optional parameters
+  # @option opts [BasicDealProduct] :basic_deal_product 
+  # @return [GetProductAttachementDetails]
+  describe 'deals_id_products_product_attachment_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 deals_id_put
+  # Update a deal
+  # Updates the properties of a deal. For more information on how to update a deal, see <a href=\"https://pipedrive.readme.io/docs/updating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param id ID of the deal
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :title Deal title
+  # @option opts [String] :value Value of the deal. If omitted, value will be set to 0.
+  # @option opts [String] :currency Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
+  # @option opts [Integer] :user_id ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used.
+  # @option opts [Integer] :person_id ID of the person this deal will be associated with
+  # @option opts [Integer] :org_id ID of the organization this deal will be associated with
+  # @option opts [Integer] :stage_id ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id). If omitted, the deal will be placed in the first stage of the default pipeline.
+  # @option opts [String] :status open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.
+  # @option opts [Float] :probability Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled.
+  # @option opts [String] :lost_reason Optional message about why the deal was lost (to be used when status=lost)
+  # @option opts [VisibleTo] :visible_to Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<dl class=\\\"fields-list\\\"><dt>1</dt><dd>Owner & followers (private)</dd><dt>3</dt><dd>Entire company (shared)</dd></dl>
+  # @return [GetAddedDeal]
+  describe 'deals_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 deals_post
+  # Add a deal
+  # Adds a new deal. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for 'key' values. For more information on how to add a deal, see <a href=\"https://pipedrive.readme.io/docs/creating-a-deal\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param [Hash] opts the optional parameters
+  # @return [GetAddedDeal]
+  describe 'deals_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 deals_search_get
+  # Search deals
+  # Searches all Deals by title, notes 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. Found Deals can be filtered by Person ID and Organization ID.
+  # @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 [Integer] :person_id Will filter Deals by the provided Person ID. The upper limit of found Deals associated with the Person is 2000.
+  # @option opts [Integer] :organization_id Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.
+  # @option opts [String] :status Will filter Deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found Deals associated with the status is 2000.
+  # @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 'deals_search_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 deals_summary_get
+  # Get deals summary
+  # Returns summary of all the deals.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :status Only fetch deals with specific status. open = Open, won = Won, lost = Lost
+  # @option opts [Integer] :filter_id user_id will not be considered. Only deals matching the given filter will be returned.
+  # @option opts [Integer] :user_id Only deals matching the given user will be returned. user_id will not be considered if you use filter_id.
+  # @option opts [Integer] :stage_id Only deals within the given stage will be returned.
+  # @return [GetDealsSummary]
+  describe 'deals_summary_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 deals_timeline_get
+  # Get deals timeline
+  # Returns open and won deals, grouped by defined interval of time set in a date-type dealField (field_key) — e.g. when month is the chosen interval, and 3 months are asked starting from  January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given field_key.
+  # @param start_date Date where the first interval starts. Format: YYYY-MM-DD
+  # @param interval The type of interval<dl class=\"fields-list\"><dt>day</dt><dd>Day</dd><dt>week</dt><dd>A full week (7 days) starting from start_date</dd><dt>month</dt><dd>A full month (depending on the number of days in given month) starting from start_date</dd><dt>quarter</dt><dd>A full quarter (3 months) starting from start_date</dd></dl>
+  # @param amount The number of given intervals, starting from start_date, to fetch. E.g. 3 (months).
+  # @param field_key The date field key which deals will be retrieved from
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id If supplied, only deals matching the given user will be returned.
+  # @option opts [Integer] :pipeline_id If supplied, only deals matching the given pipeline will be returned
+  # @option opts [Integer] :filter_id If supplied, only deals matching the given filter will be returned
+  # @option opts [NumberBoolean] :exclude_deals Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
+  # @option opts [String] :totals_convert_currency 3-letter currency code of any of the supported currencies. When supplied, totals_converted is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to 'default_currency' in which case users default currency is used.
+  # @return [GetDealsTimeline]
+  describe 'deals_timeline_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end