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
@@ -0,0 +1,555 @@
1
+ =begin
2
+ #SCORM Cloud Rest API
3
+
4
+ #REST API used for SCORM Cloud integrations.
5
+
6
+ OpenAPI spec version: 2.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require "uri"
13
+
14
+ module RusticiSoftwareCloudV2
15
+ class XapiApi
16
+ attr_accessor :api_client
17
+
18
+ def initialize(api_client = ApiClient.default)
19
+ @api_client = api_client
20
+ end
21
+
22
+ # Create an xAPI statement pipe.
23
+ # Create an xAPI statement pipe.
24
+ # @param xapi_statement_pipe
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [StringResultSchema]
27
+ def create_statement_pipe(xapi_statement_pipe, opts = {})
28
+ data, _status_code, _headers = create_statement_pipe_with_http_info(xapi_statement_pipe, opts)
29
+ return data
30
+ end
31
+
32
+ # Create an xAPI statement pipe.
33
+ # Create an xAPI statement pipe.
34
+ # @param xapi_statement_pipe
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
37
+ def create_statement_pipe_with_http_info(xapi_statement_pipe, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug "Calling API: XapiApi.create_statement_pipe ..."
40
+ end
41
+ # verify the required parameter 'xapi_statement_pipe' is set
42
+ fail ArgumentError, "Missing the required parameter 'xapi_statement_pipe' when calling XapiApi.create_statement_pipe" if xapi_statement_pipe.nil?
43
+ # resource path
44
+ local_var_path = "/xapi/statementPipes".sub('{format}','json')
45
+
46
+ # query parameters
47
+ query_params = {}
48
+
49
+ # header parameters
50
+ header_params = {}
51
+ # HTTP header 'Accept' (if needed)
52
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
+ # HTTP header 'Content-Type'
54
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
55
+
56
+ # form parameters
57
+ form_params = {}
58
+
59
+ # http body (model)
60
+ post_body = @api_client.object_to_http_body(xapi_statement_pipe)
61
+ auth_names = ['APP_NORMAL', 'OAUTH']
62
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
63
+ :header_params => header_params,
64
+ :query_params => query_params,
65
+ :form_params => form_params,
66
+ :body => post_body,
67
+ :auth_names => auth_names,
68
+ :return_type => 'StringResultSchema')
69
+ if @api_client.config.debugging
70
+ @api_client.config.logger.debug "API called: XapiApi#create_statement_pipe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
71
+ end
72
+ return data, status_code, headers
73
+ end
74
+
75
+ # Create a xAPI credential.
76
+ # Create a xAPI credential.
77
+ # @param xapi_credential
78
+ # @param [Hash] opts the optional parameters
79
+ # @return [StringResultSchema]
80
+ def create_xapi_credential(xapi_credential, opts = {})
81
+ data, _status_code, _headers = create_xapi_credential_with_http_info(xapi_credential, opts)
82
+ return data
83
+ end
84
+
85
+ # Create a xAPI credential.
86
+ # Create a xAPI credential.
87
+ # @param xapi_credential
88
+ # @param [Hash] opts the optional parameters
89
+ # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
90
+ def create_xapi_credential_with_http_info(xapi_credential, opts = {})
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "Calling API: XapiApi.create_xapi_credential ..."
93
+ end
94
+ # verify the required parameter 'xapi_credential' is set
95
+ fail ArgumentError, "Missing the required parameter 'xapi_credential' when calling XapiApi.create_xapi_credential" if xapi_credential.nil?
96
+ # resource path
97
+ local_var_path = "/xapi/credentials".sub('{format}','json')
98
+
99
+ # query parameters
100
+ query_params = {}
101
+
102
+ # header parameters
103
+ header_params = {}
104
+ # HTTP header 'Accept' (if needed)
105
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
106
+ # HTTP header 'Content-Type'
107
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
108
+
109
+ # form parameters
110
+ form_params = {}
111
+
112
+ # http body (model)
113
+ post_body = @api_client.object_to_http_body(xapi_credential)
114
+ auth_names = ['APP_NORMAL', 'OAUTH']
115
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
116
+ :header_params => header_params,
117
+ :query_params => query_params,
118
+ :form_params => form_params,
119
+ :body => post_body,
120
+ :auth_names => auth_names,
121
+ :return_type => 'StringResultSchema')
122
+ if @api_client.config.debugging
123
+ @api_client.config.logger.debug "API called: XapiApi#create_xapi_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
124
+ end
125
+ return data, status_code, headers
126
+ end
127
+
128
+ # Deletes this xAPI pipe.
129
+ # Caution: avoid re-creating a pipe with the same ID quickly after a delete. The old version could still be processing, in which case the new pipe could be updated improperly by the processor.
130
+ # @param statement_pipe_id id for this xAPI statement pipe
131
+ # @param [Hash] opts the optional parameters
132
+ # @return [nil]
133
+ def delete_statement_pipe(statement_pipe_id, opts = {})
134
+ delete_statement_pipe_with_http_info(statement_pipe_id, opts)
135
+ return nil
136
+ end
137
+
138
+ # Deletes this xAPI pipe.
139
+ # Caution: avoid re-creating a pipe with the same ID quickly after a delete. The old version could still be processing, in which case the new pipe could be updated improperly by the processor.
140
+ # @param statement_pipe_id id for this xAPI statement pipe
141
+ # @param [Hash] opts the optional parameters
142
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
143
+ def delete_statement_pipe_with_http_info(statement_pipe_id, opts = {})
144
+ if @api_client.config.debugging
145
+ @api_client.config.logger.debug "Calling API: XapiApi.delete_statement_pipe ..."
146
+ end
147
+ # verify the required parameter 'statement_pipe_id' is set
148
+ fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.delete_statement_pipe" if statement_pipe_id.nil?
149
+ # resource path
150
+ local_var_path = "/xapi/statementPipes/{statementPipeId}".sub('{format}','json').sub('{' + 'statementPipeId' + '}', statement_pipe_id.to_s)
151
+
152
+ # query parameters
153
+ query_params = {}
154
+
155
+ # header parameters
156
+ header_params = {}
157
+ # HTTP header 'Accept' (if needed)
158
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
159
+ # HTTP header 'Content-Type'
160
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
161
+
162
+ # form parameters
163
+ form_params = {}
164
+
165
+ # http body (model)
166
+ post_body = nil
167
+ auth_names = ['APP_NORMAL', 'OAUTH']
168
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
169
+ :header_params => header_params,
170
+ :query_params => query_params,
171
+ :form_params => form_params,
172
+ :body => post_body,
173
+ :auth_names => auth_names)
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug "API called: XapiApi#delete_statement_pipe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
176
+ end
177
+ return data, status_code, headers
178
+ end
179
+
180
+ # Deletes the xAPI credentials specified by the xAPI credentials id
181
+ # Deletes the xAPI credentials specified by the xAPI credentials id
182
+ # @param xapi_credential_id id for this xAPI credential
183
+ # @param [Hash] opts the optional parameters
184
+ # @return [nil]
185
+ def delete_xapi_credential(xapi_credential_id, opts = {})
186
+ delete_xapi_credential_with_http_info(xapi_credential_id, opts)
187
+ return nil
188
+ end
189
+
190
+ # Deletes the xAPI credentials specified by the xAPI credentials id
191
+ # Deletes the xAPI credentials specified by the xAPI credentials id
192
+ # @param xapi_credential_id id for this xAPI credential
193
+ # @param [Hash] opts the optional parameters
194
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
195
+ def delete_xapi_credential_with_http_info(xapi_credential_id, opts = {})
196
+ if @api_client.config.debugging
197
+ @api_client.config.logger.debug "Calling API: XapiApi.delete_xapi_credential ..."
198
+ end
199
+ # verify the required parameter 'xapi_credential_id' is set
200
+ fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.delete_xapi_credential" if xapi_credential_id.nil?
201
+ # resource path
202
+ local_var_path = "/xapi/credentials/{xapiCredentialId}".sub('{format}','json').sub('{' + 'xapiCredentialId' + '}', xapi_credential_id.to_s)
203
+
204
+ # query parameters
205
+ query_params = {}
206
+
207
+ # header parameters
208
+ header_params = {}
209
+ # HTTP header 'Accept' (if needed)
210
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
211
+ # HTTP header 'Content-Type'
212
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
213
+
214
+ # form parameters
215
+ form_params = {}
216
+
217
+ # http body (model)
218
+ post_body = nil
219
+ auth_names = ['APP_NORMAL', 'OAUTH']
220
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
221
+ :header_params => header_params,
222
+ :query_params => query_params,
223
+ :form_params => form_params,
224
+ :body => post_body,
225
+ :auth_names => auth_names)
226
+ if @api_client.config.debugging
227
+ @api_client.config.logger.debug "API called: XapiApi#delete_xapi_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
228
+ end
229
+ return data, status_code, headers
230
+ end
231
+
232
+ # Retrieves xAPI pipe for `xapiPipeId`
233
+ # Retrieves xAPI pipe for `xapiPipeId`
234
+ # @param statement_pipe_id id for this xAPI statement pipe
235
+ # @param [Hash] opts the optional parameters
236
+ # @return [XapiStatementPipeSchema]
237
+ def get_statement_pipe(statement_pipe_id, opts = {})
238
+ data, _status_code, _headers = get_statement_pipe_with_http_info(statement_pipe_id, opts)
239
+ return data
240
+ end
241
+
242
+ # Retrieves xAPI pipe for &#x60;xapiPipeId&#x60;
243
+ # Retrieves xAPI pipe for &#x60;xapiPipeId&#x60;
244
+ # @param statement_pipe_id id for this xAPI statement pipe
245
+ # @param [Hash] opts the optional parameters
246
+ # @return [Array<(XapiStatementPipeSchema, Fixnum, Hash)>] XapiStatementPipeSchema data, response status code and response headers
247
+ def get_statement_pipe_with_http_info(statement_pipe_id, opts = {})
248
+ if @api_client.config.debugging
249
+ @api_client.config.logger.debug "Calling API: XapiApi.get_statement_pipe ..."
250
+ end
251
+ # verify the required parameter 'statement_pipe_id' is set
252
+ fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.get_statement_pipe" if statement_pipe_id.nil?
253
+ # resource path
254
+ local_var_path = "/xapi/statementPipes/{statementPipeId}".sub('{format}','json').sub('{' + 'statementPipeId' + '}', statement_pipe_id.to_s)
255
+
256
+ # query parameters
257
+ query_params = {}
258
+
259
+ # header parameters
260
+ header_params = {}
261
+ # HTTP header 'Accept' (if needed)
262
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
263
+ # HTTP header 'Content-Type'
264
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
265
+
266
+ # form parameters
267
+ form_params = {}
268
+
269
+ # http body (model)
270
+ post_body = nil
271
+ auth_names = ['APP_NORMAL', 'OAUTH']
272
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
273
+ :header_params => header_params,
274
+ :query_params => query_params,
275
+ :form_params => form_params,
276
+ :body => post_body,
277
+ :auth_names => auth_names,
278
+ :return_type => 'XapiStatementPipeSchema')
279
+ if @api_client.config.debugging
280
+ @api_client.config.logger.debug "API called: XapiApi#get_statement_pipe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
281
+ end
282
+ return data, status_code, headers
283
+ end
284
+
285
+ # Get all of the xapiPipes for `appId`
286
+ # Get all of the xapiPipes for `appId`
287
+ # @param [Hash] opts the optional parameters
288
+ # @return [XapiStatementPipeListSchema]
289
+ def get_statement_pipes(opts = {})
290
+ data, _status_code, _headers = get_statement_pipes_with_http_info(opts)
291
+ return data
292
+ end
293
+
294
+ # Get all of the xapiPipes for &#x60;appId&#x60;
295
+ # Get all of the xapiPipes for &#x60;appId&#x60;
296
+ # @param [Hash] opts the optional parameters
297
+ # @return [Array<(XapiStatementPipeListSchema, Fixnum, Hash)>] XapiStatementPipeListSchema data, response status code and response headers
298
+ def get_statement_pipes_with_http_info(opts = {})
299
+ if @api_client.config.debugging
300
+ @api_client.config.logger.debug "Calling API: XapiApi.get_statement_pipes ..."
301
+ end
302
+ # resource path
303
+ local_var_path = "/xapi/statementPipes".sub('{format}','json')
304
+
305
+ # query parameters
306
+ query_params = {}
307
+
308
+ # header parameters
309
+ header_params = {}
310
+ # HTTP header 'Accept' (if needed)
311
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
312
+ # HTTP header 'Content-Type'
313
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
314
+
315
+ # form parameters
316
+ form_params = {}
317
+
318
+ # http body (model)
319
+ post_body = nil
320
+ auth_names = ['APP_NORMAL', 'OAUTH']
321
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
322
+ :header_params => header_params,
323
+ :query_params => query_params,
324
+ :form_params => form_params,
325
+ :body => post_body,
326
+ :auth_names => auth_names,
327
+ :return_type => 'XapiStatementPipeListSchema')
328
+ if @api_client.config.debugging
329
+ @api_client.config.logger.debug "API called: XapiApi#get_statement_pipes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
330
+ end
331
+ return data, status_code, headers
332
+ end
333
+
334
+ # Retrieves the xAPI credentials specified by the xAPI credentials id.
335
+ # Retrieves the xAPI credentials specified by the xAPI credentials id.
336
+ # @param xapi_credential_id id for this xAPI credential
337
+ # @param [Hash] opts the optional parameters
338
+ # @return [XapiCredentialSchema]
339
+ def get_xapi_credential(xapi_credential_id, opts = {})
340
+ data, _status_code, _headers = get_xapi_credential_with_http_info(xapi_credential_id, opts)
341
+ return data
342
+ end
343
+
344
+ # Retrieves the xAPI credentials specified by the xAPI credentials id.
345
+ # Retrieves the xAPI credentials specified by the xAPI credentials id.
346
+ # @param xapi_credential_id id for this xAPI credential
347
+ # @param [Hash] opts the optional parameters
348
+ # @return [Array<(XapiCredentialSchema, Fixnum, Hash)>] XapiCredentialSchema data, response status code and response headers
349
+ def get_xapi_credential_with_http_info(xapi_credential_id, opts = {})
350
+ if @api_client.config.debugging
351
+ @api_client.config.logger.debug "Calling API: XapiApi.get_xapi_credential ..."
352
+ end
353
+ # verify the required parameter 'xapi_credential_id' is set
354
+ fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.get_xapi_credential" if xapi_credential_id.nil?
355
+ # resource path
356
+ local_var_path = "/xapi/credentials/{xapiCredentialId}".sub('{format}','json').sub('{' + 'xapiCredentialId' + '}', xapi_credential_id.to_s)
357
+
358
+ # query parameters
359
+ query_params = {}
360
+
361
+ # header parameters
362
+ header_params = {}
363
+ # HTTP header 'Accept' (if needed)
364
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
365
+ # HTTP header 'Content-Type'
366
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
367
+
368
+ # form parameters
369
+ form_params = {}
370
+
371
+ # http body (model)
372
+ post_body = nil
373
+ auth_names = ['APP_NORMAL', 'OAUTH']
374
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
375
+ :header_params => header_params,
376
+ :query_params => query_params,
377
+ :form_params => form_params,
378
+ :body => post_body,
379
+ :auth_names => auth_names,
380
+ :return_type => 'XapiCredentialSchema')
381
+ if @api_client.config.debugging
382
+ @api_client.config.logger.debug "API called: XapiApi#get_xapi_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
383
+ end
384
+ return data, status_code, headers
385
+ end
386
+
387
+ # Get the list of xapiCredentials
388
+ # Get the list of xapiCredentials
389
+ # @param [Hash] opts the optional parameters
390
+ # @option opts [DateTime] :since Only &lt;&lt;resourcePathName&gt;&gt; updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
391
+ # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of &lt;&lt;resourcePathName&gt;&gt; lists, where needed. An opaque value, construction and parsing may change without notice.
392
+ # @return [XapiCredentialsListSchema]
393
+ def get_xapi_credentials(opts = {})
394
+ data, _status_code, _headers = get_xapi_credentials_with_http_info(opts)
395
+ return data
396
+ end
397
+
398
+ # Get the list of xapiCredentials
399
+ # Get the list of xapiCredentials
400
+ # @param [Hash] opts the optional parameters
401
+ # @option opts [DateTime] :since Only &lt;&lt;resourcePathName&gt;&gt; updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
402
+ # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of &lt;&lt;resourcePathName&gt;&gt; lists, where needed. An opaque value, construction and parsing may change without notice.
403
+ # @return [Array<(XapiCredentialsListSchema, Fixnum, Hash)>] XapiCredentialsListSchema data, response status code and response headers
404
+ def get_xapi_credentials_with_http_info(opts = {})
405
+ if @api_client.config.debugging
406
+ @api_client.config.logger.debug "Calling API: XapiApi.get_xapi_credentials ..."
407
+ end
408
+ # resource path
409
+ local_var_path = "/xapi/credentials".sub('{format}','json')
410
+
411
+ # query parameters
412
+ query_params = {}
413
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
414
+ query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
415
+
416
+ # header parameters
417
+ header_params = {}
418
+ # HTTP header 'Accept' (if needed)
419
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
420
+ # HTTP header 'Content-Type'
421
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
422
+
423
+ # form parameters
424
+ form_params = {}
425
+
426
+ # http body (model)
427
+ post_body = nil
428
+ auth_names = ['APP_NORMAL', 'OAUTH']
429
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
430
+ :header_params => header_params,
431
+ :query_params => query_params,
432
+ :form_params => form_params,
433
+ :body => post_body,
434
+ :auth_names => auth_names,
435
+ :return_type => 'XapiCredentialsListSchema')
436
+ if @api_client.config.debugging
437
+ @api_client.config.logger.debug "API called: XapiApi#get_xapi_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
438
+ end
439
+ return data, status_code, headers
440
+ end
441
+
442
+ # Edit an existing xAPI pipe or create a new one.
443
+ # Editing a pipe will cause it to start over and forward any statements it finds, even if the prior version of the pipe had already forwarded those statements. If the pipe being edited is currently being processed, the this request will fail with a status code of 409.
444
+ # @param statement_pipe_id id for this xAPI statement pipe
445
+ # @param xapi_statement_pipe
446
+ # @param [Hash] opts the optional parameters
447
+ # @return [StringResultSchema]
448
+ def set_statement_pipe(statement_pipe_id, xapi_statement_pipe, opts = {})
449
+ data, _status_code, _headers = set_statement_pipe_with_http_info(statement_pipe_id, xapi_statement_pipe, opts)
450
+ return data
451
+ end
452
+
453
+ # Edit an existing xAPI pipe or create a new one.
454
+ # Editing a pipe will cause it to start over and forward any statements it finds, even if the prior version of the pipe had already forwarded those statements. If the pipe being edited is currently being processed, the this request will fail with a status code of 409.
455
+ # @param statement_pipe_id id for this xAPI statement pipe
456
+ # @param xapi_statement_pipe
457
+ # @param [Hash] opts the optional parameters
458
+ # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
459
+ def set_statement_pipe_with_http_info(statement_pipe_id, xapi_statement_pipe, opts = {})
460
+ if @api_client.config.debugging
461
+ @api_client.config.logger.debug "Calling API: XapiApi.set_statement_pipe ..."
462
+ end
463
+ # verify the required parameter 'statement_pipe_id' is set
464
+ fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.set_statement_pipe" if statement_pipe_id.nil?
465
+ # verify the required parameter 'xapi_statement_pipe' is set
466
+ fail ArgumentError, "Missing the required parameter 'xapi_statement_pipe' when calling XapiApi.set_statement_pipe" if xapi_statement_pipe.nil?
467
+ # resource path
468
+ local_var_path = "/xapi/statementPipes/{statementPipeId}".sub('{format}','json').sub('{' + 'statementPipeId' + '}', statement_pipe_id.to_s)
469
+
470
+ # query parameters
471
+ query_params = {}
472
+
473
+ # header parameters
474
+ header_params = {}
475
+ # HTTP header 'Accept' (if needed)
476
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
477
+ # HTTP header 'Content-Type'
478
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
479
+
480
+ # form parameters
481
+ form_params = {}
482
+
483
+ # http body (model)
484
+ post_body = @api_client.object_to_http_body(xapi_statement_pipe)
485
+ auth_names = ['APP_NORMAL', 'OAUTH']
486
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
487
+ :header_params => header_params,
488
+ :query_params => query_params,
489
+ :form_params => form_params,
490
+ :body => post_body,
491
+ :auth_names => auth_names,
492
+ :return_type => 'StringResultSchema')
493
+ if @api_client.config.debugging
494
+ @api_client.config.logger.debug "API called: XapiApi#set_statement_pipe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
495
+ end
496
+ return data, status_code, headers
497
+ end
498
+
499
+ # Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id
500
+ # Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id
501
+ # @param xapi_credential_id id for this xAPI credential
502
+ # @param xapi_credential
503
+ # @param [Hash] opts the optional parameters
504
+ # @return [nil]
505
+ def set_xapi_credential(xapi_credential_id, xapi_credential, opts = {})
506
+ set_xapi_credential_with_http_info(xapi_credential_id, xapi_credential, opts)
507
+ return nil
508
+ end
509
+
510
+ # Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id
511
+ # Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id
512
+ # @param xapi_credential_id id for this xAPI credential
513
+ # @param xapi_credential
514
+ # @param [Hash] opts the optional parameters
515
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
516
+ def set_xapi_credential_with_http_info(xapi_credential_id, xapi_credential, opts = {})
517
+ if @api_client.config.debugging
518
+ @api_client.config.logger.debug "Calling API: XapiApi.set_xapi_credential ..."
519
+ end
520
+ # verify the required parameter 'xapi_credential_id' is set
521
+ fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.set_xapi_credential" if xapi_credential_id.nil?
522
+ # verify the required parameter 'xapi_credential' is set
523
+ fail ArgumentError, "Missing the required parameter 'xapi_credential' when calling XapiApi.set_xapi_credential" if xapi_credential.nil?
524
+ # resource path
525
+ local_var_path = "/xapi/credentials/{xapiCredentialId}".sub('{format}','json').sub('{' + 'xapiCredentialId' + '}', xapi_credential_id.to_s)
526
+
527
+ # query parameters
528
+ query_params = {}
529
+
530
+ # header parameters
531
+ header_params = {}
532
+ # HTTP header 'Accept' (if needed)
533
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
534
+ # HTTP header 'Content-Type'
535
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
536
+
537
+ # form parameters
538
+ form_params = {}
539
+
540
+ # http body (model)
541
+ post_body = @api_client.object_to_http_body(xapi_credential)
542
+ auth_names = ['APP_NORMAL', 'OAUTH']
543
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
544
+ :header_params => header_params,
545
+ :query_params => query_params,
546
+ :form_params => form_params,
547
+ :body => post_body,
548
+ :auth_names => auth_names)
549
+ if @api_client.config.debugging
550
+ @api_client.config.logger.debug "API called: XapiApi#set_xapi_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
551
+ end
552
+ return data, status_code, headers
553
+ end
554
+ end
555
+ end