Class: RusticiSoftwareCloudV2::InvitationsApi

Inherits:
Object
  • Object
show all
Extended by:
Gem::Deprecate
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 Creates a private invitation job which sends emails with a link to the course. Invitations are meant as a way to provide access to your content. Registrations will be created from the provided email addresses. The email job will asynchronously send emails to those addresses inviting them to the course. When the learners visit the link in the email, the course will be launched with the already created registration. The private invitation ID can be used with GetPrivateInvitationJobStatus to view the status of the email job. >Info: >While invitations are a way to provide access to your content, the majority of use cases would be better suited by creating a registration and building a launch link with the registration endpoints instead. Invitations build upon registrations by grouping a set of registrations together and adding access control measures to said group. Invitations could be used to pass yearly compliance training to an entire company. Invitations also have an associated expiration date which determines when the course will no longer be launchable. >Note: >The behavior of a private invitation request sent to a learner who has already been sent an invitation to the course can be specified with the ‘duplicateRegistrationOption` parameter. The available options are: >- `FAIL`: Do not send an invitation to any learners who have already received an invitation to the course. Use this option when a list of emails might contain learners who have and have not received an invitation and you only want to send the invitation to the learners who have not yet received an invitation. >- `INSTANCE_EXISTING`: Send an invitation to all learners in the list. For learners who have previously been sent an invitation, instance their existing registration. Use this option to force the learner to start the course from the beginning, regardless if they have taken the course in the past. Results from all instances of a registration can be fetched <a href=\"cloud.scorm.com/docs/v2/reference/swagger/#/registration/GetRegistrationInstances\">here</a> >- `SEND_EXISTING`: For any learners who have previously been sent an invitation to the course, use the existing registration on the previous invitation. Use this if you want to remind a learner to take their course or continue their existing course. >- `CREATE_NEW`: For any learners who have previously been sent an invitation to the course, create a new registration for the learner. Use this if you’d like to have simultaneous records of the same user to one course.

Parameters:

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 29

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

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

Create a Private Invitation to a Course Creates a private invitation job which sends emails with a link to the course. Invitations are meant as a way to provide access to your content. Registrations will be created from the provided email addresses. The email job will asynchronously send emails to those addresses inviting them to the course. When the learners visit the link in the email, the course will be launched with the already created registration. The private invitation ID can be used with GetPrivateInvitationJobStatus to view the status of the email job. &gt;Info: &gt;While invitations are a way to provide access to your content, the majority of use cases would be better suited by creating a registration and building a launch link with the registration endpoints instead. Invitations build upon registrations by grouping a set of registrations together and adding access control measures to said group. Invitations could be used to pass yearly compliance training to an entire company. Invitations also have an associated expiration date which determines when the course will no longer be launchable. &gt;Note: &gt;The behavior of a private invitation request sent to a learner who has already been sent an invitation to the course can be specified with the &#x60;duplicateRegistrationOption&#x60; parameter. The available options are: &gt;- &#x60;FAIL&#x60;: Do not send an invitation to any learners who have already received an invitation to the course. Use this option when a list of emails might contain learners who have and have not received an invitation and you only want to send the invitation to the learners who have not yet received an invitation. &gt;- &#x60;INSTANCE_EXISTING&#x60;: Send an invitation to all learners in the list. For learners who have previously been sent an invitation, instance their existing registration. Use this option to force the learner to start the course from the beginning, regardless if they have taken the course in the past. Results from all instances of a registration can be fetched &lt;a href&#x3D;\&quot;cloud.scorm.com/docs/v2/reference/swagger/#/registration/GetRegistrationInstances\&quot;&gt;here&lt;/a&gt; &gt;- &#x60;SEND_EXISTING&#x60;: For any learners who have previously been sent an invitation to the course, use the existing registration on the previous invitation. Use this if you want to remind a learner to take their course or continue their existing course. &gt;- &#x60;CREATE_NEW&#x60;: For any learners who have previously been sent an invitation to the course, create a new registration for the learner. Use this if you&#39;d like to have simultaneous records of the same user to one course.

Parameters:

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

    the optional parameters

Returns:

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

    InvitationSummarySchema data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 39

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
  if private_invitation_request.nil?
    fail ArgumentError, "Missing the required parameter 'private_invitation_request' when calling InvitationsApi.create_private_invitation"
  end
  # resource path
  local_var_path = '/invitations/private'

  # 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 Public Invitation to a Course Creates an invitation link to the course which can then be publicly distributed. Invitations are meant as a way to provide access to your content. When a learner visits the link, they will be prompted for name and email, a registration will be created from the information provided, and they will be redirected to the course. Since anyone visiting the link will create a registration, it is highly advised that you set the ‘registrationCap` parameter when calling this method. >Info: >While invitations are a way to provide access to your content, the majority of use cases would be better suited by creating a registration and building a launch link with the registration endpoints instead. Invitations build upon registrations by grouping a set of registrations together and adding access control measures to said group. Invitations could be used to pass yearly compliance training to an entire company. Invitations also have an associated expiration date which determines when the course will no longer be launchable.

