rustici_software_cloud_v2 2.0.0 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (160) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/rustici_software_cloud_v2/api/about_api.rb +1 -1
  4. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +1 -1
  5. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +1 -1
  6. data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +236 -0
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +117 -3
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +178 -3
  9. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +1 -1
  10. data/lib/rustici_software_cloud_v2/api/learner_api.rb +1 -1
  11. data/lib/rustici_software_cloud_v2/api/ping_api.rb +1 -1
  12. data/lib/rustici_software_cloud_v2/api/registration_api.rb +1 -1
  13. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +1 -1
  14. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +1 -1
  15. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +1 -1
  16. data/lib/rustici_software_cloud_v2/api_client.rb +1 -1
  17. data/lib/rustici_software_cloud_v2/api_error.rb +1 -1
  18. data/lib/rustici_software_cloud_v2/configuration.rb +8 -1
  19. data/lib/rustici_software_cloud_v2/models/about_schema.rb +1 -1
  20. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +1 -1
  21. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +1 -1
  22. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +1 -1
  23. data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +1 -1
  24. data/lib/rustici_software_cloud_v2/models/application_schema.rb +1 -1
  25. data/lib/rustici_software_cloud_v2/models/application_token.rb +1 -1
  26. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +1 -1
  27. data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +1 -1
  28. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +1 -1
  29. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +1 -1
  30. data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +188 -0
  31. data/lib/rustici_software_cloud_v2/models/connector_schema.rb +226 -0
  32. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +2 -2
  33. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +1 -1
  34. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +1 -1
  35. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +1 -1
  36. data/lib/rustici_software_cloud_v2/models/course_schema.rb +2 -2
  37. data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +218 -0
  38. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +1 -1
  39. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +1 -1
  40. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +1 -1
  41. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +1 -1
  42. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +1 -1
  43. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +1 -1
  44. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +1 -1
  45. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +1 -1
  46. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +1 -1
  47. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +1 -1
  48. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +1 -1
  49. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +1 -1
  50. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +32 -5
  51. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +1 -1
  52. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +1 -1
  53. data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +186 -0
  54. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +1 -1
  55. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +1 -1
  56. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +1 -1
  57. data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +1 -1
  58. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +1 -1
  59. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +1 -1
  60. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +1 -1
  61. data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +207 -0
  62. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +1 -1
  63. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +1 -1
  64. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +1 -1
  65. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +15 -6
  66. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +1 -1
  67. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +1 -1
  68. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +1 -1
  69. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +1 -1
  70. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +1 -1
  71. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +1 -1
  72. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +1 -1
  73. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +1 -1
  74. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +1 -1
  75. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +1 -1
  76. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +1 -1
  77. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +1 -1
  78. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +1 -1
  79. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +1 -1
  80. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +1 -1
  81. data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +261 -0
  82. data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +236 -0
  83. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +1 -1
  84. data/lib/rustici_software_cloud_v2/models/message_schema.rb +1 -1
  85. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +1 -1
  86. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +1 -1
  87. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +1 -1
  88. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +1 -1
  89. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +1 -1
  90. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +1 -1
  91. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +1 -1
  92. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +1 -1
  93. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +1 -1
  94. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +11 -2
  95. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +1 -1
  96. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +1 -1
  97. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +1 -1
  98. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +1 -1
  99. data/lib/rustici_software_cloud_v2/models/registration_success.rb +1 -1
  100. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +1 -1
  101. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +1 -1
  102. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +1 -1
  103. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +1 -1
  104. data/lib/rustici_software_cloud_v2/models/response_error.rb +1 -1
  105. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +1 -1
  106. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +1 -1
  107. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +1 -1
  108. data/lib/rustici_software_cloud_v2/models/score_schema.rb +1 -1
  109. data/lib/rustici_software_cloud_v2/models/setting_item.rb +1 -1
  110. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +1 -1
  111. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +1 -1
  112. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +1 -1
  113. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +1 -1
  114. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +1 -1
  115. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +1 -1
  116. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +1 -1
  117. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +1 -1
  118. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +1 -1
  119. data/lib/rustici_software_cloud_v2/models/title_schema.rb +1 -1
  120. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +1 -1
  121. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +1 -1
  122. data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +196 -0
  123. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +1 -1
  124. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +1 -1
  125. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +1 -1
  126. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +1 -1
  127. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +1 -1
  128. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +1 -1
  129. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +1 -1
  130. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +1 -1
  131. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +1 -1
  132. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +1 -1
  133. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +1 -1
  134. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +1 -1
  135. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +1 -1
  136. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +1 -1
  137. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +1 -1
  138. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +1 -1
  139. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +1 -1
  140. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +1 -1
  141. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +1 -1
  142. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +1 -1
  143. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +1 -1
  144. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +1 -1
  145. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +1 -1
  146. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +1 -1
  147. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +1 -1
  148. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +1 -1
  149. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +1 -1
  150. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +1 -1
  151. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +1 -1
  152. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +1 -1
  153. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +1 -1
  154. data/lib/rustici_software_cloud_v2/version.rb +2 -2
  155. data/lib/rustici_software_cloud_v2.rb +10 -1
  156. data/rustici_software_cloud_v2.gemspec +1 -1
  157. data/spec/api_client_spec.rb +1 -1
  158. data/spec/configuration_spec.rb +1 -1
  159. data/spec/spec_helper.rb +1 -1
  160. metadata +12 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 76a614b52e38306b7ef49b804c9d53209e8ad854f4e74a11cd2092be1638180b
