Class: BillingApi::ReservationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_billing_api/api/reservations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReservationsApi

Returns a new instance of ReservationsApi.



19
20
21
 
# File 'lib/pnap_billing_api/api/reservations_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/pnap_billing_api/api/reservations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#reservations_get(opts = {}) ⇒ Array<Reservation>

List all Reservations. Retrieves all reservations associated with the authenticated account. All date & times are in UTC.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



27
28
29
30
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 27

def reservations_get(opts = {})
  data, _status_code, _headers = reservations_get_with_http_info(opts)
  data
end

#reservations_get_with_http_info(opts = {}) ⇒ Array<(Array<Reservation>, Integer, Hash)>

List all Reservations. Retrieves all reservations associated with the authenticated account. All date &amp; times are in UTC.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Array<Reservation> data, response status code and response headers



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
80
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 37

def reservations_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReservationsApi.reservations_get ...'
  end
  # resource path
  local_var_path = '/reservations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'productCategory'] = opts[:'product_category'] if !opts[:'product_category'].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] || 'Array<Reservation>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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

#reservations_post(opts = {}) ⇒ Reservation

Create a reservation. Creates new package reservation for authenticated account.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



87
88
89
90
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 87

def reservations_post(opts = {})
  data, _status_code, _headers = reservations_post_with_http_info(opts)
  data
end

#reservations_post_with_http_info(opts = {}) ⇒ Array<(Reservation, Integer, Hash)>

Create a reservation. Creates new package reservation for authenticated account.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Reservation data, response status code and response headers



97
98
99
100
101
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
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 97

def reservations_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReservationsApi.reservations_post ...'
  end
  # resource path
  local_var_path = '/reservations'

  # 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[:'reservation_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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

#reservations_reservation_id_actions_auto_renew_disable_post(id, opts = {}) ⇒ Reservation

Disable auto-renewal for reservation by id. Disable auto-renewal for reservation by reservation id.

Parameters:

  • id (String) —

    Resource id.

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

    the optional parameters

Options Hash (opts):

Returns:



152
153
154
155
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 152

def reservations_reservation_id_actions_auto_renew_disable_post(id, opts = {})
  data, _status_code, _headers = reservations_reservation_id_actions_auto_renew_disable_post_with_http_info(id, opts)
  data
end

#reservations_reservation_id_actions_auto_renew_disable_post_with_http_info(id, opts = {}) ⇒ Array<(Reservation, Integer, Hash)>

Disable auto-renewal for reservation by id. Disable auto-renewal for reservation by reservation id.

Parameters:

  • id (String) —

    Resource id.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Reservation data, response status code and response headers



163
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
210
211
212
213
214
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 163

def reservations_reservation_id_actions_auto_renew_disable_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReservationsApi.reservations_reservation_id_actions_auto_renew_disable_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ReservationsApi.reservations_reservation_id_actions_auto_renew_disable_post"
  end
  # resource path
  local_var_path = '/reservations/{id}/actions/auto-renew/disable'.sub('{' + 'id' + '}', CGI.escape(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(opts[:'reservation_auto_renew_disable_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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

#reservations_reservation_id_actions_auto_renew_enable_post(id, opts = {}) ⇒ Reservation

Enable auto-renewal for unexpired reservation by reservation id. Enable auto-renewal for unexpired reservation by reservation id.

Parameters:

  • id (String) —

    Resource id.

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

    the optional parameters

Returns:



221
222
223
224
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 221

def reservations_reservation_id_actions_auto_renew_enable_post(id, opts = {})
  data, _status_code, _headers = reservations_reservation_id_actions_auto_renew_enable_post_with_http_info(id, opts)
  data
end

#reservations_reservation_id_actions_auto_renew_enable_post_with_http_info(id, opts = {}) ⇒ Array<(Reservation, Integer, Hash)>

Enable auto-renewal for unexpired reservation by reservation id. Enable auto-renewal for unexpired reservation by reservation id.

Parameters:

  • id (String) —

    Resource id.

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

    the optional parameters

Returns:

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

    Reservation data, response status code and response headers



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
273
274
275
276
277
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 231

def reservations_reservation_id_actions_auto_renew_enable_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReservationsApi.reservations_reservation_id_actions_auto_renew_enable_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ReservationsApi.reservations_reservation_id_actions_auto_renew_enable_post"
  end
  # resource path
  local_var_path = '/reservations/{id}/actions/auto-renew/enable'.sub('{' + 'id' + '}', CGI.escape(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] || 'Reservation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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

#reservations_reservation_id_actions_convert_post(id, opts = {}) ⇒ Reservation

Convert reservation pricing model by reservation ID. Convert reservation pricing model by reservation id.

Parameters:

  • id (String) —

    Resource id.

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

    the optional parameters

Options Hash (opts):

Returns:



285
286
287
288
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 285

def reservations_reservation_id_actions_convert_post(id, opts = {})
  data, _status_code, _headers = reservations_reservation_id_actions_convert_post_with_http_info(id, opts)
  data
end

#reservations_reservation_id_actions_convert_post_with_http_info(id, opts = {}) ⇒ Array<(Reservation, Integer, Hash)>

Convert reservation pricing model by reservation ID. Convert reservation pricing model by reservation id.

Parameters:

  • id (String) —

    Resource id.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Reservation data, response status code and response headers



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
347
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 296

def reservations_reservation_id_actions_convert_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReservationsApi.reservations_reservation_id_actions_convert_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ReservationsApi.reservations_reservation_id_actions_convert_post"
  end
  # resource path
  local_var_path = '/reservations/{id}/actions/convert'.sub('{' + 'id' + '}', CGI.escape(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(opts[:'reservation_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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

#reservations_reservation_id_get(id, opts = {}) ⇒ Reservation

Get a reservation. Retrieves the reservations with the specified identifier. All date & times are in UTC.

Parameters:

  • id (String) —

    Resource id.

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

    the optional parameters

Returns:



354
355
356
357
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 354

def reservations_reservation_id_get(id, opts = {})
  data, _status_code, _headers = reservations_reservation_id_get_with_http_info(id, opts)
  data
end

#reservations_reservation_id_get_with_http_info(id, opts = {}) ⇒ Array<(Reservation, Integer, Hash)>

Get a reservation. Retrieves the reservations with the specified identifier. All date &amp; times are in UTC.

Parameters:

  • id (String) —

    Resource id.

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

    the optional parameters

Returns:

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

    Reservation data, response status code and response headers



364
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
 
# File 'lib/pnap_billing_api/api/reservations_api.rb', line 364

def reservations_reservation_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReservationsApi.reservations_reservation_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ReservationsApi.reservations_reservation_id_get"
  end
  # resource path
  local_var_path = '/reservations/{id}'.sub('{' + 'id' + '}', CGI.escape(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] || 'Reservation'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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