Parameters:

  • public_invitation_request —

    A description of the public invitation to be created.

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 84

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

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

Create a Public Invitation to a Course Creates an invitation link to the course which can then be publicly distributed. Invitations are meant as a way to provide access to your content. When a learner visits the link, they will be prompted for name and email, a registration will be created from the information provided, and they will be redirected to the course. Since anyone visiting the link will create a registration, it is highly advised that you set the &#x60;registrationCap&#x60; parameter when calling this method. &gt;Info: &gt;While invitations are a way to provide access to your content, the majority of use cases would be better suited by creating a registration and building a launch link with the registration endpoints instead. Invitations build upon registrations by grouping a set of registrations together and adding access control measures to said group. Invitations could be used to pass yearly compliance training to an entire company. Invitations also have an associated expiration date which determines when the course will no longer be launchable.

Parameters:

  • public_invitation_request —

    A description of the public invitation to be created.

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

    the optional parameters

Returns:

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

    PublicInvitationSchema data, response status code and response headers



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
127
128
129
130
131
132
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 94

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
  if public_invitation_request.nil?
    fail ArgumentError, "Missing the required parameter 'public_invitation_request' when calling InvitationsApi.create_public_invitation"
  end
  # resource path
  local_var_path = '/invitations/public'

  # 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 tags from an Invitation Deletes the specified tags from the invitation. Deleting tags that do not exist will still result in a success.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


140
141
142
143
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 140

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

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

Delete tags from an Invitation Deletes the specified tags from the invitation. Deleting tags that do not exist will still result in a success.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.delete_invitation_tags"
  end
  # verify the required parameter 'tags' is set
  if tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling InvitationsApi.delete_invitation_tags"
  end
  # resource path
  local_var_path = '/invitations/{invitationId}/tags'.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 Invitations Returns a list of invitations (both public and private). Can be filtered using the request parameters to provide a subset of results. >Note: >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a ‘more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retrieve resources having &#x60;courseId&#x60;

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to updated)

  • :tags (Array<String>) —

    Filter items matching any tag provided (not all)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)

Returns:



208
209
210
211
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 208

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

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

Get a list of Invitations Returns a list of invitations (both public and private). Can be filtered using the request parameters to provide a subset of results. &gt;Note: &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retrieve resources having &#x60;courseId&#x60;

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against

  • :tags (Array<String>) —

    Filter items matching any tag provided (not all)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter.

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results.

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.

Returns:

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

    InvitationSummaryList data, response status code and response headers



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

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
  # resource path
  local_var_path = '/invitations'

  # 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[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_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 => '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 tags for an Invitation Returns the tags for the invitation.

Parameters:

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

    the optional parameters

Returns:



278
279
280
281
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 278

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

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

Get tags for an Invitation Returns the tags for the invitation.

Parameters:

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

    the optional parameters

Returns:

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

    TagListSchema data, response status code and response headers



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 288

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_invitation_tags"
  end
  # resource path
  local_var_path = '/invitations/{invitationId}/tags'.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 detailed information about a Private Invitation Returns detailed information about the private invitation. This includes the email sent, course ID, and whether new the invitation can still be launched or not.

Parameters:

  • 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:



334
335
336
337
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 334

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

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

Get email job status for a Private Invitation Check the status of a private invitation email job. This can be called incrementally to check the progress of the emails.

Parameters:

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

    the optional parameters

Returns:



391
392
393
394
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 391

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

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

Get email job status for a Private Invitation Check the status of a private invitation email job. This can be called incrementally to check the progress of the emails.

Parameters:

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

    the optional parameters

Returns:

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

    InvitationJobStatusSchema data, response status code and response headers



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 401

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_invitation_job_status"
  end
  # resource path
  local_var_path = '/invitations/private/{invitationId}/jobStatus'.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, Integer, Hash)>

Get detailed information about a Private Invitation Returns detailed information about the private invitation. This includes the email sent, course ID, and whether new the invitation can still be launched or not.