4
- data.tar.gz: cda1d65a0e1ee135dd3905169a2fdbdd1a92155e271efbe24e9555cb9edde962
3
+ metadata.gz: 247b1a7a7ea4ee91459e4651907dc34c8e01c1922b908de16df785bd6e013eba
4
+ data.tar.gz: 7140c78703919b71ab730564ee20aa982abeb3ab270325dcb2eeb9e680119149
5
5
  SHA512:
6
- metadata.gz: aeca3f98049127435943a6d120e86d1aa9a97b09d0ff826c62806000f5f53e2ab580359b3ce682aca846e2555642bfbf0e3e0bf4623bbb182054a0a2c35b63a2
7
- data.tar.gz: 2aa262cd225e5bf1ec2d36b132839cdfaf7e6435b061403cc2dc5252df8ffea7bad38fcfbca5dc2db24afa59ea7f51b74502fd29dd2d5da167effb14c719d361
6
+ metadata.gz: ac4f6a667976b270b3b230de312167e8e8fd0731a494e1dfbb1c17a99c826e2f80bbb81c894880088c23a36a8b2eff038927831eee52dc5d45f86ad143ea317b
7
+ data.tar.gz: c41e7e7b66dffcdc05ab1169e531fbd88f3f8ba3b2095a6648598de86ae114e5bec6c8418d193f519d86b767e86e14bc2ea878067fb15dca3050ceb8b0588129
data/README.md CHANGED
@@ -7,7 +7,7 @@ REST API used for SCORM Cloud integrations.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0
10
- - Package version: 2.0.0
10
+ - Package version: 2.1.0
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -22,13 +22,13 @@ gem build rustici_software_cloud_v2.gemspec
22
22
  ```
23
23
 
24
24
  ```shell
25
- gem install ./rustici_software_cloud_v2-2.0.0.gem
25
+ gem install ./rustici_software_cloud_v2-2.1.0.gem
26
26
  ```
27
- For development, run `gem install --dev ./rustici_software_cloud_v2-2.0.0.gem` to install the development dependencies
27
+ For development, run `gem install --dev ./rustici_software_cloud_v2-2.1.0.gem` to install the development dependencies
28
28
 
29
29
  Finally add this to the Gemfile:
30
30
 
31
- gem 'rustici_software_cloud_v2', '~> 2.0.0'
31
+ gem 'rustici_software_cloud_v2', '~> 2.1.0'
32
32
 
33
33
  ## Tips and Tricks
34
34
  Working with headers will require calling the `WithHttpInfo` version of the function. This allows for grabbing the header directly from the response object:
@@ -39,7 +39,7 @@ response = dispatch_api.update_dispatches_with_http_info(RusticiSoftwareCloudV2:
39
39
  puts response[2]["X-Total-Count"]
40
40
  ```
41
41
 
