rustici_software_cloud_v2 1.0.0beta → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (268) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +194 -88
  3. data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
  4. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +161 -97
  5. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +13 -13
  6. data/lib/rustici_software_cloud_v2/api/course_api.rb +246 -260
  7. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +1994 -0
  8. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +964 -0
  9. data/lib/rustici_software_cloud_v2/api/learner_api.rb +296 -0
  10. data/lib/rustici_software_cloud_v2/api/ping_api.rb +10 -8
  11. data/lib/rustici_software_cloud_v2/api/registration_api.rb +379 -324
  12. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
  13. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +555 -0
  14. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +448 -0
  15. data/lib/rustici_software_cloud_v2/api_client.rb +2 -3
  16. data/lib/rustici_software_cloud_v2/api_error.rb +1 -2
  17. data/lib/rustici_software_cloud_v2/configuration.rb +9 -19
  18. data/lib/rustici_software_cloud_v2/models/about_schema.rb +196 -0
  19. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +17 -14
  20. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +12 -8
  21. data/lib/rustici_software_cloud_v2/models/application_schema.rb +12 -8
  22. data/lib/rustici_software_cloud_v2/models/application_token.rb +12 -8
  23. data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +29 -23
  24. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +12 -8
  25. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +12 -8
  26. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +14 -11
  27. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +12 -8
  28. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +12 -8
  29. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +11 -8
  30. data/lib/rustici_software_cloud_v2/models/course_schema.rb +14 -11
  31. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +225 -0
  32. data/lib/rustici_software_cloud_v2/models/{link_schema.rb → create_dispatch_list_schema.rb} +22 -21
  33. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +308 -0
  34. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +254 -0
  35. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +252 -0
  36. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +15 -11
  37. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +12 -8
  38. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +12 -8
  39. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +12 -8
  40. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +12 -8
  41. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +197 -0
  42. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +200 -0
  43. data/lib/rustici_software_cloud_v2/models/{setting_metadata_valid_values.rb → destination_schema.rb} +42 -31
  44. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +196 -0
  45. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +198 -0
  46. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +196 -0
  47. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +290 -0
  48. data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +24 -11
  49. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +12 -9
  50. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +14 -11
  51. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +12 -8
  52. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +13 -9
  53. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +215 -0
  54. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +253 -0
  55. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +199 -0
  56. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +227 -0
  57. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +12 -8
  58. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +12 -8
  59. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +19 -16
  60. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +17 -8
  61. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +13 -9
  62. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +12 -8
  63. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +13 -9
  64. data/lib/rustici_software_cloud_v2/models/message_schema.rb +13 -9
  65. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -8
  66. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +23 -20
  67. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +12 -8
  68. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +28 -20
  69. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +33 -20
  70. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +199 -0
  71. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +266 -0
  72. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +199 -0
  73. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +289 -0
  74. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +5 -14
  75. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +13 -9
  76. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +24 -9
  77. data/lib/rustici_software_cloud_v2/models/registration_success.rb +5 -14
  78. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +259 -0
  79. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +214 -0
  80. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +196 -0
  81. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +187 -0
  82. data/lib/rustici_software_cloud_v2/models/response_error.rb +13 -9
  83. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +14 -11
  84. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +19 -16
  85. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +15 -12
  86. data/lib/rustici_software_cloud_v2/models/score_schema.rb +12 -8
  87. data/lib/rustici_software_cloud_v2/models/setting_item.rb +14 -11
  88. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +13 -9
  89. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +15 -12
  90. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +12 -8
  91. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +12 -8
  92. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +12 -8
  93. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +12 -8
  94. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +12 -8
  95. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +13 -9
  96. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +12 -8
  97. data/lib/rustici_software_cloud_v2/models/title_schema.rb +12 -8
  98. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +14 -10
  99. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +258 -0
  100. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +199 -0
  101. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +236 -0
  102. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +214 -0
  103. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +13 -10
  104. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +13 -10
  105. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +14 -11
  106. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +14 -12
  107. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +18 -15
  108. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +12 -9
  109. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +11 -8
  110. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +220 -0
  111. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +220 -0
  112. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +252 -0
  113. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +266 -0
  114. data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → xapi_credentials_list_schema.rb} +30 -31
  115. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +205 -0
  116. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +13 -10
  117. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +12 -9
  118. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +11 -8
  119. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +11 -8
  120. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +194 -0
  121. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +196 -0
  122. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +241 -0
  123. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +14 -11
  124. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +12 -9
  125. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +13 -10
  126. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +187 -0
  127. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +196 -0
  128. data/lib/rustici_software_cloud_v2/version.rb +2 -3
  129. data/lib/rustici_software_cloud_v2.rb +50 -6
  130. data/rustici_software_cloud_v2.gemspec +10 -11
  131. data/spec/api_client_spec.rb +1 -13
  132. data/spec/configuration_spec.rb +9 -10
  133. data/spec/spec_helper.rb +1 -13
  134. metadata +107 -271
  135. data/docs/ActivityResultSchema.md +0 -20
  136. data/docs/ApplicationListSchema.md +0 -8
  137. data/docs/ApplicationManagementApi.md +0 -570
  138. data/docs/ApplicationSchema.md +0 -9
  139. data/docs/ApplicationToken.md +0 -10
  140. data/docs/AuthenticationApi.md +0 -64
  141. data/docs/CommentSchema.md +0 -10
  142. data/docs/CompletionAmountSchema.md +0 -8
  143. data/docs/CourseActivitySchema.md +0 -15
  144. data/docs/CourseApi.md +0 -1459
  145. data/docs/CourseListNonPagedSchema.md +0 -8
  146. data/docs/CourseListSchema.md +0 -9
  147. data/docs/CourseReferenceSchema.md +0 -10
  148. data/docs/CourseSchema.md +0 -20
  149. data/docs/CourseTagsBatchSchema.md +0 -9
  150. data/docs/CreateRegistrationSchema.md +0 -17
  151. data/docs/CredentialCreatedSchema.md +0 -12
  152. data/docs/CredentialListSchema.md +0 -8
  153. data/docs/CredentialRequestSchema.md +0 -9
  154. data/docs/CredentialSchema.md +0 -12
  155. data/docs/ImportFetchRequestSchema.md +0 -8
  156. data/docs/ImportJobResultSchema.md +0 -11
  157. data/docs/ImportResultSchema.md +0 -11
  158. data/docs/IntegerResultSchema.md +0 -8
  159. data/docs/ItemValuePairSchema.md +0 -9
  160. data/docs/LaunchHistoryListSchema.md +0 -8
  161. data/docs/LaunchHistorySchema.md +0 -17
  162. data/docs/LaunchLinkRequestSchema.md +0 -17
  163. data/docs/LaunchLinkSchema.md +0 -8
  164. data/docs/LearnerPreferenceSchema.md +0 -11
  165. data/docs/LearnerSchema.md +0 -11
  166. data/docs/LinkSchema.md +0 -8
  167. data/docs/MessageSchema.md +0 -8
  168. data/docs/MetadataSchema.md +0 -14
  169. data/docs/ObjectiveSchema.md +0 -20
  170. data/docs/PermissionsSchema.md +0 -9
  171. data/docs/PingApi.md +0 -57
  172. data/docs/PingSchema.md +0 -8
  173. data/docs/PostBackSchema.md +0 -12
  174. data/docs/RegistrationApi.md +0 -1490
  175. data/docs/RegistrationCompletion.md +0 -7
  176. data/docs/RegistrationListSchema.md +0 -9
  177. data/docs/RegistrationSchema.md +0 -27
  178. data/docs/RegistrationSuccess.md +0 -7
  179. data/docs/RegistrationTagsBatchSchema.md +0 -9
  180. data/docs/ResponseError.md +0 -8
  181. data/docs/RuntimeInteractionSchema.md +0 -18
  182. data/docs/RuntimeObjectiveSchema.md +0 -16
  183. data/docs/RuntimeSchema.md +0 -27
  184. data/docs/ScoreSchema.md +0 -8
  185. data/docs/SettingItem.md +0 -12
  186. data/docs/SettingListSchema.md +0 -8
  187. data/docs/SettingMetadata.md +0 -15
  188. data/docs/SettingMetadataValidValues.md +0 -9
  189. data/docs/SettingValidValue.md +0 -9
  190. data/docs/SettingsIndividualSchema.md +0 -10
  191. data/docs/SettingsPostSchema.md +0 -8
  192. data/docs/SharedDataEntrySchema.md +0 -9
  193. data/docs/StaticPropertiesSchema.md +0 -13
  194. data/docs/StringResultSchema.md +0 -8
  195. data/docs/TagListSchema.md +0 -8
  196. data/docs/TagPostSchema.md +0 -7
  197. data/docs/TitleSchema.md +0 -8
  198. data/docs/TokenRequestSchema.md +0 -9
  199. data/docs/XapiAccount.md +0 -9
  200. data/docs/XapiActivity.md +0 -10
  201. data/docs/XapiActivityDefinition.md +0 -19
  202. data/docs/XapiAgentGroup.md +0 -14
  203. data/docs/XapiAttachment.md +0 -14
  204. data/docs/XapiContext.md +0 -16
  205. data/docs/XapiContextActivity.md +0 -11
  206. data/docs/XapiInteractionComponent.md +0 -9
  207. data/docs/XapiResult.md +0 -13
  208. data/docs/XapiScore.md +0 -11
  209. data/docs/XapiStatement.md +0 -20
  210. data/docs/XapiStatementReference.md +0 -9
  211. data/docs/XapiStatementResult.md +0 -9
  212. data/docs/XapiVerb.md +0 -9
  213. data/git_push.sh +0 -55
  214. data/spec/models/activity_result_schema_spec.rb +0 -133
  215. data/spec/models/application_list_schema_spec.rb +0 -53
  216. data/spec/models/application_schema_spec.rb +0 -59
  217. data/spec/models/application_token_spec.rb +0 -65
  218. data/spec/models/comment_schema_spec.rb +0 -65
  219. data/spec/models/completion_amount_schema_spec.rb +0 -53
  220. data/spec/models/course_activity_schema_spec.rb +0 -99
  221. data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
  222. data/spec/models/course_list_schema_spec.rb +0 -59
  223. data/spec/models/course_reference_schema_spec.rb +0 -65
  224. data/spec/models/course_schema_spec.rb +0 -129
  225. data/spec/models/create_registration_schema_spec.rb +0 -107
  226. data/spec/models/credential_created_schema_spec.rb +0 -77
  227. data/spec/models/credential_list_schema_spec.rb +0 -53
  228. data/spec/models/credential_request_schema_spec.rb +0 -59
  229. data/spec/models/credential_schema_spec.rb +0 -77
  230. data/spec/models/import_fetch_request_schema_spec.rb +0 -53
  231. data/spec/models/import_job_result_schema_spec.rb +0 -75
  232. data/spec/models/import_result_schema_spec.rb +0 -71
  233. data/spec/models/integer_result_schema_spec.rb +0 -53
  234. data/spec/models/item_value_pair_schema_spec.rb +0 -59
  235. data/spec/models/launch_history_list_schema_spec.rb +0 -53
  236. data/spec/models/launch_history_schema_spec.rb +0 -115
  237. data/spec/models/launch_link_request_schema_spec.rb +0 -107
  238. data/spec/models/launch_link_schema_spec.rb +0 -53
  239. data/spec/models/learner_preference_schema_spec.rb +0 -71
  240. data/spec/models/learner_schema_spec.rb +0 -71
  241. data/spec/models/link_schema_spec.rb +0 -53
  242. data/spec/models/message_schema_spec.rb +0 -53
  243. data/spec/models/metadata_schema_spec.rb +0 -89
  244. data/spec/models/objective_schema_spec.rb +0 -137
  245. data/spec/models/permissions_schema_spec.rb +0 -59
  246. data/spec/models/ping_schema_spec.rb +0 -53
  247. data/spec/models/post_back_schema_spec.rb +0 -85
  248. data/spec/models/registration_completion_spec.rb +0 -47
  249. data/spec/models/registration_list_schema_spec.rb +0 -59
  250. data/spec/models/registration_schema_spec.rb +0 -167
  251. data/spec/models/registration_success_spec.rb +0 -47
  252. data/spec/models/response_error_spec.rb +0 -53
  253. data/spec/models/runtime_interaction_schema_spec.rb +0 -117
  254. data/spec/models/runtime_objective_schema_spec.rb +0 -109
  255. data/spec/models/runtime_schema_spec.rb +0 -171
  256. data/spec/models/score_schema_spec.rb +0 -53
  257. data/spec/models/setting_item_spec.rb +0 -81
  258. data/spec/models/setting_list_schema_spec.rb +0 -53
  259. data/spec/models/setting_metadata_spec.rb +0 -99
  260. data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
  261. data/spec/models/settings_individual_schema_spec.rb +0 -65
  262. data/spec/models/settings_post_schema_spec.rb +0 -53
  263. data/spec/models/shared_data_entry_schema_spec.rb +0 -59
  264. data/spec/models/static_properties_schema_spec.rb +0 -83
  265. data/spec/models/string_result_schema_spec.rb +0 -53
  266. data/spec/models/title_schema_spec.rb +0 -53
  267. data/spec/models/token_request_schema_spec.rb +0 -59
  268. data/swagger-codegen.config +0 -11
