Class: Hubspot::OAuth::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/oauth/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.


20
21
22
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 20

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


18
19
20
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#archive_refresh_token(token, opts = {}) ⇒ Error

Parameters:

  • token (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:


26
27
28
29
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 26

def archive_refresh_token(token, opts = {})
  data, _status_code, _headers = archive_refresh_token_with_http_info(token, opts)
  data
end

#archive_refresh_token_with_http_info(token, opts = {}) ⇒ Array<(Error, Integer, Hash)>

Returns Error data, response status code and response headers.

Parameters:

  • token (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Error, Integer, Hash)>)

    Error data, response status code and response headers


34
35
36
37
38
39
40
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
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 34

def archive_refresh_token_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.archive_refresh_token ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DefaultApi.archive_refresh_token"
  end
  # resource path
  local_var_path = '/oauth/v1/refresh-tokens/{token}'.sub('{' + 'token' + '}', CGI.escape(token.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(['*/*'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Error' 

  # auth_names
  auth_names = opts[:auth_names] || []

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

#create_token(opts = {}) ⇒ TokenResponseIF

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :grant_type (String)
  • :code (String)
  • :redirect_uri (String)
  • :client_id (String)
  • :client_secret (String)
  • :refresh_token (String)

Returns:


89
90
91
92
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 89

def create_token(opts = {})
  data, _status_code, _headers = create_token_with_http_info(opts)
  data
end

#create_token_with_http_info(opts = {}) ⇒ Array<(TokenResponseIF, Integer, Hash)>

Returns TokenResponseIF data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :grant_type (String)
  • :code (String)
  • :redirect_uri (String)
  • :client_id (String)
  • :client_secret (String)
  • :refresh_token (String)

Returns:

  • (Array<(TokenResponseIF, Integer, Hash)>)

    TokenResponseIF data, response status code and response headers


102
103
104
105
106
107
108
109
110
111
112
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
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 102

def create_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_token ...'
  end
  # resource path
  local_var_path = '/oauth/v1/token'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['grant_type'] = opts[:'grant_type'] if !opts[:'grant_type'].nil?
  form_params['code'] = opts[:'code'] if !opts[:'code'].nil?
  form_params['redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
  form_params['client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
  form_params['client_secret'] = opts[:'client_secret'] if !opts[:'client_secret'].nil?
  form_params['refresh_token'] = opts[:'refresh_token'] if !opts[:'refresh_token'].nil?

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

  # return_type
  return_type = opts[:return_type] || 'TokenResponseIF' 

  # auth_names
  auth_names = opts[:auth_names] || []

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

#get_access_token(token, opts = {}) ⇒ AccessTokenInfoResponse

Parameters:

  • token (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:


156
157
158
159
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 156

def get_access_token(token, opts = {})
  data, _status_code, _headers = get_access_token_with_http_info(token, opts)
  data
end

#get_access_token_with_http_info(token, opts = {}) ⇒ Array<(AccessTokenInfoResponse, Integer, Hash)>

Returns AccessTokenInfoResponse data, response status code and response headers.

Parameters:

  • token (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(AccessTokenInfoResponse, Integer, Hash)>)

    AccessTokenInfoResponse data, response status code and response headers


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 164

def get_access_token_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_access_token ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DefaultApi.get_access_token"
  end
  # resource path
  local_var_path = '/oauth/v1/access-tokens/{token}'.sub('{' + 'token' + '}', CGI.escape(token.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] || 'AccessTokenInfoResponse' 

  # auth_names
  auth_names = opts[:auth_names] || []

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

#get_refresh_token(token, opts = {}) ⇒ RefreshTokenInfoResponse

Parameters:

  • token (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:


214
215
216
217
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 214

def get_refresh_token(token, opts = {})
  data, _status_code, _headers = get_refresh_token_with_http_info(token, opts)
  data
end

#get_refresh_token_with_http_info(token, opts = {}) ⇒ Array<(RefreshTokenInfoResponse, Integer, Hash)>

Returns RefreshTokenInfoResponse data, response status code and response headers.

Parameters:

  • token (String)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(RefreshTokenInfoResponse, Integer, Hash)>)

    RefreshTokenInfoResponse data, response status code and response headers


222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/hubspot/codegen/oauth/api/default_api.rb', line 222

def get_refresh_token_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_refresh_token ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling DefaultApi.get_refresh_token"
  end
  # resource path
  local_var_path = '/oauth/v1/refresh-tokens/{token}'.sub('{' + 'token' + '}', CGI.escape(token.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] || 'RefreshTokenInfoResponse' 

  # auth_names
  auth_names = opts[:auth_names] || []

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