42
- ## Release 2.0.X:
42
+ ## Changelog:
43
43
  Check the [changelog](https://cloud.scorm.com/docs/v2/reference/changelog/) for details of what has changed.
44
44
 
45
45
  ## Sample Code
@@ -6,7 +6,7 @@
6
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.12
9
+ Swagger Codegen version: 2.4.27
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
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.12
9
+ Swagger Codegen version: 2.4.27
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
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.12
9
+ Swagger Codegen version: 2.4.27
10
10
 
11
11
  =end
12
12
 
@@ -0,0 +1,236 @@
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
+ Swagger Codegen version: 2.4.27
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module RusticiSoftwareCloudV2
16
+ class ContentConnectorsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # A call to this method will create a new content connector and return a newly created Id for it.
23
+ # @param connector
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [StringResultSchema]
26
+ def create_connector(connector, opts = {})
27
+ data, _status_code, _headers = create_connector_with_http_info(connector, opts)
28
+ data
29
+ end
30
+
31
+ # A call to this method will create a new content connector and return a newly created Id for it.
32
+ # @param connector
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
35
+ def create_connector_with_http_info(connector, opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.create_connector ...'
38
+ end
39
+ # verify the required parameter 'connector' is set
40
+ if connector.nil?
41
+ fail ArgumentError, "Missing the required parameter 'connector' when calling ContentConnectorsApi.create_connector"
42
+ end
43
+ # resource path
44
+ local_var_path = '/contentConnectors'
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(connector)
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: ContentConnectorsApi#create_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
71
+ end
72
+ return data, status_code, headers
73
+ end
74
+ # Delete a connector
75
+ # Delete the specified connector.
76
+ # @param connector_id the connector id
77
+ # @param [Hash] opts the optional parameters
78
+ # @return [nil]
79
+ def delete_connector(connector_id, opts = {})
80
+ delete_connector_with_http_info(connector_id, opts)
81
+ nil
82
+ end
83
+
84
+ # Delete a connector
85
+ # Delete the specified connector.
86
+ # @param connector_id the connector id
87
+ # @param [Hash] opts the optional parameters
88
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
89
+ def delete_connector_with_http_info(connector_id, opts = {})
90
+ if @api_client.config.debugging
91
+ @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.delete_connector ...'
92
+ end
93
+ # verify the required parameter 'connector_id' is set
94
+ if connector_id.nil?
95
+ fail ArgumentError, "Missing the required parameter 'connector_id' when calling ContentConnectorsApi.delete_connector"
96
+ end
97
+ # resource path
98
+ local_var_path = '/contentConnectors/{connectorId}'.sub('{' + 'connectorId' + '}', connector_id.to_s)
99
+
100
+ # query parameters
101
+ query_params = {}
102
+
103
+ # header parameters
104
+ header_params = {}
105
+ # HTTP header 'Accept' (if needed)
106
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
107
+ # HTTP header 'Content-Type'
108
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
109
+
110
+ # form parameters
111
+ form_params = {}
112
+
113
+ # http body (model)
114
+ post_body = nil
115
+ auth_names = ['APP_NORMAL', 'OAUTH']
116
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
117
+ :header_params => header_params,
118
+ :query_params => query_params,
119
+ :form_params => form_params,
120
+ :body => post_body,
121
+ :auth_names => auth_names)
122
+ if @api_client.config.debugging
123
+ @api_client.config.logger.debug "API called: ContentConnectorsApi#delete_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
124
+ end
125
+ return data, status_code, headers
126
+ end
127
+ # Get a list of all Content Connectors for the application
128
+ # Get list of all Content Connectors in this application.
129
+ # @param [Hash] opts the optional parameters
130
+ # @option opts [BOOLEAN] :include_additional_instance_information
131
+ # @return [ConnectorListSchema]
132
+ def get_connectors_list(opts = {})
133
+ data, _status_code, _headers = get_connectors_list_with_http_info(opts)
134
+ data
135
+ end
136
+
137
+ # Get a list of all Content Connectors for the application
138
+ # Get list of all Content Connectors in this application.
139
+ # @param [Hash] opts the optional parameters
140
+ # @option opts [BOOLEAN] :include_additional_instance_information
141
+ # @return [Array<(ConnectorListSchema, Fixnum, Hash)>] ConnectorListSchema data, response status code and response headers
142
+ def get_connectors_list_with_http_info(opts = {})
143
+ if @api_client.config.debugging
144
+ @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.get_connectors_list ...'
145
+ end
146
+ # resource path
147
+ local_var_path = '/contentConnectors'
148
+
149
+ # query parameters
150
+ query_params = {}
151
+ query_params[:'includeAdditionalInstanceInformation'] = opts[:'include_additional_instance_information'] if !opts[:'include_additional_instance_information'].nil?
152
+
153
+ # header parameters
154
+ header_params = {}
155
+ # HTTP header 'Accept' (if needed)
156
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
157
+ # HTTP header 'Content-Type'
158
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
159
+
160
+ # form parameters
161
+ form_params = {}
162
+
163
+ # http body (model)
164
+ post_body = nil
165
+ auth_names = ['APP_NORMAL', 'OAUTH']
166
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
167
+ :header_params => header_params,
168
+ :query_params => query_params,
169
+ :form_params => form_params,
170
+ :body => post_body,
171
+ :auth_names => auth_names,
172
+ :return_type => 'ConnectorListSchema')
173
+ if @api_client.config.debugging
174
+ @api_client.config.logger.debug "API called: ContentConnectorsApi#get_connectors_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
175
+ end
176
+ return data, status_code, headers
177
+ end
178
+ # Update the configuration or enabled flag associated with `connectorId`.
179
+ # @param connector_id the connector id
180
+ # @param connector
181
+ # @param [Hash] opts the optional parameters
182
+ # @return [nil]
183
+ def update_connector(connector_id, connector, opts = {})
184
+ update_connector_with_http_info(connector_id, connector, opts)
185
+ nil
186
+ end
187
+
188
+ # Update the configuration or enabled flag associated with &#x60;connectorId&#x60;.
189
+ # @param connector_id the connector id
190
+ # @param connector
191
+ # @param [Hash] opts the optional parameters
192
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
193
+ def update_connector_with_http_info(connector_id, connector, opts = {})
194
+ if @api_client.config.debugging
195
+ @api_client.config.logger.debug 'Calling API: ContentConnectorsApi.update_connector ...'
196
+ end
197
+ # verify the required parameter 'connector_id' is set
198
+ if connector_id.nil?
199
+ fail ArgumentError, "Missing the required parameter 'connector_id' when calling ContentConnectorsApi.update_connector"
200
+ end
201
+ # verify the required parameter 'connector' is set
202
+ if connector.nil?
203
+ fail ArgumentError, "Missing the required parameter 'connector' when calling ContentConnectorsApi.update_connector"
204
+ end
205
+ # resource path
206
+ local_var_path = '/contentConnectors/{connectorId}'.sub('{' + 'connectorId' + '}', connector_id.to_s)
207
+
208
+ # query parameters
209
+ query_params = {}
210
+
211
+ # header parameters
212
+ header_params = {}
213
+ # HTTP header 'Accept' (if needed)
214
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
215
+ # HTTP header 'Content-Type'
216
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
217
+
218
+ # form parameters
219
+ form_params = {}
220
+
221
+ # http body (model)
222
+ post_body = @api_client.object_to_http_body(connector)
223
+ auth_names = ['APP_NORMAL', 'OAUTH']
224
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
225
+ :header_params => header_params,
226
+ :query_params => query_params,
227
+ :form_params => form_params,
228
+ :body => post_body,
229
+ :auth_names => auth_names)
230
+ if @api_client.config.debugging
231
+ @api_client.config.logger.debug "API called: ContentConnectorsApi#update_connector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
232
+ end
233
+ return data, status_code, headers
234
+ end
235
+ end
236
+ end
@@ -6,7 +6,7 @@
6
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.12
9
+ Swagger Codegen version: 2.4.27
10
10
 