@@ -3,14 +3,13 @@
3
3
 
4
4
  #REST API used for SCORM Cloud integrations.
5
5
 
6
- OpenAPI spec version: 2.0 beta
6
+ OpenAPI spec version: 2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.3
10
9
 
11
10
  =end
12
11
 
13
- require 'uri'
12
+ require "uri"
14
13
 
15
14
  module RusticiSoftwareCloudV2
16
15
  class ApplicationManagementApi
@@ -19,29 +18,30 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
22
- # Create a new application
21
+
22
+ #
23
+ # A call to this method will create a new application and return a basic object describing it.
23
24
  # @param application_name
24
25
  # @param [Hash] opts the optional parameters
25
26
  # @return [ApplicationSchema]
26
27
  def create_application(application_name, opts = {})
27
28
  data, _status_code, _headers = create_application_with_http_info(application_name, opts)
28
- data
29
+ return data
29
30
  end
30
31
 
31
- # Create a new application
32
+ #
33
+ # A call to this method will create a new application and return a basic object describing it.
32
34
  # @param application_name
33
35
  # @param [Hash] opts the optional parameters
34
36
  # @return [Array<(ApplicationSchema, Fixnum, Hash)>] ApplicationSchema data, response status code and response headers
35
37
  def create_application_with_http_info(application_name, opts = {})
