Class: Hubspot::Crm::Owners::OwnersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/owners/api/owners_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OwnersApi

Returns a new instance of OwnersApi.



21
22
23
 
# File 'lib/hubspot/codegen/crm/owners/api/owners_api.rb', line 21

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/crm/owners/api/owners_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#get_by_id(owner_id, opts = {}) ⇒ PublicOwner

Read an owner by given ‘id` or `userId`

Parameters:

  • owner_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_property (String) — default: default to 'id'
  • :archived (Boolean) —

    Whether to return only results that have been archived. (default to false)

Returns:



30
31
32
33
 
# File 'lib/hubspot/codegen/crm/owners/api/owners_api.rb', line 30

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 = {}) ⇒ Array<(PublicOwner, Integer, Hash)>

Read an owner by given &#x60;id&#x60; or &#x60;userId&#x60;

Parameters:

  • owner_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_property (String)
  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:

  • (Array<(PublicOwner, Integer, Hash)>) —

    PublicOwner data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/hubspot/codegen/crm/owners/api/owners_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: OwnersApi.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 OwnersApi.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?
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].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: OwnersApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_page(opts = {}) ⇒ CollectionResponsePublicOwnerForwardPaging

Get a page of owners

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :email (String) —

    Filter by email address (optional)

  • :after (String) —

    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.

  • :limit (Integer) —

    The maximum number of results to display per page. (default to 100)

  • :archived (Boolean) —

    Whether to return only results that have been archived. (default to false)

Returns:



101
102
103
104
 
# File 'lib/hubspot/codegen/crm/owners/api/owners_api.rb', line 101

def get_page(opts = {})
  data, _status_code, _headers = get_page_with_http_info(opts)
  data
end

#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponsePublicOwnerForwardPaging, Integer, Hash)>

Get a page of owners

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :email (String) —

    Filter by email address (optional)

  • :after (String) —

    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.

  • :limit (Integer) —

    The maximum number of results to display per page.

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/hubspot/codegen/crm/owners/api/owners_api.rb', line 113

def get_page_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OwnersApi.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?
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].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] || 'CollectionResponsePublicOwnerForwardPaging' 

  # 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: OwnersApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end