11
11
  =end
12
12
 
@@ -213,7 +213,7 @@ module RusticiSoftwareCloudV2
213
213
  return data, status_code, headers
214
214
  end
215
215
  # Create a Course from a fetched or referenced external media file
216
- # Creates a course from one of two methods, fetchRequest or mediaFileReferenceRequest. In either case, an import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. - A fetchRequest performs the same actions as CreateFetchAndImportCourseJob. A course will be created from a package fetched from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. - A mediaFileReferenceRequest will not store the file in SCORM Cloud. Instead it will reference the media file at the time the learner needs to view the file from the provided url. >**Note:** >The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes. >**Info:** >Unless working with media files, it is typical to use one of the other two import methods. >- CreateUploadAndImportCourseJob would be used if the course is in your local file system. >- CreateFetchAndImportCourseJob would be better suited for situations where the course is uploaded remotely but is accessible via a public url.
216
+ # Creates a course from one of the following methods: fetchRequest, mediaFileReferenceRequest, or connectorReferenceRequest. In all cases, an import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. - A fetchRequest performs the same actions as CreateFetchAndImportCourseJob. A course will be created from a package fetched from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. - A mediaFileReferenceRequest will not store the file in SCORM Cloud. Instead it will reference the media file at the time the learner needs to view the file from the provided url. - A connectorReferenceRequest is used to import content from an external content connector, for example an LTI 1.3 tool. >**Note:** >The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes. >**Info:** >Unless working with media files, it is typical to use one of the other two import methods. >- CreateUploadAndImportCourseJob would be used if the course is in your local file system. >- CreateFetchAndImportCourseJob would be better suited for situations where the course is uploaded remotely but is accessible via a public url.
217
217
  # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
