Class: LinodeOpenapiClient::SupportApi

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/api/support_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SupportApi

Returns a new instance of SupportApi.



19
20
21
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_ticket(api_version, ticket_id, opts = {}) ⇒ GetTicket200Response

Get a support ticket Returns a Support Ticket under your Account. <<LB>> — - __CLI__. “‘ linode-cli tickets view 11223344 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 28

def get_ticket(api_version, ticket_id, opts = {})
  data, _status_code, _headers = get_ticket_with_http_info(api_version, ticket_id, opts)
  data
end

#get_ticket_replies(api_version, ticket_id, opts = {}) ⇒ GetTicketReplies200Response

List replies Returns a collection of replies to a Support Ticket on your Account. <<LB>> — - __CLI__. “‘ linode-cli tickets replies 11223344 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



104
105
106
107
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 104

def get_ticket_replies(api_version, ticket_id, opts = {})
  data, _status_code, _headers = get_ticket_replies_with_http_info(api_version, ticket_id, opts)
  data
end

#get_ticket_replies_with_http_info(api_version, ticket_id, opts = {}) ⇒ Array<(GetTicketReplies200Response, Integer, Hash)>

List replies Returns a collection of replies to a Support Ticket on your Account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli tickets replies 11223344 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetTicketReplies200Response data, response status code and response headers



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 117

