pipedrive-openapi-client 1.0.0

data/spec/api/leads_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::LeadsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'LeadsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::LeadsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of LeadsApi' do
+    it 'should create an instance of LeadsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::LeadsApi)
+    end
+  end
+
+  # unit tests for lead_labels_get
+  # Get all lead labels
+  # Returns details of all Lead Labels. This endpoint does not support pagination and all Labels are always returned.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2006]
+  describe 'lead_labels_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 lead_labels_id_delete
+  # Delete a lead label
+  # Deletes a specific Lead Label
+  # @param id The ID of the Lead Label
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'lead_labels_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 lead_labels_id_get
+  # Get one lead label
+  # Returns details of a specific Lead Label
+  # @param id The ID of the Lead Label
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'lead_labels_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 lead_labels_id_patch
+  # Update a lead label
+  # Updates one or more properties of a Lead Label. Only properties included in the request will be updated. 
+  # @param id The ID of the Lead Label
+  # @param [Hash] opts the optional parameters
+  # @option opts [InlineObject17] :inline_object17 
+  # @return [nil]
+  describe 'lead_labels_id_patch 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 lead_labels_post
+  # Add a lead label
+  # Creates a Lead Label
+  # @param [Hash] opts the optional parameters
+  # @option opts [InlineObject16] :inline_object16 
+  # @return [InlineResponse2007]
+  describe 'lead_labels_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 lead_sources_get
+  # Get all lead sources
+  # Returns all Lead Sources. Please note that the list of Lead Sources is fixed, it cannot be modified. All Leads created through the Public Pipedrive API will have a Lead Source `API` assigned. 
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2008]
+  describe 'lead_sources_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 leads_get
+  # Get all leads
+  # Returns multiple Leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
+  # @option opts [Integer] :start For pagination, the position that represents the first result for the page
+  # @option opts [String] :archived_status Filtering based on archived status of a Lead. If not provided, `All` is used.
+  # @return [InlineResponse2004]
+  describe 'leads_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 leads_id_delete
+  # Delete a lead
+  # Deletes a specific Lead
+  # @param id The ID of the Lead
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2005]
+  describe 'leads_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 leads_id_get
+  # Get one lead
+  # Returns details of a specific Lead
+  # @param id The ID of the Lead
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'leads_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 leads_id_patch
+  # Update a lead
+  # Updates one or more properties of a Lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). 
+  # @param id The ID of the Lead
+  # @param [Hash] opts the optional parameters
+  # @option opts [InlineObject15] :inline_object15 
+  # @return [nil]
+  describe 'leads_id_patch 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 leads_post
+  # Add a lead
+  # Creates a Lead. A Lead always has to be linked to a Person or an Organization or both. All Leads created through the Public Pipedrive API will have a Lead Source `API` assigned. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [InlineObject14] :inline_object14 
+  # @return [InlineResponse201]
+  describe 'leads_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/mail_messages_api_spec.rb

@@ -0,0 +1,48 @@
+=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::MailMessagesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MailMessagesApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::MailMessagesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MailMessagesApi' do
+    it 'should create an instance of MailMessagesApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::MailMessagesApi)
+    end
+  end
+
+  # unit tests for mailbox_mail_messages_id_get
+  # Get one mail message
+  # Returns data about specific mail message.
+  # @param id ID of the mail message to fetch.
+  # @param [Hash] opts the optional parameters
+  # @option opts [NumberBooleanDefault0] :include_body Whether to include full message body or not. 0 = Don't include, 1 = Include
+  # @return [MailMessage]
+  describe 'mailbox_mail_messages_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

data/spec/api/mail_threads_api_spec.rb

