class Pipedrive::RecentsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pipedrive-openapi-client/api/recents_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

recents_get(since_timestamp, opts = {}) click to toggle source

Get recents Returns data about all recent changes occured after given timestamp. @param since_timestamp [String] Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS @param [Hash] opts the optional parameters @option opts [String] :items Multiple selection of item types to include in query (optional) @option opts [Integer] :start Pagination start (default to 0) @option opts [Integer] :limit Items shown per page @return [nil]

# File lib/pipedrive-openapi-client/api/recents_api.rb, line 30
def recents_get(since_timestamp, opts = {})
  recents_get_with_http_info(since_timestamp, opts)
  nil
end
recents_get_with_http_info(since_timestamp, opts = {}) click to toggle source

Get recents Returns data about all recent changes occured after given timestamp. @param since_timestamp [String] Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS @param [Hash] opts the optional parameters @option opts [String] :items Multiple selection of item types to include in query (optional) @option opts [Integer] :start Pagination start @option opts [Integer] :limit Items shown per page @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/pipedrive-openapi-client/api/recents_api.rb, line 43
def recents_get_with_http_info(since_timestamp, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RecentsApi.recents_get ...'
  end
  # verify the required parameter 'since_timestamp' is set
  if @api_client.config.client_side_validation && since_timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'since_timestamp' when calling RecentsApi.recents_get"
  end
  allowable_values = ["activity", "activityType", "deal", "delete_log", "file", "filter", "note", "person", "organization", "pipeline", "product", "stage", "user"]
  if @api_client.config.client_side_validation && opts[:'items'] && !allowable_values.include?(opts[:'items'])
    fail ArgumentError, "invalid value for \"items\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/recents'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'since_timestamp'] = since_timestamp
  query_params[:'items'] = opts[:'items'] if !opts[:'items'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # 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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecentsApi#recents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end