Class: RusticiSoftwareCloudV2::InvitationsApi
- Inherits:
-
Object
- Object
- RusticiSoftwareCloudV2::InvitationsApi
- Defined in:
- lib/rustici_software_cloud_v2/api/invitations_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#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.
-
#create_private_invitation_with_http_info(private_invitation_request, opts = {}) ⇒ Array<(InvitationSummarySchema, Fixnum, Hash)>
Create a Private Invitation to a Course Creates a private invitation job which sends emails with a link to the course.
-
#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.
-
#create_public_invitation_with_http_info(public_invitation_request, opts = {}) ⇒ Array<(PublicInvitationSchema, Fixnum, Hash)>
Create a Public Invitation to a Course Creates an invitation link to the course which can then be publicly distributed.
-
#delete_invitation_tags(invitation_id, tags, opts = {}) ⇒ nil
Delete tags from an Invitation Deletes the specified tags from the invitation.
-
#delete_invitation_tags_with_http_info(invitation_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete tags from an Invitation Deletes the specified tags from the invitation.
-
#get_all_invitations(opts = {}) ⇒ InvitationSummaryList
Get a list of Invitations Returns a list of invitations (both public and private).
-
#get_all_invitations_with_http_info(opts = {}) ⇒ Array<(InvitationSummaryList, Fixnum, Hash)>
Get a list of Invitations Returns a list of invitations (both public and private).
-
#get_invitation_tags(invitation_id, opts = {}) ⇒ TagListSchema
Get tags for an Invitation Returns the tags for the invitation.
-
#get_invitation_tags_with_http_info(invitation_id, opts = {}) ⇒ Array<(TagListSchema, Fixnum, Hash)>
Get tags for an Invitation Returns the tags for the invitation.
-
#get_private_invitation(invitation_id, opts = {}) ⇒ PrivateInvitationSchema
Get detailed information about a Private Invitation Returns detailed information about the private invitation.
-
#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.
-
#get_private_invitation_job_status_with_http_info(invitation_id, opts = {}) ⇒ Array<(InvitationJobStatusSchema, Fixnum, Hash)>
Get email job status for a Private Invitation Check the status of a private invitation email job.
-
#get_private_invitation_with_http_info(invitation_id, opts = {}) ⇒ Array<(PrivateInvitationSchema, Fixnum, Hash)>
Get detailed information about a Private Invitation Returns detailed information about the private invitation.
-
#get_private_invitations(opts = {}) ⇒ PrivateInvitationList
Get a list of Private Invitations Returns a list of private invitations.
-
#get_private_invitations_with_http_info(opts = {}) ⇒ Array<(PrivateInvitationList, Fixnum, Hash)>
Get a list of Private Invitations Returns a list of private invitations.
-
#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.
-
#get_private_user_invitations_with_http_info(invitation_id, opts = {}) ⇒ Array<(UserInvitationList, Fixnum, Hash)>
Get a list of Private User Invitations Get a list of user who were invited to view the course.
-
#get_public_invitation(invitation_id, opts = {}) ⇒ PublicInvitationSchema
Get detailed information about a Public Invitation Returns detailed information about the public invitation.
-
#get_public_invitation_with_http_info(invitation_id, opts = {}) ⇒ Array<(PublicInvitationSchema, Fixnum, Hash)>
Get detailed information about a Public Invitation Returns detailed information about the public invitation.
-
#get_public_invitations(opts = {}) ⇒ PublicInvitationList
Get a list of Public Invitations Returns a list of public invitations.
-
#get_public_invitations_with_http_info(opts = {}) ⇒ Array<(PublicInvitationList, Fixnum, Hash)>
Get a list of Public Invitations Returns a list of public invitations.
-
#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.
-
#get_public_user_invitations_with_http_info(invitation_id, opts = {}) ⇒ Array<(UserInvitationList, Fixnum, Hash)>
Get a list of Public User Invitations Returns a list of users who have visited the public invitation link.
-
#initialize(api_client = ApiClient.default) ⇒ InvitationsApi
constructor
A new instance of InvitationsApi.
-
#put_invitation_tags(invitation_id, tags, opts = {}) ⇒ nil
Add tags to an Invitation Applies the provided tags to the invitation.
-
#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.
-
#put_invitation_tags_batch_with_http_info(batch, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Add a group of tags to a group of Invitations Applies all of the provided tags on all of the provided invitations.
-
#put_invitation_tags_with_http_info(invitation_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Add tags to an Invitation Applies the provided tags to the invitation.
-
#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.
-
#update_private_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {}) ⇒ Array<(PrivateInvitationSchema, Fixnum, Hash)>
Update information about a Private Invitation Updates information about the private invitation, such as the expiration date and registration cap.
-
#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.
-
#update_public_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {}) ⇒ Array<(PublicInvitationSchema, Fixnum, Hash)>
Update information about a Public Invitation Updates information about the public invitation, such as the expiration date and registration cap.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ InvitationsApi
Returns a new instance of InvitationsApi.
19 20 21 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 17 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.
27 28 29 30 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 27 def create_private_invitation(private_invitation_request, opts = {}) data, _status_code, _headers = create_private_invitation_with_http_info(private_invitation_request, opts) data end |
#create_private_invitation_with_http_info(private_invitation_request, opts = {}) ⇒ Array<(InvitationSummarySchema, Fixnum, 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. >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.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 37 def create_private_invitation_with_http_info(private_invitation_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: InvitationsApi.create_private_invitation ...' end # verify the required parameter 'private_invitation_request' is set 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.
81 82 83 84 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 81 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, Fixnum, 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 `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.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 91 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.
136 137 138 139 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 136 def (invitation_id, , opts = {}) (invitation_id, , opts) nil end |
#delete_invitation_tags_with_http_info(invitation_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, 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.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 147 def (invitation_id, , 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 .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() 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.
202 203 204 205 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 202 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, Fixnum, 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. >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.
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 220 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? # 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.
269 270 271 272 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 269 def (invitation_id, opts = {}) data, _status_code, _headers = (invitation_id, opts) data end |
#get_invitation_tags_with_http_info(invitation_id, opts = {}) ⇒ Array<(TagListSchema, Fixnum, Hash)>
Get tags for an Invitation Returns the tags for the invitation.
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 279 def (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.
324 325 326 327 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 324 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.
380 381 382 383 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 380 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, Fixnum, 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.
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 390 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, Fixnum, 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.
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 335 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.
442 443 444 445 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 442 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, Fixnum, 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. >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.
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 460 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? # 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.
517 518 519 520 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 517 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, Fixnum, 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. >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.
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 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 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 535 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? # 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.
588 589 590 591 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 588 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, Fixnum, 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.
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 599 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.
652 653 654 655 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 652 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, Fixnum, 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. >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.
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 670 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? # 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.
727 728 729 730 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 727 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, Fixnum, 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. >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.
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 745 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? # 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).
798 799 800 801 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 798 def (invitation_id, , opts = {}) (invitation_id, , 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).
856 857 858 859 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 856 def (batch, opts = {}) (batch, opts) nil end |
#put_invitation_tags_batch_with_http_info(batch, opts = {}) ⇒ Array<(nil, Fixnum, 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).
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 866 def (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, Fixnum, 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).
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 809 def (invitation_id, , 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 .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() 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.
910 911 912 913 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 910 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, Fixnum, 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.
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 921 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.
970 971 972 973 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 970 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, Fixnum, 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.
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 |
# File 'lib/rustici_software_cloud_v2/api/invitations_api.rb', line 981 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 |