36
38
  if @api_client.config.debugging
37
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_application ...'
39
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.create_application ..."
38
40
  end
39
41
  # verify the required parameter 'application_name' is set
40
- if @api_client.config.client_side_validation && application_name.nil?
41
- fail ArgumentError, "Missing the required parameter 'application_name' when calling ApplicationManagementApi.create_application"
42
- end
42
+ fail ArgumentError, "Missing the required parameter 'application_name' when calling ApplicationManagementApi.create_application" if application_name.nil?
43
43
  # resource path
44
- local_var_path = '/appManagement/applications/{applicationName}'.sub('{' + 'applicationName' + '}', application_name.to_s)
44
+ local_var_path = "/appManagement/applications".sub('{format}','json')
45
45
 
46
46
  # query parameters
47
47
  query_params = {}
@@ -57,9 +57,9 @@ module RusticiSoftwareCloudV2
57
57
  form_params = {}
58
58
 
59
59
  # http body (model)
60
- post_body = nil
61
- auth_names = ['APP_NORMAL', 'OAUTH']
62
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
60
+ post_body = @api_client.object_to_http_body(application_name)
61
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
62
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
63
63
  :header_params => header_params,
64
64
  :query_params => query_params,
65
65
  :form_params => form_params,
@@ -71,35 +71,34 @@ module RusticiSoftwareCloudV2
71
71
  end
72
72
  return data, status_code, headers
73
73
  end
74
- # Create credential
74
+
75
+ #
76
+ # Create a new credential (aka secret key) for use with the `childAppId`.
75
77
  # @param child_app_id
76
78
  # @param credential_request
77
79
  # @param [Hash] opts the optional parameters
78
80
  # @return [CredentialCreatedSchema]
79
81
  def create_credential(child_app_id, credential_request, opts = {})
80
82
  data, _status_code, _headers = create_credential_with_http_info(child_app_id, credential_request, opts)
