pipedrive-openapi-client 1.0.0

data/spec/api/organization_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::OrganizationFieldsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'OrganizationFieldsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::OrganizationFieldsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrganizationFieldsApi' do
+    it 'should create an instance of OrganizationFieldsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::OrganizationFieldsApi)
+    end
+  end
+
+  # unit tests for organization_fields_delete
+  # Delete multiple organization 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 'organization_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 organization_fields_get
+  # Get all organization fields
+  # Returns data about all organization fields
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organization_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 organization_fields_id_delete
+  # Delete an organization 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 'organization_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 organization_fields_id_get
+  # Get one organization field
+  # Returns data about a specific organization field.
+  # @param id ID of the field
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organization_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 organization_fields_id_put
+  # Update an organization field
+  # Updates an organization 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 of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: [{\\\"id\\\":123,\\\"label\\\":\\\"Existing Item\\\"},{\\\"label\\\":\\\"New Item\\\"}]
+  # @return [nil]
+  describe 'organization_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 organization_fields_post
+  # Add a new organization field
+  # Adds a new organization 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 'organization_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/organization_relationships_api_spec.rb

@@ -0,0 +1,99 @@
+=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::OrganizationRelationshipsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'OrganizationRelationshipsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::OrganizationRelationshipsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrganizationRelationshipsApi' do
+    it 'should create an instance of OrganizationRelationshipsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::OrganizationRelationshipsApi)
+    end
+  end
+
+  # unit tests for organization_relationships_get
+  # Get all relationships for organization
+  # Gets all of the relationships for a supplied organization id.
+  # @param org_id ID of the organization to get relationships for
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organization_relationships_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 organization_relationships_id_delete
+  # Delete an organization relationship
+  # Deletes an organization relationship and returns the deleted id.
+  # @param id ID of the organization relationship
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organization_relationships_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 organization_relationships_id_get
+  # Get one organization relationship
+  # Finds and returns an organization relationship from its ID.
+  # @param id ID of the organization relationship
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :org_id ID of the base organization for the returned calculated values
+  # @return [nil]
+  describe 'organization_relationships_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 organization_relationships_id_put
+  # Update an organization relationship
+  # Updates and returns an organization relationship.
+  # @param id ID of the organization relationship
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :org_id ID of the base organization for the returned calculated values
+  # @option opts [String] :type The type of organization relationship.
+  # @option opts [Integer] :rel_owner_org_id The owner of this relationship. If type is 'parent', then the owner is the parent and the linked organization is the daughter.
+  # @option opts [Integer] :rel_linked_org_id The linked organization in this relationship. If type is 'parent', then the linked organization is the daughter.
+  # @return [nil]
+  describe 'organization_relationships_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 organization_relationships_post
+  # Create an organization relationship
+  # Creates and returns an organization relationship.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organization_relationships_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/organizations_api_spec.rb

@@ -0,0 +1,300 @@
+=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::OrganizationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'OrganizationsApi' do
+  before do
+    # run before each test
+    @api_instance = Pipedrive::OrganizationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrganizationsApi' do
+    it 'should create an instance of OrganizationsApi' do
+      expect(@api_instance).to be_instance_of(Pipedrive::OrganizationsApi)
+    end
+  end
+
+  # unit tests for organizations_delete
+  # Delete multiple organizations in bulk
+  # Marks multiple organizations as deleted.
+  # @param ids Comma-separated IDs that will be deleted
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_find_get
+  # Find organizations by name
+  # <strong>This endpoint is deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_search\">/v1/organizations/search</a> or <<a href=\"https://developers.pipedrive.com/docs/api/v1/#!/ItemSearch/get_itemSearch\">/v1/itemSearch</a> instead</strong>. <br> Searches all organizations by their name.
+  # @param term Search term to look for
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'organizations_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 organizations_get
+  # Get all organizations
+  # Returns all organizations
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :user_id If supplied, only organizations 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 organizations 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
+  # @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).
+  # @return [nil]
+  describe 'organizations_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 organizations_id_activities_get
+  # List activities associated with an organization
+  # Lists activities associated with an organization.
+  # @param id ID of the organization
+  # @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 'organizations_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 organizations_id_deals_get
+  # List deals associated with an organization
+  # Lists deals associated with an organization.
+  # @param id ID of the organization
+  # @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.
+  # @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] :only_primary_association If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.
+  # @return [nil]
+  describe 'organizations_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 organizations_id_delete
+  # Delete an organization
+  # Marks an organization as deleted.
+  # @param id ID of the organization
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_id_files_get
+  # List files attached to an organization
+  # Lists files associated with an organization.
+  # @param id ID of the organization
+  # @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 'organizations_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 organizations_id_flow_get
+  # List updates about an organization
+  # Lists updates about an organization.
+  # @param id ID of the organization
+  # @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 'organizations_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 organizations_id_followers_follower_id_delete
+  # Delete a follower from an organization
+  # Deletes a follower from an organization. You can retrieve the follower_id from the <a href=\"https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_followers\">List followers of an organization</a> endpoint.
+  # @param id ID of the organization
+  # @param follower_id ID of the follower
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_id_followers_get
+  # List followers of an organization
+  # Lists the followers of an organization.
+  # @param id ID of the organization
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_id_followers_post
+  # Add a follower to an organization
+  # Adds a follower to an organization.
+  # @param id ID of the organization
+  # @param user_id ID of the user
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_id_get
+  # Get details of an organization
+  # Returns details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the 'key' value of organizationFields.
+  # @param id ID of the organization
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_id_mail_messages_get
+  # List mail messages associated with an organization
+  # Lists mail messages associated with an organization.
+  # @param id ID of the organization
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'organizations_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 organizations_id_merge_put
+  # Merge two organizations
+  # Merges an organization with another organization. For more information on how to merge two organizations, see <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param id ID of the organization
+  # @param merge_with_id ID of the organization that the organization will be merged with
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_id_permitted_users_get
+  # List permitted users
+  # List users permitted to access an organization
+  # @param id ID of the organization
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_id_persons_get
+  # List persons of an organization
+  # Lists persons associated with an organization.
+  # @param id ID of the organization
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start Pagination start
+  # @option opts [Integer] :limit Items shown per page
+  # @return [nil]
+  describe 'organizations_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 organizations_id_put
+  # Update an organization
+  # Updates the properties of an organization.
+  # @param id ID of the organization
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name Organization name
+  # @option opts [Integer] :owner_id ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used.
+  # @option opts [VisibleTo] :visible_to Visibility of the organization. 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 [nil]
+  describe 'organizations_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 organizations_post
+  # Add an organization
+  # Adds a new organization. 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 organizationFields and look for 'key' values. For more information on how to add an organization, see <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'organizations_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 organizations_search_get
+  # Search organizations
+  # Searches all Organizations by name, address, 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.
+  # @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] :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 'organizations_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