218
218
  # @param import_request
219
219
  # @param [Hash] opts the optional parameters
@@ -226,7 +226,7 @@ module RusticiSoftwareCloudV2
226
226
  end
227
227
 
228
228
  # Create a Course from a fetched or referenced external media file
229
- # Creates a course from one of two methods, fetchRequest or mediaFileReferenceRequest. In either case, an import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. - A fetchRequest performs the same actions as CreateFetchAndImportCourseJob. A course will be created from a package fetched from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. - A mediaFileReferenceRequest will not store the file in SCORM Cloud. Instead it will reference the media file at the time the learner needs to view the file from the provided url. &gt;**Note:** &gt;The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes. &gt;**Info:** &gt;Unless working with media files, it is typical to use one of the other two import methods. &gt;- CreateUploadAndImportCourseJob would be used if the course is in your local file system. &gt;- CreateFetchAndImportCourseJob would be better suited for situations where the course is uploaded remotely but is accessible via a public url.
229
+ # Creates a course from one of the following methods: fetchRequest, mediaFileReferenceRequest, or connectorReferenceRequest. In all cases, an import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. - A fetchRequest performs the same actions as CreateFetchAndImportCourseJob. A course will be created from a package fetched from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. - A mediaFileReferenceRequest will not store the file in SCORM Cloud. Instead it will reference the media file at the time the learner needs to view the file from the provided url. - A connectorReferenceRequest is used to import content from an external content connector, for example an LTI 1.3 tool. &gt;**Note:** &gt;The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes. &gt;**Info:** &gt;Unless working with media files, it is typical to use one of the other two import methods. &gt;- CreateUploadAndImportCourseJob would be used if the course is in your local file system. &gt;- CreateFetchAndImportCourseJob would be better suited for situations where the course is uploaded remotely but is accessible via a public url.
230
230
  # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
231
231
  # @param import_request
232
232
  # @param [Hash] opts the optional parameters
@@ -1516,6 +1516,60 @@ module RusticiSoftwareCloudV2
1516
1516
  end
1517
1517
  return data, status_code, headers
1518
1518
  end
1519
+ # Download a zip package for a Course
1520
+ # Downloads a zip package for the course. The course zip package contains all of the files (assets) needed for a learner to take the course. The returned zip will contain all of the files orginally uploaded with the course, as well as any modifications made through updating/ adding new assets. >**Info:** >If looking to retrieve a specific file from a course, use `GetCourseAsset` instead.
1521
+ # @param course_id
1522
+ # @param [Hash] opts the optional parameters
1523
+ # @return [File]
1524
+ def get_course_zip(course_id, opts = {})
1525
+ data, _status_code, _headers = get_course_zip_with_http_info(course_id, opts)
1526
+ data
1527
+ end
1528
+
1529
+ # Download a zip package for a Course
1530
+ # Downloads a zip package for the course. The course zip package contains all of the files (assets) needed for a learner to take the course. The returned zip will contain all of the files orginally uploaded with the course, as well as any modifications made through updating/ adding new assets. &gt;**Info:** &gt;If looking to retrieve a specific file from a course, use &#x60;GetCourseAsset&#x60; instead.
1531
+ # @param course_id
1532
+ # @param [Hash] opts the optional parameters
1533
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
1534
+ def get_course_zip_with_http_info(course_id, opts = {})
1535
+ if @api_client.config.debugging
1536
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_zip ...'
1537
+ end
1538
+ # verify the required parameter 'course_id' is set
1539
+ if course_id.nil?
1540
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_zip"
1541
+ end
1542
+ # resource path
1543
+ local_var_path = '/courses/{courseId}/zip'.sub('{' + 'courseId' + '}', course_id.to_s)
1544
+
1545
+ # query parameters
1546
+ query_params = {}
1547
+
1548
+ # header parameters
1549
+ header_params = {}
1550
+ # HTTP header 'Accept' (if needed)
1551
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1552
+ # HTTP header 'Content-Type'
1553
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1554
+
1555
+ # form parameters
1556
+ form_params = {}
1557
+
1558
+ # http body (model)
1559
+ post_body = nil
1560
+ auth_names = ['APP_NORMAL', 'OAUTH']
1561
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1562
+ :header_params => header_params,
1563
+ :query_params => query_params,
1564
+ :form_params => form_params,
1565
+ :body => post_body,
1566
+ :auth_names => auth_names,
1567
+ :return_type => 'File')
1568
+ if @api_client.config.debugging
1569
+ @api_client.config.logger.debug "API called: CourseApi#get_course_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1570
+ end
1571
+ return data, status_code, headers
1572
+ end
1519
1573
  # Get a list of Courses