81
- data
83
+ return data
82
84
  end
83
85
 
84
- # Create credential
86
+ #
87
+ # Create a new credential (aka secret key) for use with the &#x60;childAppId&#x60;.
85
88
  # @param child_app_id
86
89
  # @param credential_request
87
90
  # @param [Hash] opts the optional parameters
88
91
  # @return [Array<(CredentialCreatedSchema, Fixnum, Hash)>] CredentialCreatedSchema data, response status code and response headers
89
92
  def create_credential_with_http_info(child_app_id, credential_request, opts = {})
90
93
  if @api_client.config.debugging
91
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_credential ...'
94
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.create_credential ..."
92
95
  end
93
96
  # verify the required parameter 'child_app_id' is set
94
- if @api_client.config.client_side_validation && child_app_id.nil?
95
- fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.create_credential"
96
- end
97
+ fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.create_credential" if child_app_id.nil?
97
98
  # verify the required parameter 'credential_request' is set
98
- if @api_client.config.client_side_validation && credential_request.nil?
99
- fail ArgumentError, "Missing the required parameter 'credential_request' when calling ApplicationManagementApi.create_credential"
100
- end
99
+ fail ArgumentError, "Missing the required parameter 'credential_request' when calling ApplicationManagementApi.create_credential" if credential_request.nil?
101
100
  # resource path
102
- local_var_path = '/appManagement/{childAppId}/credentials'.sub('{' + 'childAppId' + '}', child_app_id.to_s)
101
+ local_var_path = "/appManagement/{childAppId}/credentials".sub('{format}','json').sub('{' + 'childAppId' + '}', child_app_id.to_s)
103
102
 
104
103
  # query parameters
105
104
  query_params = {}
@@ -116,7 +115,7 @@ module RusticiSoftwareCloudV2
116
115
 
117
116
  # http body (model)
118
117
  post_body = @api_client.object_to_http_body(credential_request)
119
- auth_names = ['APP_NORMAL', 'OAUTH']
118
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
120
119
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
121
120
  :header_params => header_params,
122
121
  :query_params => query_params,
@@ -129,31 +128,30 @@ module RusticiSoftwareCloudV2
129
128
  end
130
129
  return data, status_code, headers
131
130
  end
132
- # Create token
133
- # Creates, signs and returns a token based on the provided permissions, if the credentials used to request the token have the permissions being requested. Note: the token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed. As long as the secret used to create it is not changed the token will be valid until it expires.
131
+
132
+ #
133
+ # Creates, signs and returns an OAuth2 token based on the provided permissions, if the credentials used to request the token have the permissions being requested. Note: the token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed. As long as the secret used to create it is not changed the token will be valid until it expires.
134
134
  # @param token_request
135
135
  # @param [Hash] opts the optional parameters
136
136
  # @return [StringResultSchema]
137
137
  def create_token(token_request, opts = {})
138
138
  data, _status_code, _headers = create_token_with_http_info(token_request, opts)
139
- data
139
+ return data
140
140
  end
141
141
 
142
- # Create token
143
- # Creates, signs and returns a token based on the provided permissions, if the credentials used to request the token have the permissions being requested. Note: the token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed. As long as the secret used to create it is not changed the token will be valid until it expires.
142
+ #
143
+ # Creates, signs and returns an OAuth2 token based on the provided permissions, if the credentials used to request the token have the permissions being requested. Note: the token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed. As long as the secret used to create it is not changed the token will be valid until it expires.
144
144
  # @param token_request
145
145
  # @param [Hash] opts the optional parameters
146
146
  # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
147
147
  def create_token_with_http_info(token_request, opts = {})
148
148
  if @api_client.config.debugging
149
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_token ...'
149
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.create_token ..."
150
150
  end
151
151
  # verify the required parameter 'token_request' is set
152
- if @api_client.config.client_side_validation && token_request.nil?
153
- fail ArgumentError, "Missing the required parameter 'token_request' when calling ApplicationManagementApi.create_token"
154
- end
152
+ fail ArgumentError, "Missing the required parameter 'token_request' when calling ApplicationManagementApi.create_token" if token_request.nil?
155
153
  # resource path
156
- local_var_path = '/appManagement/token'
154
+ local_var_path = "/appManagement/token".sub('{format}','json')
157
155
 
158
156
  # query parameters
159
157
  query_params = {}
@@ -183,32 +181,94 @@ module RusticiSoftwareCloudV2
183
181
  end
184
182
  return data, status_code, headers
185
183
  end
184
+
185
+ #
186
186
  # Delete an application. If the application contains content, it must first be manually removed before calling this method, else an error will be thrown.
187
187
  # @param child_app_id
188
188
  # @param [Hash] opts the optional parameters
189
189
  # @return [nil]
190
190
  def delete_application(child_app_id, opts = {})
191
191
  delete_application_with_http_info(child_app_id, opts)
192
- nil
192
+ return nil
193
193
  end
194
194
 
195
+ #
195
196
  # Delete an application. If the application contains content, it must first be manually removed before calling this method, else an error will be thrown.
196
197
  # @param child_app_id
197
198
  # @param [Hash] opts the optional parameters
198
199
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
199
200
  def delete_application_with_http_info(child_app_id, opts = {})
200
201
  if @api_client.config.debugging
201
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application ...'
202
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.delete_application ..."
202
203
  end
203
204
  # verify the required parameter 'child_app_id' is set
