rustici_software_cloud_v2 1.0.0beta → 2.0.0

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