1520
1574
  # Returns a list of courses. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
1521
1575
  # @param [Hash] opts the optional parameters
@@ -1648,6 +1702,66 @@ module RusticiSoftwareCloudV2
1648
1702
  end
1649
1703
  return data, status_code, headers
1650
1704
  end
1705
+ # Download a zip package for a Course Version
1706
+ # Downloads a zip package for the course version. The course zip package contains all of the files (assets) needed for a learner to take the course. The returned zip will contain all of the files orginally uploaded with the course, as well as any modifications made through updating/ adding new assets. >**Info:** >If looking to retrieve a specific file from a course version, use `GetCourseVersionAsset` instead.
1707
+ # @param course_id
1708
+ # @param version_id
1709
+ # @param [Hash] opts the optional parameters
1710
+ # @return [File]
1711
+ def get_versioned_course_zip(course_id, version_id, opts = {})
1712
+ data, _status_code, _headers = get_versioned_course_zip_with_http_info(course_id, version_id, opts)
1713
+ data
1714
+ end
1715
+
1716
+ # Download a zip package for a Course Version
1717
+ # Downloads a zip package for the course version. The course zip package contains all of the files (assets) needed for a learner to take the course. The returned zip will contain all of the files orginally uploaded with the course, as well as any modifications made through updating/ adding new assets. &gt;**Info:** &gt;If looking to retrieve a specific file from a course version, use &#x60;GetCourseVersionAsset&#x60; instead.
1718
+ # @param course_id
1719
+ # @param version_id
1720
+ # @param [Hash] opts the optional parameters
1721
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
1722
+ def get_versioned_course_zip_with_http_info(course_id, version_id, opts = {})
1723
+ if @api_client.config.debugging
1724
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_versioned_course_zip ...'
1725
+ end
1726
+ # verify the required parameter 'course_id' is set
1727
+ if course_id.nil?
1728
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_versioned_course_zip"
1729
+ end
1730
+ # verify the required parameter 'version_id' is set
1731
+ if version_id.nil?
1732
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_versioned_course_zip"
1733
+ end
1734
+ # resource path
1735
+ local_var_path = '/courses/{courseId}/versions/{versionId}/zip'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1736
+
1737
+ # query parameters
1738
+ query_params = {}
1739
+
1740
+ # header parameters
1741
+ header_params = {}
1742
+ # HTTP header 'Accept' (if needed)
1743
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1744
+ # HTTP header 'Content-Type'
1745
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1746
+
1747
+ # form parameters
1748
+ form_params = {}
1749
+
1750
+ # http body (model)
1751
+ post_body = nil
1752
+ auth_names = ['APP_NORMAL', 'OAUTH']
1753
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1754
+ :header_params => header_params,
1755
+ :query_params => query_params,
1756
+ :form_params => form_params,
1757
+ :body => post_body,
1758
+ :auth_names => auth_names,
1759
+ :return_type => 'File')
1760
+ if @api_client.config.debugging
1761
+ @api_client.config.logger.debug "API called: CourseApi#get_versioned_course_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1762
+ end
1763
+ return data, status_code, headers
1764
+ end
1651
1765
  # Import an asset file for a Course
1652
1766
  # Creates or updates an asset file fetched from the provided url into the course. The file will be downloaded from the url and stored in SCORM Cloud. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
1653
1767
  # @param course_id