def get_ticket_replies_with_http_info(api_version, ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupportApi.get_ticket_replies ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling SupportApi.get_ticket_replies"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling SupportApi.get_ticket_replies"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SupportApi.get_ticket_replies, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SupportApi.get_ticket_replies, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SupportApi.get_ticket_replies, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/support/tickets/{ticketId}/replies'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'GetTicketReplies200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"SupportApi.get_ticket_replies",
    :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: SupportApi#get_ticket_replies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ticket_with_http_info(api_version, ticket_id, opts = {}) ⇒ Array<(GetTicket200Response, Integer, Hash)>

Get a support ticket Returns a Support Ticket under your Account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli tickets view 11223344 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

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

    the optional parameters

Returns:

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

    GetTicket200Response data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 39

def get_ticket_with_http_info(api_version, ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupportApi.get_ticket ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling SupportApi.get_ticket"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling SupportApi.get_ticket"
  end
  # resource path
  local_var_path = '/{apiVersion}/support/tickets/{ticketId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'ticketId' + '}', CGI.escape(ticket_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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'GetTicket200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"SupportApi.get_ticket",
    :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: SupportApi#get_ticket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tickets(api_version, opts = {}) ⇒ GetTickets200Response

List support tickets Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account. This collection includes all Support Tickets generated on your Account, with open tickets returned first. <<LB>> — - __CLI__. “‘ linode-cli tickets list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



195
196
197
198
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 195

def get_tickets(api_version, opts = {})
  data, _status_code, _headers = get_tickets_with_http_info(api_version, opts)
  data
end

#get_tickets_with_http_info(api_version, opts = {}) ⇒ Array<(GetTickets200Response, Integer, Hash)>

List support tickets Returns a collection of Support Tickets on your Account. Support Tickets can be both tickets you open with Linode for support, as well as tickets generated by Linode regarding your Account. This collection includes all Support Tickets generated on your Account, with open tickets returned first. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli tickets list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetTickets200Response data, response status code and response headers



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
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
268
269
270
271
272
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 207

def get_tickets_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupportApi.get_tickets ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling SupportApi.get_tickets"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SupportApi.get_tickets, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SupportApi.get_tickets, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SupportApi.get_tickets, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/support/tickets'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'GetTickets200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"SupportApi.get_tickets",
    :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: SupportApi#get_tickets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_close_ticket(api_version, ticket_id, opts = {}) ⇒ Object

Close a support ticket Closes a Support Ticket you have access to modify. <<LB>> — - __CLI__. “‘ linode-cli tickets close 11223344 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

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

    the optional parameters

Returns:

  • (Object) 


280
281
282
283
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 280

def post_close_ticket(api_version, ticket_id, opts = {})
  data, _status_code, _headers = post_close_ticket_with_http_info(api_version, ticket_id, opts)
  data
end

#post_close_ticket_with_http_info(api_version, ticket_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Close a support ticket Closes a Support Ticket you have access to modify. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli tickets close 11223344 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 291

def post_close_ticket_with_http_info(api_version, ticket_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupportApi.post_close_ticket ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling SupportApi.post_close_ticket"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling SupportApi.post_close_ticket"
  end
  # resource path
  local_var_path = '/{apiVersion}/support/tickets/{ticketId}/close'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'ticketId' + '}', CGI.escape(ticket_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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"SupportApi.post_close_ticket",
    :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: SupportApi#post_close_ticket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ticket(api_version, opts = {}) ⇒ PostTicket200Response

Open a support ticket Open a Support Ticket. Only one of the ID attributes (‘linode_id`, `domain_id`, etc.) can be set on a single Support Ticket. <<LB>> — - __CLI__. “` linode-cli tickets create \ –description "I’m having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I’m not sure what I’m doing wrong. Can you please help me figure out how I can reset it?" \ –linode_id 123 \ –summary "Having trouble resetting root password on my Linode" “‘ [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

Returns:



354
355
356
357
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 354

def post_ticket(api_version, opts = {})
  data, _status_code, _headers = post_ticket_with_http_info(api_version, opts)
  data
end

#post_ticket_attachment(api_version, ticket_id, file, opts = {}) ⇒ Object

Create a support ticket attachment Adds a file attachment to an existing Support Ticket on your Account. File attachments are used to assist our Support team in resolving your Ticket. Examples of attachments are screen shots and text files that provide additional information. The file attachment is submitted in the request as multipart/form-data. __Note__. Accepted file extensions include: .gif, .jpg, .jpeg, .pjpg, .pjpeg, .tif, .tiff, .png, .pdf, or .txt. <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

  • file (String) —

    The local, absolute path to the file you want to attach to your Support Ticket.

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

    the optional parameters

Returns:

  • (Object) 


430
431
432
433
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 430

def post_ticket_attachment(api_version, ticket_id, file, opts = {})
  data, _status_code, _headers = post_ticket_attachment_with_http_info(api_version, ticket_id, file, opts)
  data
end

#post_ticket_attachment_with_http_info(api_version, ticket_id, file, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Create a support ticket attachment Adds a file attachment to an existing Support Ticket on your Account. File attachments are used to assist our Support team in resolving your Ticket. Examples of attachments are screen shots and text files that provide additional information. The file attachment is submitted in the request as multipart/form-data. __Note__. Accepted file extensions include: .gif, .jpg, .jpeg, .pjpg, .pjpeg, .tif, .tiff, .png, .pdf, or .txt. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

  • file (String) —

    The local, absolute path to the file you want to attach to your Support Ticket.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 442

def post_ticket_attachment_with_http_info(api_version, ticket_id, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupportApi.post_ticket_attachment ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling SupportApi.post_ticket_attachment"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling SupportApi.post_ticket_attachment"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling SupportApi.post_ticket_attachment"
  end
  # resource path
  local_var_path = '/{apiVersion}/support/tickets/{ticketId}/attachments'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'ticketId' + '}', CGI.escape(ticket_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"SupportApi.post_ticket_attachment",
    :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: SupportApi#post_ticket_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ticket_reply(api_version, ticket_id, post_ticket_reply_request, opts = {}) ⇒ PostTicketReply200Response

Create a reply Adds a reply to an existing Support Ticket. <<LB>> — - __CLI__. “‘ linode-cli tickets reply 11223344 \ –description "Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!" “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

  • post_ticket_reply_request (PostTicketReplyRequest) —

    Add a reply.

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

    the optional parameters

Returns:



516
517
518
519
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 516

def post_ticket_reply(api_version, ticket_id, post_ticket_reply_request, opts = {})
  data, _status_code, _headers = post_ticket_reply_with_http_info(api_version, ticket_id, post_ticket_reply_request, opts)
  data
end

#post_ticket_reply_with_http_info(api_version, ticket_id, post_ticket_reply_request, opts = {}) ⇒ Array<(PostTicketReply200Response, Integer, Hash)>

Create a reply Adds a reply to an existing Support Ticket. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli tickets reply 11223344 \ –description &quot;Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • ticket_id (Integer) —

    The ID of the Support Ticket.

  • post_ticket_reply_request (PostTicketReplyRequest) —

    Add a reply.

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

    the optional parameters

Returns:

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

    PostTicketReply200Response data, response status code and response headers



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 528

def post_ticket_reply_with_http_info(api_version, ticket_id, post_ticket_reply_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupportApi.post_ticket_reply ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling SupportApi.post_ticket_reply"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling SupportApi.post_ticket_reply"
  end
  # verify the required parameter 'post_ticket_reply_request' is set
  if @api_client.config.client_side_validation && post_ticket_reply_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_ticket_reply_request' when calling SupportApi.post_ticket_reply"
  end
  # resource path
  local_var_path = '/{apiVersion}/support/tickets/{ticketId}/replies'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'ticketId' + '}', CGI.escape(ticket_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_ticket_reply_request)

  # return_type
  return_type = opts[:debug_return_type] || 'PostTicketReply200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"SupportApi.post_ticket_reply",
    :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: SupportApi#post_ticket_reply\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ticket_with_http_info(api_version, opts = {}) ⇒ Array<(PostTicket200Response, Integer, Hash)>

Open a support ticket Open a Support Ticket. Only one of the ID attributes (&#x60;linode_id&#x60;, &#x60;domain_id&#x60;, etc.) can be set on a single Support Ticket. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli tickets create \ –description &quot;I&#39;m having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I&#39;m not sure what I&#39;m doing wrong. Can you please help me figure out how I can reset it?&quot; \ –linode_id 123 \ –summary &quot;Having trouble resetting root password on my Linode&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PostTicket200Response data, response status code and response headers



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/linode_openapi_client/api/support_api.rb', line 365

def post_ticket_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SupportApi.post_ticket ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling SupportApi.post_ticket"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/support/tickets'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'post_ticket_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'PostTicket200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"SupportApi.post_ticket",
    :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: SupportApi#post_ticket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end