pipedrive-openapi-client 1.0.0

data/lib/pipedrive-openapi-client/api/filters_api.rb

@@ -0,0 +1,436 @@
+=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 'cgi'
+
+module Pipedrive
+  class FiltersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete multiple filters in bulk
+    # Marks multiple filters as deleted.
+    # @param ids [String] Comma-separated filter IDs to delete
+    # @param [Hash] opts the optional parameters
+    # @return [BaseResponse]
+    def filters_delete(ids, opts = {})
+      data, _status_code, _headers = filters_delete_with_http_info(ids, opts)
+      data
+    end
+
+    # Delete multiple filters in bulk
+    # Marks multiple filters as deleted.
+    # @param ids [String] Comma-separated filter IDs to delete
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
+    def filters_delete_with_http_info(ids, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FiltersApi.filters_delete ...'
+      end
+      # verify the required parameter 'ids' is set
+      if @api_client.config.client_side_validation && ids.nil?
+        fail ArgumentError, "Missing the required parameter 'ids' when calling FiltersApi.filters_delete"
+      end
+      # resource path
+      local_var_path = '/filters'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ids'] = ids
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'BaseResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FiltersApi#filters_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all filters
+    # Returns data about all filters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [FilterType] :type The types of filters to fetch
+    # @return [BaseResponse]
+    def filters_get(opts = {})
+      data, _status_code, _headers = filters_get_with_http_info(opts)
+      data
+    end
+
+    # Get all filters
+    # Returns data about all filters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [FilterType] :type The types of filters to fetch
+    # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
+    def filters_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FiltersApi.filters_get ...'
+      end
+      # resource path
+      local_var_path = '/filters'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'BaseResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FiltersApi#filters_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all filter helpers
+    # Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/#!/Filters/post_filters\">add</a> or <a href=\"/docs/api/v1/#!/Filters/put_filters_id\">update</a> filters. For more information on how filter’s helpers can be used, see <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def filters_helpers_get(opts = {})
+      data, _status_code, _headers = filters_helpers_get_with_http_info(opts)
+      data
+    end
+
+    # Get all filter helpers
+    # Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to &lt;a href&#x3D;\&quot;/docs/api/v1/#!/Filters/post_filters\&quot;&gt;add&lt;/a&gt; or &lt;a href&#x3D;\&quot;/docs/api/v1/#!/Filters/put_filters_id\&quot;&gt;update&lt;/a&gt; filters. For more information on how filter’s helpers can be used, see &lt;a href&#x3D;\&quot;https://pipedrive.readme.io/docs/adding-a-filter\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;this tutorial&lt;/a&gt;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def filters_helpers_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FiltersApi.filters_helpers_get ...'
+      end
+      # resource path
+      local_var_path = '/filters/helpers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Object' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FiltersApi#filters_helpers_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a filter
+    # Marks a filter as deleted.
+    # @param [Hash] opts the optional parameters
+    # @return [BaseResponse]
+    def filters_id_delete(opts = {})
+      data, _status_code, _headers = filters_id_delete_with_http_info(opts)
+      data
+    end
+
+    # Delete a filter
+    # Marks a filter as deleted.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
+    def filters_id_delete_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FiltersApi.filters_id_delete ...'
+      end
+      # resource path
+      local_var_path = '/filters/{id}'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'BaseResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FiltersApi#filters_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get one filter
+    # Returns data about a specific filter. Note that this also returns the condition lines of the filter.
+    # @param id [Integer] The ID of the filter
+    # @param [Hash] opts the optional parameters
+    # @return [BaseResponse]
+    def filters_id_get(id, opts = {})
+      data, _status_code, _headers = filters_id_get_with_http_info(id, opts)
+      data
+    end
+
+    # Get one filter
+    # Returns data about a specific filter. Note that this also returns the condition lines of the filter.
+    # @param id [Integer] The ID of the filter
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
+    def filters_id_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FiltersApi.filters_id_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling FiltersApi.filters_id_get"
+      end
+      # resource path
+      local_var_path = '/filters/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'BaseResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FiltersApi#filters_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update filter
+    # Updates an existing filter.
+    # @param [Hash] opts the optional parameters
+    # @option opts [InlineObject13] :inline_object13 
+    # @return [nil]
+    def filters_id_put(opts = {})
+      filters_id_put_with_http_info(opts)
+      nil
+    end
+
+    # Update filter
+    # Updates an existing filter.
+    # @param [Hash] opts the optional parameters
+    # @option opts [InlineObject13] :inline_object13 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def filters_id_put_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FiltersApi.filters_id_put ...'
+      end
+      # resource path
+      local_var_path = '/filters/{id}'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'inline_object13']) 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FiltersApi#filters_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add a new filter
+    # Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information on how to add a new filter, see <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">this tutorial</a>.
+    # @param [Hash] opts the optional parameters
+    # @option opts [InlineObject12] :inline_object12 
+    # @return [BaseResponse]
+    def filters_post(opts = {})
+      data, _status_code, _headers = filters_post_with_http_info(opts)
+      data
+    end
+
+    # Add a new filter
+    # Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with &#39;AND&#39;, and only two second level condition groups are supported of which one must be glued with &#39;AND&#39; and the second with &#39;OR&#39;. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information on how to add a new filter, see &lt;a href&#x3D;\&quot;https://pipedrive.readme.io/docs/adding-a-filter\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;this tutorial&lt;/a&gt;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [InlineObject12] :inline_object12 
+    # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
+    def filters_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FiltersApi.filters_post ...'
+      end
+      # resource path
+      local_var_path = '/filters'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'inline_object12']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'BaseResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FiltersApi#filters_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pipedrive-openapi-client/api/global_messages_api.rb

@@ -0,0 +1,143 @@
+=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 'cgi'
+
+module Pipedrive
+  class GlobalMessagesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get global messages
+    # Returns data about global messages to display for the authorized user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of messages to get from 1 to 100. The message number 1 is returned by default. (default to 1)
+    # @return [GlobalMessageGet]
+    def global_messages_get(opts = {})
+      data, _status_code, _headers = global_messages_get_with_http_info(opts)
+      data
+    end
+
+    # Get global messages
+    # Returns data about global messages to display for the authorized user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of messages to get from 1 to 100. The message number 1 is returned by default.
+    # @return [Array<(GlobalMessageGet, Integer, Hash)>] GlobalMessageGet data, response status code and response headers
+    def global_messages_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GlobalMessagesApi.global_messages_get ...'
+      end
+      # resource path
+      local_var_path = '/globalMessages'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'GlobalMessageGet' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GlobalMessagesApi#global_messages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Dismiss a global message
+    # Removes global message from being shown, if message is dismissible
+    # @param id [Integer] ID of global message to be dismissed.
+    # @param [Hash] opts the optional parameters
+    # @return [GlobalMessageDelete]
+    def global_messages_id_delete(id, opts = {})
+      data, _status_code, _headers = global_messages_id_delete_with_http_info(id, opts)
+      data
+    end
+
+    # Dismiss a global message
+    # Removes global message from being shown, if message is dismissible
+    # @param id [Integer] ID of global message to be dismissed.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GlobalMessageDelete, Integer, Hash)>] GlobalMessageDelete data, response status code and response headers
+    def global_messages_id_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GlobalMessagesApi.global_messages_id_delete ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling GlobalMessagesApi.global_messages_id_delete"
+      end
+      # resource path
+      local_var_path = '/globalMessages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'GlobalMessageDelete' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GlobalMessagesApi#global_messages_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end