204
- if @api_client.config.client_side_validation && child_app_id.nil?
205
- fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_application"
205
+ fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_application" if child_app_id.nil?
206
+ # resource path
207
+ local_var_path = "/appManagement/applications/{childAppId}".sub('{format}','json').sub('{' + 'childAppId' + '}', child_app_id.to_s)
208
+
209
+ # query parameters
210
+ query_params = {}
211
+
212
+ # header parameters
213
+ header_params = {}
214
+ # HTTP header 'Accept' (if needed)
215
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
216
+ # HTTP header 'Content-Type'
217
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
218
+
219
+ # form parameters
220
+ form_params = {}
221
+
222
+ # http body (model)
223
+ post_body = nil
224
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
225
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
226
+ :header_params => header_params,
227
+ :query_params => query_params,
228
+ :form_params => form_params,
229
+ :body => post_body,
230
+ :auth_names => auth_names)
231
+ if @api_client.config.debugging
232
+ @api_client.config.logger.debug "API called: ApplicationManagementApi#delete_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
+ end
234
+ return data, status_code, headers
235
+ end
236
+
237
+ # Clears the `settingId` value for this level
238
+ # Clears the setting value at this level. This is effectively reverting the setting to the system level default.
239
+ # @param setting_id
240
+ # @param [Hash] opts the optional parameters
241
+ # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
242
+ # @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
243
+ # @return [nil]
244
+ def delete_application_configuration_setting(setting_id, opts = {})
245
+ delete_application_configuration_setting_with_http_info(setting_id, opts)
246
+ return nil
247
+ end
248
+
249
+ # Clears the &#x60;settingId&#x60; value for this level
250
+ # Clears the setting value at this level. This is effectively reverting the setting to the system level default.
251
+ # @param setting_id
252
+ # @param [Hash] opts the optional parameters
253
+ # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
254
+ # @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
255
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
256
+ def delete_application_configuration_setting_with_http_info(setting_id, opts = {})
257
+ if @api_client.config.debugging
258
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.delete_application_configuration_setting ..."
259
+ end
260
+ # verify the required parameter 'setting_id' is set
261
+ fail ArgumentError, "Missing the required parameter 'setting_id' when calling ApplicationManagementApi.delete_application_configuration_setting" if setting_id.nil?
262
+ if opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
263
+ fail ArgumentError, 'invalid value for "learning_standard", must be one of SCORM_11, SCORM_12, SCORM_2004_2ND_EDITION, SCORM_2004_3RD_EDITION, SCORM_2004_4TH_EDITION, AICC, XAPI, CMI5'
206
264
  end
207
265
  # resource path
208
- local_var_path = '/appManagement/applications/{childAppId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s)
266
+ local_var_path = "/appManagement/configuration/{settingId}".sub('{format}','json').sub('{' + 'settingId' + '}', setting_id.to_s)
209
267
 
210
268
  # query parameters
211
269
  query_params = {}
270
+ query_params[:'learningStandard'] = opts[:'learning_standard'] if !opts[:'learning_standard'].nil?
271
+ query_params[:'singleSco'] = opts[:'single_sco'] if !opts[:'single_sco'].nil?
212
272
 
213
273
  # header parameters
214
274
  header_params = {}
@@ -230,39 +290,38 @@ module RusticiSoftwareCloudV2
230
290
  :body => post_body,
231
291
  :auth_names => auth_names)
232
292
  if @api_client.config.debugging
233
- @api_client.config.logger.debug "API called: ApplicationManagementApi#delete_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
293
+ @api_client.config.logger.debug "API called: ApplicationManagementApi#delete_application_configuration_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
234
294
  end
235
295
  return data, status_code, headers
236
296
  end
237
- # Removes `credentialId` credentials
297
+
298
+ #
299
+ # Delete `credentialId` from the system. Note: if an application's last secret key is deleted it will not be able to use the SCORM Cloud api until another key is granted to it via `CreateCredential`. Removing the last secret key may also disable some priviledges in the website.
238
300
  # @param child_app_id
239
301
  # @param credential_id
240
302
  # @param [Hash] opts the optional parameters
241
303
  # @return [nil]
242
304
  def delete_credential(child_app_id, credential_id, opts = {})
243
305
  delete_credential_with_http_info(child_app_id, credential_id, opts)
244
- nil
306
+ return nil
245
307
  end
246
308
 
247
- # Removes &#x60;credentialId&#x60; credentials
309
+ #
310
+ # Delete &#x60;credentialId&#x60; from the system. Note: if an application&#39;s last secret key is deleted it will not be able to use the SCORM Cloud api until another key is granted to it via &#x60;CreateCredential&#x60;. Removing the last secret key may also disable some priviledges in the website.
248
311
  # @param child_app_id
249
312
  # @param credential_id
250
313
  # @param [Hash] opts the optional parameters
251
314
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
252
315
  def delete_credential_with_http_info(child_app_id, credential_id, opts = {})
253
316
  if @api_client.config.debugging
254
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_credential ...'
317
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.delete_credential ..."
255
318
  end
256
319
  # verify the required parameter 'child_app_id' is set
257
- if @api_client.config.client_side_validation && child_app_id.nil?
258
- fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_credential"
259
- end
320
+ fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_credential" if child_app_id.nil?
260
321
  # verify the required parameter 'credential_id' is set
261
- if @api_client.config.client_side_validation && credential_id.nil?
262
- fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.delete_credential"
263
- end
322
+ fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.delete_credential" if credential_id.nil?
264
323
  # resource path
265
- local_var_path = '/appManagement/{childAppId}/credentials/{credentialId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s).sub('{' + 'credentialId' + '}', credential_id.to_s)
324
+ local_var_path = "/appManagement/{childAppId}/credentials/{credentialId}".sub('{format}','json').sub('{' + 'childAppId' + '}', child_app_id.to_s).sub('{' + 'credentialId' + '}', credential_id.to_s)
266
325
 
