Class: Falcon::ReleaseNotes

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/release_notes.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ReleaseNotes

Returns a new instance of ReleaseNotes.



35
36
37
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 35

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#combined_release_notes_v1(authorization, opts = {}) ⇒ ReleasenotesReleaseNoteWrapperV1

Queries for release-notes resources and returns details

Parameters:

  • authorization (String) —

    authorization header

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

    the optional parameters

Options Hash (opts):

  • :x_cs_username (String) —

    user name

  • :filter (String) —

    FQL query specifying filter parameters.

  • :limit (Integer) —

    Maximum number of records to return.

  • :offset (String) —

    Starting pagination offset of records to return.

  • :sort (String) —

    Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Returns:



47
48
49
50
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 47

def combined_release_notes_v1(authorization, opts = {})
  data, _status_code, _headers = combined_release_notes_v1_with_http_info(authorization, opts)
  data
end

#combined_release_notes_v1_with_http_info(authorization, opts = {}) ⇒ Array<(ReleasenotesReleaseNoteWrapperV1, Integer, Hash)>

Queries for release-notes resources and returns details

Parameters:

  • authorization (String) —

    authorization header

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

    the optional parameters

Options Hash (opts):

  • :x_cs_username (String) —

    user name

  • :filter (String) —

    FQL query specifying filter parameters.

  • :limit (Integer) —

    Maximum number of records to return.

  • :offset (String) —

    Starting pagination offset of records to return.

  • :sort (String) —

    Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Returns:



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
95
96
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
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 61

def combined_release_notes_v1_with_http_info(authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleaseNotes.combined_release_notes_v1 ...'
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling ReleaseNotes.combined_release_notes_v1"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ReleaseNotes.combined_release_notes_v1, must be smaller than or equal to 500.'
  end

  pattern = Regexp.new(/^\w+(\.asc|\.desc)?(,\w+(\.asc|\.desc)?)*$/)
  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling ReleaseNotes.combined_release_notes_v1, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/deployment-coordinator/combined/release-notes/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Authorization'] = authorization
  header_params[:'X-CS-USERNAME'] = opts[:'x_cs_username'] if !opts[:'x_cs_username'].nil?

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

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

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

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

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

#get_entity_ids_by_query_post(authorization, body, opts = {}) ⇒ ReleasenotesReleaseNoteWrapperV1

returns the release notes for the IDs in the request

Parameters:

Options Hash (opts):

  • :x_cs_username (String) —

    user name

Returns:



130
131
132
133
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 130

def get_entity_ids_by_query_post(authorization, body, opts = {})
  data, _status_code, _headers = get_entity_ids_by_query_post_with_http_info(authorization, body, opts)
  data
end

#get_entity_ids_by_query_post_with_http_info(authorization, body, opts = {}) ⇒ Array<(ReleasenotesReleaseNoteWrapperV1, Integer, Hash)>

returns the release notes for the IDs in the request

Parameters:

Options Hash (opts):

  • :x_cs_username (String) —

    user name

Returns:



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
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 141

def get_entity_ids_by_query_post_with_http_info(authorization, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleaseNotes.get_entity_ids_by_query_post ...'
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling ReleaseNotes.get_entity_ids_by_query_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ReleaseNotes.get_entity_ids_by_query_post"
  end
  # resource path
  local_var_path = '/deployment-coordinator/entities/release-notes/GET/v1'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Authorization'] = authorization
  header_params[:'X-CS-USERNAME'] = opts[:'x_cs_username'] if !opts[:'x_cs_username'].nil?

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

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

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

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

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

#get_entity_ids_by_query_postv2(authorization, body, opts = {}) ⇒ ReleasenotesReleaseNoteWrapperV2

returns the release notes for the IDs in the request with EA and GA dates in ISO 8601 format

Parameters:

Options Hash (opts):

  • :x_cs_username (String) —

    user name

Returns:



206
207
208
209
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 206

def get_entity_ids_by_query_postv2(authorization, body, opts = {})
  data, _status_code, _headers = get_entity_ids_by_query_postv2_with_http_info(authorization, body, opts)
  data
end

#get_entity_ids_by_query_postv2_with_http_info(authorization, body, opts = {}) ⇒ Array<(ReleasenotesReleaseNoteWrapperV2, Integer, Hash)>

returns the release notes for the IDs in the request with EA and GA dates in ISO 8601 format

Parameters:

Options Hash (opts):

  • :x_cs_username (String) —

    user name

Returns:



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
273
274
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 217

def get_entity_ids_by_query_postv2_with_http_info(authorization, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleaseNotes.get_entity_ids_by_query_postv2 ...'
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling ReleaseNotes.get_entity_ids_by_query_postv2"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling ReleaseNotes.get_entity_ids_by_query_postv2"
  end
  # resource path
  local_var_path = '/deployment-coordinator/entities/release-notes/GET/v2'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Authorization'] = authorization
  header_params[:'X-CS-USERNAME'] = opts[:'x_cs_username'] if !opts[:'x_cs_username'].nil?

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

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

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

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

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

#query_release_notes_v1(authorization, opts = {}) ⇒ StringWrapper

Queries for release-notes resources and returns ids

Parameters:

  • authorization (String) —

    authorization header

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

    the optional parameters

Options Hash (opts):

  • :x_cs_username (String) —

    user name

  • :filter (String) —

    FQL query specifying filter parameters.

  • :limit (Integer) —

    Maximum number of records to return.

  • :offset (String) —

    Starting pagination offset of records to return.

  • :sort (String) —

    Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Returns:



285
286
287
288
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 285

def query_release_notes_v1(authorization, opts = {})
  data, _status_code, _headers = query_release_notes_v1_with_http_info(authorization, opts)
  data
end

#query_release_notes_v1_with_http_info(authorization, opts = {}) ⇒ Array<(StringWrapper, Integer, Hash)>

Queries for release-notes resources and returns ids

Parameters:

  • authorization (String) —

    authorization header

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

    the optional parameters

Options Hash (opts):

  • :x_cs_username (String) —

    user name

  • :filter (String) —

    FQL query specifying filter parameters.

  • :limit (Integer) —

    Maximum number of records to return.

  • :offset (String) —

    Starting pagination offset of records to return.

  • :sort (String) —

    Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Returns:

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

    StringWrapper data, response status code and response headers



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
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/crimson-falcon/api/release_notes.rb', line 299

def query_release_notes_v1_with_http_info(authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ReleaseNotes.query_release_notes_v1 ...'
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling ReleaseNotes.query_release_notes_v1"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ReleaseNotes.query_release_notes_v1, must be smaller than or equal to 500.'
  end

  pattern = Regexp.new(/^\w+(\.asc|\.desc)?(,\w+(\.asc|\.desc)?)*$/)
  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling ReleaseNotes.query_release_notes_v1, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/deployment-coordinator/queries/release-notes/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Authorization'] = authorization
  header_params[:'X-CS-USERNAME'] = opts[:'x_cs_username'] if !opts[:'x_cs_username'].nil?

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

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

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

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

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