Class: RusticiSoftwareCloudV2::InvitationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/api/invitations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvitationsApi

Returns a new instance of InvitationsApi.



18
19
20
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_private_invitation(private_invitation_request, opts = {}) ⇒ InvitationSummarySchema

Create a private invitation to a course. Create a private invitation to a course. The provided information will be used to create new registrations for all of the provided e-mail addresses, and send asynchronously send e-mails to those addresses inviting them to the course. To check the status of this process, a subsequent call to ‘/invitations/private/invitationId/status` must be made.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 27

def create_private_invitation(private_invitation_request, opts = {})
  data, _status_code, _headers = create_private_invitation_with_http_info(private_invitation_request, opts)
  return data
end

#create_private_invitation_with_http_info(private_invitation_request, opts = {}) ⇒ Array<(InvitationSummarySchema, Fixnum, Hash)>

Create a private invitation to a course. Create a private invitation to a course. The provided information will be used to create new registrations for all of the provided e-mail addresses, and send asynchronously send e-mails to those addresses inviting them to the course. To check the status of this process, a subsequent call to &#x60;/invitations/private/invitationId/status&#x60; must be made.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(InvitationSummarySchema, Fixnum, Hash)>) —

    InvitationSummarySchema 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
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 37

def create_private_invitation_with_http_info(private_invitation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.create_private_invitation ..."
  end
  # verify the required parameter 'private_invitation_request' is set
  fail ArgumentError, "Missing the required parameter 'private_invitation_request' when calling InvitationsApi.create_private_invitation" if private_invitation_request.nil?
  # resource path
  local_var_path = "/invitations/private".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(private_invitation_request)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvitationSummarySchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#create_private_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_public_invitation(public_invitation_request, opts = {}) ⇒ PublicInvitationSchema

Create a publicly accessible invitation to a course. Create a publicly accessible invitation to a course.

Parameters:

  • public_invitation_request —

    A description of the public invitation to be created.

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 80

def create_public_invitation(public_invitation_request, opts = {})
  data, _status_code, _headers = create_public_invitation_with_http_info(public_invitation_request, opts)
  return data
end

#create_public_invitation_with_http_info(public_invitation_request, opts = {}) ⇒ Array<(PublicInvitationSchema, Fixnum, Hash)>

Create a publicly accessible invitation to a course. Create a publicly accessible invitation to a course.

Parameters:

  • public_invitation_request —

    A description of the public invitation to be created.

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

    the optional parameters

Returns:

  • (Array<(PublicInvitationSchema, Fixnum, Hash)>) —

    PublicInvitationSchema data, response status code and response headers



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
123
124
125
126
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 90

def create_public_invitation_with_http_info(public_invitation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.create_public_invitation ..."
  end
  # verify the required parameter 'public_invitation_request' is set
  fail ArgumentError, "Missing the required parameter 'public_invitation_request' when calling InvitationsApi.create_public_invitation" if public_invitation_request.nil?
  # resource path
  local_var_path = "/invitations/public".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(public_invitation_request)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PublicInvitationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#create_public_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_invitation_tags(invitation_id, tags, opts = {}) ⇒ nil

Delete the tags for this invitation Delete the tags for this invitation

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Returns:

  • (nil) 


134
135
136
137
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 134

def delete_invitation_tags(invitation_id, tags, opts = {})
  delete_invitation_tags_with_http_info(invitation_id, tags, opts)
  return nil
end

#delete_invitation_tags_with_http_info(invitation_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the tags for this invitation Delete the tags for this invitation

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 145

def delete_invitation_tags_with_http_info(invitation_id, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.delete_invitation_tags ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.delete_invitation_tags" if invitation_id.nil?
  # verify the required parameter 'tags' is set
  fail ArgumentError, "Missing the required parameter 'tags' when calling InvitationsApi.delete_invitation_tags" if tags.nil?
  # resource path
  local_var_path = "/invitations/{invitationId}/tags".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(tags)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#delete_invitation_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_invitations(opts = {}) ⇒ InvitationSummaryList

Get a list of invitation summaries. Get a summary of all the invitations for an appId, both public and private.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Limit the results to invitations with courseIds that match the filter.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;. (default to updated)

  • :tags (Array<String>)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:



194
195
196
197
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 194

def get_all_invitations(opts = {})
  data, _status_code, _headers = get_all_invitations_with_http_info(opts)
  return data
end

#get_all_invitations_with_http_info(opts = {}) ⇒ Array<(InvitationSummaryList, Fixnum, Hash)>

Get a list of invitation summaries. Get a summary of all the invitations for an appId, both public and private.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Limit the results to invitations with courseIds that match the filter.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;.

  • :tags (Array<String>)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:

  • (Array<(InvitationSummaryList, Fixnum, Hash)>) —

    InvitationSummaryList data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 209

def get_all_invitations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_all_invitations ..."
  end
  if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  # resource path
  local_var_path = "/invitations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvitationSummaryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_all_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invitation_tags(invitation_id, opts = {}) ⇒ TagListSchema

Get the tags for this invitation Get the tags for this invitation

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Returns:



259
260
261
262
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 259

def get_invitation_tags(invitation_id, opts = {})
  data, _status_code, _headers = get_invitation_tags_with_http_info(invitation_id, opts)
  return data
end

#get_invitation_tags_with_http_info(invitation_id, opts = {}) ⇒ Array<(TagListSchema, Fixnum, Hash)>

Get the tags for this invitation Get the tags for this invitation

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Returns:

  • (Array<(TagListSchema, Fixnum, Hash)>) —

    TagListSchema data, response status code and response headers



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 269

def get_invitation_tags_with_http_info(invitation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_invitation_tags ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_invitation_tags" if invitation_id.nil?
  # resource path
  local_var_path = "/invitations/{invitationId}/tags".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TagListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_invitation_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_private_invitation(invitation_id, opts = {}) ⇒ PrivateInvitationSchema

Get a information about a private invitation. Get a information about a private invitation.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Options Hash (opts):

  • :include_registration_count (BOOLEAN) —

    Include the registration count in the results (default to false)

Returns:



313
314
315
316
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 313

def get_private_invitation(invitation_id, opts = {})
  data, _status_code, _headers = get_private_invitation_with_http_info(invitation_id, opts)
  return data
end

#get_private_invitation_job_status(invitation_id, opts = {}) ⇒ InvitationJobStatusSchema

Get the status of an invitation job. Get the status of a job to send out private invitations.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Returns:



368
369
370
371
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 368

def get_private_invitation_job_status(invitation_id, opts = {})
  data, _status_code, _headers = get_private_invitation_job_status_with_http_info(invitation_id, opts)
  return data
end

#get_private_invitation_job_status_with_http_info(invitation_id, opts = {}) ⇒ Array<(InvitationJobStatusSchema, Fixnum, Hash)>

Get the status of an invitation job. Get the status of a job to send out private invitations.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Returns:

  • (Array<(InvitationJobStatusSchema, Fixnum, Hash)>) —

    InvitationJobStatusSchema data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 378

def get_private_invitation_job_status_with_http_info(invitation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_private_invitation_job_status ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_invitation_job_status" if invitation_id.nil?
  # resource path
  local_var_path = "/invitations/private/{invitationId}/jobStatus".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvitationJobStatusSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_private_invitation_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_private_invitation_with_http_info(invitation_id, opts = {}) ⇒ Array<(PrivateInvitationSchema, Fixnum, Hash)>

Get a information about a private invitation. Get a information about a private invitation.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Options Hash (opts):

  • :include_registration_count (BOOLEAN) —

    Include the registration count in the results

Returns:

  • (Array<(PrivateInvitationSchema, Fixnum, Hash)>) —

    PrivateInvitationSchema data, response status code and response headers



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
361
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 324

def get_private_invitation_with_http_info(invitation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_private_invitation ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_invitation" if invitation_id.nil?
  # resource path
  local_var_path = "/invitations/private/{invitationId}".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PrivateInvitationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_private_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_private_invitations(opts = {}) ⇒ PrivateInvitationList

Get a list of all private invitations. Retrieves a list of all private invitations, optionally filtered by the given parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Limit the results to invitations with courseIds that match the filter.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;. (default to updated)

  • :tags (Array<String>)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:



426
427
428
429
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 426

def get_private_invitations(opts = {})
  data, _status_code, _headers = get_private_invitations_with_http_info(opts)
  return data
end

#get_private_invitations_with_http_info(opts = {}) ⇒ Array<(PrivateInvitationList, Fixnum, Hash)>

Get a list of all private invitations. Retrieves a list of all private invitations, optionally filtered by the given parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Limit the results to invitations with courseIds that match the filter.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;.

  • :tags (Array<String>)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:

  • (Array<(PrivateInvitationList, Fixnum, Hash)>) —

    PrivateInvitationList data, response status code and response headers



441
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
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 441

def get_private_invitations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_private_invitations ..."
  end
  if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  # resource path
  local_var_path = "/invitations/private".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PrivateInvitationList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_private_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_private_user_invitations(invitation_id, opts = {}) ⇒ UserInvitationList

Get a list of user invitations. Get a list of objects which contain the specific information about each user to whom this invitation was sent.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :include_registration_report (BOOLEAN)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:



495
496
497
498
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 495

def get_private_user_invitations(invitation_id, opts = {})
  data, _status_code, _headers = get_private_user_invitations_with_http_info(invitation_id, opts)
  return data
end

#get_private_user_invitations_with_http_info(invitation_id, opts = {}) ⇒ Array<(UserInvitationList, Fixnum, Hash)>

Get a list of user invitations. Get a list of objects which contain the specific information about each user to whom this invitation was sent.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :include_registration_report (BOOLEAN)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:

  • (Array<(UserInvitationList, Fixnum, Hash)>) —

    UserInvitationList data, response status code and response headers



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 509

def get_private_user_invitations_with_http_info(invitation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_private_user_invitations ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_user_invitations" if invitation_id.nil?
  # resource path
  local_var_path = "/invitations/private/{invitationId}/userInvitations".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserInvitationList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_private_user_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_public_invitation(invitation_id, opts = {}) ⇒ PublicInvitationSchema

Get a information about a public invitation. Get a information about a public invitation.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Options Hash (opts):

  • :include_registration_count (BOOLEAN) —

    Include the registration count in the results (default to false)

Returns:



557
558
559
560
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 557

def get_public_invitation(invitation_id, opts = {})
  data, _status_code, _headers = get_public_invitation_with_http_info(invitation_id, opts)
  return data
end

#get_public_invitation_with_http_info(invitation_id, opts = {}) ⇒ Array<(PublicInvitationSchema, Fixnum, Hash)>

Get a information about a public invitation. Get a information about a public invitation.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Options Hash (opts):

  • :include_registration_count (BOOLEAN) —

    Include the registration count in the results

Returns:

  • (Array<(PublicInvitationSchema, Fixnum, Hash)>) —

    PublicInvitationSchema data, response status code and response headers



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
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 568

def get_public_invitation_with_http_info(invitation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_public_invitation ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_public_invitation" if invitation_id.nil?
  # resource path
  local_var_path = "/invitations/public/{invitationId}".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PublicInvitationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_public_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_public_invitations(opts = {}) ⇒ PublicInvitationList

Get a list of all public invitations. Retrieves a list of all public invitations, optionally filtered by the given parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Limit the results to invitations with courseIds that match the filter.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;. (default to updated)

  • :tags (Array<String>)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:



617
618
619
620
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 617

def get_public_invitations(opts = {})
  data, _status_code, _headers = get_public_invitations_with_http_info(opts)
  return data
end

#get_public_invitations_with_http_info(opts = {}) ⇒ Array<(PublicInvitationList, Fixnum, Hash)>

Get a list of all public invitations. Retrieves a list of all public invitations, optionally filtered by the given parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Limit the results to invitations with courseIds that match the filter.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;.

  • :tags (Array<String>)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:

  • (Array<(PublicInvitationList, Fixnum, Hash)>) —

    PublicInvitationList data, response status code and response headers



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 632

def get_public_invitations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_public_invitations ..."
  end
  if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  # resource path
  local_var_path = "/invitations/public".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PublicInvitationList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_public_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_public_user_invitations(invitation_id, opts = {}) ⇒ UserInvitationList

Get a list of user invitations. Get a list of objects which contain the specific information about each user who visited the invitation link.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :include_registration_report (BOOLEAN)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:



686
687
688
689
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 686

def get_public_user_invitations(invitation_id, opts = {})
  data, _status_code, _headers = get_public_user_invitations_with_http_info(invitation_id, opts)
  return data
end

#get_public_user_invitations_with_http_info(invitation_id, opts = {}) ⇒ Array<(UserInvitationList, Fixnum, Hash)>

Get a list of user invitations. Get a list of objects which contain the specific information about each user who visited the invitation link.

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :include_registration_report (BOOLEAN)
  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:

  • (Array<(UserInvitationList, Fixnum, Hash)>) —

    UserInvitationList data, response status code and response headers



700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 700

def get_public_user_invitations_with_http_info(invitation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.get_public_user_invitations ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_public_user_invitations" if invitation_id.nil?
  # resource path
  local_var_path = "/invitations/public/{invitationId}/userInvitations".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserInvitationList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#get_public_user_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_invitation_tags(invitation_id, tags, opts = {}) ⇒ nil

Set the tags for this invitation Set the tags for this invitation

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Returns:

  • (nil) 


748
749
750
751
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 748

def put_invitation_tags(invitation_id, tags, opts = {})
  put_invitation_tags_with_http_info(invitation_id, tags, opts)
  return nil
end

#put_invitation_tags_batch(batch, opts = {}) ⇒ nil

Sets all of the provided tags on all of the provided invitations Sets all of the provided tags on all of the provided invitations

Parameters:

  • batch —

    Object representing an array of ids to apply an array of tags to.

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

    the optional parameters

Returns:

  • (nil) 


803
804
805
806
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 803

def put_invitation_tags_batch(batch, opts = {})
  put_invitation_tags_batch_with_http_info(batch, opts)
  return nil
end

#put_invitation_tags_batch_with_http_info(batch, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Sets all of the provided tags on all of the provided invitations Sets all of the provided tags on all of the provided invitations

Parameters:

  • batch —

    Object representing an array of ids to apply an array of tags to.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 813

def put_invitation_tags_batch_with_http_info(batch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.put_invitation_tags_batch ..."
  end
  # verify the required parameter 'batch' is set
  fail ArgumentError, "Missing the required parameter 'batch' when calling InvitationsApi.put_invitation_tags_batch" if batch.nil?
  # resource path
  local_var_path = "/invitations/tags".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(batch)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#put_invitation_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_invitation_tags_with_http_info(invitation_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set the tags for this invitation Set the tags for this invitation

Parameters:

  • invitation_id —

    invitation id

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 759

def put_invitation_tags_with_http_info(invitation_id, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.put_invitation_tags ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.put_invitation_tags" if invitation_id.nil?
  # verify the required parameter 'tags' is set
  fail ArgumentError, "Missing the required parameter 'tags' when calling InvitationsApi.put_invitation_tags" if tags.nil?
  # resource path
  local_var_path = "/invitations/{invitationId}/tags".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(tags)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#put_invitation_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_private_invitation(invitation_id, invitation_update_schema, opts = {}) ⇒ PrivateInvitationSchema

Update attributes of this invitation. Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - invitationEmail - postBack - expirationDate NOTE: Any attributes not in the above list will not be considered for update.

Parameters:

  • invitation_id —

    invitation id

  • invitation_update_schema —

    A PrivateInvitationSchema with values to update. This can be a sparse schema only containing the values to be updated. Any value not allowed for update will be ignored.

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

    the optional parameters

Returns:



856
857
858
859
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 856

def update_private_invitation(invitation_id, invitation_update_schema, opts = {})
  data, _status_code, _headers = update_private_invitation_with_http_info(invitation_id, invitation_update_schema, opts)
  return data
end

#update_private_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {}) ⇒ Array<(PrivateInvitationSchema, Fixnum, Hash)>

Update attributes of this invitation. Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - invitationEmail - postBack - expirationDate NOTE: Any attributes not in the above list will not be considered for update.

Parameters:

  • invitation_id —

    invitation id

  • invitation_update_schema —

    A PrivateInvitationSchema with values to update. This can be a sparse schema only containing the values to be updated. Any value not allowed for update will be ignored.

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

    the optional parameters

Returns:

  • (Array<(PrivateInvitationSchema, Fixnum, Hash)>) —

    PrivateInvitationSchema data, response status code and response headers



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 867

def update_private_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.update_private_invitation ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.update_private_invitation" if invitation_id.nil?
  # verify the required parameter 'invitation_update_schema' is set
  fail ArgumentError, "Missing the required parameter 'invitation_update_schema' when calling InvitationsApi.update_private_invitation" if invitation_update_schema.nil?
  # resource path
  local_var_path = "/invitations/private/{invitationId}".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invitation_update_schema)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PrivateInvitationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#update_private_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_public_invitation(invitation_id, invitation_update_schema, opts = {}) ⇒ PublicInvitationSchema

Update attributes of this invitation. Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - allowNewRegistrations - postBack - expirationDate - registrationCap NOTE: Any attributes not in the above list will not be considered for update.

Parameters:

  • invitation_id —

    invitation id

  • invitation_update_schema —

    A PublicInvitationSchema with values to update. This can be a sparse schema only containing the values to be updated. Any value not allowed for update will be ignored.

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

    the optional parameters

Returns:



913
914
915
916
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 913

def update_public_invitation(invitation_id, invitation_update_schema, opts = {})
  data, _status_code, _headers = update_public_invitation_with_http_info(invitation_id, invitation_update_schema, opts)
  return data
end

#update_public_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {}) ⇒ Array<(PublicInvitationSchema, Fixnum, Hash)>

Update attributes of this invitation. Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - allowNewRegistrations - postBack - expirationDate - registrationCap NOTE: Any attributes not in the above list will not be considered for update.

Parameters:

  • invitation_id —

    invitation id

  • invitation_update_schema —

    A PublicInvitationSchema with values to update. This can be a sparse schema only containing the values to be updated. Any value not allowed for update will be ignored.

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

    the optional parameters

Returns:

  • (Array<(PublicInvitationSchema, Fixnum, Hash)>) —

    PublicInvitationSchema data, response status code and response headers



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 924

def update_public_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InvitationsApi.update_public_invitation ..."
  end
  # verify the required parameter 'invitation_id' is set
  fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.update_public_invitation" if invitation_id.nil?
  # verify the required parameter 'invitation_update_schema' is set
  fail ArgumentError, "Missing the required parameter 'invitation_update_schema' when calling InvitationsApi.update_public_invitation" if invitation_update_schema.nil?
  # resource path
  local_var_path = "/invitations/public/{invitationId}".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invitation_update_schema)
  auth_names = ['APP_NORMAL', 'OAUTH']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PublicInvitationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvitationsApi#update_public_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end