rustici_software_cloud_v2 1.1.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +355 -356
- data/lib/rustici_software_cloud_v2/api/about_api.rb +4 -4
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +190 -62
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +9 -17
- data/lib/rustici_software_cloud_v2/api/course_api.rb +903 -196
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +458 -268
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +212 -170
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +48 -48
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +2 -0
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +255 -269
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +19 -23
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +81 -66
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +124 -55
- data/lib/rustici_software_cloud_v2/api_client.rb +2 -2
- data/lib/rustici_software_cloud_v2/configuration.rb +3 -3
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +8 -36
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +186 -0
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/application_token.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +2 -19
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +4 -2
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +43 -3
- data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
- data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +29 -6
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
- data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +195 -0
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +8 -36
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +10 -8
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +11 -43
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +8 -36
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +5 -3
- data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +6 -4
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/response_error.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +8 -36
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +15 -3
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +5 -29
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +4 -1
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +3 -1
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +13 -1
- data/lib/rustici_software_cloud_v2/version.rb +1 -1
- data/lib/rustici_software_cloud_v2.rb +13 -0
- data/rustici_software_cloud_v2.gemspec +2 -1
- data/spec/api_client_spec.rb +17 -0
- metadata +35 -2
@@ -19,8 +19,8 @@ module RusticiSoftwareCloudV2
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
-
# Create a
|
23
|
-
#
|
22
|
+
# Create a Private Invitation to a Course
|
23
|
+
# 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.
|
24
24
|
# @param private_invitation_request
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [InvitationSummarySchema]
|
@@ -29,8 +29,8 @@ module RusticiSoftwareCloudV2
|
|
29
29
|
data
|
30
30
|
end
|
31
31
|
|
32
|
-
# Create a
|
33
|
-
#
|
32
|
+
# Create a Private Invitation to a Course
|
33
|
+
# 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.
|
34
34
|
# @param private_invitation_request
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(InvitationSummarySchema, Fixnum, Hash)>] InvitationSummarySchema data, response status code and response headers
|
@@ -39,7 +39,7 @@ module RusticiSoftwareCloudV2
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.create_private_invitation ...'
|
40
40
|
end
|
41
41
|
# verify the required parameter 'private_invitation_request' is set
|
42
|
-
if
|
42
|
+
if private_invitation_request.nil?
|
43
43
|
fail ArgumentError, "Missing the required parameter 'private_invitation_request' when calling InvitationsApi.create_private_invitation"
|
44
44
|
end
|
45
45
|
# resource path
|
@@ -73,8 +73,8 @@ module RusticiSoftwareCloudV2
|
|
73
73
|
end
|
74
74
|
return data, status_code, headers
|
75
75
|
end
|
76
|
-
# Create a
|
77
|
-
#
|
76
|
+
# Create a Public Invitation to a Course
|
77
|
+
# 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.
|
78
78
|
# @param public_invitation_request A description of the public invitation to be created.
|
79
79
|
# @param [Hash] opts the optional parameters
|
80
80
|
# @return [PublicInvitationSchema]
|
@@ -83,8 +83,8 @@ module RusticiSoftwareCloudV2
|
|
83
83
|
data
|
84
84
|
end
|
85
85
|
|
86
|
-
# Create a
|
87
|
-
#
|
86
|
+
# Create a Public Invitation to a Course
|
87
|
+
# 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.
|
88
88
|
# @param public_invitation_request A description of the public invitation to be created.
|
89
89
|
# @param [Hash] opts the optional parameters
|
90
90
|
# @return [Array<(PublicInvitationSchema, Fixnum, Hash)>] PublicInvitationSchema data, response status code and response headers
|
@@ -93,7 +93,7 @@ module RusticiSoftwareCloudV2
|
|
93
93
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.create_public_invitation ...'
|
94
94
|
end
|
95
95
|
# verify the required parameter 'public_invitation_request' is set
|
96
|
-
if
|
96
|
+
if public_invitation_request.nil?
|
97
97
|
fail ArgumentError, "Missing the required parameter 'public_invitation_request' when calling InvitationsApi.create_public_invitation"
|
98
98
|
end
|
99
99
|
# resource path
|
@@ -127,9 +127,9 @@ module RusticiSoftwareCloudV2
|
|
127
127
|
end
|
128
128
|
return data, status_code, headers
|
129
129
|
end
|
130
|
-
# Delete
|
131
|
-
#
|
132
|
-
# @param invitation_id
|
130
|
+
# Delete tags from an Invitation
|
131
|
+
# Deletes the specified tags from the invitation. Deleting tags that do not exist will still result in a success.
|
132
|
+
# @param invitation_id
|
133
133
|
# @param tags
|
134
134
|
# @param [Hash] opts the optional parameters
|
135
135
|
# @return [nil]
|
@@ -138,9 +138,9 @@ module RusticiSoftwareCloudV2
|
|
138
138
|
nil
|
139
139
|
end
|
140
140
|
|
141
|
-
# Delete
|
142
|
-
#
|
143
|
-
# @param invitation_id
|
141
|
+
# Delete tags from an Invitation
|
142
|
+
# Deletes the specified tags from the invitation. Deleting tags that do not exist will still result in a success.
|
143
|
+
# @param invitation_id
|
144
144
|
# @param tags
|
145
145
|
# @param [Hash] opts the optional parameters
|
146
146
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -149,11 +149,11 @@ module RusticiSoftwareCloudV2
|
|
149
149
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.delete_invitation_tags ...'
|
150
150
|
end
|
151
151
|
# verify the required parameter 'invitation_id' is set
|
152
|
-
if
|
152
|
+
if invitation_id.nil?
|
153
153
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.delete_invitation_tags"
|
154
154
|
end
|
155
155
|
# verify the required parameter 'tags' is set
|
156
|
-
if
|
156
|
+
if tags.nil?
|
157
157
|
fail ArgumentError, "Missing the required parameter 'tags' when calling InvitationsApi.delete_invitation_tags"
|
158
158
|
end
|
159
159
|
# resource path
|
@@ -186,38 +186,41 @@ module RusticiSoftwareCloudV2
|
|
186
186
|
end
|
187
187
|
return data, status_code, headers
|
188
188
|
end
|
189
|
-
# Get a list of
|
190
|
-
#
|
189
|
+
# Get a list of Invitations
|
190
|
+
# 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.
|
191
191
|
# @param [Hash] opts the optional parameters
|
192
|
-
# @option opts [String] :course_id
|
193
|
-
# @option opts [DateTime] :since
|
194
|
-
# @option opts [DateTime] :_until
|
195
|
-
# @option opts [String] :datetime_filter
|
196
|
-
# @option opts [Array<String>] :tags
|
197
|
-
# @option opts [String] :
|
192
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
193
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
194
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
195
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
196
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
197
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
198
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)
|
199
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
200
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
198
201
|
# @return [InvitationSummaryList]
|
199
202
|
def get_all_invitations(opts = {})
|
200
203
|
data, _status_code, _headers = get_all_invitations_with_http_info(opts)
|
201
204
|
data
|
202
205
|
end
|
203
206
|
|
204
|
-
# Get a list of
|
205
|
-
#
|
207
|
+
# Get a list of Invitations
|
208
|
+
# 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.
|
206
209
|
# @param [Hash] opts the optional parameters
|
207
|
-
# @option opts [String] :course_id
|
208
|
-
# @option opts [DateTime] :since
|
209
|
-
# @option opts [DateTime] :_until
|
210
|
-
# @option opts [String] :datetime_filter
|
211
|
-
# @option opts [Array<String>] :tags
|
212
|
-
# @option opts [String] :
|
210
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
211
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
212
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
213
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
214
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
215
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
216
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
217
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
218
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
213
219
|
# @return [Array<(InvitationSummaryList, Fixnum, Hash)>] InvitationSummaryList data, response status code and response headers
|
214
220
|
def get_all_invitations_with_http_info(opts = {})
|
215
221
|
if @api_client.config.debugging
|
216
222
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_all_invitations ...'
|
217
223
|
end
|
218
|
-
if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
219
|
-
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
220
|
-
end
|
221
224
|
# resource path
|
222
225
|
local_var_path = '/invitations'
|
223
226
|
|
@@ -228,6 +231,9 @@ module RusticiSoftwareCloudV2
|
|
228
231
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
229
232
|
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
230
233
|
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
234
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
235
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
236
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
231
237
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
232
238
|
|
233
239
|
# header parameters
|
@@ -255,9 +261,9 @@ module RusticiSoftwareCloudV2
|
|
255
261
|
end
|
256
262
|
return data, status_code, headers
|
257
263
|
end
|
258
|
-
# Get
|
259
|
-
#
|
260
|
-
# @param invitation_id
|
264
|
+
# Get tags for an Invitation
|
265
|
+
# Returns the tags for the invitation.
|
266
|
+
# @param invitation_id
|
261
267
|
# @param [Hash] opts the optional parameters
|
262
268
|
# @return [TagListSchema]
|
263
269
|
def get_invitation_tags(invitation_id, opts = {})
|
@@ -265,9 +271,9 @@ module RusticiSoftwareCloudV2
|
|
265
271
|
data
|
266
272
|
end
|
267
273
|
|
268
|
-
# Get
|
269
|
-
#
|
270
|
-
# @param invitation_id
|
274
|
+
# Get tags for an Invitation
|
275
|
+
# Returns the tags for the invitation.
|
276
|
+
# @param invitation_id
|
271
277
|
# @param [Hash] opts the optional parameters
|
272
278
|
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
273
279
|
def get_invitation_tags_with_http_info(invitation_id, opts = {})
|
@@ -275,7 +281,7 @@ module RusticiSoftwareCloudV2
|
|
275
281
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_invitation_tags ...'
|
276
282
|
end
|
277
283
|
# verify the required parameter 'invitation_id' is set
|
278
|
-
if
|
284
|
+
if invitation_id.nil?
|
279
285
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_invitation_tags"
|
280
286
|
end
|
281
287
|
# resource path
|
@@ -309,9 +315,9 @@ module RusticiSoftwareCloudV2
|
|
309
315
|
end
|
310
316
|
return data, status_code, headers
|
311
317
|
end
|
312
|
-
# Get
|
313
|
-
#
|
314
|
-
# @param invitation_id
|
318
|
+
# Get detailed information about a Private Invitation
|
319
|
+
# 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.
|
320
|
+
# @param invitation_id
|
315
321
|
# @param [Hash] opts the optional parameters
|
316
322
|
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
|
317
323
|
# @return [PrivateInvitationSchema]
|
@@ -320,9 +326,9 @@ module RusticiSoftwareCloudV2
|
|
320
326
|
data
|
321
327
|
end
|
322
328
|
|
323
|
-
# Get
|
324
|
-
#
|
325
|
-
# @param invitation_id
|
329
|
+
# Get detailed information about a Private Invitation
|
330
|
+
# 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.
|
331
|
+
# @param invitation_id
|
326
332
|
# @param [Hash] opts the optional parameters
|
327
333
|
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
|
328
334
|
# @return [Array<(PrivateInvitationSchema, Fixnum, Hash)>] PrivateInvitationSchema data, response status code and response headers
|
@@ -331,7 +337,7 @@ module RusticiSoftwareCloudV2
|
|
331
337
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_private_invitation ...'
|
332
338
|
end
|
333
339
|
# verify the required parameter 'invitation_id' is set
|
334
|
-
if
|
340
|
+
if invitation_id.nil?
|
335
341
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_invitation"
|
336
342
|
end
|
337
343
|
# resource path
|
@@ -366,9 +372,9 @@ module RusticiSoftwareCloudV2
|
|
366
372
|
end
|
367
373
|
return data, status_code, headers
|
368
374
|
end
|
369
|
-
# Get
|
370
|
-
#
|
371
|
-
# @param invitation_id
|
375
|
+
# Get email job status for a Private Invitation
|
376
|
+
# Check the status of a private invitation email job. This can be called incrementally to check the progress of the emails.
|
377
|
+
# @param invitation_id
|
372
378
|
# @param [Hash] opts the optional parameters
|
373
379
|
# @return [InvitationJobStatusSchema]
|
374
380
|
def get_private_invitation_job_status(invitation_id, opts = {})
|
@@ -376,9 +382,9 @@ module RusticiSoftwareCloudV2
|
|
376
382
|
data
|
377
383
|
end
|
378
384
|
|
379
|
-
# Get
|
380
|
-
#
|
381
|
-
# @param invitation_id
|
385
|
+
# Get email job status for a Private Invitation
|
386
|
+
# Check the status of a private invitation email job. This can be called incrementally to check the progress of the emails.
|
387
|
+
# @param invitation_id
|
382
388
|
# @param [Hash] opts the optional parameters
|
383
389
|
# @return [Array<(InvitationJobStatusSchema, Fixnum, Hash)>] InvitationJobStatusSchema data, response status code and response headers
|
384
390
|
def get_private_invitation_job_status_with_http_info(invitation_id, opts = {})
|
@@ -386,7 +392,7 @@ module RusticiSoftwareCloudV2
|
|
386
392
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_private_invitation_job_status ...'
|
387
393
|
end
|
388
394
|
# verify the required parameter 'invitation_id' is set
|
389
|
-
if
|
395
|
+
if invitation_id.nil?
|
390
396
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_invitation_job_status"
|
391
397
|
end
|
392
398
|
# resource path
|
@@ -420,38 +426,41 @@ module RusticiSoftwareCloudV2
|
|
420
426
|
end
|
421
427
|
return data, status_code, headers
|
422
428
|
end
|
423
|
-
# Get a list of
|
424
|
-
#
|
429
|
+
# Get a list of Private Invitations
|
430
|
+
# 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.
|
425
431
|
# @param [Hash] opts the optional parameters
|
426
|
-
# @option opts [String] :course_id
|
427
|
-
# @option opts [DateTime] :since
|
428
|
-
# @option opts [DateTime] :_until
|
429
|
-
# @option opts [String] :datetime_filter
|
430
|
-
# @option opts [Array<String>] :tags
|
431
|
-
# @option opts [String] :
|
432
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
433
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
434
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
435
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
436
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
437
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
438
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)
|
439
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
440
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
432
441
|
# @return [PrivateInvitationList]
|
433
442
|
def get_private_invitations(opts = {})
|
434
443
|
data, _status_code, _headers = get_private_invitations_with_http_info(opts)
|
435
444
|
data
|
436
445
|
end
|
437
446
|
|
438
|
-
# Get a list of
|
439
|
-
#
|
447
|
+
# Get a list of Private Invitations
|
448
|
+
# 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.
|
440
449
|
# @param [Hash] opts the optional parameters
|
441
|
-
# @option opts [String] :course_id
|
442
|
-
# @option opts [DateTime] :since
|
443
|
-
# @option opts [DateTime] :_until
|
444
|
-
# @option opts [String] :datetime_filter
|
445
|
-
# @option opts [Array<String>] :tags
|
446
|
-
# @option opts [String] :
|
450
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
451
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
452
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
453
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
454
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
455
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
456
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
457
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
458
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
447
459
|
# @return [Array<(PrivateInvitationList, Fixnum, Hash)>] PrivateInvitationList data, response status code and response headers
|
448
460
|
def get_private_invitations_with_http_info(opts = {})
|
449
461
|
if @api_client.config.debugging
|
450
462
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_private_invitations ...'
|
451
463
|
end
|
452
|
-
if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
453
|
-
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
454
|
-
end
|
455
464
|
# resource path
|
456
465
|
local_var_path = '/invitations/private'
|
457
466
|
|
@@ -462,6 +471,9 @@ module RusticiSoftwareCloudV2
|
|
462
471
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
463
472
|
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
464
473
|
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
474
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
475
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
476
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
465
477
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
466
478
|
|
467
479
|
# header parameters
|
@@ -489,35 +501,43 @@ module RusticiSoftwareCloudV2
|
|
489
501
|
end
|
490
502
|
return data, status_code, headers
|
491
503
|
end
|
492
|
-
# Get a list of
|
493
|
-
# Get a list of
|
494
|
-
# @param invitation_id
|
504
|
+
# Get a list of Private User Invitations
|
505
|
+
# 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.
|
506
|
+
# @param invitation_id
|
495
507
|
# @param [Hash] opts the optional parameters
|
496
|
-
# @option opts [DateTime] :since
|
497
|
-
# @option opts [DateTime] :_until
|
498
|
-
# @option opts [
|
499
|
-
# @option opts [String] :
|
508
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
509
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
510
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
511
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
512
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to registration_id)
|
513
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
514
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
515
|
+
# @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
|
500
516
|
# @return [UserInvitationList]
|
501
517
|
def get_private_user_invitations(invitation_id, opts = {})
|
502
518
|
data, _status_code, _headers = get_private_user_invitations_with_http_info(invitation_id, opts)
|
503
519
|
data
|
504
520
|
end
|
505
521
|
|
506
|
-
# Get a list of
|
507
|
-
# Get a list of
|
508
|
-
# @param invitation_id
|
522
|
+
# Get a list of Private User Invitations
|
523
|
+
# 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.
|
524
|
+
# @param invitation_id
|
509
525
|
# @param [Hash] opts the optional parameters
|
510
|
-
# @option opts [DateTime] :since
|
511
|
-
# @option opts [DateTime] :_until
|
512
|
-
# @option opts [
|
513
|
-
# @option opts [String] :
|
526
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
527
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
528
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
529
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
530
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
531
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
532
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
533
|
+
# @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
|
514
534
|
# @return [Array<(UserInvitationList, Fixnum, Hash)>] UserInvitationList data, response status code and response headers
|
515
535
|
def get_private_user_invitations_with_http_info(invitation_id, opts = {})
|
516
536
|
if @api_client.config.debugging
|
517
537
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_private_user_invitations ...'
|
518
538
|
end
|
519
539
|
# verify the required parameter 'invitation_id' is set
|
520
|
-
if
|
540
|
+
if invitation_id.nil?
|
521
541
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_user_invitations"
|
522
542
|
end
|
523
543
|
# resource path
|
@@ -527,8 +547,12 @@ module RusticiSoftwareCloudV2
|
|
527
547
|
query_params = {}
|
528
548
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
529
549
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
530
|
-
query_params[:'
|
550
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
551
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
552
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
553
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
531
554
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
555
|
+
query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
|
532
556
|
|
533
557
|
# header parameters
|
534
558
|
header_params = {}
|
@@ -555,9 +579,9 @@ module RusticiSoftwareCloudV2
|
|
555
579
|
end
|
556
580
|
return data, status_code, headers
|
557
581
|
end
|
558
|
-
# Get
|
559
|
-
#
|
560
|
-
# @param invitation_id
|
582
|
+
# Get detailed information about a Public Invitation
|
583
|
+
# Returns detailed information about the public invitation. This includes url, registration cap, and whether new learners can accept the invitation or not.
|
584
|
+
# @param invitation_id
|
561
585
|
# @param [Hash] opts the optional parameters
|
562
586
|
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
|
563
587
|
# @return [PublicInvitationSchema]
|
@@ -566,9 +590,9 @@ module RusticiSoftwareCloudV2
|
|
566
590
|
data
|
567
591
|
end
|
568
592
|
|
569
|
-
# Get
|
570
|
-
#
|
571
|
-
# @param invitation_id
|
593
|
+
# Get detailed information about a Public Invitation
|
594
|
+
# Returns detailed information about the public invitation. This includes url, registration cap, and whether new learners can accept the invitation or not.
|
595
|
+
# @param invitation_id
|
572
596
|
# @param [Hash] opts the optional parameters
|
573
597
|
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
|
574
598
|
# @return [Array<(PublicInvitationSchema, Fixnum, Hash)>] PublicInvitationSchema data, response status code and response headers
|
@@ -577,7 +601,7 @@ module RusticiSoftwareCloudV2
|
|
577
601
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_public_invitation ...'
|
578
602
|
end
|
579
603
|
# verify the required parameter 'invitation_id' is set
|
580
|
-
if
|
604
|
+
if invitation_id.nil?
|
581
605
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_public_invitation"
|
582
606
|
end
|
583
607
|
# resource path
|
@@ -612,38 +636,41 @@ module RusticiSoftwareCloudV2
|
|
612
636
|
end
|
613
637
|
return data, status_code, headers
|
614
638
|
end
|
615
|
-
# Get a list of
|
616
|
-
#
|
639
|
+
# Get a list of Public Invitations
|
640
|
+
# 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.
|
617
641
|
# @param [Hash] opts the optional parameters
|
618
|
-
# @option opts [String] :course_id
|
619
|
-
# @option opts [DateTime] :since
|
620
|
-
# @option opts [DateTime] :_until
|
621
|
-
# @option opts [String] :datetime_filter
|
622
|
-
# @option opts [Array<String>] :tags
|
623
|
-
# @option opts [String] :
|
642
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
643
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
644
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
645
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
646
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
647
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
648
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)
|
649
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
650
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
624
651
|
# @return [PublicInvitationList]
|
625
652
|
def get_public_invitations(opts = {})
|
626
653
|
data, _status_code, _headers = get_public_invitations_with_http_info(opts)
|
627
654
|
data
|
628
655
|
end
|
629
656
|
|
630
|
-
# Get a list of
|
631
|
-
#
|
657
|
+
# Get a list of Public Invitations
|
658
|
+
# 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.
|
632
659
|
# @param [Hash] opts the optional parameters
|
633
|
-
# @option opts [String] :course_id
|
634
|
-
# @option opts [DateTime] :since
|
635
|
-
# @option opts [DateTime] :_until
|
636
|
-
# @option opts [String] :datetime_filter
|
637
|
-
# @option opts [Array<String>] :tags
|
638
|
-
# @option opts [String] :
|
660
|
+
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
661
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
662
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
663
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
664
|
+
# @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
|
665
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
666
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
667
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
668
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
639
669
|
# @return [Array<(PublicInvitationList, Fixnum, Hash)>] PublicInvitationList data, response status code and response headers
|
640
670
|
def get_public_invitations_with_http_info(opts = {})
|
641
671
|
if @api_client.config.debugging
|
642
672
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_public_invitations ...'
|
643
673
|
end
|
644
|
-
if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
645
|
-
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
646
|
-
end
|
647
674
|
# resource path
|
648
675
|
local_var_path = '/invitations/public'
|
649
676
|
|
@@ -654,6 +681,9 @@ module RusticiSoftwareCloudV2
|
|
654
681
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
655
682
|
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
656
683
|
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
684
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
685
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
686
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
657
687
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
658
688
|
|
659
689
|
# header parameters
|
@@ -681,35 +711,43 @@ module RusticiSoftwareCloudV2
|
|
681
711
|
end
|
682
712
|
return data, status_code, headers
|
683
713
|
end
|
684
|
-
# Get a list of
|
685
|
-
#
|
686
|
-
# @param invitation_id
|
714
|
+
# Get a list of Public User Invitations
|
715
|
+
# 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.
|
716
|
+
# @param invitation_id
|
687
717
|
# @param [Hash] opts the optional parameters
|
688
|
-
# @option opts [DateTime] :since
|
689
|
-
# @option opts [DateTime] :_until
|
690
|
-
# @option opts [
|
691
|
-
# @option opts [String] :
|
718
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
719
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
720
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against (default to updated)
|
721
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
722
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to registration_id)
|
723
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
724
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
725
|
+
# @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
|
692
726
|
# @return [UserInvitationList]
|
693
727
|
def get_public_user_invitations(invitation_id, opts = {})
|
694
728
|
data, _status_code, _headers = get_public_user_invitations_with_http_info(invitation_id, opts)
|
695
729
|
data
|
696
730
|
end
|
697
731
|
|
698
|
-
# Get a list of
|
699
|
-
#
|
700
|
-
# @param invitation_id
|
732
|
+
# Get a list of Public User Invitations
|
733
|
+
# 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.
|
734
|
+
# @param invitation_id
|
701
735
|
# @param [Hash] opts the optional parameters
|
702
|
-
# @option opts [DateTime] :since
|
703
|
-
# @option opts [DateTime] :_until
|
704
|
-
# @option opts [
|
705
|
-
# @option opts [String] :
|
736
|
+
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
737
|
+
# @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
738
|
+
# @option opts [String] :datetime_filter Specifies field that `since` and `until` parameters are applied against
|
739
|
+
# @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
|
740
|
+
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
741
|
+
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
742
|
+
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
743
|
+
# @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
|
706
744
|
# @return [Array<(UserInvitationList, Fixnum, Hash)>] UserInvitationList data, response status code and response headers
|
707
745
|
def get_public_user_invitations_with_http_info(invitation_id, opts = {})
|
708
746
|
if @api_client.config.debugging
|
709
747
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.get_public_user_invitations ...'
|
710
748
|
end
|
711
749
|
# verify the required parameter 'invitation_id' is set
|
712
|
-
if
|
750
|
+
if invitation_id.nil?
|
713
751
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_public_user_invitations"
|
714
752
|
end
|
715
753
|
# resource path
|
@@ -719,8 +757,12 @@ module RusticiSoftwareCloudV2
|
|
719
757
|
query_params = {}
|
720
758
|
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
721
759
|
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
722
|
-
query_params[:'
|
760
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
761
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
762
|
+
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
763
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
723
764
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
765
|
+
query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
|
724
766
|
|
725
767
|
# header parameters
|
726
768
|
header_params = {}
|
@@ -747,9 +789,9 @@ module RusticiSoftwareCloudV2
|
|
747
789
|
end
|
748
790
|
return data, status_code, headers
|
749
791
|
end
|
750
|
-
#
|
751
|
-
#
|
752
|
-
# @param invitation_id
|
792
|
+
# Add tags to an Invitation
|
793
|
+
# 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).
|
794
|
+
# @param invitation_id
|
753
795
|
# @param tags
|
754
796
|
# @param [Hash] opts the optional parameters
|
755
797
|
# @return [nil]
|
@@ -758,9 +800,9 @@ module RusticiSoftwareCloudV2
|
|
758
800
|
nil
|
759
801
|
end
|
760
802
|
|
761
|
-
#
|
762
|
-
#
|
763
|
-
# @param invitation_id
|
803
|
+
# Add tags to an Invitation
|
804
|
+
# 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).
|
805
|
+
# @param invitation_id
|
764
806
|
# @param tags
|
765
807
|
# @param [Hash] opts the optional parameters
|
766
808
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -769,11 +811,11 @@ module RusticiSoftwareCloudV2
|
|
769
811
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.put_invitation_tags ...'
|
770
812
|
end
|
771
813
|
# verify the required parameter 'invitation_id' is set
|
772
|
-
if
|
814
|
+
if invitation_id.nil?
|
773
815
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.put_invitation_tags"
|
774
816
|
end
|
775
817
|
# verify the required parameter 'tags' is set
|
776
|
-
if
|
818
|
+
if tags.nil?
|
777
819
|
fail ArgumentError, "Missing the required parameter 'tags' when calling InvitationsApi.put_invitation_tags"
|
778
820
|
end
|
779
821
|
# resource path
|
@@ -806,9 +848,9 @@ module RusticiSoftwareCloudV2
|
|
806
848
|
end
|
807
849
|
return data, status_code, headers
|
808
850
|
end
|
809
|
-
#
|
810
|
-
#
|
811
|
-
# @param batch
|
851
|
+
# Add a group of tags to a group of Invitations
|
852
|
+
# 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).
|
853
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
812
854
|
# @param [Hash] opts the optional parameters
|
813
855
|
# @return [nil]
|
814
856
|
def put_invitation_tags_batch(batch, opts = {})
|
@@ -816,9 +858,9 @@ module RusticiSoftwareCloudV2
|
|
816
858
|
nil
|
817
859
|
end
|
818
860
|
|
819
|
-
#
|
820
|
-
#
|
821
|
-
# @param batch
|
861
|
+
# Add a group of tags to a group of Invitations
|
862
|
+
# 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).
|
863
|
+
# @param batch Array of ids, and array of tags for bulk tag operations
|
822
864
|
# @param [Hash] opts the optional parameters
|
823
865
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
824
866
|
def put_invitation_tags_batch_with_http_info(batch, opts = {})
|
@@ -826,7 +868,7 @@ module RusticiSoftwareCloudV2
|
|
826
868
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.put_invitation_tags_batch ...'
|
827
869
|
end
|
828
870
|
# verify the required parameter 'batch' is set
|
829
|
-
if
|
871
|
+
if batch.nil?
|
830
872
|
fail ArgumentError, "Missing the required parameter 'batch' when calling InvitationsApi.put_invitation_tags_batch"
|
831
873
|
end
|
832
874
|
# resource path
|
@@ -859,10 +901,10 @@ module RusticiSoftwareCloudV2
|
|
859
901
|
end
|
860
902
|
return data, status_code, headers
|
861
903
|
end
|
862
|
-
# Update
|
863
|
-
# Updates
|
864
|
-
# @param invitation_id
|
865
|
-
# @param invitation_update_schema
|
904
|
+
# Update information about a Private Invitation
|
905
|
+
# Updates information about the private invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
906
|
+
# @param invitation_id
|
907
|
+
# @param invitation_update_schema Object with values to be updated. Any value not specified above will be ignored.
|
866
908
|
# @param [Hash] opts the optional parameters
|
867
909
|
# @return [PrivateInvitationSchema]
|
868
910
|
def update_private_invitation(invitation_id, invitation_update_schema, opts = {})
|
@@ -870,10 +912,10 @@ module RusticiSoftwareCloudV2
|
|
870
912
|
data
|
871
913
|
end
|
872
914
|
|
873
|
-
# Update
|
874
|
-
# Updates
|
875
|
-
# @param invitation_id
|
876
|
-
# @param invitation_update_schema
|
915
|
+
# Update information about a Private Invitation
|
916
|
+
# Updates information about the private invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
917
|
+
# @param invitation_id
|
918
|
+
# @param invitation_update_schema Object with values to be updated. Any value not specified above will be ignored.
|
877
919
|
# @param [Hash] opts the optional parameters
|
878
920
|
# @return [Array<(PrivateInvitationSchema, Fixnum, Hash)>] PrivateInvitationSchema data, response status code and response headers
|
879
921
|
def update_private_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {})
|
@@ -881,11 +923,11 @@ module RusticiSoftwareCloudV2
|
|
881
923
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.update_private_invitation ...'
|
882
924
|
end
|
883
925
|
# verify the required parameter 'invitation_id' is set
|
884
|
-
if
|
926
|
+
if invitation_id.nil?
|
885
927
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.update_private_invitation"
|
886
928
|
end
|
887
929
|
# verify the required parameter 'invitation_update_schema' is set
|
888
|
-
if
|
930
|
+
if invitation_update_schema.nil?
|
889
931
|
fail ArgumentError, "Missing the required parameter 'invitation_update_schema' when calling InvitationsApi.update_private_invitation"
|
890
932
|
end
|
891
933
|
# resource path
|
@@ -919,10 +961,10 @@ module RusticiSoftwareCloudV2
|
|
919
961
|
end
|
920
962
|
return data, status_code, headers
|
921
963
|
end
|
922
|
-
# Update
|
923
|
-
# Updates
|
924
|
-
# @param invitation_id
|
925
|
-
# @param invitation_update_schema
|
964
|
+
# Update information about a Public Invitation
|
965
|
+
# Updates information about the public invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
966
|
+
# @param invitation_id
|
967
|
+
# @param invitation_update_schema Object with values to be updated. Any value not specified above will be ignored.
|
926
968
|
# @param [Hash] opts the optional parameters
|
927
969
|
# @return [PublicInvitationSchema]
|
928
970
|
def update_public_invitation(invitation_id, invitation_update_schema, opts = {})
|
@@ -930,10 +972,10 @@ module RusticiSoftwareCloudV2
|
|
930
972
|
data
|
931
973
|
end
|
932
974
|
|
933
|
-
# Update
|
934
|
-
# Updates
|
935
|
-
# @param invitation_id
|
936
|
-
# @param invitation_update_schema
|
975
|
+
# Update information about a Public Invitation
|
976
|
+
# Updates information about the public invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
977
|
+
# @param invitation_id
|
978
|
+
# @param invitation_update_schema Object with values to be updated. Any value not specified above will be ignored.
|
937
979
|
# @param [Hash] opts the optional parameters
|
938
980
|
# @return [Array<(PublicInvitationSchema, Fixnum, Hash)>] PublicInvitationSchema data, response status code and response headers
|
939
981
|
def update_public_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {})
|
@@ -941,11 +983,11 @@ module RusticiSoftwareCloudV2
|
|
941
983
|
@api_client.config.logger.debug 'Calling API: InvitationsApi.update_public_invitation ...'
|
942
984
|
end
|
943
985
|
# verify the required parameter 'invitation_id' is set
|
944
|
-
if
|
986
|
+
if invitation_id.nil?
|
945
987
|
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.update_public_invitation"
|
946
988
|
end
|
947
989
|
# verify the required parameter 'invitation_update_schema' is set
|
948
|
-
if
|
990
|
+
if invitation_update_schema.nil?
|
949
991
|
fail ArgumentError, "Missing the required parameter 'invitation_update_schema' when calling InvitationsApi.update_public_invitation"
|
950
992
|
end
|
951
993
|
# resource path
|