267
326
  # query parameters
268
327
  query_params = {}
@@ -279,7 +338,7 @@ module RusticiSoftwareCloudV2
279
338
 
280
339
  # http body (model)
281
340
  post_body = nil
282
- auth_names = ['APP_NORMAL', 'OAUTH']
341
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
283
342
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
284
343
  :header_params => header_params,
285
344
  :query_params => query_params,
@@ -291,7 +350,9 @@ module RusticiSoftwareCloudV2
291
350
  end
292
351
  return data, status_code, headers
293
352
  end
294
- # Returns all configuration settings for this level
353
+
354
+ #
355
+ # Returns all configuration settings for this level. These settings will only affect items within this application which do not have that setting themselves. >Note ----- >This resource actually represents 2 distinct levels which are: >- ALL content in an application. This is achieved by leaving `learningStandard` and `singleSco` as `null`. Anything set at the learningStandard/singleSco level will take precedence over these settings. - Content falling into a learningStandard/singleSco category. This allows setting more specific defaults for a particular learningStandard/singleSco combination. Note: both `learningStandard` and `singleSco` must be provided, as this level is considered to be identified by those items joined.
295
356
  # @param [Hash] opts the optional parameters
296
357
  # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
297
358
  # @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
@@ -299,10 +360,11 @@ module RusticiSoftwareCloudV2
299
360
  # @return [SettingListSchema]
300
361
  def get_application_configuration(opts = {})
301
362
  data, _status_code, _headers = get_application_configuration_with_http_info(opts)
302
- data
363
+ return data
303
364
  end
304
365
 
305
- # Returns all configuration settings for this level
366
+ #
367
+ # Returns all configuration settings for this level. These settings will only affect items within this application which do not have that setting themselves. &gt;Note ----- &gt;This resource actually represents 2 distinct levels which are: &gt;- ALL content in an application. This is achieved by leaving &#x60;learningStandard&#x60; and &#x60;singleSco&#x60; as &#x60;null&#x60;. Anything set at the learningStandard/singleSco level will take precedence over these settings. - Content falling into a learningStandard/singleSco category. This allows setting more specific defaults for a particular learningStandard/singleSco combination. Note: both &#x60;learningStandard&#x60; and &#x60;singleSco&#x60; must be provided, as this level is considered to be identified by those items joined.
306
368
  # @param [Hash] opts the optional parameters
307
369
  # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
308
370
  # @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
@@ -310,13 +372,13 @@ module RusticiSoftwareCloudV2
310
372
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
311
373
  def get_application_configuration_with_http_info(opts = {})
312
374
  if @api_client.config.debugging
313
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_configuration ...'
375
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.get_application_configuration ..."
314
376
  end
315
- if @api_client.config.client_side_validation && opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
377
+ if opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
316
378
  fail ArgumentError, 'invalid value for "learning_standard", must be one of SCORM_11, SCORM_12, SCORM_2004_2ND_EDITION, SCORM_2004_3RD_EDITION, SCORM_2004_4TH_EDITION, AICC, XAPI, CMI5'
317
379
  end
318
380
  # resource path
319
- local_var_path = '/appManagement/configuration'
381
+ local_var_path = "/appManagement/configuration".sub('{format}','json')
320
382
 
321
383
  # query parameters
322
384
  query_params = {}
@@ -349,23 +411,26 @@ module RusticiSoftwareCloudV2
349
411
  end
350
412
  return data, status_code, headers
351
413
  end
414
+
415
+ # Get a list of all applications for the realm.
352
416
  # Get list of all applications in this realm.
353
417
  # @param [Hash] opts the optional parameters
354
418
  # @return [ApplicationListSchema]
355
419
  def get_application_list(opts = {})
356
420
  data, _status_code, _headers = get_application_list_with_http_info(opts)
357
- data
421
+ return data
358
422
  end
359
423
 
424
+ # Get a list of all applications for the realm.
360
425
  # Get list of all applications in this realm.
361
426
  # @param [Hash] opts the optional parameters
362
427
  # @return [Array<(ApplicationListSchema, Fixnum, Hash)>] ApplicationListSchema data, response status code and response headers
363
428
  def get_application_list_with_http_info(opts = {})
364
429
  if @api_client.config.debugging
365
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_list ...'
430
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.get_application_list ..."
366
431
  end
367
432
  # resource path
368
- local_var_path = '/appManagement/applications'
433
+ local_var_path = "/appManagement/applications".sub('{format}','json')
369
434
 
370
435
  # query parameters
371
436
  query_params = {}
@@ -382,7 +447,7 @@ module RusticiSoftwareCloudV2
382
447
 
383
448
  # http body (model)
384
449
  post_body = nil
385
- auth_names = ['APP_NORMAL', 'OAUTH']
450
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
386
451
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
387
452
  :header_params => header_params,
388
453
  :query_params => query_params,
@@ -395,29 +460,30 @@ module RusticiSoftwareCloudV2
395
460
  end
396
461
  return data, status_code, headers
397
462
  end
398
- # List of credentials
463
+
464
+ #
465
+ # Retrieve a list of all credentials (aka secret keys) belonging to `childAppId` and their statuses.
399
466
  # @param child_app_id
400
467
  # @param [Hash] opts the optional parameters
401
468
  # @return [CredentialListSchema]
402
469
  def get_credentials(child_app_id, opts = {})
403
470
  data, _status_code, _headers = get_credentials_with_http_info(child_app_id, opts)
