Class: TogaiClient::LicensesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/api/licenses_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LicensesApi

Returns a new instance of LicensesApi.



19
20
21
 
# File 'lib/togai_client/api/licenses_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/togai_client/api/licenses_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_license_update_entry(opts = {}) ⇒ LicenseUpdateResponse

Update a license entry This API let’s you to add a license entry

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



27
28
29
30
 
# File 'lib/togai_client/api/licenses_api.rb', line 27

def add_license_update_entry(opts = {})
  data, _status_code, _headers = add_license_update_entry_with_http_info(opts)
  data
end

#add_license_update_entry_with_http_info(opts = {}) ⇒ Array<(LicenseUpdateResponse, Integer, Hash)>

Update a license entry This API let’s you to add a license entry

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    LicenseUpdateResponse 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
81
82
83
84
 
# File 'lib/togai_client/api/licenses_api.rb', line 37

def add_license_update_entry_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LicensesApi.add_license_update_entry ...'
  end
  # resource path
  local_var_path = '/license_updates'

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

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

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

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

#get_license_updates(opts = {}) ⇒ GetLicenseUpdatesResponse

Get a list of licenses updates This API let’s you to fetch a list of licenses updates with multiple query parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_token (String) —

    Pagination token used as a marker to get records from next page.

  • :account_id (String) —

    Filter option to filter based on account id.

  • :page_size (Integer) —

    Maximum page size expected by client to return the record list. NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

  • :license_id (String) —

    License Id to filter

  • :effective_from (Time) —

    effectiveFrom to filter

Returns:



95
96
97
98
 
# File 'lib/togai_client/api/licenses_api.rb', line 95

def get_license_updates(opts = {})
  data, _status_code, _headers = get_license_updates_with_http_info(opts)
  data
end

#get_license_updates_with_http_info(opts = {}) ⇒ Array<(GetLicenseUpdatesResponse, Integer, Hash)>

Get a list of licenses updates This API let’s you to fetch a list of licenses updates with multiple query parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_token (String) —

    Pagination token used as a marker to get records from next page.

  • :account_id (String) —

    Filter option to filter based on account id.

  • :page_size (Integer) —

    Maximum page size expected by client to return the record list. NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

  • :license_id (String) —

    License Id to filter

  • :effective_from (Time) —

    effectiveFrom to filter

Returns:

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

    GetLicenseUpdatesResponse data, response status code and response headers



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
152
153
154
155
156
 
# File 'lib/togai_client/api/licenses_api.rb', line 109

def get_license_updates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LicensesApi.get_license_updates ...'
  end
  # resource path
  local_var_path = '/license_updates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'licenseId'] = opts[:'license_id'] if !opts[:'license_id'].nil?
  query_params[:'effectiveFrom'] = opts[:'effective_from'] if !opts[:'effective_from'].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] || 'GetLicenseUpdatesResponse'

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

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

#get_named_license_updates(opts = {}) ⇒ NamedLicenseUpdatesPaginatedResponse

Get a list of named licenses updates This API let’s you to fetch a list of named licenses updates with multiple query parameters

Parameters:

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

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/togai_client/api/licenses_api.rb', line 162

def get_named_license_updates(opts = {})
  data, _status_code, _headers = get_named_license_updates_with_http_info(opts)
  data
end

#get_named_license_updates_with_http_info(opts = {}) ⇒ Array<(NamedLicenseUpdatesPaginatedResponse, Integer, Hash)>

Get a list of named licenses updates This API let’s you to fetch a list of named licenses updates with multiple query parameters

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/togai_client/api/licenses_api.rb', line 171

def get_named_license_updates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LicensesApi.get_named_license_updates ...'
  end
  # resource path
  local_var_path = '/named_license_updates'

  # 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] || 'NamedLicenseUpdatesPaginatedResponse'

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

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

#update_license_entry_details(opts = {}) ⇒ LicenseUpdateResponse

Update a license entry details This API let’s you to update metadata of a license entry

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



221
222
223
224
 
# File 'lib/togai_client/api/licenses_api.rb', line 221

def update_license_entry_details(opts = {})
  data, _status_code, _headers = update_license_entry_details_with_http_info(opts)
  data
end

#update_license_entry_details_with_http_info(opts = {}) ⇒ Array<(LicenseUpdateResponse, Integer, Hash)>

Update a license entry details This API let’s you to update metadata of a license entry

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    LicenseUpdateResponse data, response status code and response headers



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
278
279
280
 
# File 'lib/togai_client/api/licenses_api.rb', line 232

def update_license_entry_details_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LicensesApi.update_license_entry_details ...'
  end
  # resource path
  local_var_path = '/license_updates/{license_id}'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'licenseId'] = opts[:'license_id'] if !opts[:'license_id'].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']
  # 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[:'license_entry_details_update_request'])

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

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

  new_options = opts.merge(
    :operation => :"LicensesApi.update_license_entry_details",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LicensesApi#update_license_entry_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end