Parameters:

  • 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, Integer, Hash)>) —

    PrivateInvitationSchema data, response status code and response headers



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 345

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_invitation"
  end
  # resource path
  local_var_path = '/invitations/private/{invitationId}'.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 Private Invitations Returns a list of private invitations. Can be filtered using the request parameters to provide a subset of results. >Note: >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a ‘more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >Info: >This endpoint caches the launched registration count and total registration count of all private invitations for 24 hours if the `includeRegistrationCount` parameter is set to `true`. Since these values are cached for an extended period, any changes made to the number of launched registrations for a private invitation will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get up-to-date values of the launched or total registration counts for a single private invitation within the caching period, use the GetPrivateInvitation endpoint with `includeRegistrationCount` set to `true`. GetPrivateInvitation always gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that private invitation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retrieve resources having &#x60;courseId&#x60;

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to updated)

  • :tags (Array<String>) —

    Filter items matching any tag provided (not all)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_registration_count (BOOLEAN) —

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

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)

Returns:



456
457
458
459
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 456

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

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

Get a list of Private Invitations Returns a list of private invitations. Can be filtered using the request parameters to provide a subset of results. &gt;Note: &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. &gt;Info: &gt;This endpoint caches the launched registration count and total registration count of all private invitations for 24 hours if the &#x60;includeRegistrationCount&#x60; parameter is set to &#x60;true&#x60;. Since these values are cached for an extended period, any changes made to the number of launched registrations for a private invitation will not be reflected in the results of this endpoint until the caching period has passed. &gt;If you want to get up-to-date values of the launched or total registration counts for a single private invitation within the caching period, use the GetPrivateInvitation endpoint with &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;. GetPrivateInvitation always gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that private invitation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retrieve resources having &#x60;courseId&#x60;

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against

  • :tags (Array<String>) —

    Filter items matching any tag provided (not all)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter.

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results.

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_registration_count (BOOLEAN) —

    Include the registration count in the results

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.

Returns:

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

    PrivateInvitationList data, response status code and response headers



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 476

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
  # resource path
  local_var_path = '/invitations/private'

  # 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[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
  query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_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 => '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 Private User Invitations Get a list of user who were invited to view the course. Can be filtered using the request parameters to provide a subset of results. >Note: >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a ‘more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to updated)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter. (default to registration_id)

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_registration_report (BOOLEAN) —

    Optional flag to include basic registration information

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)

Returns:



537
538
539
540
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 537

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

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

Get a list of Private User Invitations Get a list of user who were invited to view the course. Can be filtered using the request parameters to provide a subset of results. &gt;Note: &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter.

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results.

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_registration_report (BOOLEAN) —

    Optional flag to include basic registration information

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.

Returns:

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

    UserInvitationList data, response status code and response headers



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 556

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_user_invitations"
  end
  # resource path
  local_var_path = '/invitations/private/{invitationId}/userInvitations'.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[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
  query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_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 => '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 detailed information about a Public Invitation Returns detailed information about the public invitation. This includes url, registration cap, and whether new learners can accept the invitation or not.

Parameters:

  • 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:



611
612
613
614
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 611

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

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

Get detailed information about a Public Invitation Returns detailed information about the public invitation. This includes url, registration cap, and whether new learners can accept the invitation or not.

Parameters:

  • 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, Integer, Hash)>) —

    PublicInvitationSchema data, response status code and response headers



622
623
624
625
626
627
628
629
630
631
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
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 622

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_public_invitation"
  end
  # resource path
  local_var_path = '/invitations/public/{invitationId}'.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 Public Invitations Returns a list of public invitations. Can be filtered using the request parameters to provide a subset of results. >Note: >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a ‘more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >Info: >This endpoint caches the registration count of all public invitations for 24 hours if the `includeRegistrationCount` parameter is set to `true`. Since this value is cached for an extended period, any changes made to the number of registrations for a public invitation will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the registration count for a single public invitation within the caching period, use the GetPublicInvitation endpoint with `includeRegistrationCount` set to `true`. GetPublicInvitation always gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that public invitation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retrieve resources having &#x60;courseId&#x60;

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to updated)

  • :tags (Array<String>) —

    Filter items matching any tag provided (not all)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_registration_count (BOOLEAN) —

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

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)

Returns:



678
679
680
681
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 678

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

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

Get a list of Public Invitations Returns a list of public invitations. Can be filtered using the request parameters to provide a subset of results. &gt;Note: &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. &gt;Info: &gt;This endpoint caches the registration count of all public invitations for 24 hours if the &#x60;includeRegistrationCount&#x60; parameter is set to &#x60;true&#x60;. Since this value is cached for an extended period, any changes made to the number of registrations for a public invitation will not be reflected in the results of this endpoint until the caching period has passed. &gt;If you want to get an up-to-date value of the registration count for a single public invitation within the caching period, use the GetPublicInvitation endpoint with &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;. GetPublicInvitation always gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that public invitation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retrieve resources having &#x60;courseId&#x60;

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against

  • :tags (Array<String>) —

    Filter items matching any tag provided (not all)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter.

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results.

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_registration_count (BOOLEAN) —

    Include the registration count in the results

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.