404
- data
471
+ return data
405
472
  end
406
473
 
407
- # List of credentials
474
+ #
475
+ # Retrieve a list of all credentials (aka secret keys) belonging to &#x60;childAppId&#x60; and their statuses.
408
476
  # @param child_app_id
409
477
  # @param [Hash] opts the optional parameters
410
478
  # @return [Array<(CredentialListSchema, Fixnum, Hash)>] CredentialListSchema data, response status code and response headers
411
479
  def get_credentials_with_http_info(child_app_id, opts = {})
412
480
  if @api_client.config.debugging
413
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_credentials ...'
481
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.get_credentials ..."
414
482
  end
415
483
  # verify the required parameter 'child_app_id' is set
416
- if @api_client.config.client_side_validation && child_app_id.nil?
417
- fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.get_credentials"
418
- end
484
+ fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.get_credentials" if child_app_id.nil?
419
485
  # resource path
420
- local_var_path = '/appManagement/{childAppId}/credentials'.sub('{' + 'childAppId' + '}', child_app_id.to_s)
486
+ local_var_path = "/appManagement/{childAppId}/credentials".sub('{format}','json').sub('{' + 'childAppId' + '}', child_app_id.to_s)
421
487
 
422
488
  # query parameters
423
489
  query_params = {}
@@ -434,7 +500,7 @@ module RusticiSoftwareCloudV2
434
500
 
435
501
  # http body (model)
436
502
  post_body = nil
437
- auth_names = ['APP_NORMAL', 'OAUTH']
503
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
438
504
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
439
505
  :header_params => header_params,
440
506
  :query_params => query_params,
@@ -447,7 +513,9 @@ module RusticiSoftwareCloudV2
447
513
  end
448
514
  return data, status_code, headers
449
515
  end
450
- # Set configuration settings for this level.
516
+
517
+ #
518
+ # Set configuration settings for the application level. These settings will only affect items within the application which do not have their own configuration set. This can be used to effectively set application level defaults.
451
519
  # @param configuration_settings
452
520
  # @param [Hash] opts the optional parameters
453
521
  # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
@@ -455,10 +523,11 @@ module RusticiSoftwareCloudV2
455
523
  # @return [nil]
456
524
  def set_application_configuration(configuration_settings, opts = {})
457
525
  set_application_configuration_with_http_info(configuration_settings, opts)
458
- nil
526
+ return nil
459
527
  end
460
528
 
461
- # Set configuration settings for this level.
529
+ #
530
+ # Set configuration settings for the application level. These settings will only affect items within the application which do not have their own configuration set. This can be used to effectively set application level defaults.
462
531
  # @param configuration_settings
463
532
  # @param [Hash] opts the optional parameters
464
533
  # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
@@ -466,17 +535,15 @@ module RusticiSoftwareCloudV2
466
535
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
467
536
  def set_application_configuration_with_http_info(configuration_settings, opts = {})
468
537
  if @api_client.config.debugging
469
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.set_application_configuration ...'
538
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.set_application_configuration ..."
470
539
  end
471
540
  # verify the required parameter 'configuration_settings' is set
472
- if @api_client.config.client_side_validation && configuration_settings.nil?
473
- fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling ApplicationManagementApi.set_application_configuration"
474
- end
475
- if @api_client.config.client_side_validation && opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
541
+ fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling ApplicationManagementApi.set_application_configuration" if configuration_settings.nil?
542
+ if opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
476
543
  fail ArgumentError, 'invalid value for "learning_standard", must be one of SCORM_11, SCORM_12, SCORM_2004_2ND_EDITION, SCORM_2004_3RD_EDITION, SCORM_2004_4TH_EDITION, AICC, XAPI, CMI5'
477
544
  end
478
545
  # resource path
479
- local_var_path = '/appManagement/configuration'
546
+ local_var_path = "/appManagement/configuration".sub('{format}','json')
480
547
 
481
548
  # query parameters
482
549
  query_params = {}
@@ -507,7 +574,9 @@ module RusticiSoftwareCloudV2
507
574
  end
508
575
  return data, status_code, headers
509
576
  end
510
- # Update the name or status associated with `credentialId`
577
+
578
+ #
579
+ # Update the name or status associated with `credentialId`. If the status is updated to disabled, the credential will no longer be valid for authorization through the API. If the last (or only) key for an application is disabled it may affect some website priviledges
511
580
  # @param child_app_id
512
581
  # @param credential_id
513
582
  # @param credential_update
@@ -515,10 +584,11 @@ module RusticiSoftwareCloudV2
515
584
  # @return [nil]
516
585
  def update_credential(child_app_id, credential_id, credential_update, opts = {})
517
586
  update_credential_with_http_info(child_app_id, credential_id, credential_update, opts)
518
- nil
587
+ return nil
519
588
  end
520
589
 
521
- # Update the name or status associated with &#x60;credentialId&#x60;
590
+ #
591
+ # Update the name or status associated with &#x60;credentialId&#x60;. If the status is updated to disabled, the credential will no longer be valid for authorization through the API. If the last (or only) key for an application is disabled it may affect some website priviledges
522
592
  # @param child_app_id
523
593
  # @param credential_id
524
594
  # @param credential_update
@@ -526,22 +596,16 @@ module RusticiSoftwareCloudV2
526
596
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
527
597
  def update_credential_with_http_info(child_app_id, credential_id, credential_update, opts = {})
528
598
  if @api_client.config.debugging
529
- @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_credential ...'
599
+ @api_client.config.logger.debug "Calling API: ApplicationManagementApi.update_credential ..."
530
600
  end