@@ -0,0 +1,101 @@
+=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::MailThreadsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MailThreadsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::MailThreadsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MailThreadsApi' do
+    it 'should create an instance of MailThreadsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::MailThreadsApi)
+    end
+  end
+
+  # unit tests for mailbox_mail_threads_get
+  # Get mail threads
+  # Returns mail threads in specified folder ordered by most recent message within.
+  # @param folder Type of folder to fetch.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [MailThread]
+  describe 'mailbox_mail_threads_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 mailbox_mail_threads_id_delete
+  # Delete mail thread
+  # Marks mail thread as deleted.
+  # @param id ID of the mail thread
+  # @param [Hash] opts the optional parameters
+  # @return [MailThreadDelete]
+  describe 'mailbox_mail_threads_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 mailbox_mail_threads_id_get
+  # Get one mail thread
+  # Returns specific mail thread.
+  # @param id ID of the mail thread
+  # @param [Hash] opts the optional parameters
+  # @return [MailThreadOne]
+  describe 'mailbox_mail_threads_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 mailbox_mail_threads_id_mail_messages_get
+  # Get all mail messages of mail thread
+  # Get mail messages inside specified mail thread.
+  # @param id ID of the mail thread
+  # @param [Hash] opts the optional parameters
+  # @return [MailThreadMessages]
+  describe 'mailbox_mail_threads_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 mailbox_mail_threads_id_put
+  # Update mail thread details
+  # Updates the properties of a mail thread.
+  # @param id ID of the mail thread
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :deal_id ID of the deal this thread is associated with
+  # @option opts [NumberBoolean] :shared_flag 
+  # @option opts [NumberBoolean] :read_flag 
+  # @option opts [NumberBoolean] :archived_flag 
+  # @return [MailThreadPut]
+  describe 'mailbox_mail_threads_id_put 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/note_fields_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::NoteFieldsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'NoteFieldsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::NoteFieldsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NoteFieldsApi' do
+    it 'should create an instance of NoteFieldsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::NoteFieldsApi)
+    end
+  end
+
+  # unit tests for note_fields_get
+  # Get all fields for a note
+  # Return list of all fields for note
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'note_fields_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/notes_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::NotesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'NotesApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::NotesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NotesApi' do
+    it 'should create an instance of NotesApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::NotesApi)
+    end
+  end
+
+  # unit tests for notes_get
+  # Get all notes
+  # Returns all notes.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id ID of the user whose notes to fetch. If omitted, notes by all users will be returned.
+  # @option opts [Integer] :deal_id ID of the deal which notes to fetch. If omitted, notes about all deals with be returned.
+  # @option opts [Integer] :person_id ID of the person whose notes to fetch. If omitted, notes about all persons with be returned.
+  # @option opts [Integer] :org_id ID of the organization which notes to fetch. If omitted, notes about all organizations with be returned.
+  # @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). Supported fields: id, user_id, deal_id, person_id, org_id, content, add_time, update_time.
+  # @option opts [Date] :start_date Date in format of YYYY-MM-DD from which notes to fetch from.
+  # @option opts [Date] :end_date Date in format of YYYY-MM-DD until which notes to fetch to.
+  # @option opts [NumberBoolean] :pinned_to_deal_flag If set, then results are filtered by note to deal pinning state.
+  # @option opts [NumberBoolean] :pinned_to_organization_flag If set, then results are filtered by note to organization pinning state.
+  # @option opts [NumberBoolean] :pinned_to_person_flag If set, then results are filtered by note to person pinning state.
+  # @return [GetNotes]
+  describe 'notes_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 notes_id_delete
+  # Delete a note
+  # Deletes a specific note.
+  # @param id ID of the note
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteNote]
+  describe 'notes_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 notes_id_get
+  # Get one note
+  # Returns details about a specific note.
+  # @param id ID of the note
+  # @param [Hash] opts the optional parameters
+  # @return [PostNote]
+  describe 'notes_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 notes_id_put
+  # Update a note
+  # Updates a note.
+  # @param id ID of the note
+  # @param content Content of the note in HTML format. Subject to sanitization on the back-end.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id ID of the user who will be marked as the author of this note. Only an admin can change the author.
+  # @option opts [Integer] :deal_id ID of the deal the note will be attached to.
+  # @option opts [Integer] :person_id ID of the person this note will be attached to.
+  # @option opts [Integer] :org_id ID of the organization this note will be attached to.
+  # @option opts [String] :add_time Optional creation date & time of the Note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
+  # @option opts [NumberBoolean] :pinned_to_deal_flag If set, then results are filtered by note to deal pinning state (deal_id is also required).
+  # @option opts [NumberBoolean] :pinned_to_organization_flag If set, then results are filtered by note to organization pinning state (org_id is also required).
+  # @option opts [NumberBoolean] :pinned_to_person_flag If set, then results are filtered by note to person pinning state (person_id is also required).
+  # @return [PostNote]
+  describe 'notes_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 notes_post
+  # Add a note
+  # Adds a new note.
+  # @param content Content of the note in HTML format. Subject to sanitization on the back-end.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id ID of the user who will be marked as the author of this note. Only an admin can change the author.
+  # @option opts [Integer] :deal_id ID of the deal the note will be attached to.
+  # @option opts [Integer] :person_id ID of the person this note will be attached to.
+  # @option opts [Integer] :org_id ID of the organization this note will be attached to.
+  # @option opts [String] :add_time Optional creation date & time of the Note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS
+  # @option opts [NumberBoolean] :pinned_to_deal_flag If set, then results are filtered by note to deal pinning state (deal_id is also required).
+  # @option opts [NumberBoolean] :pinned_to_organization_flag If set, then results are filtered by note to organization pinning state (org_id is also required).
+  # @option opts [NumberBoolean] :pinned_to_person_flag If set, then results are filtered by note to person pinning state (person_id is also required).
+  # @return [PostNote]
+  describe 'notes_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end