Returns:

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

    PublicInvitationList data, response status code and response headers



698
699
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
741
742
743
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 698

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
  # resource path
  local_var_path = '/invitations/public'

  # 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[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
  query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_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 => '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 Public User Invitations Returns a list of users who have visited the public invitation link. Can be filtered using the request parameters to provide a subset of results. >Note: >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a ‘more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to updated)

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter. (default to registration_id)

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_registration_report (BOOLEAN) —

    Optional flag to include basic registration information

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)

Returns:



759
760
761
762
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 759

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

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

Get a list of Public User Invitations Returns a list of users who have visited the public invitation link. Can be filtered using the request parameters to provide a subset of results. &gt;Note: &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :_until (DateTime) —

    Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

  • :datetime_filter (String) —

    Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against

  • :filter (String) —

    Optional string which filters results by a specified field (described by filterBy).

  • :filter_by (String) —

    Optional enum parameter for specifying the field on which to run the filter.

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results.

  • :more (String) —

    Pagination token returned as &#x60;more&#x60; property of multi page list requests

  • :include_registration_report (BOOLEAN) —

    Optional flag to include basic registration information

  • :include_total_count (BOOLEAN) —

    Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.

Returns:

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

    UserInvitationList data, response status code and response headers



778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 778

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_public_user_invitations"
  end
  # resource path
  local_var_path = '/invitations/public/{invitationId}/userInvitations'.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[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
  query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_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 => '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

Add tags to an Invitation Applies the provided tags to the invitation. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetInvitations).

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


833
834
835
836
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 833

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

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

Add a group of tags to a group of Invitations Applies all of the provided tags on all of the provided invitations. Both public and private invitations may be tagged via this operation. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetInvitations).

Parameters:

  • batch —

    Array of ids, and array of tags for bulk tag operations

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

    the optional parameters

Returns:

  • (nil) 


892
893
894
895
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 892

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

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

Add a group of tags to a group of Invitations Applies all of the provided tags on all of the provided invitations. Both public and private invitations may be tagged via this operation. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetInvitations).

Parameters:

  • batch —

    Array of ids, and array of tags for bulk tag operations

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 902

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
  if batch.nil?
    fail ArgumentError, "Missing the required parameter 'batch' when calling InvitationsApi.put_invitation_tags_batch"
  end
  # resource path
  local_var_path = '/invitations/tags'

  # 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, Integer, Hash)>

Add tags to an Invitation Applies the provided tags to the invitation. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetInvitations).

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 844

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.put_invitation_tags"
  end
  # verify the required parameter 'tags' is set
  if tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling InvitationsApi.put_invitation_tags"
  end
  # resource path
  local_var_path = '/invitations/{invitationId}/tags'.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 information about a Private Invitation Updates information about the private invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.

Parameters:

  • invitation_id
  • invitation_update_schema —

    Object with values to be updated. Any value not specified above will be ignored.

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

    the optional parameters

Returns:



947
948
949
950
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 947

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)
  data
end

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

Update information about a Private Invitation Updates information about the private invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.

Parameters:

  • invitation_id
  • invitation_update_schema —

    Object with values to be updated. Any value not specified above will be ignored.

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

    the optional parameters

Returns:

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

    PrivateInvitationSchema data, response status code and response headers



958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 958

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.update_private_invitation"
  end
  # verify the required parameter 'invitation_update_schema' is set
  if invitation_update_schema.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_update_schema' when calling InvitationsApi.update_private_invitation"
  end
  # resource path
  local_var_path = '/invitations/private/{invitationId}'.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 information about a Public Invitation Updates information about the public invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.

Parameters:

  • invitation_id
  • invitation_update_schema —

    Object with values to be updated. Any value not specified above will be ignored.

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

    the optional parameters

Returns:



1008
1009
1010
1011
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 1008

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)
  data
end

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

Update information about a Public Invitation Updates information about the public invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.

Parameters:

  • invitation_id
  • invitation_update_schema —

    Object with values to be updated. Any value not specified above will be ignored.

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

    the optional parameters

Returns:

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

    PublicInvitationSchema data, response status code and response headers



1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 1019

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
  if invitation_id.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.update_public_invitation"
  end
  # verify the required parameter 'invitation_update_schema' is set
  if invitation_update_schema.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_update_schema' when calling InvitationsApi.update_public_invitation"
  end
  # resource path
  local_var_path = '/invitations/public/{invitationId}'.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