531
601
  # verify the required parameter 'child_app_id' is set
532
- if @api_client.config.client_side_validation && child_app_id.nil?
533
- fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.update_credential"
534
- end
602
+ fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.update_credential" if child_app_id.nil?
535
603
  # verify the required parameter 'credential_id' is set
536
- if @api_client.config.client_side_validation && credential_id.nil?
537
- fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.update_credential"
538
- end
604
+ fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.update_credential" if credential_id.nil?
539
605
  # verify the required parameter 'credential_update' is set
540
- if @api_client.config.client_side_validation && credential_update.nil?
541
- fail ArgumentError, "Missing the required parameter 'credential_update' when calling ApplicationManagementApi.update_credential"
542
- end
606
+ fail ArgumentError, "Missing the required parameter 'credential_update' when calling ApplicationManagementApi.update_credential" if credential_update.nil?
543
607
  # resource path
544
- local_var_path = '/appManagement/{childAppId}/credentials/{credentialId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s).sub('{' + 'credentialId' + '}', credential_id.to_s)
608
+ local_var_path = "/appManagement/{childAppId}/credentials/{credentialId}".sub('{format}','json').sub('{' + 'childAppId' + '}', child_app_id.to_s).sub('{' + 'credentialId' + '}', credential_id.to_s)
545
609
 
546
610
  # query parameters
547
611
  query_params = {}
@@ -558,7 +622,7 @@ module RusticiSoftwareCloudV2
558
622
 
559
623
  # http body (model)
560
624
  post_body = @api_client.object_to_http_body(credential_update)
561
- auth_names = ['APP_NORMAL', 'OAUTH']
625
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
562
626
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
563
627
  :header_params => header_params,
564
628
  :query_params => query_params,
@@ -3,14 +3,13 @@
3
3
 
4
4
  #REST API used for SCORM Cloud integrations.
5
5
 
6
- OpenAPI spec version: 2.0 beta
6
+ OpenAPI spec version: 2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.3
10
9
 
11
10
  =end
12
11
 
13
- require 'uri'
12
+ require "uri"
14
13
 
15
14
  module RusticiSoftwareCloudV2
16
15
  class AuthenticationApi
@@ -19,39 +18,40 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
21
+
22
22
  # Authenticates for a oauth token
23
+ # Creates, signs and returns an OAuth2 token based on the provided permissions, if the credentials used to request the token have the permissions being requested. >Note: >The token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed. As long as the secret used to create it is not changed the token will be valid until it expires.
23
24
  # @param scope
24
25
  # @param [Hash] opts the optional parameters
25
26
  # @option opts [Integer] :expiration (default to 300)
26
27
  # @return [ApplicationToken]
27
28
  def get_app_token(scope, opts = {})
28
29
  data, _status_code, _headers = get_app_token_with_http_info(scope, opts)
29
- data
30
+ return data
30
31
  end
31
32
 
32
33
  # Authenticates for a oauth token
34
+ # Creates, signs and returns an OAuth2 token based on the provided permissions, if the credentials used to request the token have the permissions being requested. &gt;Note: &gt;The token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed. As long as the secret used to create it is not changed the token will be valid until it expires.
33
35
  # @param scope
34
36
  # @param [Hash] opts the optional parameters
35
37
  # @option opts [Integer] :expiration
36
38
  # @return [Array<(ApplicationToken, Fixnum, Hash)>] ApplicationToken data, response status code and response headers
37
39
  def get_app_token_with_http_info(scope, opts = {})
38
40
  if @api_client.config.debugging
39
- @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_app_token ...'
41
+ @api_client.config.logger.debug "Calling API: AuthenticationApi.get_app_token ..."
40
42
  end
41
43
  # verify the required parameter 'scope' is set
42
- if @api_client.config.client_side_validation && scope.nil?
43
- fail ArgumentError, "Missing the required parameter 'scope' when calling AuthenticationApi.get_app_token"
44
- end
45
- if @api_client.config.client_side_validation && !opts[:'expiration'].nil? && opts[:'expiration'] > 43200
44
+ fail ArgumentError, "Missing the required parameter 'scope' when calling AuthenticationApi.get_app_token" if scope.nil?
45
+ if !opts[:'expiration'].nil? && opts[:'expiration'] > 43200
46
46
  fail ArgumentError, 'invalid value for "opts[:"expiration"]" when calling AuthenticationApi.get_app_token, must be smaller than or equal to 43200.'
47
47
  end
48
48
 
49
- if @api_client.config.client_side_validation && !opts[:'expiration'].nil? && opts[:'expiration'] < 60
49
+ if !opts[:'expiration'].nil? && opts[:'expiration'] < 60
50
50
  fail ArgumentError, 'invalid value for "opts[:"expiration"]" when calling AuthenticationApi.get_app_token, must be greater than or equal to 60.'
51
51
  end
52
52
 
53
53
  # resource path
54
- local_var_path = '/oauth/authenticate/application/token'
54
+ local_var_path = "/oauth/authenticate/application/token".sub('{format}','json')
55
55
 
56
56
  # query parameters
57
57
  query_params = {}
@@ -65,8 +65,8 @@ module RusticiSoftwareCloudV2
65
65
 
66
66
  # form parameters
67
67
  form_params = {}
68
- form_params['scope'] = scope
69
- form_params['expiration'] = opts[:'expiration'] if !opts[:'expiration'].nil?
68
+ form_params["scope"] = scope
69
+ form_params["expiration"] = opts[:'expiration'] if !opts[:'expiration'].nil?
70
70
 
71
71
  # http body (model)
72
72
  post_body = nil