rustici_software_cloud_v2 1.0.0beta
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +7 -0
- data/LICENSE +201 -0
- data/README.md +283 -0
- data/Rakefile +8 -0
- data/docs/ActivityResultSchema.md +20 -0
- data/docs/ApplicationListSchema.md +8 -0
- data/docs/ApplicationManagementApi.md +570 -0
- data/docs/ApplicationSchema.md +9 -0
- data/docs/ApplicationToken.md +10 -0
- data/docs/AuthenticationApi.md +64 -0
- data/docs/CommentSchema.md +10 -0
- data/docs/CompletionAmountSchema.md +8 -0
- data/docs/CourseActivitySchema.md +15 -0
- data/docs/CourseApi.md +1459 -0
- data/docs/CourseListNonPagedSchema.md +8 -0
- data/docs/CourseListSchema.md +9 -0
- data/docs/CourseReferenceSchema.md +10 -0
- data/docs/CourseSchema.md +20 -0
- data/docs/CourseTagsBatchSchema.md +9 -0
- data/docs/CreateRegistrationSchema.md +17 -0
- data/docs/CredentialCreatedSchema.md +12 -0
- data/docs/CredentialListSchema.md +8 -0
- data/docs/CredentialRequestSchema.md +9 -0
- data/docs/CredentialSchema.md +12 -0
- data/docs/ImportFetchRequestSchema.md +8 -0
- data/docs/ImportJobResultSchema.md +11 -0
- data/docs/ImportResultSchema.md +11 -0
- data/docs/IntegerResultSchema.md +8 -0
- data/docs/ItemValuePairSchema.md +9 -0
- data/docs/LaunchHistoryListSchema.md +8 -0
- data/docs/LaunchHistorySchema.md +17 -0
- data/docs/LaunchLinkRequestSchema.md +17 -0
- data/docs/LaunchLinkSchema.md +8 -0
- data/docs/LearnerPreferenceSchema.md +11 -0
- data/docs/LearnerSchema.md +11 -0
- data/docs/LinkSchema.md +8 -0
- data/docs/MessageSchema.md +8 -0
- data/docs/MetadataSchema.md +14 -0
- data/docs/ObjectiveSchema.md +20 -0
- data/docs/PermissionsSchema.md +9 -0
- data/docs/PingApi.md +57 -0
- data/docs/PingSchema.md +8 -0
- data/docs/PostBackSchema.md +12 -0
- data/docs/RegistrationApi.md +1490 -0
- data/docs/RegistrationCompletion.md +7 -0
- data/docs/RegistrationListSchema.md +9 -0
- data/docs/RegistrationSchema.md +27 -0
- data/docs/RegistrationSuccess.md +7 -0
- data/docs/RegistrationTagsBatchSchema.md +9 -0
- data/docs/ResponseError.md +8 -0
- data/docs/RuntimeInteractionSchema.md +18 -0
- data/docs/RuntimeObjectiveSchema.md +16 -0
- data/docs/RuntimeSchema.md +27 -0
- data/docs/ScoreSchema.md +8 -0
- data/docs/SettingItem.md +12 -0
- data/docs/SettingListSchema.md +8 -0
- data/docs/SettingMetadata.md +15 -0
- data/docs/SettingMetadataValidValues.md +9 -0
- data/docs/SettingValidValue.md +9 -0
- data/docs/SettingsIndividualSchema.md +10 -0
- data/docs/SettingsPostSchema.md +8 -0
- data/docs/SharedDataEntrySchema.md +9 -0
- data/docs/StaticPropertiesSchema.md +13 -0
- data/docs/StringResultSchema.md +8 -0
- data/docs/TagListSchema.md +8 -0
- data/docs/TagPostSchema.md +7 -0
- data/docs/TitleSchema.md +8 -0
- data/docs/TokenRequestSchema.md +9 -0
- data/docs/XapiAccount.md +9 -0
- data/docs/XapiActivity.md +10 -0
- data/docs/XapiActivityDefinition.md +19 -0
- data/docs/XapiAgentGroup.md +14 -0
- data/docs/XapiAttachment.md +14 -0
- data/docs/XapiContext.md +16 -0
- data/docs/XapiContextActivity.md +11 -0
- data/docs/XapiInteractionComponent.md +9 -0
- data/docs/XapiResult.md +13 -0
- data/docs/XapiScore.md +11 -0
- data/docs/XapiStatement.md +20 -0
- data/docs/XapiStatementReference.md +9 -0
- data/docs/XapiStatementResult.md +9 -0
- data/docs/XapiVerb.md +9 -0
- data/git_push.sh +55 -0
- data/lib/rustici_software_cloud_v2.rb +116 -0
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +574 -0
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +87 -0
- data/lib/rustici_software_cloud_v2/api/course_api.rb +1469 -0
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +69 -0
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +1499 -0
- data/lib/rustici_software_cloud_v2/api_client.rb +389 -0
- data/lib/rustici_software_cloud_v2/api_error.rb +38 -0
- data/lib/rustici_software_cloud_v2/configuration.rb +237 -0
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +341 -0
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/application_token.rb +201 -0
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +201 -0
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +184 -0
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +289 -0
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +202 -0
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +328 -0
- data/lib/rustici_software_cloud_v2/models/course_tags_batch_schema.rb +204 -0
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +287 -0
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +223 -0
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +223 -0
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +190 -0
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +244 -0
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +215 -0
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +192 -0
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +317 -0
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +282 -0
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +210 -0
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +216 -0
- data/lib/rustici_software_cloud_v2/models/link_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +239 -0
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +355 -0
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +195 -0
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +273 -0
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +31 -0
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +360 -0
- data/lib/rustici_software_cloud_v2/models/registration_success.rb +31 -0
- data/lib/rustici_software_cloud_v2/models/registration_tags_batch_schema.rb +204 -0
- data/lib/rustici_software_cloud_v2/models/response_error.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +311 -0
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +305 -0
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +398 -0
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +184 -0
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +256 -0
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +190 -0
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +294 -0
- data/lib/rustici_software_cloud_v2/models/setting_metadata_valid_values.rb +209 -0
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +193 -0
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +203 -0
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +192 -0
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +228 -0
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/tag_post_schema.rb +174 -0
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +183 -0
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +203 -0
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +203 -0
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +209 -0
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +301 -0
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +279 -0
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +267 -0
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +258 -0
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +219 -0
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +200 -0
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +231 -0
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +211 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +294 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +205 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +200 -0
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +200 -0
- data/lib/rustici_software_cloud_v2/version.rb +15 -0
- data/rustici_software_cloud_v2.gemspec +45 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/activity_result_schema_spec.rb +133 -0
- data/spec/models/application_list_schema_spec.rb +53 -0
- data/spec/models/application_schema_spec.rb +59 -0
- data/spec/models/application_token_spec.rb +65 -0
- data/spec/models/comment_schema_spec.rb +65 -0
- data/spec/models/completion_amount_schema_spec.rb +53 -0
- data/spec/models/course_activity_schema_spec.rb +99 -0
- data/spec/models/course_list_non_paged_schema_spec.rb +53 -0
- data/spec/models/course_list_schema_spec.rb +59 -0
- data/spec/models/course_reference_schema_spec.rb +65 -0
- data/spec/models/course_schema_spec.rb +129 -0
- data/spec/models/create_registration_schema_spec.rb +107 -0
- data/spec/models/credential_created_schema_spec.rb +77 -0
- data/spec/models/credential_list_schema_spec.rb +53 -0
- data/spec/models/credential_request_schema_spec.rb +59 -0
- data/spec/models/credential_schema_spec.rb +77 -0
- data/spec/models/import_fetch_request_schema_spec.rb +53 -0
- data/spec/models/import_job_result_schema_spec.rb +75 -0
- data/spec/models/import_result_schema_spec.rb +71 -0
- data/spec/models/integer_result_schema_spec.rb +53 -0
- data/spec/models/item_value_pair_schema_spec.rb +59 -0
- data/spec/models/launch_history_list_schema_spec.rb +53 -0
- data/spec/models/launch_history_schema_spec.rb +115 -0
- data/spec/models/launch_link_request_schema_spec.rb +107 -0
- data/spec/models/launch_link_schema_spec.rb +53 -0
- data/spec/models/learner_preference_schema_spec.rb +71 -0
- data/spec/models/learner_schema_spec.rb +71 -0
- data/spec/models/link_schema_spec.rb +53 -0
- data/spec/models/message_schema_spec.rb +53 -0
- data/spec/models/metadata_schema_spec.rb +89 -0
- data/spec/models/objective_schema_spec.rb +137 -0
- data/spec/models/permissions_schema_spec.rb +59 -0
- data/spec/models/ping_schema_spec.rb +53 -0
- data/spec/models/post_back_schema_spec.rb +85 -0
- data/spec/models/registration_completion_spec.rb +47 -0
- data/spec/models/registration_list_schema_spec.rb +59 -0
- data/spec/models/registration_schema_spec.rb +167 -0
- data/spec/models/registration_success_spec.rb +47 -0
- data/spec/models/response_error_spec.rb +53 -0
- data/spec/models/runtime_interaction_schema_spec.rb +117 -0
- data/spec/models/runtime_objective_schema_spec.rb +109 -0
- data/spec/models/runtime_schema_spec.rb +171 -0
- data/spec/models/score_schema_spec.rb +53 -0
- data/spec/models/setting_item_spec.rb +81 -0
- data/spec/models/setting_list_schema_spec.rb +53 -0
- data/spec/models/setting_metadata_spec.rb +99 -0
- data/spec/models/setting_metadata_valid_values_spec.rb +59 -0
- data/spec/models/settings_individual_schema_spec.rb +65 -0
- data/spec/models/settings_post_schema_spec.rb +53 -0
- data/spec/models/shared_data_entry_schema_spec.rb +59 -0
- data/spec/models/static_properties_schema_spec.rb +83 -0
- data/spec/models/string_result_schema_spec.rb +53 -0
- data/spec/models/title_schema_spec.rb +53 -0
- data/spec/models/token_request_schema_spec.rb +59 -0
- data/spec/spec_helper.rb +122 -0
- data/swagger-codegen.config +11 -0
- metadata +526 -0
@@ -0,0 +1,69 @@
|
|
1
|
+
=begin
|
2
|
+
#SCORM Cloud Rest API
|
3
|
+
|
4
|
+
#REST API used for SCORM Cloud integrations.
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0 beta
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.3
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module RusticiSoftwareCloudV2
|
16
|
+
class PingApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get back a message indicating that the API is working.
|
23
|
+
# @param [Hash] opts the optional parameters
|
24
|
+
# @return [PingSchema]
|
25
|
+
def ping_app_id(opts = {})
|
26
|
+
data, _status_code, _headers = ping_app_id_with_http_info(opts)
|
27
|
+
data
|
28
|
+
end
|
29
|
+
|
30
|
+
# Get back a message indicating that the API is working.
|
31
|
+
# @param [Hash] opts the optional parameters
|
32
|
+
# @return [Array<(PingSchema, Fixnum, Hash)>] PingSchema data, response status code and response headers
|
33
|
+
def ping_app_id_with_http_info(opts = {})
|
34
|
+
if @api_client.config.debugging
|
35
|
+
@api_client.config.logger.debug 'Calling API: PingApi.ping_app_id ...'
|
36
|
+
end
|
37
|
+
# resource path
|
38
|
+
local_var_path = '/ping'
|
39
|
+
|
40
|
+
# query parameters
|
41
|
+
query_params = {}
|
42
|
+
|
43
|
+
# header parameters
|
44
|
+
header_params = {}
|
45
|
+
# HTTP header 'Accept' (if needed)
|
46
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
47
|
+
# HTTP header 'Content-Type'
|
48
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
49
|
+
|
50
|
+
# form parameters
|
51
|
+
form_params = {}
|
52
|
+
|
53
|
+
# http body (model)
|
54
|
+
post_body = nil
|
55
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
56
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
57
|
+
:header_params => header_params,
|
58
|
+
:query_params => query_params,
|
59
|
+
:form_params => form_params,
|
60
|
+
:body => post_body,
|
61
|
+
:auth_names => auth_names,
|
62
|
+
:return_type => 'PingSchema')
|
63
|
+
if @api_client.config.debugging
|
64
|
+
@api_client.config.logger.debug "API called: PingApi#ping_app_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
65
|
+
end
|
66
|
+
return data, status_code, headers
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
@@ -0,0 +1,1499 @@
|
|
1
|
+
=begin
|
2
|
+
#SCORM Cloud Rest API
|
3
|
+
|
4
|
+
#REST API used for SCORM Cloud integrations.
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0 beta
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.3
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module RusticiSoftwareCloudV2
|
16
|
+
class RegistrationApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Create a new instance for this registration specified by the registration ID
|
23
|
+
# @param registration_id id for this registration
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @return [nil]
|
26
|
+
def create_new_registration_instance(registration_id, opts = {})
|
27
|
+
create_new_registration_instance_with_http_info(registration_id, opts)
|
28
|
+
nil
|
29
|
+
end
|
30
|
+
|
31
|
+
# Create a new instance for this registration specified by the registration ID
|
32
|
+
# @param registration_id id for this registration
|
33
|
+
# @param [Hash] opts the optional parameters
|
34
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
35
|
+
def create_new_registration_instance_with_http_info(registration_id, opts = {})
|
36
|
+
if @api_client.config.debugging
|
37
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.create_new_registration_instance ...'
|
38
|
+
end
|
39
|
+
# verify the required parameter 'registration_id' is set
|
40
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
41
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.create_new_registration_instance"
|
42
|
+
end
|
43
|
+
# resource path
|
44
|
+
local_var_path = '/registrations/{registrationId}/instances'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
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 = nil
|
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
|
+
if @api_client.config.debugging
|
69
|
+
@api_client.config.logger.debug "API called: RegistrationApi#create_new_registration_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
70
|
+
end
|
71
|
+
return data, status_code, headers
|
72
|
+
end
|
73
|
+
# Create a registration.
|
74
|
+
# @param registration
|
75
|
+
# @param [Hash] opts the optional parameters
|
76
|
+
# @option opts [Integer] :course_version The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.
|
77
|
+
# @return [nil]
|
78
|
+
def create_registration(registration, opts = {})
|
79
|
+
create_registration_with_http_info(registration, opts)
|
80
|
+
nil
|
81
|
+
end
|
82
|
+
|
83
|
+
# Create a registration.
|
84
|
+
# @param registration
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @option opts [Integer] :course_version The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.
|
87
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
88
|
+
def create_registration_with_http_info(registration, opts = {})
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.create_registration ...'
|
91
|
+
end
|
92
|
+
# verify the required parameter 'registration' is set
|
93
|
+
if @api_client.config.client_side_validation && registration.nil?
|
94
|
+
fail ArgumentError, "Missing the required parameter 'registration' when calling RegistrationApi.create_registration"
|
95
|
+
end
|
96
|
+
# resource path
|
97
|
+
local_var_path = '/registrations'
|
98
|
+
|
99
|
+
# query parameters
|
100
|
+
query_params = {}
|
101
|
+
query_params[:'courseVersion'] = opts[:'course_version'] if !opts[:'course_version'].nil?
|
102
|
+
|
103
|
+
# header parameters
|
104
|
+
header_params = {}
|
105
|
+
# HTTP header 'Accept' (if needed)
|
106
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
107
|
+
# HTTP header 'Content-Type'
|
108
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
109
|
+
|
110
|
+
# form parameters
|
111
|
+
form_params = {}
|
112
|
+
|
113
|
+
# http body (model)
|
114
|
+
post_body = @api_client.object_to_http_body(registration)
|
115
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
116
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
117
|
+
:header_params => header_params,
|
118
|
+
:query_params => query_params,
|
119
|
+
:form_params => form_params,
|
120
|
+
:body => post_body,
|
121
|
+
:auth_names => auth_names)
|
122
|
+
if @api_client.config.debugging
|
123
|
+
@api_client.config.logger.debug "API called: RegistrationApi#create_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
124
|
+
end
|
125
|
+
return data, status_code, headers
|
126
|
+
end
|
127
|
+
# Delete `registrationId`
|
128
|
+
# @param registration_id id for this registration
|
129
|
+
# @param [Hash] opts the optional parameters
|
130
|
+
# @return [nil]
|
131
|
+
def delete_registration(registration_id, opts = {})
|
132
|
+
delete_registration_with_http_info(registration_id, opts)
|
133
|
+
nil
|
134
|
+
end
|
135
|
+
|
136
|
+
# Delete `registrationId`
|
137
|
+
# @param registration_id id for this registration
|
138
|
+
# @param [Hash] opts the optional parameters
|
139
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
140
|
+
def delete_registration_with_http_info(registration_id, opts = {})
|
141
|
+
if @api_client.config.debugging
|
142
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration ...'
|
143
|
+
end
|
144
|
+
# verify the required parameter 'registration_id' is set
|
145
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
146
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration"
|
147
|
+
end
|
148
|
+
# resource path
|
149
|
+
local_var_path = '/registrations/{registrationId}'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
150
|
+
|
151
|
+
# query parameters
|
152
|
+
query_params = {}
|
153
|
+
|
154
|
+
# header parameters
|
155
|
+
header_params = {}
|
156
|
+
# HTTP header 'Accept' (if needed)
|
157
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
158
|
+
# HTTP header 'Content-Type'
|
159
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
160
|
+
|
161
|
+
# form parameters
|
162
|
+
form_params = {}
|
163
|
+
|
164
|
+
# http body (model)
|
165
|
+
post_body = nil
|
166
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
167
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
168
|
+
:header_params => header_params,
|
169
|
+
:query_params => query_params,
|
170
|
+
:form_params => form_params,
|
171
|
+
:body => post_body,
|
172
|
+
:auth_names => auth_names)
|
173
|
+
if @api_client.config.debugging
|
174
|
+
@api_client.config.logger.debug "API called: RegistrationApi#delete_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
175
|
+
end
|
176
|
+
return data, status_code, headers
|
177
|
+
end
|
178
|
+
# Clears the `settingId` value for this registration
|
179
|
+
# @param registration_id id for this registration
|
180
|
+
# @param setting_id
|
181
|
+
# @param [Hash] opts the optional parameters
|
182
|
+
# @return [nil]
|
183
|
+
def delete_registration_configuration_setting(registration_id, setting_id, opts = {})
|
184
|
+
delete_registration_configuration_setting_with_http_info(registration_id, setting_id, opts)
|
185
|
+
nil
|
186
|
+
end
|
187
|
+
|
188
|
+
# Clears the `settingId` value for this registration
|
189
|
+
# @param registration_id id for this registration
|
190
|
+
# @param setting_id
|
191
|
+
# @param [Hash] opts the optional parameters
|
192
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
193
|
+
def delete_registration_configuration_setting_with_http_info(registration_id, setting_id, opts = {})
|
194
|
+
if @api_client.config.debugging
|
195
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_configuration_setting ...'
|
196
|
+
end
|
197
|
+
# verify the required parameter 'registration_id' is set
|
198
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
199
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_configuration_setting"
|
200
|
+
end
|
201
|
+
# verify the required parameter 'setting_id' is set
|
202
|
+
if @api_client.config.client_side_validation && setting_id.nil?
|
203
|
+
fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_configuration_setting"
|
204
|
+
end
|
205
|
+
# resource path
|
206
|
+
local_var_path = '/registrations/{registrationId}/configuration/{settingId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
|
207
|
+
|
208
|
+
# query parameters
|
209
|
+
query_params = {}
|
210
|
+
|
211
|
+
# header parameters
|
212
|
+
header_params = {}
|
213
|
+
# HTTP header 'Accept' (if needed)
|
214
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
215
|
+
# HTTP header 'Content-Type'
|
216
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
217
|
+
|
218
|
+
# form parameters
|
219
|
+
form_params = {}
|
220
|
+
|
221
|
+
# http body (model)
|
222
|
+
post_body = nil
|
223
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
224
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
225
|
+
:header_params => header_params,
|
226
|
+
:query_params => query_params,
|
227
|
+
:form_params => form_params,
|
228
|
+
:body => post_body,
|
229
|
+
:auth_names => auth_names)
|
230
|
+
if @api_client.config.debugging
|
231
|
+
@api_client.config.logger.debug "API called: RegistrationApi#delete_registration_configuration_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
232
|
+
end
|
233
|
+
return data, status_code, headers
|
234
|
+
end
|
235
|
+
# Clears the `settingId` value for this registration instance
|
236
|
+
# @param registration_id id for this registration
|
237
|
+
# @param instance_id The instance of this registration
|
238
|
+
# @param setting_id
|
239
|
+
# @param [Hash] opts the optional parameters
|
240
|
+
# @return [nil]
|
241
|
+
def delete_registration_instance_configuration_setting(registration_id, instance_id, setting_id, opts = {})
|
242
|
+
delete_registration_instance_configuration_setting_with_http_info(registration_id, instance_id, setting_id, opts)
|
243
|
+
nil
|
244
|
+
end
|
245
|
+
|
246
|
+
# Clears the `settingId` value for this registration instance
|
247
|
+
# @param registration_id id for this registration
|
248
|
+
# @param instance_id The instance of this registration
|
249
|
+
# @param setting_id
|
250
|
+
# @param [Hash] opts the optional parameters
|
251
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
252
|
+
def delete_registration_instance_configuration_setting_with_http_info(registration_id, instance_id, setting_id, opts = {})
|
253
|
+
if @api_client.config.debugging
|
254
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance_configuration_setting ...'
|
255
|
+
end
|
256
|
+
# verify the required parameter 'registration_id' is set
|
257
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
258
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
|
259
|
+
end
|
260
|
+
# verify the required parameter 'instance_id' is set
|
261
|
+
if @api_client.config.client_side_validation && instance_id.nil?
|
262
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
|
263
|
+
end
|
264
|
+
if @api_client.config.client_side_validation && instance_id < 0
|
265
|
+
fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.delete_registration_instance_configuration_setting, must be greater than or equal to 0.'
|
266
|
+
end
|
267
|
+
|
268
|
+
# verify the required parameter 'setting_id' is set
|
269
|
+
if @api_client.config.client_side_validation && setting_id.nil?
|
270
|
+
fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
|
271
|
+
end
|
272
|
+
# resource path
|
273
|
+
local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration/{settingId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
|
274
|
+
|
275
|
+
# query parameters
|
276
|
+
query_params = {}
|
277
|
+
|
278
|
+
# header parameters
|
279
|
+
header_params = {}
|
280
|
+
# HTTP header 'Accept' (if needed)
|
281
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
282
|
+
# HTTP header 'Content-Type'
|
283
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
284
|
+
|
285
|
+
# form parameters
|
286
|
+
form_params = {}
|
287
|
+
|
288
|
+
# http body (model)
|
289
|
+
post_body = nil
|
290
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
291
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
292
|
+
:header_params => header_params,
|
293
|
+
:query_params => query_params,
|
294
|
+
:form_params => form_params,
|
295
|
+
:body => post_body,
|
296
|
+
:auth_names => auth_names)
|
297
|
+
if @api_client.config.debugging
|
298
|
+
@api_client.config.logger.debug "API called: RegistrationApi#delete_registration_instance_configuration_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
299
|
+
end
|
300
|
+
return data, status_code, headers
|
301
|
+
end
|
302
|
+
# Delete registration progress (clear registration)
|
303
|
+
# @param registration_id id for this registration
|
304
|
+
# @param [Hash] opts the optional parameters
|
305
|
+
# @return [nil]
|
306
|
+
def delete_registration_progress(registration_id, opts = {})
|
307
|
+
delete_registration_progress_with_http_info(registration_id, opts)
|
308
|
+
nil
|
309
|
+
end
|
310
|
+
|
311
|
+
# Delete registration progress (clear registration)
|
312
|
+
# @param registration_id id for this registration
|
313
|
+
# @param [Hash] opts the optional parameters
|
314
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
315
|
+
def delete_registration_progress_with_http_info(registration_id, opts = {})
|
316
|
+
if @api_client.config.debugging
|
317
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_progress ...'
|
318
|
+
end
|
319
|
+
# verify the required parameter 'registration_id' is set
|
320
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
321
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_progress"
|
322
|
+
end
|
323
|
+
# resource path
|
324
|
+
local_var_path = '/registrations/{registrationId}/progress'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
325
|
+
|
326
|
+
# query parameters
|
327
|
+
query_params = {}
|
328
|
+
|
329
|
+
# header parameters
|
330
|
+
header_params = {}
|
331
|
+
# HTTP header 'Accept' (if needed)
|
332
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
333
|
+
# HTTP header 'Content-Type'
|
334
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
335
|
+
|
336
|
+
# form parameters
|
337
|
+
form_params = {}
|
338
|
+
|
339
|
+
# http body (model)
|
340
|
+
post_body = nil
|
341
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
342
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
343
|
+
:header_params => header_params,
|
344
|
+
:query_params => query_params,
|
345
|
+
:form_params => form_params,
|
346
|
+
:body => post_body,
|
347
|
+
:auth_names => auth_names)
|
348
|
+
if @api_client.config.debugging
|
349
|
+
@api_client.config.logger.debug "API called: RegistrationApi#delete_registration_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
350
|
+
end
|
351
|
+
return data, status_code, headers
|
352
|
+
end
|
353
|
+
# Delete tags for this registration
|
354
|
+
# @param registration_id id for this registration
|
355
|
+
# @param tags
|
356
|
+
# @param [Hash] opts the optional parameters
|
357
|
+
# @return [nil]
|
358
|
+
def delete_registration_tags(registration_id, tags, opts = {})
|
359
|
+
delete_registration_tags_with_http_info(registration_id, tags, opts)
|
360
|
+
nil
|
361
|
+
end
|
362
|
+
|
363
|
+
# Delete tags for this registration
|
364
|
+
# @param registration_id id for this registration
|
365
|
+
# @param tags
|
366
|
+
# @param [Hash] opts the optional parameters
|
367
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
368
|
+
def delete_registration_tags_with_http_info(registration_id, tags, opts = {})
|
369
|
+
if @api_client.config.debugging
|
370
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_tags ...'
|
371
|
+
end
|
372
|
+
# verify the required parameter 'registration_id' is set
|
373
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
374
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_tags"
|
375
|
+
end
|
376
|
+
# verify the required parameter 'tags' is set
|
377
|
+
if @api_client.config.client_side_validation && tags.nil?
|
378
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.delete_registration_tags"
|
379
|
+
end
|
380
|
+
# resource path
|
381
|
+
local_var_path = '/registrations/{registrationId}/tags'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
382
|
+
|
383
|
+
# query parameters
|
384
|
+
query_params = {}
|
385
|
+
|
386
|
+
# header parameters
|
387
|
+
header_params = {}
|
388
|
+
# HTTP header 'Accept' (if needed)
|
389
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
390
|
+
# HTTP header 'Content-Type'
|
391
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
392
|
+
|
393
|
+
# form parameters
|
394
|
+
form_params = {}
|
395
|
+
|
396
|
+
# http body (model)
|
397
|
+
post_body = @api_client.object_to_http_body(tags)
|
398
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
399
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
400
|
+
:header_params => header_params,
|
401
|
+
:query_params => query_params,
|
402
|
+
:form_params => form_params,
|
403
|
+
:body => post_body,
|
404
|
+
:auth_names => auth_names)
|
405
|
+
if @api_client.config.debugging
|
406
|
+
@api_client.config.logger.debug "API called: RegistrationApi#delete_registration_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
407
|
+
end
|
408
|
+
return data, status_code, headers
|
409
|
+
end
|
410
|
+
# Delete global data associated with `registrationId`
|
411
|
+
# @param registration_id id for this registration
|
412
|
+
# @param [Hash] opts the optional parameters
|
413
|
+
# @return [nil]
|
414
|
+
def delete_registrations_global_data(registration_id, opts = {})
|
415
|
+
delete_registrations_global_data_with_http_info(registration_id, opts)
|
416
|
+
nil
|
417
|
+
end
|
418
|
+
|
419
|
+
# Delete global data associated with `registrationId`
|
420
|
+
# @param registration_id id for this registration
|
421
|
+
# @param [Hash] opts the optional parameters
|
422
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
423
|
+
def delete_registrations_global_data_with_http_info(registration_id, opts = {})
|
424
|
+
if @api_client.config.debugging
|
425
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registrations_global_data ...'
|
426
|
+
end
|
427
|
+
# verify the required parameter 'registration_id' is set
|
428
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
429
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registrations_global_data"
|
430
|
+
end
|
431
|
+
# resource path
|
432
|
+
local_var_path = '/registrations/{registrationId}/globalData'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
433
|
+
|
434
|
+
# query parameters
|
435
|
+
query_params = {}
|
436
|
+
|
437
|
+
# header parameters
|
438
|
+
header_params = {}
|
439
|
+
# HTTP header 'Accept' (if needed)
|
440
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
441
|
+
# HTTP header 'Content-Type'
|
442
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
443
|
+
|
444
|
+
# form parameters
|
445
|
+
form_params = {}
|
446
|
+
|
447
|
+
# http body (model)
|
448
|
+
post_body = nil
|
449
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
450
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
451
|
+
:header_params => header_params,
|
452
|
+
:query_params => query_params,
|
453
|
+
:form_params => form_params,
|
454
|
+
:body => post_body,
|
455
|
+
:auth_names => auth_names)
|
456
|
+
if @api_client.config.debugging
|
457
|
+
@api_client.config.logger.debug "API called: RegistrationApi#delete_registrations_global_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
458
|
+
end
|
459
|
+
return data, status_code, headers
|
460
|
+
end
|
461
|
+
# Returns all configuration settings for this registration
|
462
|
+
# @param registration_id id for this registration
|
463
|
+
# @param [Hash] opts the optional parameters
|
464
|
+
# @option opts [BOOLEAN] :include_metadata (default to false)
|
465
|
+
# @return [SettingListSchema]
|
466
|
+
def get_registration_configuration(registration_id, opts = {})
|
467
|
+
data, _status_code, _headers = get_registration_configuration_with_http_info(registration_id, opts)
|
468
|
+
data
|
469
|
+
end
|
470
|
+
|
471
|
+
# Returns all configuration settings for this registration
|
472
|
+
# @param registration_id id for this registration
|
473
|
+
# @param [Hash] opts the optional parameters
|
474
|
+
# @option opts [BOOLEAN] :include_metadata
|
475
|
+
# @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
|
476
|
+
def get_registration_configuration_with_http_info(registration_id, opts = {})
|
477
|
+
if @api_client.config.debugging
|
478
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_configuration ...'
|
479
|
+
end
|
480
|
+
# verify the required parameter 'registration_id' is set
|
481
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
482
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_configuration"
|
483
|
+
end
|
484
|
+
# resource path
|
485
|
+
local_var_path = '/registrations/{registrationId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
486
|
+
|
487
|
+
# query parameters
|
488
|
+
query_params = {}
|
489
|
+
query_params[:'includeMetadata'] = opts[:'include_metadata'] if !opts[:'include_metadata'].nil?
|
490
|
+
|
491
|
+
# header parameters
|
492
|
+
header_params = {}
|
493
|
+
# HTTP header 'Accept' (if needed)
|
494
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
495
|
+
# HTTP header 'Content-Type'
|
496
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
497
|
+
|
498
|
+
# form parameters
|
499
|
+
form_params = {}
|
500
|
+
|
501
|
+
# http body (model)
|
502
|
+
post_body = nil
|
503
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
504
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
505
|
+
:header_params => header_params,
|
506
|
+
:query_params => query_params,
|
507
|
+
:form_params => form_params,
|
508
|
+
:body => post_body,
|
509
|
+
:auth_names => auth_names,
|
510
|
+
:return_type => 'SettingListSchema')
|
511
|
+
if @api_client.config.debugging
|
512
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
513
|
+
end
|
514
|
+
return data, status_code, headers
|
515
|
+
end
|
516
|
+
# Returns all configuration settings for this registration instance
|
517
|
+
# @param registration_id id for this registration
|
518
|
+
# @param instance_id The instance of this registration
|
519
|
+
# @param [Hash] opts the optional parameters
|
520
|
+
# @option opts [BOOLEAN] :include_metadata (default to false)
|
521
|
+
# @return [SettingListSchema]
|
522
|
+
def get_registration_instance_configuration(registration_id, instance_id, opts = {})
|
523
|
+
data, _status_code, _headers = get_registration_instance_configuration_with_http_info(registration_id, instance_id, opts)
|
524
|
+
data
|
525
|
+
end
|
526
|
+
|
527
|
+
# Returns all configuration settings for this registration instance
|
528
|
+
# @param registration_id id for this registration
|
529
|
+
# @param instance_id The instance of this registration
|
530
|
+
# @param [Hash] opts the optional parameters
|
531
|
+
# @option opts [BOOLEAN] :include_metadata
|
532
|
+
# @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
|
533
|
+
def get_registration_instance_configuration_with_http_info(registration_id, instance_id, opts = {})
|
534
|
+
if @api_client.config.debugging
|
535
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_configuration ...'
|
536
|
+
end
|
537
|
+
# verify the required parameter 'registration_id' is set
|
538
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
539
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_configuration"
|
540
|
+
end
|
541
|
+
# verify the required parameter 'instance_id' is set
|
542
|
+
if @api_client.config.client_side_validation && instance_id.nil?
|
543
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_configuration"
|
544
|
+
end
|
545
|
+
if @api_client.config.client_side_validation && instance_id < 0
|
546
|
+
fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_configuration, must be greater than or equal to 0.'
|
547
|
+
end
|
548
|
+
|
549
|
+
# resource path
|
550
|
+
local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
551
|
+
|
552
|
+
# query parameters
|
553
|
+
query_params = {}
|
554
|
+
query_params[:'includeMetadata'] = opts[:'include_metadata'] if !opts[:'include_metadata'].nil?
|
555
|
+
|
556
|
+
# header parameters
|
557
|
+
header_params = {}
|
558
|
+
# HTTP header 'Accept' (if needed)
|
559
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
560
|
+
# HTTP header 'Content-Type'
|
561
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
562
|
+
|
563
|
+
# form parameters
|
564
|
+
form_params = {}
|
565
|
+
|
566
|
+
# http body (model)
|
567
|
+
post_body = nil
|
568
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
569
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
570
|
+
:header_params => header_params,
|
571
|
+
:query_params => query_params,
|
572
|
+
:form_params => form_params,
|
573
|
+
:body => post_body,
|
574
|
+
:auth_names => auth_names,
|
575
|
+
:return_type => 'SettingListSchema')
|
576
|
+
if @api_client.config.debugging
|
577
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_instance_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
578
|
+
end
|
579
|
+
return data, status_code, headers
|
580
|
+
end
|
581
|
+
# Returns history of this registration's launches
|
582
|
+
# @param registration_id id for this registration
|
583
|
+
# @param instance_id The instance of this registration
|
584
|
+
# @param [Hash] opts the optional parameters
|
585
|
+
# @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history (default to false)
|
586
|
+
# @return [LaunchHistoryListSchema]
|
587
|
+
def get_registration_instance_launch_history(registration_id, instance_id, opts = {})
|
588
|
+
data, _status_code, _headers = get_registration_instance_launch_history_with_http_info(registration_id, instance_id, opts)
|
589
|
+
data
|
590
|
+
end
|
591
|
+
|
592
|
+
# Returns history of this registration's launches
|
593
|
+
# @param registration_id id for this registration
|
594
|
+
# @param instance_id The instance of this registration
|
595
|
+
# @param [Hash] opts the optional parameters
|
596
|
+
# @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
|
597
|
+
# @return [Array<(LaunchHistoryListSchema, Fixnum, Hash)>] LaunchHistoryListSchema data, response status code and response headers
|
598
|
+
def get_registration_instance_launch_history_with_http_info(registration_id, instance_id, opts = {})
|
599
|
+
if @api_client.config.debugging
|
600
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_launch_history ...'
|
601
|
+
end
|
602
|
+
# verify the required parameter 'registration_id' is set
|
603
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
604
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_launch_history"
|
605
|
+
end
|
606
|
+
# verify the required parameter 'instance_id' is set
|
607
|
+
if @api_client.config.client_side_validation && instance_id.nil?
|
608
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_launch_history"
|
609
|
+
end
|
610
|
+
if @api_client.config.client_side_validation && instance_id < 0
|
611
|
+
fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_launch_history, must be greater than or equal to 0.'
|
612
|
+
end
|
613
|
+
|
614
|
+
# resource path
|
615
|
+
local_var_path = '/registrations/{registrationId}/instances/{instanceId}/launchHistory'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
616
|
+
|
617
|
+
# query parameters
|
618
|
+
query_params = {}
|
619
|
+
query_params[:'includeHistoryLog'] = opts[:'include_history_log'] if !opts[:'include_history_log'].nil?
|
620
|
+
|
621
|
+
# header parameters
|
622
|
+
header_params = {}
|
623
|
+
# HTTP header 'Accept' (if needed)
|
624
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
625
|
+
# HTTP header 'Content-Type'
|
626
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
627
|
+
|
628
|
+
# form parameters
|
629
|
+
form_params = {}
|
630
|
+
|
631
|
+
# http body (model)
|
632
|
+
post_body = nil
|
633
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
634
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
635
|
+
:header_params => header_params,
|
636
|
+
:query_params => query_params,
|
637
|
+
:form_params => form_params,
|
638
|
+
:body => post_body,
|
639
|
+
:auth_names => auth_names,
|
640
|
+
:return_type => 'LaunchHistoryListSchema')
|
641
|
+
if @api_client.config.debugging
|
642
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_instance_launch_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
643
|
+
end
|
644
|
+
return data, status_code, headers
|
645
|
+
end
|
646
|
+
# Get registration progress for instance `instanceId` of `registrationId`
|
647
|
+
# @param registration_id id for this registration
|
648
|
+
# @param instance_id The instance of this registration
|
649
|
+
# @param [Hash] opts the optional parameters
|
650
|
+
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
|
651
|
+
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
|
652
|
+
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
|
653
|
+
# @return [RegistrationSchema]
|
654
|
+
def get_registration_instance_progress(registration_id, instance_id, opts = {})
|
655
|
+
data, _status_code, _headers = get_registration_instance_progress_with_http_info(registration_id, instance_id, opts)
|
656
|
+
data
|
657
|
+
end
|
658
|
+
|
659
|
+
# Get registration progress for instance `instanceId` of `registrationId`
|
660
|
+
# @param registration_id id for this registration
|
661
|
+
# @param instance_id The instance of this registration
|
662
|
+
# @param [Hash] opts the optional parameters
|
663
|
+
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
|
664
|
+
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
|
665
|
+
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results
|
666
|
+
# @return [Array<(RegistrationSchema, Fixnum, Hash)>] RegistrationSchema data, response status code and response headers
|
667
|
+
def get_registration_instance_progress_with_http_info(registration_id, instance_id, opts = {})
|
668
|
+
if @api_client.config.debugging
|
669
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_progress ...'
|
670
|
+
end
|
671
|
+
# verify the required parameter 'registration_id' is set
|
672
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
673
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_progress"
|
674
|
+
end
|
675
|
+
# verify the required parameter 'instance_id' is set
|
676
|
+
if @api_client.config.client_side_validation && instance_id.nil?
|
677
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_progress"
|
678
|
+
end
|
679
|
+
if @api_client.config.client_side_validation && instance_id < 0
|
680
|
+
fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_progress, must be greater than or equal to 0.'
|
681
|
+
end
|
682
|
+
|
683
|
+
# resource path
|
684
|
+
local_var_path = '/registrations/{registrationId}/instances/{instanceId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
685
|
+
|
686
|
+
# query parameters
|
687
|
+
query_params = {}
|
688
|
+
query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
|
689
|
+
query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
|
690
|
+
query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
|
691
|
+
|
692
|
+
# header parameters
|
693
|
+
header_params = {}
|
694
|
+
# HTTP header 'Accept' (if needed)
|
695
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
696
|
+
# HTTP header 'Content-Type'
|
697
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
698
|
+
|
699
|
+
# form parameters
|
700
|
+
form_params = {}
|
701
|
+
|
702
|
+
# http body (model)
|
703
|
+
post_body = nil
|
704
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
705
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
706
|
+
:header_params => header_params,
|
707
|
+
:query_params => query_params,
|
708
|
+
:form_params => form_params,
|
709
|
+
:body => post_body,
|
710
|
+
:auth_names => auth_names,
|
711
|
+
:return_type => 'RegistrationSchema')
|
712
|
+
if @api_client.config.debugging
|
713
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_instance_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
714
|
+
end
|
715
|
+
return data, status_code, headers
|
716
|
+
end
|
717
|
+
# Get xAPI statements for instance `instanceId` of `registrationId`
|
718
|
+
# @param registration_id id for this registration
|
719
|
+
# @param instance_id The instance of this registration
|
720
|
+
# @param [Hash] opts the optional parameters
|
721
|
+
# @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.
|
722
|
+
# @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.
|
723
|
+
# @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.
|
724
|
+
# @return [XapiStatementResult]
|
725
|
+
def get_registration_instance_statements(registration_id, instance_id, opts = {})
|
726
|
+
data, _status_code, _headers = get_registration_instance_statements_with_http_info(registration_id, instance_id, opts)
|
727
|
+
data
|
728
|
+
end
|
729
|
+
|
730
|
+
# Get xAPI statements for instance `instanceId` of `registrationId`
|
731
|
+
# @param registration_id id for this registration
|
732
|
+
# @param instance_id The instance of this registration
|
733
|
+
# @param [Hash] opts the optional parameters
|
734
|
+
# @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.
|
735
|
+
# @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.
|
736
|
+
# @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.
|
737
|
+
# @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
|
738
|
+
def get_registration_instance_statements_with_http_info(registration_id, instance_id, opts = {})
|
739
|
+
if @api_client.config.debugging
|
740
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_statements ...'
|
741
|
+
end
|
742
|
+
# verify the required parameter 'registration_id' is set
|
743
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
744
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_statements"
|
745
|
+
end
|
746
|
+
# verify the required parameter 'instance_id' is set
|
747
|
+
if @api_client.config.client_side_validation && instance_id.nil?
|
748
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_statements"
|
749
|
+
end
|
750
|
+
if @api_client.config.client_side_validation && instance_id < 0
|
751
|
+
fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_statements, must be greater than or equal to 0.'
|
752
|
+
end
|
753
|
+
|
754
|
+
# resource path
|
755
|
+
local_var_path = '/registrations/{registrationId}/instances/{instanceId}/xAPIStatements'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
756
|
+
|
757
|
+
# query parameters
|
758
|
+
query_params = {}
|
759
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
760
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
761
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
762
|
+
|
763
|
+
# header parameters
|
764
|
+
header_params = {}
|
765
|
+
# HTTP header 'Accept' (if needed)
|
766
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
767
|
+
# HTTP header 'Content-Type'
|
768
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
769
|
+
|
770
|
+
# form parameters
|
771
|
+
form_params = {}
|
772
|
+
|
773
|
+
# http body (model)
|
774
|
+
post_body = nil
|
775
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
776
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
777
|
+
:header_params => header_params,
|
778
|
+
:query_params => query_params,
|
779
|
+
:form_params => form_params,
|
780
|
+
:body => post_body,
|
781
|
+
:auth_names => auth_names,
|
782
|
+
:return_type => 'XapiStatementResult')
|
783
|
+
if @api_client.config.debugging
|
784
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_instance_statements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
785
|
+
end
|
786
|
+
return data, status_code, headers
|
787
|
+
end
|
788
|
+
# Get all the instances of this the registration specified by the registration ID
|
789
|
+
# @param registration_id id for this registration
|
790
|
+
# @param [Hash] opts the optional parameters
|
791
|
+
# @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.
|
792
|
+
# @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.
|
793
|
+
# @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.
|
794
|
+
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
|
795
|
+
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
|
796
|
+
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
|
797
|
+
# @return [RegistrationListSchema]
|
798
|
+
def get_registration_instances(registration_id, opts = {})
|
799
|
+
data, _status_code, _headers = get_registration_instances_with_http_info(registration_id, opts)
|
800
|
+
data
|
801
|
+
end
|
802
|
+
|
803
|
+
# Get all the instances of this the registration specified by the registration ID
|
804
|
+
# @param registration_id id for this registration
|
805
|
+
# @param [Hash] opts the optional parameters
|
806
|
+
# @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.
|
807
|
+
# @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.
|
808
|
+
# @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.
|
809
|
+
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
|
810
|
+
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
|
811
|
+
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results
|
812
|
+
# @return [Array<(RegistrationListSchema, Fixnum, Hash)>] RegistrationListSchema data, response status code and response headers
|
813
|
+
def get_registration_instances_with_http_info(registration_id, opts = {})
|
814
|
+
if @api_client.config.debugging
|
815
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instances ...'
|
816
|
+
end
|
817
|
+
# verify the required parameter 'registration_id' is set
|
818
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
819
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instances"
|
820
|
+
end
|
821
|
+
# resource path
|
822
|
+
local_var_path = '/registrations/{registrationId}/instances'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
823
|
+
|
824
|
+
# query parameters
|
825
|
+
query_params = {}
|
826
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
827
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
828
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
829
|
+
query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
|
830
|
+
query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
|
831
|
+
query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
|
832
|
+
|
833
|
+
# header parameters
|
834
|
+
header_params = {}
|
835
|
+
# HTTP header 'Accept' (if needed)
|
836
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
837
|
+
# HTTP header 'Content-Type'
|
838
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
839
|
+
|
840
|
+
# form parameters
|
841
|
+
form_params = {}
|
842
|
+
|
843
|
+
# http body (model)
|
844
|
+
post_body = nil
|
845
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
846
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
847
|
+
:header_params => header_params,
|
848
|
+
:query_params => query_params,
|
849
|
+
:form_params => form_params,
|
850
|
+
:body => post_body,
|
851
|
+
:auth_names => auth_names,
|
852
|
+
:return_type => 'RegistrationListSchema')
|
853
|
+
if @api_client.config.debugging
|
854
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
855
|
+
end
|
856
|
+
return data, status_code, headers
|
857
|
+
end
|
858
|
+
# Returns history of this registration's launches
|
859
|
+
# @param registration_id id for this registration
|
860
|
+
# @param [Hash] opts the optional parameters
|
861
|
+
# @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history (default to false)
|
862
|
+
# @return [LaunchHistoryListSchema]
|
863
|
+
def get_registration_launch_history(registration_id, opts = {})
|
864
|
+
data, _status_code, _headers = get_registration_launch_history_with_http_info(registration_id, opts)
|
865
|
+
data
|
866
|
+
end
|
867
|
+
|
868
|
+
# Returns history of this registration's launches
|
869
|
+
# @param registration_id id for this registration
|
870
|
+
# @param [Hash] opts the optional parameters
|
871
|
+
# @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
|
872
|
+
# @return [Array<(LaunchHistoryListSchema, Fixnum, Hash)>] LaunchHistoryListSchema data, response status code and response headers
|
873
|
+
def get_registration_launch_history_with_http_info(registration_id, opts = {})
|
874
|
+
if @api_client.config.debugging
|
875
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_launch_history ...'
|
876
|
+
end
|
877
|
+
# verify the required parameter 'registration_id' is set
|
878
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
879
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_history"
|
880
|
+
end
|
881
|
+
# resource path
|
882
|
+
local_var_path = '/registrations/{registrationId}/launchHistory'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
883
|
+
|
884
|
+
# query parameters
|
885
|
+
query_params = {}
|
886
|
+
query_params[:'includeHistoryLog'] = opts[:'include_history_log'] if !opts[:'include_history_log'].nil?
|
887
|
+
|
888
|
+
# header parameters
|
889
|
+
header_params = {}
|
890
|
+
# HTTP header 'Accept' (if needed)
|
891
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
892
|
+
# HTTP header 'Content-Type'
|
893
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
894
|
+
|
895
|
+
# form parameters
|
896
|
+
form_params = {}
|
897
|
+
|
898
|
+
# http body (model)
|
899
|
+
post_body = nil
|
900
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
901
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
902
|
+
:header_params => header_params,
|
903
|
+
:query_params => query_params,
|
904
|
+
:form_params => form_params,
|
905
|
+
:body => post_body,
|
906
|
+
:auth_names => auth_names,
|
907
|
+
:return_type => 'LaunchHistoryListSchema')
|
908
|
+
if @api_client.config.debugging
|
909
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_launch_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
910
|
+
end
|
911
|
+
return data, status_code, headers
|
912
|
+
end
|
913
|
+
# Returns the link to use to launch this registration
|
914
|
+
# @param registration_id id for this registration
|
915
|
+
# @param launch_link_request
|
916
|
+
# @param [Hash] opts the optional parameters
|
917
|
+
# @return [LaunchLinkSchema]
|
918
|
+
def get_registration_launch_link(registration_id, launch_link_request, opts = {})
|
919
|
+
data, _status_code, _headers = get_registration_launch_link_with_http_info(registration_id, launch_link_request, opts)
|
920
|
+
data
|
921
|
+
end
|
922
|
+
|
923
|
+
# Returns the link to use to launch this registration
|
924
|
+
# @param registration_id id for this registration
|
925
|
+
# @param launch_link_request
|
926
|
+
# @param [Hash] opts the optional parameters
|
927
|
+
# @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
|
928
|
+
def get_registration_launch_link_with_http_info(registration_id, launch_link_request, opts = {})
|
929
|
+
if @api_client.config.debugging
|
930
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_launch_link ...'
|
931
|
+
end
|
932
|
+
# verify the required parameter 'registration_id' is set
|
933
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
934
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_link"
|
935
|
+
end
|
936
|
+
# verify the required parameter 'launch_link_request' is set
|
937
|
+
if @api_client.config.client_side_validation && launch_link_request.nil?
|
938
|
+
fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling RegistrationApi.get_registration_launch_link"
|
939
|
+
end
|
940
|
+
# resource path
|
941
|
+
local_var_path = '/registrations/{registrationId}/launchLink'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
942
|
+
|
943
|
+
# query parameters
|
944
|
+
query_params = {}
|
945
|
+
|
946
|
+
# header parameters
|
947
|
+
header_params = {}
|
948
|
+
# HTTP header 'Accept' (if needed)
|
949
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
950
|
+
# HTTP header 'Content-Type'
|
951
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
952
|
+
|
953
|
+
# form parameters
|
954
|
+
form_params = {}
|
955
|
+
|
956
|
+
# http body (model)
|
957
|
+
post_body = @api_client.object_to_http_body(launch_link_request)
|
958
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
959
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
960
|
+
:header_params => header_params,
|
961
|
+
:query_params => query_params,
|
962
|
+
:form_params => form_params,
|
963
|
+
:body => post_body,
|
964
|
+
:auth_names => auth_names,
|
965
|
+
:return_type => 'LaunchLinkSchema')
|
966
|
+
if @api_client.config.debugging
|
967
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_launch_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
968
|
+
end
|
969
|
+
return data, status_code, headers
|
970
|
+
end
|
971
|
+
# Get registration progress for `registrationId`
|
972
|
+
# @param registration_id id for this registration
|
973
|
+
# @param [Hash] opts the optional parameters
|
974
|
+
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
|
975
|
+
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
|
976
|
+
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
|
977
|
+
# @return [RegistrationSchema]
|
978
|
+
def get_registration_progress(registration_id, opts = {})
|
979
|
+
data, _status_code, _headers = get_registration_progress_with_http_info(registration_id, opts)
|
980
|
+
data
|
981
|
+
end
|
982
|
+
|
983
|
+
# Get registration progress for `registrationId`
|
984
|
+
# @param registration_id id for this registration
|
985
|
+
# @param [Hash] opts the optional parameters
|
986
|
+
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
|
987
|
+
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
|
988
|
+
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results
|
989
|
+
# @return [Array<(RegistrationSchema, Fixnum, Hash)>] RegistrationSchema data, response status code and response headers
|
990
|
+
def get_registration_progress_with_http_info(registration_id, opts = {})
|
991
|
+
if @api_client.config.debugging
|
992
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_progress ...'
|
993
|
+
end
|
994
|
+
# verify the required parameter 'registration_id' is set
|
995
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
996
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_progress"
|
997
|
+
end
|
998
|
+
# resource path
|
999
|
+
local_var_path = '/registrations/{registrationId}'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
1000
|
+
|
1001
|
+
# query parameters
|
1002
|
+
query_params = {}
|
1003
|
+
query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
|
1004
|
+
query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
|
1005
|
+
query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
|
1006
|
+
|
1007
|
+
# header parameters
|
1008
|
+
header_params = {}
|
1009
|
+
# HTTP header 'Accept' (if needed)
|
1010
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1011
|
+
# HTTP header 'Content-Type'
|
1012
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1013
|
+
|
1014
|
+
# form parameters
|
1015
|
+
form_params = {}
|
1016
|
+
|
1017
|
+
# http body (model)
|
1018
|
+
post_body = nil
|
1019
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1020
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1021
|
+
:header_params => header_params,
|
1022
|
+
:query_params => query_params,
|
1023
|
+
:form_params => form_params,
|
1024
|
+
:body => post_body,
|
1025
|
+
:auth_names => auth_names,
|
1026
|
+
:return_type => 'RegistrationSchema')
|
1027
|
+
if @api_client.config.debugging
|
1028
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1029
|
+
end
|
1030
|
+
return data, status_code, headers
|
1031
|
+
end
|
1032
|
+
# Get xAPI statements for `registrationId`
|
1033
|
+
# @param registration_id id for this registration
|
1034
|
+
# @param [Hash] opts the optional parameters
|
1035
|
+
# @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.
|
1036
|
+
# @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.
|
1037
|
+
# @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.
|
1038
|
+
# @return [XapiStatementResult]
|
1039
|
+
def get_registration_statements(registration_id, opts = {})
|
1040
|
+
data, _status_code, _headers = get_registration_statements_with_http_info(registration_id, opts)
|
1041
|
+
data
|
1042
|
+
end
|
1043
|
+
|
1044
|
+
# Get xAPI statements for `registrationId`
|
1045
|
+
# @param registration_id id for this registration
|
1046
|
+
# @param [Hash] opts the optional parameters
|
1047
|
+
# @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.
|
1048
|
+
# @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.
|
1049
|
+
# @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.
|
1050
|
+
# @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
|
1051
|
+
def get_registration_statements_with_http_info(registration_id, opts = {})
|
1052
|
+
if @api_client.config.debugging
|
1053
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_statements ...'
|
1054
|
+
end
|
1055
|
+
# verify the required parameter 'registration_id' is set
|
1056
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
1057
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_statements"
|
1058
|
+
end
|
1059
|
+
# resource path
|
1060
|
+
local_var_path = '/registrations/{registrationId}/xAPIStatements'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
1061
|
+
|
1062
|
+
# query parameters
|
1063
|
+
query_params = {}
|
1064
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1065
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
1066
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
1067
|
+
|
1068
|
+
# header parameters
|
1069
|
+
header_params = {}
|
1070
|
+
# HTTP header 'Accept' (if needed)
|
1071
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1072
|
+
# HTTP header 'Content-Type'
|
1073
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1074
|
+
|
1075
|
+
# form parameters
|
1076
|
+
form_params = {}
|
1077
|
+
|
1078
|
+
# http body (model)
|
1079
|
+
post_body = nil
|
1080
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1081
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1082
|
+
:header_params => header_params,
|
1083
|
+
:query_params => query_params,
|
1084
|
+
:form_params => form_params,
|
1085
|
+
:body => post_body,
|
1086
|
+
:auth_names => auth_names,
|
1087
|
+
:return_type => 'XapiStatementResult')
|
1088
|
+
if @api_client.config.debugging
|
1089
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_statements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1090
|
+
end
|
1091
|
+
return data, status_code, headers
|
1092
|
+
end
|
1093
|
+
# Get the tags for this registration
|
1094
|
+
# @param registration_id id for this registration
|
1095
|
+
# @param [Hash] opts the optional parameters
|
1096
|
+
# @return [TagListSchema]
|
1097
|
+
def get_registration_tags(registration_id, opts = {})
|
1098
|
+
data, _status_code, _headers = get_registration_tags_with_http_info(registration_id, opts)
|
1099
|
+
data
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
# Get the tags for this registration
|
1103
|
+
# @param registration_id id for this registration
|
1104
|
+
# @param [Hash] opts the optional parameters
|
1105
|
+
# @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
|
1106
|
+
def get_registration_tags_with_http_info(registration_id, opts = {})
|
1107
|
+
if @api_client.config.debugging
|
1108
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_tags ...'
|
1109
|
+
end
|
1110
|
+
# verify the required parameter 'registration_id' is set
|
1111
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
1112
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_tags"
|
1113
|
+
end
|
1114
|
+
# resource path
|
1115
|
+
local_var_path = '/registrations/{registrationId}/tags'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
1116
|
+
|
1117
|
+
# query parameters
|
1118
|
+
query_params = {}
|
1119
|
+
|
1120
|
+
# header parameters
|
1121
|
+
header_params = {}
|
1122
|
+
# HTTP header 'Accept' (if needed)
|
1123
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1124
|
+
# HTTP header 'Content-Type'
|
1125
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1126
|
+
|
1127
|
+
# form parameters
|
1128
|
+
form_params = {}
|
1129
|
+
|
1130
|
+
# http body (model)
|
1131
|
+
post_body = nil
|
1132
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1133
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1134
|
+
:header_params => header_params,
|
1135
|
+
:query_params => query_params,
|
1136
|
+
:form_params => form_params,
|
1137
|
+
:body => post_body,
|
1138
|
+
:auth_names => auth_names,
|
1139
|
+
:return_type => 'TagListSchema')
|
1140
|
+
if @api_client.config.debugging
|
1141
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registration_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1142
|
+
end
|
1143
|
+
return data, status_code, headers
|
1144
|
+
end
|
1145
|
+
# Gets a list of registrations including a summary of the status of each registration.
|
1146
|
+
# @param [Hash] opts the optional parameters
|
1147
|
+
# @option opts [String] :course_id Only registrations for the specified course id will be included.
|
1148
|
+
# @option opts [String] :learner_id Only registrations for the specified learner id will be included.
|
1149
|
+
# @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.
|
1150
|
+
# @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.
|
1151
|
+
# @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.
|
1152
|
+
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
|
1153
|
+
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
|
1154
|
+
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
|
1155
|
+
# @return [RegistrationListSchema]
|
1156
|
+
def get_registrations(opts = {})
|
1157
|
+
data, _status_code, _headers = get_registrations_with_http_info(opts)
|
1158
|
+
data
|
1159
|
+
end
|
1160
|
+
|
1161
|
+
# Gets a list of registrations including a summary of the status of each registration.
|
1162
|
+
# @param [Hash] opts the optional parameters
|
1163
|
+
# @option opts [String] :course_id Only registrations for the specified course id will be included.
|
1164
|
+
# @option opts [String] :learner_id Only registrations for the specified learner id will be included.
|
1165
|
+
# @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.
|
1166
|
+
# @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.
|
1167
|
+
# @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.
|
1168
|
+
# @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
|
1169
|
+
# @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
|
1170
|
+
# @option opts [BOOLEAN] :include_runtime Include runtime details in the results
|
1171
|
+
# @return [Array<(RegistrationListSchema, Fixnum, Hash)>] RegistrationListSchema data, response status code and response headers
|
1172
|
+
def get_registrations_with_http_info(opts = {})
|
1173
|
+
if @api_client.config.debugging
|
1174
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.get_registrations ...'
|
1175
|
+
end
|
1176
|
+
# resource path
|
1177
|
+
local_var_path = '/registrations'
|
1178
|
+
|
1179
|
+
# query parameters
|
1180
|
+
query_params = {}
|
1181
|
+
query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
|
1182
|
+
query_params[:'learnerId'] = opts[:'learner_id'] if !opts[:'learner_id'].nil?
|
1183
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
1184
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
1185
|
+
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
1186
|
+
query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
|
1187
|
+
query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
|
1188
|
+
query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
|
1189
|
+
|
1190
|
+
# header parameters
|
1191
|
+
header_params = {}
|
1192
|
+
# HTTP header 'Accept' (if needed)
|
1193
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1194
|
+
# HTTP header 'Content-Type'
|
1195
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1196
|
+
|
1197
|
+
# form parameters
|
1198
|
+
form_params = {}
|
1199
|
+
|
1200
|
+
# http body (model)
|
1201
|
+
post_body = nil
|
1202
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1203
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1204
|
+
:header_params => header_params,
|
1205
|
+
:query_params => query_params,
|
1206
|
+
:form_params => form_params,
|
1207
|
+
:body => post_body,
|
1208
|
+
:auth_names => auth_names,
|
1209
|
+
:return_type => 'RegistrationListSchema')
|
1210
|
+
if @api_client.config.debugging
|
1211
|
+
@api_client.config.logger.debug "API called: RegistrationApi#get_registrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1212
|
+
end
|
1213
|
+
return data, status_code, headers
|
1214
|
+
end
|
1215
|
+
# Set the tags for this registration
|
1216
|
+
# @param registration_id id for this registration
|
1217
|
+
# @param tags
|
1218
|
+
# @param [Hash] opts the optional parameters
|
1219
|
+
# @return [nil]
|
1220
|
+
def put_registration_tags(registration_id, tags, opts = {})
|
1221
|
+
put_registration_tags_with_http_info(registration_id, tags, opts)
|
1222
|
+
nil
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# Set the tags for this registration
|
1226
|
+
# @param registration_id id for this registration
|
1227
|
+
# @param tags
|
1228
|
+
# @param [Hash] opts the optional parameters
|
1229
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1230
|
+
def put_registration_tags_with_http_info(registration_id, tags, opts = {})
|
1231
|
+
if @api_client.config.debugging
|
1232
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags ...'
|
1233
|
+
end
|
1234
|
+
# verify the required parameter 'registration_id' is set
|
1235
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
1236
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.put_registration_tags"
|
1237
|
+
end
|
1238
|
+
# verify the required parameter 'tags' is set
|
1239
|
+
if @api_client.config.client_side_validation && tags.nil?
|
1240
|
+
fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.put_registration_tags"
|
1241
|
+
end
|
1242
|
+
# resource path
|
1243
|
+
local_var_path = '/registrations/{registrationId}/tags'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
1244
|
+
|
1245
|
+
# query parameters
|
1246
|
+
query_params = {}
|
1247
|
+
|
1248
|
+
# header parameters
|
1249
|
+
header_params = {}
|
1250
|
+
# HTTP header 'Accept' (if needed)
|
1251
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1252
|
+
# HTTP header 'Content-Type'
|
1253
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1254
|
+
|
1255
|
+
# form parameters
|
1256
|
+
form_params = {}
|
1257
|
+
|
1258
|
+
# http body (model)
|
1259
|
+
post_body = @api_client.object_to_http_body(tags)
|
1260
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1261
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1262
|
+
:header_params => header_params,
|
1263
|
+
:query_params => query_params,
|
1264
|
+
:form_params => form_params,
|
1265
|
+
:body => post_body,
|
1266
|
+
:auth_names => auth_names)
|
1267
|
+
if @api_client.config.debugging
|
1268
|
+
@api_client.config.logger.debug "API called: RegistrationApi#put_registration_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1269
|
+
end
|
1270
|
+
return data, status_code, headers
|
1271
|
+
end
|
1272
|
+
# Sets all of the provided tags on all of the provided registrations
|
1273
|
+
# @param batch
|
1274
|
+
# @param [Hash] opts the optional parameters
|
1275
|
+
# @return [nil]
|
1276
|
+
def put_registration_tags_batch(batch, opts = {})
|
1277
|
+
put_registration_tags_batch_with_http_info(batch, opts)
|
1278
|
+
nil
|
1279
|
+
end
|
1280
|
+
|
1281
|
+
# Sets all of the provided tags on all of the provided registrations
|
1282
|
+
# @param batch
|
1283
|
+
# @param [Hash] opts the optional parameters
|
1284
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1285
|
+
def put_registration_tags_batch_with_http_info(batch, opts = {})
|
1286
|
+
if @api_client.config.debugging
|
1287
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags_batch ...'
|
1288
|
+
end
|
1289
|
+
# verify the required parameter 'batch' is set
|
1290
|
+
if @api_client.config.client_side_validation && batch.nil?
|
1291
|
+
fail ArgumentError, "Missing the required parameter 'batch' when calling RegistrationApi.put_registration_tags_batch"
|
1292
|
+
end
|
1293
|
+
# resource path
|
1294
|
+
local_var_path = '/registrations/tags'
|
1295
|
+
|
1296
|
+
# query parameters
|
1297
|
+
query_params = {}
|
1298
|
+
|
1299
|
+
# header parameters
|
1300
|
+
header_params = {}
|
1301
|
+
# HTTP header 'Accept' (if needed)
|
1302
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1303
|
+
# HTTP header 'Content-Type'
|
1304
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1305
|
+
|
1306
|
+
# form parameters
|
1307
|
+
form_params = {}
|
1308
|
+
|
1309
|
+
# http body (model)
|
1310
|
+
post_body = @api_client.object_to_http_body(batch)
|
1311
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1312
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1313
|
+
:header_params => header_params,
|
1314
|
+
:query_params => query_params,
|
1315
|
+
:form_params => form_params,
|
1316
|
+
:body => post_body,
|
1317
|
+
:auth_names => auth_names)
|
1318
|
+
if @api_client.config.debugging
|
1319
|
+
@api_client.config.logger.debug "API called: RegistrationApi#put_registration_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1320
|
+
end
|
1321
|
+
return data, status_code, headers
|
1322
|
+
end
|
1323
|
+
# Does this registration exist?
|
1324
|
+
# @param registration_id id for this registration
|
1325
|
+
# @param [Hash] opts the optional parameters
|
1326
|
+
# @return [nil]
|
1327
|
+
def registration_exists(registration_id, opts = {})
|
1328
|
+
registration_exists_with_http_info(registration_id, opts)
|
1329
|
+
nil
|
1330
|
+
end
|
1331
|
+
|
1332
|
+
# Does this registration exist?
|
1333
|
+
# @param registration_id id for this registration
|
1334
|
+
# @param [Hash] opts the optional parameters
|
1335
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1336
|
+
def registration_exists_with_http_info(registration_id, opts = {})
|
1337
|
+
if @api_client.config.debugging
|
1338
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.registration_exists ...'
|
1339
|
+
end
|
1340
|
+
# verify the required parameter 'registration_id' is set
|
1341
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
1342
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.registration_exists"
|
1343
|
+
end
|
1344
|
+
# resource path
|
1345
|
+
local_var_path = '/registrations/{registrationId}'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
1346
|
+
|
1347
|
+
# query parameters
|
1348
|
+
query_params = {}
|
1349
|
+
|
1350
|
+
# header parameters
|
1351
|
+
header_params = {}
|
1352
|
+
# HTTP header 'Accept' (if needed)
|
1353
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1354
|
+
# HTTP header 'Content-Type'
|
1355
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1356
|
+
|
1357
|
+
# form parameters
|
1358
|
+
form_params = {}
|
1359
|
+
|
1360
|
+
# http body (model)
|
1361
|
+
post_body = nil
|
1362
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1363
|
+
data, status_code, headers = @api_client.call_api(:HEAD, local_var_path,
|
1364
|
+
:header_params => header_params,
|
1365
|
+
:query_params => query_params,
|
1366
|
+
:form_params => form_params,
|
1367
|
+
:body => post_body,
|
1368
|
+
:auth_names => auth_names)
|
1369
|
+
if @api_client.config.debugging
|
1370
|
+
@api_client.config.logger.debug "API called: RegistrationApi#registration_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1371
|
+
end
|
1372
|
+
return data, status_code, headers
|
1373
|
+
end
|
1374
|
+
# Set configuration settings for this registration.
|
1375
|
+
# @param registration_id id for this registration
|
1376
|
+
# @param configuration_settings
|
1377
|
+
# @param [Hash] opts the optional parameters
|
1378
|
+
# @return [nil]
|
1379
|
+
def set_registration_configuration(registration_id, configuration_settings, opts = {})
|
1380
|
+
set_registration_configuration_with_http_info(registration_id, configuration_settings, opts)
|
1381
|
+
nil
|
1382
|
+
end
|
1383
|
+
|
1384
|
+
# Set configuration settings for this registration.
|
1385
|
+
# @param registration_id id for this registration
|
1386
|
+
# @param configuration_settings
|
1387
|
+
# @param [Hash] opts the optional parameters
|
1388
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1389
|
+
def set_registration_configuration_with_http_info(registration_id, configuration_settings, opts = {})
|
1390
|
+
if @api_client.config.debugging
|
1391
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_configuration ...'
|
1392
|
+
end
|
1393
|
+
# verify the required parameter 'registration_id' is set
|
1394
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
1395
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_configuration"
|
1396
|
+
end
|
1397
|
+
# verify the required parameter 'configuration_settings' is set
|
1398
|
+
if @api_client.config.client_side_validation && configuration_settings.nil?
|
1399
|
+
fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_configuration"
|
1400
|
+
end
|
1401
|
+
# resource path
|
1402
|
+
local_var_path = '/registrations/{registrationId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s)
|
1403
|
+
|
1404
|
+
# query parameters
|
1405
|
+
query_params = {}
|
1406
|
+
|
1407
|
+
# header parameters
|
1408
|
+
header_params = {}
|
1409
|
+
# HTTP header 'Accept' (if needed)
|
1410
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1411
|
+
# HTTP header 'Content-Type'
|
1412
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1413
|
+
|
1414
|
+
# form parameters
|
1415
|
+
form_params = {}
|
1416
|
+
|
1417
|
+
# http body (model)
|
1418
|
+
post_body = @api_client.object_to_http_body(configuration_settings)
|
1419
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1420
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1421
|
+
:header_params => header_params,
|
1422
|
+
:query_params => query_params,
|
1423
|
+
:form_params => form_params,
|
1424
|
+
:body => post_body,
|
1425
|
+
:auth_names => auth_names)
|
1426
|
+
if @api_client.config.debugging
|
1427
|
+
@api_client.config.logger.debug "API called: RegistrationApi#set_registration_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1428
|
+
end
|
1429
|
+
return data, status_code, headers
|
1430
|
+
end
|
1431
|
+
# Set configuration settings for this registration instance.
|
1432
|
+
# @param registration_id id for this registration
|
1433
|
+
# @param instance_id The instance of this registration
|
1434
|
+
# @param configuration_settings
|
1435
|
+
# @param [Hash] opts the optional parameters
|
1436
|
+
# @return [nil]
|
1437
|
+
def set_registration_instance_configuration(registration_id, instance_id, configuration_settings, opts = {})
|
1438
|
+
set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts)
|
1439
|
+
nil
|
1440
|
+
end
|
1441
|
+
|
1442
|
+
# Set configuration settings for this registration instance.
|
1443
|
+
# @param registration_id id for this registration
|
1444
|
+
# @param instance_id The instance of this registration
|
1445
|
+
# @param configuration_settings
|
1446
|
+
# @param [Hash] opts the optional parameters
|
1447
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1448
|
+
def set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts = {})
|
1449
|
+
if @api_client.config.debugging
|
1450
|
+
@api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_instance_configuration ...'
|
1451
|
+
end
|
1452
|
+
# verify the required parameter 'registration_id' is set
|
1453
|
+
if @api_client.config.client_side_validation && registration_id.nil?
|
1454
|
+
fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_instance_configuration"
|
1455
|
+
end
|
1456
|
+
# verify the required parameter 'instance_id' is set
|
1457
|
+
if @api_client.config.client_side_validation && instance_id.nil?
|
1458
|
+
fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.set_registration_instance_configuration"
|
1459
|
+
end
|
1460
|
+
if @api_client.config.client_side_validation && instance_id < 0
|
1461
|
+
fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.set_registration_instance_configuration, must be greater than or equal to 0.'
|
1462
|
+
end
|
1463
|
+
|
1464
|
+
# verify the required parameter 'configuration_settings' is set
|
1465
|
+
if @api_client.config.client_side_validation && configuration_settings.nil?
|
1466
|
+
fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_instance_configuration"
|
1467
|
+
end
|
1468
|
+
# resource path
|
1469
|
+
local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
|
1470
|
+
|
1471
|
+
# query parameters
|
1472
|
+
query_params = {}
|
1473
|
+
|
1474
|
+
# header parameters
|
1475
|
+
header_params = {}
|
1476
|
+
# HTTP header 'Accept' (if needed)
|
1477
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1478
|
+
# HTTP header 'Content-Type'
|
1479
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1480
|
+
|
1481
|
+
# form parameters
|
1482
|
+
form_params = {}
|
1483
|
+
|
1484
|
+
# http body (model)
|
1485
|
+
post_body = @api_client.object_to_http_body(configuration_settings)
|
1486
|
+
auth_names = ['APP_NORMAL', 'OAUTH']
|
1487
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1488
|
+
:header_params => header_params,
|
1489
|
+
:query_params => query_params,
|
1490
|
+
:form_params => form_params,
|
1491
|
+
:body => post_body,
|
1492
|
+
:auth_names => auth_names)
|
1493
|
+
if @api_client.config.debugging
|
1494
|
+
@api_client.config.logger.debug "API called: RegistrationApi#set_registration_instance_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1495
|
+
end
|
1496
|
+
return data, status_code, headers
|
1497
|
+
end
|
1498
|
+
end
|
1499
|
+
end
|