rustici_software_cloud_v2 1.0.0beta → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/README.md +194 -88
- data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +161 -97
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +13 -13
- data/lib/rustici_software_cloud_v2/api/course_api.rb +246 -260
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +1994 -0
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +964 -0
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +296 -0
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +10 -8
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +379 -324
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +555 -0
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +448 -0
- data/lib/rustici_software_cloud_v2/api_client.rb +2 -3
- data/lib/rustici_software_cloud_v2/api_error.rb +1 -2
- data/lib/rustici_software_cloud_v2/configuration.rb +9 -19
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +17 -14
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/application_token.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +29 -23
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +11 -8
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +225 -0
- data/lib/rustici_software_cloud_v2/models/{link_schema.rb → create_dispatch_list_schema.rb} +22 -21
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +308 -0
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +254 -0
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +252 -0
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +15 -11
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +197 -0
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +200 -0
- data/lib/rustici_software_cloud_v2/models/{setting_metadata_valid_values.rb → destination_schema.rb} +42 -31
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +198 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +290 -0
- data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +24 -11
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +12 -9
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +215 -0
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +253 -0
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +227 -0
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +19 -16
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +17 -8
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +23 -20
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +28 -20
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +33 -20
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +266 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +289 -0
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +5 -14
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +24 -9
- data/lib/rustici_software_cloud_v2/models/registration_success.rb +5 -14
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +259 -0
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +214 -0
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/response_error.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +19 -16
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +15 -12
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +15 -12
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +13 -9
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +12 -8
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +14 -10
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +258 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +236 -0
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +214 -0
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +13 -10
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +13 -10
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +14 -12
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +18 -15
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +12 -9
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +11 -8
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +220 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +220 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +252 -0
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +266 -0
- data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → xapi_credentials_list_schema.rb} +30 -31
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +205 -0
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +13 -10
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +12 -9
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +11 -8
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +11 -8
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +241 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +14 -11
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +12 -9
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +13 -10
- data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +187 -0
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +196 -0
- data/lib/rustici_software_cloud_v2/version.rb +2 -3
- data/lib/rustici_software_cloud_v2.rb +50 -6
- data/rustici_software_cloud_v2.gemspec +10 -11
- data/spec/api_client_spec.rb +1 -13
- data/spec/configuration_spec.rb +9 -10
- data/spec/spec_helper.rb +1 -13
- metadata +107 -271
- data/docs/ActivityResultSchema.md +0 -20
- data/docs/ApplicationListSchema.md +0 -8
- data/docs/ApplicationManagementApi.md +0 -570
- data/docs/ApplicationSchema.md +0 -9
- data/docs/ApplicationToken.md +0 -10
- data/docs/AuthenticationApi.md +0 -64
- data/docs/CommentSchema.md +0 -10
- data/docs/CompletionAmountSchema.md +0 -8
- data/docs/CourseActivitySchema.md +0 -15
- data/docs/CourseApi.md +0 -1459
- data/docs/CourseListNonPagedSchema.md +0 -8
- data/docs/CourseListSchema.md +0 -9
- data/docs/CourseReferenceSchema.md +0 -10
- data/docs/CourseSchema.md +0 -20
- data/docs/CourseTagsBatchSchema.md +0 -9
- data/docs/CreateRegistrationSchema.md +0 -17
- data/docs/CredentialCreatedSchema.md +0 -12
- data/docs/CredentialListSchema.md +0 -8
- data/docs/CredentialRequestSchema.md +0 -9
- data/docs/CredentialSchema.md +0 -12
- data/docs/ImportFetchRequestSchema.md +0 -8
- data/docs/ImportJobResultSchema.md +0 -11
- data/docs/ImportResultSchema.md +0 -11
- data/docs/IntegerResultSchema.md +0 -8
- data/docs/ItemValuePairSchema.md +0 -9
- data/docs/LaunchHistoryListSchema.md +0 -8
- data/docs/LaunchHistorySchema.md +0 -17
- data/docs/LaunchLinkRequestSchema.md +0 -17
- data/docs/LaunchLinkSchema.md +0 -8
- data/docs/LearnerPreferenceSchema.md +0 -11
- data/docs/LearnerSchema.md +0 -11
- data/docs/LinkSchema.md +0 -8
- data/docs/MessageSchema.md +0 -8
- data/docs/MetadataSchema.md +0 -14
- data/docs/ObjectiveSchema.md +0 -20
- data/docs/PermissionsSchema.md +0 -9
- data/docs/PingApi.md +0 -57
- data/docs/PingSchema.md +0 -8
- data/docs/PostBackSchema.md +0 -12
- data/docs/RegistrationApi.md +0 -1490
- data/docs/RegistrationCompletion.md +0 -7
- data/docs/RegistrationListSchema.md +0 -9
- data/docs/RegistrationSchema.md +0 -27
- data/docs/RegistrationSuccess.md +0 -7
- data/docs/RegistrationTagsBatchSchema.md +0 -9
- data/docs/ResponseError.md +0 -8
- data/docs/RuntimeInteractionSchema.md +0 -18
- data/docs/RuntimeObjectiveSchema.md +0 -16
- data/docs/RuntimeSchema.md +0 -27
- data/docs/ScoreSchema.md +0 -8
- data/docs/SettingItem.md +0 -12
- data/docs/SettingListSchema.md +0 -8
- data/docs/SettingMetadata.md +0 -15
- data/docs/SettingMetadataValidValues.md +0 -9
- data/docs/SettingValidValue.md +0 -9
- data/docs/SettingsIndividualSchema.md +0 -10
- data/docs/SettingsPostSchema.md +0 -8
- data/docs/SharedDataEntrySchema.md +0 -9
- data/docs/StaticPropertiesSchema.md +0 -13
- data/docs/StringResultSchema.md +0 -8
- data/docs/TagListSchema.md +0 -8
- data/docs/TagPostSchema.md +0 -7
- data/docs/TitleSchema.md +0 -8
- data/docs/TokenRequestSchema.md +0 -9
- data/docs/XapiAccount.md +0 -9
- data/docs/XapiActivity.md +0 -10
- data/docs/XapiActivityDefinition.md +0 -19
- data/docs/XapiAgentGroup.md +0 -14
- data/docs/XapiAttachment.md +0 -14
- data/docs/XapiContext.md +0 -16
- data/docs/XapiContextActivity.md +0 -11
- data/docs/XapiInteractionComponent.md +0 -9
- data/docs/XapiResult.md +0 -13
- data/docs/XapiScore.md +0 -11
- data/docs/XapiStatement.md +0 -20
- data/docs/XapiStatementReference.md +0 -9
- data/docs/XapiStatementResult.md +0 -9
- data/docs/XapiVerb.md +0 -9
- data/git_push.sh +0 -55
- data/spec/models/activity_result_schema_spec.rb +0 -133
- data/spec/models/application_list_schema_spec.rb +0 -53
- data/spec/models/application_schema_spec.rb +0 -59
- data/spec/models/application_token_spec.rb +0 -65
- data/spec/models/comment_schema_spec.rb +0 -65
- data/spec/models/completion_amount_schema_spec.rb +0 -53
- data/spec/models/course_activity_schema_spec.rb +0 -99
- data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
- data/spec/models/course_list_schema_spec.rb +0 -59
- data/spec/models/course_reference_schema_spec.rb +0 -65
- data/spec/models/course_schema_spec.rb +0 -129
- data/spec/models/create_registration_schema_spec.rb +0 -107
- data/spec/models/credential_created_schema_spec.rb +0 -77
- data/spec/models/credential_list_schema_spec.rb +0 -53
- data/spec/models/credential_request_schema_spec.rb +0 -59
- data/spec/models/credential_schema_spec.rb +0 -77
- data/spec/models/import_fetch_request_schema_spec.rb +0 -53
- data/spec/models/import_job_result_schema_spec.rb +0 -75
- data/spec/models/import_result_schema_spec.rb +0 -71
- data/spec/models/integer_result_schema_spec.rb +0 -53
- data/spec/models/item_value_pair_schema_spec.rb +0 -59
- data/spec/models/launch_history_list_schema_spec.rb +0 -53
- data/spec/models/launch_history_schema_spec.rb +0 -115
- data/spec/models/launch_link_request_schema_spec.rb +0 -107
- data/spec/models/launch_link_schema_spec.rb +0 -53
- data/spec/models/learner_preference_schema_spec.rb +0 -71
- data/spec/models/learner_schema_spec.rb +0 -71
- data/spec/models/link_schema_spec.rb +0 -53
- data/spec/models/message_schema_spec.rb +0 -53
- data/spec/models/metadata_schema_spec.rb +0 -89
- data/spec/models/objective_schema_spec.rb +0 -137
- data/spec/models/permissions_schema_spec.rb +0 -59
- data/spec/models/ping_schema_spec.rb +0 -53
- data/spec/models/post_back_schema_spec.rb +0 -85
- data/spec/models/registration_completion_spec.rb +0 -47
- data/spec/models/registration_list_schema_spec.rb +0 -59
- data/spec/models/registration_schema_spec.rb +0 -167
- data/spec/models/registration_success_spec.rb +0 -47
- data/spec/models/response_error_spec.rb +0 -53
- data/spec/models/runtime_interaction_schema_spec.rb +0 -117
- data/spec/models/runtime_objective_schema_spec.rb +0 -109
- data/spec/models/runtime_schema_spec.rb +0 -171
- data/spec/models/score_schema_spec.rb +0 -53
- data/spec/models/setting_item_spec.rb +0 -81
- data/spec/models/setting_list_schema_spec.rb +0 -53
- data/spec/models/setting_metadata_spec.rb +0 -99
- data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
- data/spec/models/settings_individual_schema_spec.rb +0 -65
- data/spec/models/settings_post_schema_spec.rb +0 -53
- data/spec/models/shared_data_entry_schema_spec.rb +0 -59
- data/spec/models/static_properties_schema_spec.rb +0 -83
- data/spec/models/string_result_schema_spec.rb +0 -53
- data/spec/models/title_schema_spec.rb +0 -53
- data/spec/models/token_request_schema_spec.rb +0 -59
- data/swagger-codegen.config +0 -11
|
@@ -0,0 +1,964 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#SCORM Cloud Rest API
|
|
3
|
+
|
|
4
|
+
#REST API used for SCORM Cloud integrations.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: 2.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
|
|
10
|
+
=end
|
|
11
|
+
|
|
12
|
+
require "uri"
|
|
13
|
+
|
|
14
|
+
module RusticiSoftwareCloudV2
|
|
15
|
+
class InvitationsApi
|
|
16
|
+
attr_accessor :api_client
|
|
17
|
+
|
|
18
|
+
def initialize(api_client = ApiClient.default)
|
|
19
|
+
@api_client = api_client
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# Create a private invitation to a course.
|
|
23
|
+
# Create a private invitation to a course. The provided information will be used to create new registrations for all of the provided e-mail addresses, and send asynchronously send e-mails to those addresses inviting them to the course. To check the status of this process, a subsequent call to `/invitations/private/{invitationId}/status` must be made.
|
|
24
|
+
# @param private_invitation_request
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [InvitationSummarySchema]
|
|
27
|
+
def create_private_invitation(private_invitation_request, opts = {})
|
|
28
|
+
data, _status_code, _headers = create_private_invitation_with_http_info(private_invitation_request, opts)
|
|
29
|
+
return data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Create a private invitation to a course.
|
|
33
|
+
# Create a private invitation to a course. The provided information will be used to create new registrations for all of the provided e-mail addresses, and send asynchronously send e-mails to those addresses inviting them to the course. To check the status of this process, a subsequent call to `/invitations/private/{invitationId}/status` must be made.
|
|
34
|
+
# @param private_invitation_request
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(InvitationSummarySchema, Fixnum, Hash)>] InvitationSummarySchema data, response status code and response headers
|
|
37
|
+
def create_private_invitation_with_http_info(private_invitation_request, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.create_private_invitation ..."
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'private_invitation_request' is set
|
|
42
|
+
fail ArgumentError, "Missing the required parameter 'private_invitation_request' when calling InvitationsApi.create_private_invitation" if private_invitation_request.nil?
|
|
43
|
+
# resource path
|
|
44
|
+
local_var_path = "/invitations/private".sub('{format}','json')
|
|
45
|
+
|
|
46
|
+
# query parameters
|
|
47
|
+
query_params = {}
|
|
48
|
+
|
|
49
|
+
# header parameters
|
|
50
|
+
header_params = {}
|
|
51
|
+
# HTTP header 'Accept' (if needed)
|
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
53
|
+
# HTTP header 'Content-Type'
|
|
54
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
55
|
+
|
|
56
|
+
# form parameters
|
|
57
|
+
form_params = {}
|
|
58
|
+
|
|
59
|
+
# http body (model)
|
|
60
|
+
post_body = @api_client.object_to_http_body(private_invitation_request)
|
|
61
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
62
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
63
|
+
:header_params => header_params,
|
|
64
|
+
:query_params => query_params,
|
|
65
|
+
:form_params => form_params,
|
|
66
|
+
:body => post_body,
|
|
67
|
+
:auth_names => auth_names,
|
|
68
|
+
:return_type => 'InvitationSummarySchema')
|
|
69
|
+
if @api_client.config.debugging
|
|
70
|
+
@api_client.config.logger.debug "API called: InvitationsApi#create_private_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
71
|
+
end
|
|
72
|
+
return data, status_code, headers
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Create a publicly accessible invitation to a course.
|
|
76
|
+
# Create a publicly accessible invitation to a course.
|
|
77
|
+
# @param public_invitation_request A description of the public invitation to be created.
|
|
78
|
+
# @param [Hash] opts the optional parameters
|
|
79
|
+
# @return [PublicInvitationSchema]
|
|
80
|
+
def create_public_invitation(public_invitation_request, opts = {})
|
|
81
|
+
data, _status_code, _headers = create_public_invitation_with_http_info(public_invitation_request, opts)
|
|
82
|
+
return data
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Create a publicly accessible invitation to a course.
|
|
86
|
+
# Create a publicly accessible invitation to a course.
|
|
87
|
+
# @param public_invitation_request A description of the public invitation to be created.
|
|
88
|
+
# @param [Hash] opts the optional parameters
|
|
89
|
+
# @return [Array<(PublicInvitationSchema, Fixnum, Hash)>] PublicInvitationSchema data, response status code and response headers
|
|
90
|
+
def create_public_invitation_with_http_info(public_invitation_request, opts = {})
|
|
91
|
+
if @api_client.config.debugging
|
|
92
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.create_public_invitation ..."
|
|
93
|
+
end
|
|
94
|
+
# verify the required parameter 'public_invitation_request' is set
|
|
95
|
+
fail ArgumentError, "Missing the required parameter 'public_invitation_request' when calling InvitationsApi.create_public_invitation" if public_invitation_request.nil?
|
|
96
|
+
# resource path
|
|
97
|
+
local_var_path = "/invitations/public".sub('{format}','json')
|
|
98
|
+
|
|
99
|
+
# query parameters
|
|
100
|
+
query_params = {}
|
|
101
|
+
|
|
102
|
+
# header parameters
|
|
103
|
+
header_params = {}
|
|
104
|
+
# HTTP header 'Accept' (if needed)
|
|
105
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
106
|
+
# HTTP header 'Content-Type'
|
|
107
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
108
|
+
|
|
109
|
+
# form parameters
|
|
110
|
+
form_params = {}
|
|
111
|
+
|
|
112
|
+
# http body (model)
|
|
113
|
+
post_body = @api_client.object_to_http_body(public_invitation_request)
|
|
114
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
115
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
116
|
+
:header_params => header_params,
|
|
117
|
+
:query_params => query_params,
|
|
118
|
+
:form_params => form_params,
|
|
119
|
+
:body => post_body,
|
|
120
|
+
:auth_names => auth_names,
|
|
121
|
+
:return_type => 'PublicInvitationSchema')
|
|
122
|
+
if @api_client.config.debugging
|
|
123
|
+
@api_client.config.logger.debug "API called: InvitationsApi#create_public_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
124
|
+
end
|
|
125
|
+
return data, status_code, headers
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Delete the tags for this invitation
|
|
129
|
+
# Delete the tags for this invitation
|
|
130
|
+
# @param invitation_id invitation id
|
|
131
|
+
# @param tags
|
|
132
|
+
# @param [Hash] opts the optional parameters
|
|
133
|
+
# @return [nil]
|
|
134
|
+
def delete_invitation_tags(invitation_id, tags, opts = {})
|
|
135
|
+
delete_invitation_tags_with_http_info(invitation_id, tags, opts)
|
|
136
|
+
return nil
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Delete the tags for this invitation
|
|
140
|
+
# Delete the tags for this invitation
|
|
141
|
+
# @param invitation_id invitation id
|
|
142
|
+
# @param tags
|
|
143
|
+
# @param [Hash] opts the optional parameters
|
|
144
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
145
|
+
def delete_invitation_tags_with_http_info(invitation_id, tags, opts = {})
|
|
146
|
+
if @api_client.config.debugging
|
|
147
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.delete_invitation_tags ..."
|
|
148
|
+
end
|
|
149
|
+
# verify the required parameter 'invitation_id' is set
|
|
150
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.delete_invitation_tags" if invitation_id.nil?
|
|
151
|
+
# verify the required parameter 'tags' is set
|
|
152
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling InvitationsApi.delete_invitation_tags" if tags.nil?
|
|
153
|
+
# resource path
|
|
154
|
+
local_var_path = "/invitations/{invitationId}/tags".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
155
|
+
|
|
156
|
+
# query parameters
|
|
157
|
+
query_params = {}
|
|
158
|
+
|
|
159
|
+
# header parameters
|
|
160
|
+
header_params = {}
|
|
161
|
+
# HTTP header 'Accept' (if needed)
|
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
163
|
+
# HTTP header 'Content-Type'
|
|
164
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
165
|
+
|
|
166
|
+
# form parameters
|
|
167
|
+
form_params = {}
|
|
168
|
+
|
|
169
|
+
# http body (model)
|
|
170
|
+
post_body = @api_client.object_to_http_body(tags)
|
|
171
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
172
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
173
|
+
:header_params => header_params,
|
|
174
|
+
:query_params => query_params,
|
|
175
|
+
:form_params => form_params,
|
|
176
|
+
:body => post_body,
|
|
177
|
+
:auth_names => auth_names)
|
|
178
|
+
if @api_client.config.debugging
|
|
179
|
+
@api_client.config.logger.debug "API called: InvitationsApi#delete_invitation_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
180
|
+
end
|
|
181
|
+
return data, status_code, headers
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
# Get a list of invitation summaries.
|
|
185
|
+
# Get a summary of all the invitations for an appId, both public and private.
|
|
186
|
+
# @param [Hash] opts the optional parameters
|
|
187
|
+
# @option opts [String] :course_id Limit the results to invitations with courseIds that match the filter.
|
|
188
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
189
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
190
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`. (default to updated)
|
|
191
|
+
# @option opts [Array<String>] :tags
|
|
192
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
193
|
+
# @return [InvitationSummaryList]
|
|
194
|
+
def get_all_invitations(opts = {})
|
|
195
|
+
data, _status_code, _headers = get_all_invitations_with_http_info(opts)
|
|
196
|
+
return data
|
|
197
|
+
end
|
|
198
|
+
|
|
199
|
+
# Get a list of invitation summaries.
|
|
200
|
+
# Get a summary of all the invitations for an appId, both public and private.
|
|
201
|
+
# @param [Hash] opts the optional parameters
|
|
202
|
+
# @option opts [String] :course_id Limit the results to invitations with courseIds that match the filter.
|
|
203
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
204
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
205
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`.
|
|
206
|
+
# @option opts [Array<String>] :tags
|
|
207
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
208
|
+
# @return [Array<(InvitationSummaryList, Fixnum, Hash)>] InvitationSummaryList data, response status code and response headers
|
|
209
|
+
def get_all_invitations_with_http_info(opts = {})
|
|
210
|
+
if @api_client.config.debugging
|
|
211
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_all_invitations ..."
|
|
212
|
+
end
|
|
213
|
+
if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
|
214
|
+
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
|
215
|
+
end
|
|
216
|
+
# resource path
|
|
217
|
+
local_var_path = "/invitations".sub('{format}','json')
|
|
218
|
+
|
|
219
|
+
# query parameters
|
|
220
|
+
query_params = {}
|
|
221
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
|
222
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
223
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
224
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
|
225
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
|
226
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
227
|
+
|
|
228
|
+
# header parameters
|
|
229
|
+
header_params = {}
|
|
230
|
+
# HTTP header 'Accept' (if needed)
|
|
231
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
232
|
+
# HTTP header 'Content-Type'
|
|
233
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
234
|
+
|
|
235
|
+
# form parameters
|
|
236
|
+
form_params = {}
|
|
237
|
+
|
|
238
|
+
# http body (model)
|
|
239
|
+
post_body = nil
|
|
240
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
241
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
242
|
+
:header_params => header_params,
|
|
243
|
+
:query_params => query_params,
|
|
244
|
+
:form_params => form_params,
|
|
245
|
+
:body => post_body,
|
|
246
|
+
:auth_names => auth_names,
|
|
247
|
+
:return_type => 'InvitationSummaryList')
|
|
248
|
+
if @api_client.config.debugging
|
|
249
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_all_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
250
|
+
end
|
|
251
|
+
return data, status_code, headers
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
# Get the tags for this invitation
|
|
255
|
+
# Get the tags for this invitation
|
|
256
|
+
# @param invitation_id invitation id
|
|
257
|
+
# @param [Hash] opts the optional parameters
|
|
258
|
+
# @return [TagListSchema]
|
|
259
|
+
def get_invitation_tags(invitation_id, opts = {})
|
|
260
|
+
data, _status_code, _headers = get_invitation_tags_with_http_info(invitation_id, opts)
|
|
261
|
+
return data
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
# Get the tags for this invitation
|
|
265
|
+
# Get the tags for this invitation
|
|
266
|
+
# @param invitation_id invitation id
|
|
267
|
+
# @param [Hash] opts the optional parameters
|
|
268
|
+
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
|
269
|
+
def get_invitation_tags_with_http_info(invitation_id, opts = {})
|
|
270
|
+
if @api_client.config.debugging
|
|
271
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_invitation_tags ..."
|
|
272
|
+
end
|
|
273
|
+
# verify the required parameter 'invitation_id' is set
|
|
274
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_invitation_tags" if invitation_id.nil?
|
|
275
|
+
# resource path
|
|
276
|
+
local_var_path = "/invitations/{invitationId}/tags".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
277
|
+
|
|
278
|
+
# query parameters
|
|
279
|
+
query_params = {}
|
|
280
|
+
|
|
281
|
+
# header parameters
|
|
282
|
+
header_params = {}
|
|
283
|
+
# HTTP header 'Accept' (if needed)
|
|
284
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
285
|
+
# HTTP header 'Content-Type'
|
|
286
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
287
|
+
|
|
288
|
+
# form parameters
|
|
289
|
+
form_params = {}
|
|
290
|
+
|
|
291
|
+
# http body (model)
|
|
292
|
+
post_body = nil
|
|
293
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
294
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
295
|
+
:header_params => header_params,
|
|
296
|
+
:query_params => query_params,
|
|
297
|
+
:form_params => form_params,
|
|
298
|
+
:body => post_body,
|
|
299
|
+
:auth_names => auth_names,
|
|
300
|
+
:return_type => 'TagListSchema')
|
|
301
|
+
if @api_client.config.debugging
|
|
302
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_invitation_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
303
|
+
end
|
|
304
|
+
return data, status_code, headers
|
|
305
|
+
end
|
|
306
|
+
|
|
307
|
+
# Get a information about a private invitation.
|
|
308
|
+
# Get a information about a private invitation.
|
|
309
|
+
# @param invitation_id invitation id
|
|
310
|
+
# @param [Hash] opts the optional parameters
|
|
311
|
+
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
|
|
312
|
+
# @return [PrivateInvitationSchema]
|
|
313
|
+
def get_private_invitation(invitation_id, opts = {})
|
|
314
|
+
data, _status_code, _headers = get_private_invitation_with_http_info(invitation_id, opts)
|
|
315
|
+
return data
|
|
316
|
+
end
|
|
317
|
+
|
|
318
|
+
# Get a information about a private invitation.
|
|
319
|
+
# Get a information about a private invitation.
|
|
320
|
+
# @param invitation_id invitation id
|
|
321
|
+
# @param [Hash] opts the optional parameters
|
|
322
|
+
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
|
|
323
|
+
# @return [Array<(PrivateInvitationSchema, Fixnum, Hash)>] PrivateInvitationSchema data, response status code and response headers
|
|
324
|
+
def get_private_invitation_with_http_info(invitation_id, opts = {})
|
|
325
|
+
if @api_client.config.debugging
|
|
326
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_private_invitation ..."
|
|
327
|
+
end
|
|
328
|
+
# verify the required parameter 'invitation_id' is set
|
|
329
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_invitation" if invitation_id.nil?
|
|
330
|
+
# resource path
|
|
331
|
+
local_var_path = "/invitations/private/{invitationId}".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
332
|
+
|
|
333
|
+
# query parameters
|
|
334
|
+
query_params = {}
|
|
335
|
+
query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
|
|
336
|
+
|
|
337
|
+
# header parameters
|
|
338
|
+
header_params = {}
|
|
339
|
+
# HTTP header 'Accept' (if needed)
|
|
340
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
341
|
+
# HTTP header 'Content-Type'
|
|
342
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
343
|
+
|
|
344
|
+
# form parameters
|
|
345
|
+
form_params = {}
|
|
346
|
+
|
|
347
|
+
# http body (model)
|
|
348
|
+
post_body = nil
|
|
349
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
350
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
351
|
+
:header_params => header_params,
|
|
352
|
+
:query_params => query_params,
|
|
353
|
+
:form_params => form_params,
|
|
354
|
+
:body => post_body,
|
|
355
|
+
:auth_names => auth_names,
|
|
356
|
+
:return_type => 'PrivateInvitationSchema')
|
|
357
|
+
if @api_client.config.debugging
|
|
358
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_private_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
359
|
+
end
|
|
360
|
+
return data, status_code, headers
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
# Get the status of an invitation job.
|
|
364
|
+
# Get the status of a job to send out private invitations.
|
|
365
|
+
# @param invitation_id invitation id
|
|
366
|
+
# @param [Hash] opts the optional parameters
|
|
367
|
+
# @return [InvitationJobStatusSchema]
|
|
368
|
+
def get_private_invitation_job_status(invitation_id, opts = {})
|
|
369
|
+
data, _status_code, _headers = get_private_invitation_job_status_with_http_info(invitation_id, opts)
|
|
370
|
+
return data
|
|
371
|
+
end
|
|
372
|
+
|
|
373
|
+
# Get the status of an invitation job.
|
|
374
|
+
# Get the status of a job to send out private invitations.
|
|
375
|
+
# @param invitation_id invitation id
|
|
376
|
+
# @param [Hash] opts the optional parameters
|
|
377
|
+
# @return [Array<(InvitationJobStatusSchema, Fixnum, Hash)>] InvitationJobStatusSchema data, response status code and response headers
|
|
378
|
+
def get_private_invitation_job_status_with_http_info(invitation_id, opts = {})
|
|
379
|
+
if @api_client.config.debugging
|
|
380
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_private_invitation_job_status ..."
|
|
381
|
+
end
|
|
382
|
+
# verify the required parameter 'invitation_id' is set
|
|
383
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_invitation_job_status" if invitation_id.nil?
|
|
384
|
+
# resource path
|
|
385
|
+
local_var_path = "/invitations/private/{invitationId}/jobStatus".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
386
|
+
|
|
387
|
+
# query parameters
|
|
388
|
+
query_params = {}
|
|
389
|
+
|
|
390
|
+
# header parameters
|
|
391
|
+
header_params = {}
|
|
392
|
+
# HTTP header 'Accept' (if needed)
|
|
393
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
394
|
+
# HTTP header 'Content-Type'
|
|
395
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
396
|
+
|
|
397
|
+
# form parameters
|
|
398
|
+
form_params = {}
|
|
399
|
+
|
|
400
|
+
# http body (model)
|
|
401
|
+
post_body = nil
|
|
402
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
403
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
404
|
+
:header_params => header_params,
|
|
405
|
+
:query_params => query_params,
|
|
406
|
+
:form_params => form_params,
|
|
407
|
+
:body => post_body,
|
|
408
|
+
:auth_names => auth_names,
|
|
409
|
+
:return_type => 'InvitationJobStatusSchema')
|
|
410
|
+
if @api_client.config.debugging
|
|
411
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_private_invitation_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
412
|
+
end
|
|
413
|
+
return data, status_code, headers
|
|
414
|
+
end
|
|
415
|
+
|
|
416
|
+
# Get a list of all private invitations.
|
|
417
|
+
# Retrieves a list of all private invitations, optionally filtered by the given parameters.
|
|
418
|
+
# @param [Hash] opts the optional parameters
|
|
419
|
+
# @option opts [String] :course_id Limit the results to invitations with courseIds that match the filter.
|
|
420
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
421
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
422
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`. (default to updated)
|
|
423
|
+
# @option opts [Array<String>] :tags
|
|
424
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
425
|
+
# @return [PrivateInvitationList]
|
|
426
|
+
def get_private_invitations(opts = {})
|
|
427
|
+
data, _status_code, _headers = get_private_invitations_with_http_info(opts)
|
|
428
|
+
return data
|
|
429
|
+
end
|
|
430
|
+
|
|
431
|
+
# Get a list of all private invitations.
|
|
432
|
+
# Retrieves a list of all private invitations, optionally filtered by the given parameters.
|
|
433
|
+
# @param [Hash] opts the optional parameters
|
|
434
|
+
# @option opts [String] :course_id Limit the results to invitations with courseIds that match the filter.
|
|
435
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
436
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
437
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`.
|
|
438
|
+
# @option opts [Array<String>] :tags
|
|
439
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
440
|
+
# @return [Array<(PrivateInvitationList, Fixnum, Hash)>] PrivateInvitationList data, response status code and response headers
|
|
441
|
+
def get_private_invitations_with_http_info(opts = {})
|
|
442
|
+
if @api_client.config.debugging
|
|
443
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_private_invitations ..."
|
|
444
|
+
end
|
|
445
|
+
if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
|
446
|
+
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
|
447
|
+
end
|
|
448
|
+
# resource path
|
|
449
|
+
local_var_path = "/invitations/private".sub('{format}','json')
|
|
450
|
+
|
|
451
|
+
# query parameters
|
|
452
|
+
query_params = {}
|
|
453
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
|
454
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
455
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
456
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
|
457
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
|
458
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
459
|
+
|
|
460
|
+
# header parameters
|
|
461
|
+
header_params = {}
|
|
462
|
+
# HTTP header 'Accept' (if needed)
|
|
463
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
464
|
+
# HTTP header 'Content-Type'
|
|
465
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
466
|
+
|
|
467
|
+
# form parameters
|
|
468
|
+
form_params = {}
|
|
469
|
+
|
|
470
|
+
# http body (model)
|
|
471
|
+
post_body = nil
|
|
472
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
473
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
474
|
+
:header_params => header_params,
|
|
475
|
+
:query_params => query_params,
|
|
476
|
+
:form_params => form_params,
|
|
477
|
+
:body => post_body,
|
|
478
|
+
:auth_names => auth_names,
|
|
479
|
+
:return_type => 'PrivateInvitationList')
|
|
480
|
+
if @api_client.config.debugging
|
|
481
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_private_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
482
|
+
end
|
|
483
|
+
return data, status_code, headers
|
|
484
|
+
end
|
|
485
|
+
|
|
486
|
+
# Get a list of user invitations.
|
|
487
|
+
# Get a list of objects which contain the specific information about each user to whom this invitation was sent.
|
|
488
|
+
# @param invitation_id invitation id
|
|
489
|
+
# @param [Hash] opts the optional parameters
|
|
490
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
491
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
492
|
+
# @option opts [BOOLEAN] :include_registration_report
|
|
493
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
494
|
+
# @return [UserInvitationList]
|
|
495
|
+
def get_private_user_invitations(invitation_id, opts = {})
|
|
496
|
+
data, _status_code, _headers = get_private_user_invitations_with_http_info(invitation_id, opts)
|
|
497
|
+
return data
|
|
498
|
+
end
|
|
499
|
+
|
|
500
|
+
# Get a list of user invitations.
|
|
501
|
+
# Get a list of objects which contain the specific information about each user to whom this invitation was sent.
|
|
502
|
+
# @param invitation_id invitation id
|
|
503
|
+
# @param [Hash] opts the optional parameters
|
|
504
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
505
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
506
|
+
# @option opts [BOOLEAN] :include_registration_report
|
|
507
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
508
|
+
# @return [Array<(UserInvitationList, Fixnum, Hash)>] UserInvitationList data, response status code and response headers
|
|
509
|
+
def get_private_user_invitations_with_http_info(invitation_id, opts = {})
|
|
510
|
+
if @api_client.config.debugging
|
|
511
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_private_user_invitations ..."
|
|
512
|
+
end
|
|
513
|
+
# verify the required parameter 'invitation_id' is set
|
|
514
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_private_user_invitations" if invitation_id.nil?
|
|
515
|
+
# resource path
|
|
516
|
+
local_var_path = "/invitations/private/{invitationId}/userInvitations".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
517
|
+
|
|
518
|
+
# query parameters
|
|
519
|
+
query_params = {}
|
|
520
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
521
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
522
|
+
query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
|
|
523
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
524
|
+
|
|
525
|
+
# header parameters
|
|
526
|
+
header_params = {}
|
|
527
|
+
# HTTP header 'Accept' (if needed)
|
|
528
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
529
|
+
# HTTP header 'Content-Type'
|
|
530
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
531
|
+
|
|
532
|
+
# form parameters
|
|
533
|
+
form_params = {}
|
|
534
|
+
|
|
535
|
+
# http body (model)
|
|
536
|
+
post_body = nil
|
|
537
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
538
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
539
|
+
:header_params => header_params,
|
|
540
|
+
:query_params => query_params,
|
|
541
|
+
:form_params => form_params,
|
|
542
|
+
:body => post_body,
|
|
543
|
+
:auth_names => auth_names,
|
|
544
|
+
:return_type => 'UserInvitationList')
|
|
545
|
+
if @api_client.config.debugging
|
|
546
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_private_user_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
547
|
+
end
|
|
548
|
+
return data, status_code, headers
|
|
549
|
+
end
|
|
550
|
+
|
|
551
|
+
# Get a information about a public invitation.
|
|
552
|
+
# Get a information about a public invitation.
|
|
553
|
+
# @param invitation_id invitation id
|
|
554
|
+
# @param [Hash] opts the optional parameters
|
|
555
|
+
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
|
|
556
|
+
# @return [PublicInvitationSchema]
|
|
557
|
+
def get_public_invitation(invitation_id, opts = {})
|
|
558
|
+
data, _status_code, _headers = get_public_invitation_with_http_info(invitation_id, opts)
|
|
559
|
+
return data
|
|
560
|
+
end
|
|
561
|
+
|
|
562
|
+
# Get a information about a public invitation.
|
|
563
|
+
# Get a information about a public invitation.
|
|
564
|
+
# @param invitation_id invitation id
|
|
565
|
+
# @param [Hash] opts the optional parameters
|
|
566
|
+
# @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
|
|
567
|
+
# @return [Array<(PublicInvitationSchema, Fixnum, Hash)>] PublicInvitationSchema data, response status code and response headers
|
|
568
|
+
def get_public_invitation_with_http_info(invitation_id, opts = {})
|
|
569
|
+
if @api_client.config.debugging
|
|
570
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_public_invitation ..."
|
|
571
|
+
end
|
|
572
|
+
# verify the required parameter 'invitation_id' is set
|
|
573
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_public_invitation" if invitation_id.nil?
|
|
574
|
+
# resource path
|
|
575
|
+
local_var_path = "/invitations/public/{invitationId}".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
576
|
+
|
|
577
|
+
# query parameters
|
|
578
|
+
query_params = {}
|
|
579
|
+
query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
|
|
580
|
+
|
|
581
|
+
# header parameters
|
|
582
|
+
header_params = {}
|
|
583
|
+
# HTTP header 'Accept' (if needed)
|
|
584
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
585
|
+
# HTTP header 'Content-Type'
|
|
586
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
587
|
+
|
|
588
|
+
# form parameters
|
|
589
|
+
form_params = {}
|
|
590
|
+
|
|
591
|
+
# http body (model)
|
|
592
|
+
post_body = nil
|
|
593
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
594
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
595
|
+
:header_params => header_params,
|
|
596
|
+
:query_params => query_params,
|
|
597
|
+
:form_params => form_params,
|
|
598
|
+
:body => post_body,
|
|
599
|
+
:auth_names => auth_names,
|
|
600
|
+
:return_type => 'PublicInvitationSchema')
|
|
601
|
+
if @api_client.config.debugging
|
|
602
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_public_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
603
|
+
end
|
|
604
|
+
return data, status_code, headers
|
|
605
|
+
end
|
|
606
|
+
|
|
607
|
+
# Get a list of all public invitations.
|
|
608
|
+
# Retrieves a list of all public invitations, optionally filtered by the given parameters.
|
|
609
|
+
# @param [Hash] opts the optional parameters
|
|
610
|
+
# @option opts [String] :course_id Limit the results to invitations with courseIds that match the filter.
|
|
611
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
612
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
613
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`. (default to updated)
|
|
614
|
+
# @option opts [Array<String>] :tags
|
|
615
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
616
|
+
# @return [PublicInvitationList]
|
|
617
|
+
def get_public_invitations(opts = {})
|
|
618
|
+
data, _status_code, _headers = get_public_invitations_with_http_info(opts)
|
|
619
|
+
return data
|
|
620
|
+
end
|
|
621
|
+
|
|
622
|
+
# Get a list of all public invitations.
|
|
623
|
+
# Retrieves a list of all public invitations, optionally filtered by the given parameters.
|
|
624
|
+
# @param [Hash] opts the optional parameters
|
|
625
|
+
# @option opts [String] :course_id Limit the results to invitations with courseIds that match the filter.
|
|
626
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
627
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
628
|
+
# @option opts [String] :datetime_filter A string describing what the since/until parameters will be applied to. Options are: 'created' or 'updated'. If not provided, it will default to `updated`.
|
|
629
|
+
# @option opts [Array<String>] :tags
|
|
630
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
631
|
+
# @return [Array<(PublicInvitationList, Fixnum, Hash)>] PublicInvitationList data, response status code and response headers
|
|
632
|
+
def get_public_invitations_with_http_info(opts = {})
|
|
633
|
+
if @api_client.config.debugging
|
|
634
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_public_invitations ..."
|
|
635
|
+
end
|
|
636
|
+
if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
|
|
637
|
+
fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
|
|
638
|
+
end
|
|
639
|
+
# resource path
|
|
640
|
+
local_var_path = "/invitations/public".sub('{format}','json')
|
|
641
|
+
|
|
642
|
+
# query parameters
|
|
643
|
+
query_params = {}
|
|
644
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
|
645
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
646
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
647
|
+
query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
|
|
648
|
+
query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
|
|
649
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
650
|
+
|
|
651
|
+
# header parameters
|
|
652
|
+
header_params = {}
|
|
653
|
+
# HTTP header 'Accept' (if needed)
|
|
654
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
655
|
+
# HTTP header 'Content-Type'
|
|
656
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
657
|
+
|
|
658
|
+
# form parameters
|
|
659
|
+
form_params = {}
|
|
660
|
+
|
|
661
|
+
# http body (model)
|
|
662
|
+
post_body = nil
|
|
663
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
664
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
665
|
+
:header_params => header_params,
|
|
666
|
+
:query_params => query_params,
|
|
667
|
+
:form_params => form_params,
|
|
668
|
+
:body => post_body,
|
|
669
|
+
:auth_names => auth_names,
|
|
670
|
+
:return_type => 'PublicInvitationList')
|
|
671
|
+
if @api_client.config.debugging
|
|
672
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_public_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
673
|
+
end
|
|
674
|
+
return data, status_code, headers
|
|
675
|
+
end
|
|
676
|
+
|
|
677
|
+
# Get a list of user invitations.
|
|
678
|
+
# Get a list of objects which contain the specific information about each user who visited the invitation link.
|
|
679
|
+
# @param invitation_id invitation id
|
|
680
|
+
# @param [Hash] opts the optional parameters
|
|
681
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
682
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
683
|
+
# @option opts [BOOLEAN] :include_registration_report
|
|
684
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
685
|
+
# @return [UserInvitationList]
|
|
686
|
+
def get_public_user_invitations(invitation_id, opts = {})
|
|
687
|
+
data, _status_code, _headers = get_public_user_invitations_with_http_info(invitation_id, opts)
|
|
688
|
+
return data
|
|
689
|
+
end
|
|
690
|
+
|
|
691
|
+
# Get a list of user invitations.
|
|
692
|
+
# Get a list of objects which contain the specific information about each user who visited the invitation link.
|
|
693
|
+
# @param invitation_id invitation id
|
|
694
|
+
# @param [Hash] opts the optional parameters
|
|
695
|
+
# @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
696
|
+
# @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
|
697
|
+
# @option opts [BOOLEAN] :include_registration_report
|
|
698
|
+
# @option opts [String] :more Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
|
699
|
+
# @return [Array<(UserInvitationList, Fixnum, Hash)>] UserInvitationList data, response status code and response headers
|
|
700
|
+
def get_public_user_invitations_with_http_info(invitation_id, opts = {})
|
|
701
|
+
if @api_client.config.debugging
|
|
702
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.get_public_user_invitations ..."
|
|
703
|
+
end
|
|
704
|
+
# verify the required parameter 'invitation_id' is set
|
|
705
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.get_public_user_invitations" if invitation_id.nil?
|
|
706
|
+
# resource path
|
|
707
|
+
local_var_path = "/invitations/public/{invitationId}/userInvitations".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
708
|
+
|
|
709
|
+
# query parameters
|
|
710
|
+
query_params = {}
|
|
711
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
712
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
713
|
+
query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
|
|
714
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
|
715
|
+
|
|
716
|
+
# header parameters
|
|
717
|
+
header_params = {}
|
|
718
|
+
# HTTP header 'Accept' (if needed)
|
|
719
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
720
|
+
# HTTP header 'Content-Type'
|
|
721
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
722
|
+
|
|
723
|
+
# form parameters
|
|
724
|
+
form_params = {}
|
|
725
|
+
|
|
726
|
+
# http body (model)
|
|
727
|
+
post_body = nil
|
|
728
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
729
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
730
|
+
:header_params => header_params,
|
|
731
|
+
:query_params => query_params,
|
|
732
|
+
:form_params => form_params,
|
|
733
|
+
:body => post_body,
|
|
734
|
+
:auth_names => auth_names,
|
|
735
|
+
:return_type => 'UserInvitationList')
|
|
736
|
+
if @api_client.config.debugging
|
|
737
|
+
@api_client.config.logger.debug "API called: InvitationsApi#get_public_user_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
738
|
+
end
|
|
739
|
+
return data, status_code, headers
|
|
740
|
+
end
|
|
741
|
+
|
|
742
|
+
# Set the tags for this invitation
|
|
743
|
+
# Set the tags for this invitation
|
|
744
|
+
# @param invitation_id invitation id
|
|
745
|
+
# @param tags
|
|
746
|
+
# @param [Hash] opts the optional parameters
|
|
747
|
+
# @return [nil]
|
|
748
|
+
def put_invitation_tags(invitation_id, tags, opts = {})
|
|
749
|
+
put_invitation_tags_with_http_info(invitation_id, tags, opts)
|
|
750
|
+
return nil
|
|
751
|
+
end
|
|
752
|
+
|
|
753
|
+
# Set the tags for this invitation
|
|
754
|
+
# Set the tags for this invitation
|
|
755
|
+
# @param invitation_id invitation id
|
|
756
|
+
# @param tags
|
|
757
|
+
# @param [Hash] opts the optional parameters
|
|
758
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
759
|
+
def put_invitation_tags_with_http_info(invitation_id, tags, opts = {})
|
|
760
|
+
if @api_client.config.debugging
|
|
761
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.put_invitation_tags ..."
|
|
762
|
+
end
|
|
763
|
+
# verify the required parameter 'invitation_id' is set
|
|
764
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.put_invitation_tags" if invitation_id.nil?
|
|
765
|
+
# verify the required parameter 'tags' is set
|
|
766
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling InvitationsApi.put_invitation_tags" if tags.nil?
|
|
767
|
+
# resource path
|
|
768
|
+
local_var_path = "/invitations/{invitationId}/tags".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
769
|
+
|
|
770
|
+
# query parameters
|
|
771
|
+
query_params = {}
|
|
772
|
+
|
|
773
|
+
# header parameters
|
|
774
|
+
header_params = {}
|
|
775
|
+
# HTTP header 'Accept' (if needed)
|
|
776
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
777
|
+
# HTTP header 'Content-Type'
|
|
778
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
779
|
+
|
|
780
|
+
# form parameters
|
|
781
|
+
form_params = {}
|
|
782
|
+
|
|
783
|
+
# http body (model)
|
|
784
|
+
post_body = @api_client.object_to_http_body(tags)
|
|
785
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
786
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
787
|
+
:header_params => header_params,
|
|
788
|
+
:query_params => query_params,
|
|
789
|
+
:form_params => form_params,
|
|
790
|
+
:body => post_body,
|
|
791
|
+
:auth_names => auth_names)
|
|
792
|
+
if @api_client.config.debugging
|
|
793
|
+
@api_client.config.logger.debug "API called: InvitationsApi#put_invitation_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
794
|
+
end
|
|
795
|
+
return data, status_code, headers
|
|
796
|
+
end
|
|
797
|
+
|
|
798
|
+
# Sets all of the provided tags on all of the provided invitations
|
|
799
|
+
# Sets all of the provided tags on all of the provided invitations
|
|
800
|
+
# @param batch Object representing an array of ids to apply an array of tags to.
|
|
801
|
+
# @param [Hash] opts the optional parameters
|
|
802
|
+
# @return [nil]
|
|
803
|
+
def put_invitation_tags_batch(batch, opts = {})
|
|
804
|
+
put_invitation_tags_batch_with_http_info(batch, opts)
|
|
805
|
+
return nil
|
|
806
|
+
end
|
|
807
|
+
|
|
808
|
+
# Sets all of the provided tags on all of the provided invitations
|
|
809
|
+
# Sets all of the provided tags on all of the provided invitations
|
|
810
|
+
# @param batch Object representing an array of ids to apply an array of tags to.
|
|
811
|
+
# @param [Hash] opts the optional parameters
|
|
812
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
813
|
+
def put_invitation_tags_batch_with_http_info(batch, opts = {})
|
|
814
|
+
if @api_client.config.debugging
|
|
815
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.put_invitation_tags_batch ..."
|
|
816
|
+
end
|
|
817
|
+
# verify the required parameter 'batch' is set
|
|
818
|
+
fail ArgumentError, "Missing the required parameter 'batch' when calling InvitationsApi.put_invitation_tags_batch" if batch.nil?
|
|
819
|
+
# resource path
|
|
820
|
+
local_var_path = "/invitations/tags".sub('{format}','json')
|
|
821
|
+
|
|
822
|
+
# query parameters
|
|
823
|
+
query_params = {}
|
|
824
|
+
|
|
825
|
+
# header parameters
|
|
826
|
+
header_params = {}
|
|
827
|
+
# HTTP header 'Accept' (if needed)
|
|
828
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
829
|
+
# HTTP header 'Content-Type'
|
|
830
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
831
|
+
|
|
832
|
+
# form parameters
|
|
833
|
+
form_params = {}
|
|
834
|
+
|
|
835
|
+
# http body (model)
|
|
836
|
+
post_body = @api_client.object_to_http_body(batch)
|
|
837
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
838
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
839
|
+
:header_params => header_params,
|
|
840
|
+
:query_params => query_params,
|
|
841
|
+
:form_params => form_params,
|
|
842
|
+
:body => post_body,
|
|
843
|
+
:auth_names => auth_names)
|
|
844
|
+
if @api_client.config.debugging
|
|
845
|
+
@api_client.config.logger.debug "API called: InvitationsApi#put_invitation_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
846
|
+
end
|
|
847
|
+
return data, status_code, headers
|
|
848
|
+
end
|
|
849
|
+
|
|
850
|
+
# Update attributes of this invitation.
|
|
851
|
+
# Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - invitationEmail - postBack - expirationDate NOTE: Any attributes not in the above list will not be considered for update.
|
|
852
|
+
# @param invitation_id invitation id
|
|
853
|
+
# @param invitation_update_schema A PrivateInvitationSchema with values to update. This can be a sparse schema only containing the values to be updated. Any value not allowed for update will be ignored.
|
|
854
|
+
# @param [Hash] opts the optional parameters
|
|
855
|
+
# @return [PrivateInvitationSchema]
|
|
856
|
+
def update_private_invitation(invitation_id, invitation_update_schema, opts = {})
|
|
857
|
+
data, _status_code, _headers = update_private_invitation_with_http_info(invitation_id, invitation_update_schema, opts)
|
|
858
|
+
return data
|
|
859
|
+
end
|
|
860
|
+
|
|
861
|
+
# Update attributes of this invitation.
|
|
862
|
+
# Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - invitationEmail - postBack - expirationDate NOTE: Any attributes not in the above list will not be considered for update.
|
|
863
|
+
# @param invitation_id invitation id
|
|
864
|
+
# @param invitation_update_schema A PrivateInvitationSchema with values to update. This can be a sparse schema only containing the values to be updated. Any value not allowed for update will be ignored.
|
|
865
|
+
# @param [Hash] opts the optional parameters
|
|
866
|
+
# @return [Array<(PrivateInvitationSchema, Fixnum, Hash)>] PrivateInvitationSchema data, response status code and response headers
|
|
867
|
+
def update_private_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {})
|
|
868
|
+
if @api_client.config.debugging
|
|
869
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.update_private_invitation ..."
|
|
870
|
+
end
|
|
871
|
+
# verify the required parameter 'invitation_id' is set
|
|
872
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.update_private_invitation" if invitation_id.nil?
|
|
873
|
+
# verify the required parameter 'invitation_update_schema' is set
|
|
874
|
+
fail ArgumentError, "Missing the required parameter 'invitation_update_schema' when calling InvitationsApi.update_private_invitation" if invitation_update_schema.nil?
|
|
875
|
+
# resource path
|
|
876
|
+
local_var_path = "/invitations/private/{invitationId}".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
877
|
+
|
|
878
|
+
# query parameters
|
|
879
|
+
query_params = {}
|
|
880
|
+
|
|
881
|
+
# header parameters
|
|
882
|
+
header_params = {}
|
|
883
|
+
# HTTP header 'Accept' (if needed)
|
|
884
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
885
|
+
# HTTP header 'Content-Type'
|
|
886
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
887
|
+
|
|
888
|
+
# form parameters
|
|
889
|
+
form_params = {}
|
|
890
|
+
|
|
891
|
+
# http body (model)
|
|
892
|
+
post_body = @api_client.object_to_http_body(invitation_update_schema)
|
|
893
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
894
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
895
|
+
:header_params => header_params,
|
|
896
|
+
:query_params => query_params,
|
|
897
|
+
:form_params => form_params,
|
|
898
|
+
:body => post_body,
|
|
899
|
+
:auth_names => auth_names,
|
|
900
|
+
:return_type => 'PrivateInvitationSchema')
|
|
901
|
+
if @api_client.config.debugging
|
|
902
|
+
@api_client.config.logger.debug "API called: InvitationsApi#update_private_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
903
|
+
end
|
|
904
|
+
return data, status_code, headers
|
|
905
|
+
end
|
|
906
|
+
|
|
907
|
+
# Update attributes of this invitation.
|
|
908
|
+
# Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - allowNewRegistrations - postBack - expirationDate - registrationCap NOTE: Any attributes not in the above list will not be considered for update.
|
|
909
|
+
# @param invitation_id invitation id
|
|
910
|
+
# @param invitation_update_schema A PublicInvitationSchema with values to update. This can be a sparse schema only containing the values to be updated. Any value not allowed for update will be ignored.
|
|
911
|
+
# @param [Hash] opts the optional parameters
|
|
912
|
+
# @return [PublicInvitationSchema]
|
|
913
|
+
def update_public_invitation(invitation_id, invitation_update_schema, opts = {})
|
|
914
|
+
data, _status_code, _headers = update_public_invitation_with_http_info(invitation_id, invitation_update_schema, opts)
|
|
915
|
+
return data
|
|
916
|
+
end
|
|
917
|
+
|
|
918
|
+
# Update attributes of this invitation.
|
|
919
|
+
# Updates certain attributes of this invitation, and returns the invitation its new state. The following attributes can be updated: - allowLaunch - allowNewRegistrations - postBack - expirationDate - registrationCap NOTE: Any attributes not in the above list will not be considered for update.
|
|
920
|
+
# @param invitation_id invitation id
|
|
921
|
+
# @param invitation_update_schema A PublicInvitationSchema with values to update. This can be a sparse schema only containing the values to be updated. Any value not allowed for update will be ignored.
|
|
922
|
+
# @param [Hash] opts the optional parameters
|
|
923
|
+
# @return [Array<(PublicInvitationSchema, Fixnum, Hash)>] PublicInvitationSchema data, response status code and response headers
|
|
924
|
+
def update_public_invitation_with_http_info(invitation_id, invitation_update_schema, opts = {})
|
|
925
|
+
if @api_client.config.debugging
|
|
926
|
+
@api_client.config.logger.debug "Calling API: InvitationsApi.update_public_invitation ..."
|
|
927
|
+
end
|
|
928
|
+
# verify the required parameter 'invitation_id' is set
|
|
929
|
+
fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.update_public_invitation" if invitation_id.nil?
|
|
930
|
+
# verify the required parameter 'invitation_update_schema' is set
|
|
931
|
+
fail ArgumentError, "Missing the required parameter 'invitation_update_schema' when calling InvitationsApi.update_public_invitation" if invitation_update_schema.nil?
|
|
932
|
+
# resource path
|
|
933
|
+
local_var_path = "/invitations/public/{invitationId}".sub('{format}','json').sub('{' + 'invitationId' + '}', invitation_id.to_s)
|
|
934
|
+
|
|
935
|
+
# query parameters
|
|
936
|
+
query_params = {}
|
|
937
|
+
|
|
938
|
+
# header parameters
|
|
939
|
+
header_params = {}
|
|
940
|
+
# HTTP header 'Accept' (if needed)
|
|
941
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
942
|
+
# HTTP header 'Content-Type'
|
|
943
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
944
|
+
|
|
945
|
+
# form parameters
|
|
946
|
+
form_params = {}
|
|
947
|
+
|
|
948
|
+
# http body (model)
|
|
949
|
+
post_body = @api_client.object_to_http_body(invitation_update_schema)
|
|
950
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
|
951
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
952
|
+
:header_params => header_params,
|
|
953
|
+
:query_params => query_params,
|
|
954
|
+
:form_params => form_params,
|
|
955
|
+
:body => post_body,
|
|
956
|
+
:auth_names => auth_names,
|
|
957
|
+
:return_type => 'PublicInvitationSchema')
|
|
958
|
+
if @api_client.config.debugging
|
|
959
|
+
@api_client.config.logger.debug "API called: InvitationsApi#update_public_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
960
|
+
end
|
|
961
|
+
return data, status_code, headers
|
|
962
|
+
end
|
|
963
|
+
end
|
|
964
|
+
end
|