class Hubspot::Crm::Owners::DefaultApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/hubspot/codegen/crm/owners/api/default_api.rb, line 23
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_by_id(owner_id, opts = {}) click to toggle source

Read an owner by given `id` or `userId` @param owner_id [Integer] @param [Hash] opts the optional parameters @option opts [String] :id_property (default to 'id') @return [PublicOwner]

# File lib/hubspot/codegen/crm/owners/api/default_api.rb, line 31
def get_by_id(owner_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(owner_id, opts)
  data
end
get_by_id_with_http_info(owner_id, opts = {}) click to toggle source

Read an owner by given &#x60;id&#x60; or &#x60;userId&#x60; @param owner_id [Integer] @param [Hash] opts the optional parameters @option opts [String] :id_property @return [Array<(PublicOwner, Integer, Hash)>] PublicOwner data, response status code and response headers

# File lib/hubspot/codegen/crm/owners/api/default_api.rb, line 41
def get_by_id_with_http_info(owner_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_by_id ...'
  end
  # verify the required parameter 'owner_id' is set
  if @api_client.config.client_side_validation && owner_id.nil?
    fail ArgumentError, "Missing the required parameter 'owner_id' when calling DefaultApi.get_by_id"
  end
  allowable_values = ["id", "userId"]
  if @api_client.config.client_side_validation && opts[:'id_property'] && !allowable_values.include?(opts[:'id_property'])
    fail ArgumentError, "invalid value for \"id_property\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/crm/v3/owners/{ownerId}'.sub('{' + 'ownerId' + '}', CGI.escape(owner_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].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] || 'PublicOwner' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', '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: DefaultApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_page(opts = {}) click to toggle source

Get a page of owners @param [Hash] opts the optional parameters @option opts [String] :email Filter by email address (optional) @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results. @option opts [Integer] :limit The maximum number of results to display per page. (default to 100) @return [CollectionResponsePublicOwner]

# File lib/hubspot/codegen/crm/owners/api/default_api.rb, line 99
def get_page(opts = {})
  data, _status_code, _headers = get_page_with_http_info(opts)
  data
end
get_page_with_http_info(opts = {}) click to toggle source

Get a page of owners @param [Hash] opts the optional parameters @option opts [String] :email Filter by email address (optional) @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results. @option opts [Integer] :limit The maximum number of results to display per page. @return [Array<(CollectionResponsePublicOwner, Integer, Hash)>] CollectionResponsePublicOwner data, response status code and response headers

# File lib/hubspot/codegen/crm/owners/api/default_api.rb, line 110
def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_page ...'
  end
  # resource path
  local_var_path = '/crm/v3/owners/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  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] || 'CollectionResponsePublicOwner' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', '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: DefaultApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end