rustici_software_cloud_v2 3.0.0 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +5 -5
  4. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +14 -8
  5. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +2 -2
  6. data/lib/rustici_software_cloud_v2/api_client.rb +1 -1
  7. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +24 -4
  8. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +1 -1
  9. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +24 -4
  10. data/lib/rustici_software_cloud_v2/models/{credential_created_schema.rb → destination_info_id_schema.rb} +9 -39
  11. data/lib/rustici_software_cloud_v2/models/destination_info_list_schema.rb +198 -0
  12. data/lib/rustici_software_cloud_v2/models/destination_info_schema.rb +263 -0
  13. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +4 -14
  14. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +15 -4
  15. data/lib/rustici_software_cloud_v2/models/preview_launch_link_request_schema.rb +239 -0
  16. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +1 -1
  17. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +1 -1
  18. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +3 -3
  19. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +3 -3
  20. data/lib/rustici_software_cloud_v2/version.rb +1 -1
  21. data/lib/rustici_software_cloud_v2.rb +4 -1
  22. metadata +6 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 54fecc8c26cad60fa8de9c4b72b9e18f764afe2e008f70b1a2bac4f18d3a03b4
4
- data.tar.gz: 9b9f5d532fceb6529c8aaefe18b35bb624687a5f6b5506112a26defbfebf0335
3
+ metadata.gz: f8f00a3b60d7d5cfd39d2e4870805a905568fdf6be5c29874f2d2b38a4ea949d
4
+ data.tar.gz: f65fee83e94e509c1b7685687b91c78683e1c54ce4ec78e63351e9299f46f4c8
5
5
  SHA512:
6
- metadata.gz: '039ea224b2d8524a82cb1ed5ceb2c365be1026544d5f1c4ad18fbbbcf5cd247f7d72383ba43d721db5b52ffd35ee2517d372209e6323a65cd2b5603cf5db4a3d'
7
- data.tar.gz: a066a4fc7062393edc41fa7f1758cce899881667d4070c296e6e4dd1b48b0ddbcc8944bd57596fd0bfcbcd67387602cd507fc831c00fd1b3c9d1d93f3ea7e8cb
6
+ metadata.gz: c5179ce45e2b7fec5690dfa9da23d01993905fe1e7df29ae12303d08464923f23ea889dca2b44131fca83ad30ed4690b0da0bbc69108392fd494c96de6a57d63
7
+ data.tar.gz: 62667d1c7740e64361a88f7e3b91fde6d96bd482a9e9bc10a56a4cb1cf4df0821129afe013aa994d52f18c1584296a89a401d04a07bd2ed194d2c95fdbd80e82
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: 3.0.0
10
+ - Package version: 4.0.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-3.0.0.gem
25
+ gem install ./rustici_software_cloud_v2-4.0.0.gem
26
26
  ```
27
- For development, run `gem install --dev ./rustici_software_cloud_v2-3.0.0.gem` to install the development dependencies
27
+ For development, run `gem install --dev ./rustici_software_cloud_v2-4.0.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', '~> 3.0.0'
31
+ gem 'rustici_software_cloud_v2', '~> 4.0.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:
@@ -81,7 +81,7 @@ module RusticiSoftwareCloudV2
81
81
  # @param child_app_id
82
82
  # @param credential_request
83
83
  # @param [Hash] opts the optional parameters
84
- # @return [CredentialCreatedSchema]
84
+ # @return [CredentialSchema]
85
85
  def create_credential(child_app_id, credential_request, opts = {})
86
86
  data, _status_code, _headers = create_credential_with_http_info(child_app_id, credential_request, opts)
87
87
  data
@@ -92,7 +92,7 @@ module RusticiSoftwareCloudV2
92
92
  # @param child_app_id
93
93
  # @param credential_request
94
94
  # @param [Hash] opts the optional parameters
95
- # @return [Array<(CredentialCreatedSchema, Fixnum, Hash)>] CredentialCreatedSchema data, response status code and response headers
95
+ # @return [Array<(CredentialSchema, Fixnum, Hash)>] CredentialSchema data, response status code and response headers
96
96
  def create_credential_with_http_info(child_app_id, credential_request, opts = {})
97
97
  if @api_client.config.debugging
98
98
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_credential ...'
@@ -130,7 +130,7 @@ module RusticiSoftwareCloudV2
130
130
  :form_params => form_params,
131
131
  :body => post_body,
132
132
  :auth_names => auth_names,
133
- :return_type => 'CredentialCreatedSchema')
133
+ :return_type => 'CredentialSchema')
134
134
  if @api_client.config.debugging
135
135
  @api_client.config.logger.debug "API called: ApplicationManagementApi#create_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
136
  end
@@ -537,7 +537,7 @@ module RusticiSoftwareCloudV2
537
537
  deprecate :get_application_list_with_http_info, 'GetApplicationsWithHttpInfo', 0, 0
538
538
 
539
539
  # Use the Application Management App to get a detailed list of Applications
540
- # Returns a list of applications. Can be filtered using the request parameters to provide a subset of results. This endpoint caches the course and registration counts of an application for 24 hours if either `includeCourseCount` or `includeRegistrationCount` parameters, respectively, are set to `true`. Since these values are cached for an extended period, any changes made to the number of courses or registrations in an application will not be reflected in the results of this endpoint until the caching period has passed. >**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. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. >**Info:** >If you want to get an up-to-date value of the course or registration count for a single application within the caching period, use the GetApplicationInfo endpoint with `includeCourseCount` and/or `includeRegistrationCount` set to `true`. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
540
+ # Returns a list of applications. 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. >**Note:** >Each Realm has a special application called the **Application Management Application**. When using this special application's credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn't a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. >**Info:** >This endpoint caches the course and registration counts of an application for 24 hours if either `includeCourseCount` or `includeRegistrationCount` parameters, respectively, are set to `true`. Since these values are cached for an extended period, any changes made to the number of courses or registrations in an application will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the course or registration count for a single application within the caching period, use the GetApplicationInfo endpoint with `includeCourseCount` and/or `includeRegistrationCount` set to `true`. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
541
541
  # @param [Hash] opts the optional parameters
542
542
  # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
543
543
  # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
@@ -556,7 +556,7 @@ module RusticiSoftwareCloudV2
556
556
  end
557
557
 
558
558
  # Use the Application Management App to get a detailed list of Applications
559
- # Returns a list of applications. Can be filtered using the request parameters to provide a subset of results. This endpoint caches the course and registration counts of an application for 24 hours if either &#x60;includeCourseCount&#x60; or &#x60;includeRegistrationCount&#x60; parameters, respectively, are set to &#x60;true&#x60;. Since these values are cached for an extended period, any changes made to the number of courses or registrations in an application will not be reflected in the results of this endpoint until the caching period has passed. &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. &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. &gt;**Info:** &gt;If you want to get an up-to-date value of the course or registration count for a single application within the caching period, use the GetApplicationInfo endpoint with &#x60;includeCourseCount&#x60; and/or &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
559
+ # Returns a list of applications. 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. &gt;**Note:** &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource. &gt;**Info:** &gt;This endpoint caches the course and registration counts of an application for 24 hours if either &#x60;includeCourseCount&#x60; or &#x60;includeRegistrationCount&#x60; parameters, respectively, are set to &#x60;true&#x60;. Since these values are cached for an extended period, any changes made to the number of courses or registrations in an application will not be reflected in the results of this endpoint until the caching period has passed. &gt;If you want to get an up-to-date value of the course or registration count for a single application within the caching period, use the GetApplicationInfo endpoint with &#x60;includeCourseCount&#x60; and/or &#x60;includeRegistrationCount&#x60; set to &#x60;true&#x60;. GetApplicationInfo *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that application.
560
560
  # @param [Hash] opts the optional parameters
561
561
  # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
562
562
  # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
@@ -598,7 +598,8 @@ module RusticiSoftwareCloudV2
598
598
  # Returns detailed information about the destination. This includes name, tags, and launchAuth information.
599
599
  # @param destination_id Identifier for the destination
600
600
  # @param [Hash] opts the optional parameters
601
- # @return [DestinationSchema]
601
+ # @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for the destination. (default to false)
602
+ # @return [DestinationInfoSchema]
602
603
  def get_destination(destination_id, opts = {})
603
604
  data, _status_code, _headers = get_destination_with_http_info(destination_id, opts)
604
605
  data
@@ -608,7 +609,8 @@ module RusticiSoftwareCloudV2
608
609
  # Returns detailed information about the destination. This includes name, tags, and launchAuth information.
609
610
  # @param destination_id Identifier for the destination
610
611
  # @param [Hash] opts the optional parameters
611
- # @return [Array<(DestinationSchema, Fixnum, Hash)>] DestinationSchema data, response status code and response headers
612
+ # @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for the destination.
613
+ # @return [Array<(DestinationInfoSchema, Fixnum, Hash)>] DestinationInfoSchema data, response status code and response headers
612
614
  def get_destination_with_http_info(destination_id, opts = {})
613
615
  if @api_client.config.debugging
614
616
  @api_client.config.logger.debug 'Calling API: DispatchApi.get_destination ...'
@@ -622,6 +624,7 @@ module RusticiSoftwareCloudV2
622
624
 
623
625
  # query parameters
624
626
  query_params = {}
627
+ query_params[:'includeDispatchCount'] = opts[:'include_dispatch_count'] if !opts[:'include_dispatch_count'].nil?
625
628
 
626
629
  # header parameters
627
630
  header_params = {}
@@ -642,7 +645,7 @@ module RusticiSoftwareCloudV2
642
645
  :form_params => form_params,
643
646
  :body => post_body,
644
647
  :auth_names => auth_names,
645
- :return_type => 'DestinationSchema')
648
+ :return_type => 'DestinationInfoSchema')
646
649
  if @api_client.config.debugging
647
650
  @api_client.config.logger.debug "API called: DispatchApi#get_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
648
651
  end
@@ -964,7 +967,7 @@ module RusticiSoftwareCloudV2
964
967
  end
965
968
 
966
969
  # Get a list of Destinations
967
- # Returns a list of destinations. 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.
970
+ # Returns a list of destinations. 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. >**Info:** >This endpoint caches the dispatch count of a destination for 24 hours if the `includeDispatchCount` parameter is set to `true`. Since this value is cached for an extended period, any changes made to the number of dispatches for a destination will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the dispatch count for a single destination within the caching period, use the GetDestination endpoint with `includeDispatchCount` set to `true`. GetDestination *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that destination.
968
971
  # @param [Hash] opts the optional parameters
969
972
  # @option opts [String] :course_id Only retrieve resources having &#x60;courseId&#x60;
970
973
  # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
@@ -975,15 +978,16 @@ module RusticiSoftwareCloudV2
975
978
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to destination_id)
976
979
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
977
980
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
981
+ # @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for each destination. (default to false)
978
982
  # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)
979
- # @return [DestinationListSchema]
983
+ # @return [DestinationInfoListSchema]
980
984
  def get_destinations(opts = {})
981
985
  data, _status_code, _headers = get_destinations_with_http_info(opts)
982
986
  data
983
987
  end
984
988
 
985
989
  # Get a list of Destinations
986
- # Returns a list of destinations. 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.
990
+ # Returns a list of destinations. 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. &gt;**Info:** &gt;This endpoint caches the dispatch count of a destination for 24 hours if the &#x60;includeDispatchCount&#x60; parameter is set to &#x60;true&#x60;. Since this value is cached for an extended period, any changes made to the number of dispatches for a destination will not be reflected in the results of this endpoint until the caching period has passed. &gt;If you want to get an up-to-date value of the dispatch count for a single destination within the caching period, use the GetDestination endpoint with &#x60;includeDispatchCount&#x60; set to &#x60;true&#x60;. GetDestination *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that destination.
987
991
  # @param [Hash] opts the optional parameters
988
992
  # @option opts [String] :course_id Only retrieve resources having &#x60;courseId&#x60;
989
993
  # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
@@ -994,8 +998,9 @@ module RusticiSoftwareCloudV2
994
998
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
995
999
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
996
1000
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1001
+ # @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for each destination.
997
1002
  # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.
998
- # @return [Array<(DestinationListSchema, Fixnum, Hash)>] DestinationListSchema data, response status code and response headers
1003
+ # @return [Array<(DestinationInfoListSchema, Fixnum, Hash)>] DestinationInfoListSchema data, response status code and response headers
999
1004
  def get_destinations_with_http_info(opts = {})
1000
1005
  if @api_client.config.debugging
1001
1006
  @api_client.config.logger.debug 'Calling API: DispatchApi.get_destinations ...'
@@ -1014,6 +1019,7 @@ module RusticiSoftwareCloudV2
1014
1019
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
1015
1020
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1016
1021
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1022
+ query_params[:'includeDispatchCount'] = opts[:'include_dispatch_count'] if !opts[:'include_dispatch_count'].nil?
1017
1023
  query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
1018
1024
 
1019
1025
  # header parameters
@@ -1035,7 +1041,7 @@ module RusticiSoftwareCloudV2
1035
1041
  :form_params => form_params,
1036
1042
  :body => post_body,
1037
1043
  :auth_names => auth_names,
1038
- :return_type => 'DestinationListSchema')
1044
+ :return_type => 'DestinationInfoListSchema')
1039
1045
  if @api_client.config.debugging
1040
1046
  @api_client.config.logger.debug "API called: DispatchApi#get_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1041
1047
  end
@@ -22,7 +22,7 @@ module RusticiSoftwareCloudV2
22
22
  extend Gem::Deprecate
23
23
 
24
24
  # Create a Private Invitation to a Course
25
- # 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.
25
+ # 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. >**Note:** >The behavior of a private invitation request sent to a learner who has already been sent an invitation to the course can be specified with the `duplicateRegistrationOption` parameter. The available options are: >- `FAIL`: Do not send an invitation to any learners who have already received an invitation to the course. Use this option when a list of emails might contain learners who have and have not received an invitation and you only want to send the invitation to the learners who have not yet received an invitation. >- `INSTANCE_EXISTING`: Send an invitation to all learners in the list. For learners who have previously been sent an invitation, instance their existing registration. Use this option to force the learner to start the course from the beginning, regardless if they have taken the course in the past. Results from all instances of a registration can be fetched <a href=\\\"https://cloud.scorm.com/docs/v2/reference/swagger/#/registration/GetRegistrationInstances\\\">here</a> >- `SEND_EXISTING`: For any learners who have previously been sent an invitation to the course, use the existing registration on the previous invitation. Use this if you want to remind a learner to take their course or continue their existing course. >- `CREATE_NEW`: For any learners who have previously been sent an invitation to the course, create a new registration for the learner. Use this if you'd like to have simultaneous records of the same user to one course.
26
26
  # @param private_invitation_request
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @return [InvitationSummarySchema]
@@ -32,7 +32,7 @@ module RusticiSoftwareCloudV2
32
32
  end
33
33
 
34
34
  # Create a Private Invitation to a Course
35
- # 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. &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.
35
+ # 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. &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. &gt;**Note:** &gt;The behavior of a private invitation request sent to a learner who has already been sent an invitation to the course can be specified with the &#x60;duplicateRegistrationOption&#x60; parameter. The available options are: &gt;- &#x60;FAIL&#x60;: Do not send an invitation to any learners who have already received an invitation to the course. Use this option when a list of emails might contain learners who have and have not received an invitation and you only want to send the invitation to the learners who have not yet received an invitation. &gt;- &#x60;INSTANCE_EXISTING&#x60;: Send an invitation to all learners in the list. For learners who have previously been sent an invitation, instance their existing registration. Use this option to force the learner to start the course from the beginning, regardless if they have taken the course in the past. Results from all instances of a registration can be fetched &lt;a href&#x3D;\\\&quot;https://cloud.scorm.com/docs/v2/reference/swagger/#/registration/GetRegistrationInstances\\\&quot;&gt;here&lt;/a&gt; &gt;- &#x60;SEND_EXISTING&#x60;: For any learners who have previously been sent an invitation to the course, use the existing registration on the previous invitation. Use this if you want to remind a learner to take their course or continue their existing course. &gt;- &#x60;CREATE_NEW&#x60;: For any learners who have previously been sent an invitation to the course, create a new registration for the learner. Use this if you&#39;d like to have simultaneous records of the same user to one course.
36
36
  # @param private_invitation_request
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [Array<(InvitationSummarySchema, Fixnum, Hash)>] InvitationSummarySchema data, response status code and response headers
@@ -30,7 +30,7 @@ module RusticiSoftwareCloudV2
30
30
  # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
31
31
  def initialize(config = Configuration.default)
32
32
  @config = config
33
- @user_agent = "Swagger-Codegen/3.0.0/ruby"
33
+ @user_agent = "Swagger-Codegen/4.0.0/ruby"
34
34
  @default_headers = {
35
35
  'Content-Type' => 'application/json',
36
36
  'User-Agent' => @user_agent
@@ -31,6 +31,9 @@ module RusticiSoftwareCloudV2
31
31
  # Optional tags to be applied to this invitation.
32
32
  attr_accessor :tags
33
33
 
34
+ # Represents the possible values that determine how existing registrations will be handled when an invitation is sent to an email address that has already received an invitation: - `FAIL`: Do not create a new invitation, do not send an email, and do nothing with registrations - `INSTANCE_EXISTING`: Create a new instance of the existing registration and send it with the invitation - `SEND_EXISTING`: Re-send the existing registration with the new invitation - `CREATE_NEW`: Create a new registration for the invitation
35
+ attr_accessor :duplicate_registration_option
36
+
34
37
  # Attribute mapping from ruby-style variable name to JSON key.
35
38
  def self.attribute_map
36
39
  {
@@ -39,7 +42,8 @@ module RusticiSoftwareCloudV2
39
42
  :'invitation_email' => :'invitationEmail',
40
43
  :'post_back' => :'postBack',
41
44
  :'expiration_date' => :'expirationDate',
42
- :'tags' => :'tags'
45
+ :'tags' => :'tags',
46
+ :'duplicate_registration_option' => :'duplicateRegistrationOption'
43
47
  }
44
48
  end
45
49
 
@@ -51,7 +55,8 @@ module RusticiSoftwareCloudV2
51
55
  :'invitation_email' => :'InvitationEmailSchema',
52
56
  :'post_back' => :'PostBackSchema',
53
57
  :'expiration_date' => :'DateTime',
54
- :'tags' => :'Array<String>'
58
+ :'tags' => :'Array<String>',
59
+ :'duplicate_registration_option' => :'String'
55
60
  }
56
61
  end
57
62
 
@@ -88,6 +93,12 @@ module RusticiSoftwareCloudV2
88
93
  self.tags = value
89
94
  end
90
95
  end
96
+
97
+ if attributes.has_key?(:'duplicateRegistrationOption')
98
+ self.duplicate_registration_option = attributes[:'duplicateRegistrationOption']
99
+ else
100
+ self.duplicate_registration_option = 'SEND_EXISTING'
101
+ end
91
102
  end
92
103
 
93
104
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -118,6 +129,14 @@ module RusticiSoftwareCloudV2
118
129
  true
119
130
  end
120
131
 
132
+ # Custom attribute writer method checking allowed values (enum).
133
+ #
134
+ # allowable_values = ['FAIL', 'INSTANCE_EXISTING', 'SEND_EXISTING', 'CREATE_NEW']
135
+ #
136
+ # @param [Object] duplicate_registration_option Object to be assigned
137
+ def duplicate_registration_option=(duplicate_registration_option)
138
+ @duplicate_registration_option = duplicate_registration_option
139
+ end
121
140
 
122
141
  # Checks equality by comparing each attribute.
123
142
  # @param [Object] Object to be compared
@@ -129,7 +148,8 @@ module RusticiSoftwareCloudV2
129
148
  invitation_email == o.invitation_email &&
130
149
  post_back == o.post_back &&
131
150
  expiration_date == o.expiration_date &&
132
- tags == o.tags
151
+ tags == o.tags &&
152
+ duplicate_registration_option == o.duplicate_registration_option
133
153
  end
134
154
 
135
155
  # @see the `==` method
@@ -141,7 +161,7 @@ module RusticiSoftwareCloudV2
141
161
  # Calculates hash code according to all attributes.
142
162
  # @return [Fixnum] Hash code
143
163
  def hash
144
- [course_id, creating_user_email, invitation_email, post_back, expiration_date, tags].hash
164
+ [course_id, creating_user_email, invitation_email, post_back, expiration_date, tags, duplicate_registration_option].hash
145
165
  end
146
166
 
147
167
  # Builds the object from hash
@@ -20,7 +20,7 @@ module RusticiSoftwareCloudV2
20
20
  # The email of the user who is creating the invitation.
21
21
  attr_accessor :creating_user_email
22
22
 
23
- # Integer value that limits the amount of registrations a public invitation can generate.
23
+ # Integer value that represents the maximum number of registrations that can be created for a public invitation. Setting this value to '0' allows an unlimited amount of registrations to be created for the invitation.
24
24
  attr_accessor :registration_cap
25
25
 
26
26
  # Specifies a URL for which to post activity and status data in real time as the course is completed
@@ -28,6 +28,12 @@ module RusticiSoftwareCloudV2
28
28
 
29
29
  attr_accessor :status
30
30
 
31
+ # The time the API credential was created in UTC
32
+ attr_accessor :created
33
+
34
+ # The time the API credential was last updated in UTC
35
+ attr_accessor :updated
36
+
31
37
  # Attribute mapping from ruby-style variable name to JSON key.
32
38
  def self.attribute_map
33
39
  {
@@ -35,7 +41,9 @@ module RusticiSoftwareCloudV2
35
41
  :'name' => :'name',
36
42
  :'credential' => :'credential',
37
43
  :'pens_credential' => :'pensCredential',
38
- :'status' => :'status'
44
+ :'status' => :'status',
45
+ :'created' => :'created',
46
+ :'updated' => :'updated'
39
47
  }
40
48
  end
41
49
 
@@ -46,7 +54,9 @@ module RusticiSoftwareCloudV2
46
54
  :'name' => :'String',
47
55
  :'credential' => :'String',
48
56
  :'pens_credential' => :'String',
49
- :'status' => :'String'
57
+ :'status' => :'String',
58
+ :'created' => :'DateTime',
59
+ :'updated' => :'DateTime'
50
60
  }
51
61
  end
52
62
 
@@ -77,6 +87,14 @@ module RusticiSoftwareCloudV2
77
87
  if attributes.has_key?(:'status')
78
88
  self.status = attributes[:'status']
79
89
  end
90
+
91
+ if attributes.has_key?(:'created')
92
+ self.created = attributes[:'created']
93
+ end
94
+
95
+ if attributes.has_key?(:'updated')
96
+ self.updated = attributes[:'updated']
97
+ end
80
98
  end
81
99
 
82
100
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -102,7 +120,9 @@ module RusticiSoftwareCloudV2
102
120
  name == o.name &&
103
121
  credential == o.credential &&
104
122
  pens_credential == o.pens_credential &&
105
- status == o.status
123
+ status == o.status &&
124
+ created == o.created &&
125
+ updated == o.updated
106
126
  end
107
127
 
108
128
  # @see the `==` method
@@ -114,7 +134,7 @@ module RusticiSoftwareCloudV2
114
134
  # Calculates hash code according to all attributes.
115
135
  # @return [Fixnum] Hash code
116
136
  def hash
117
- [id, name, credential, pens_credential, status].hash
137
+ [id, name, credential, pens_credential, status, created, updated].hash
118
138
  end
119
139
 
120
140
  # Builds the object from hash
@@ -13,29 +13,17 @@ require 'date'
13
13
 
14
14
 
15
15
  module RusticiSoftwareCloudV2
16
- class CredentialCreatedSchema
17
- # id for this credential
16
+ class DestinationInfoIdSchema
17
+ #
18
18
  attr_accessor :id
19
19
 
20
- # name for this credential
21
- attr_accessor :name
22
-
23
- # The newly created API credential
24
- attr_accessor :credential
25
-
26
- # The PENS key for this credential
27
- attr_accessor :pens_credential
28
-
29
- attr_accessor :status
20
+ attr_accessor :data
30
21
 
31
22
  # Attribute mapping from ruby-style variable name to JSON key.
32
23
  def self.attribute_map
33
24
  {
34
25
  :'id' => :'id',
35
- :'name' => :'name',
36
- :'credential' => :'credential',
37
- :'pens_credential' => :'pensCredential',
38
- :'status' => :'status'
26
+ :'data' => :'data'
39
27
  }
40
28
  end
41
29
 
@@ -43,10 +31,7 @@ module RusticiSoftwareCloudV2
43
31
  def self.swagger_types
44
32
  {
45
33
  :'id' => :'String',
46
- :'name' => :'String',
47
- :'credential' => :'String',
48
- :'pens_credential' => :'String',
49
- :'status' => :'String'
34
+ :'data' => :'DestinationInfoSchema'
50
35
  }
51
36
  end
52
37
 
@@ -62,20 +47,8 @@ module RusticiSoftwareCloudV2
62
47
  self.id = attributes[:'id']
63
48
  end
64
49
 
65
- if attributes.has_key?(:'name')
66
- self.name = attributes[:'name']
67
- end
68
-
69
- if attributes.has_key?(:'credential')
70
- self.credential = attributes[:'credential']
71
- end
72
-
73
- if attributes.has_key?(:'pensCredential')
74
- self.pens_credential = attributes[:'pensCredential']
75
- end
76
-
77
- if attributes.has_key?(:'status')
78
- self.status = attributes[:'status']
50
+ if attributes.has_key?(:'data')
51
+ self.data = attributes[:'data']
79
52
  end
80
53
  end
81
54
 
@@ -99,10 +72,7 @@ module RusticiSoftwareCloudV2
99
72
  return true if self.equal?(o)
100
73
  self.class == o.class &&
101
74
  id == o.id &&
102
- name == o.name &&
103
- credential == o.credential &&
104
- pens_credential == o.pens_credential &&
105
- status == o.status
75
+ data == o.data
106
76
  end
107
77
 
108
78
  # @see the `==` method
@@ -114,7 +84,7 @@ module RusticiSoftwareCloudV2
114
84
  # Calculates hash code according to all attributes.
115
85
  # @return [Fixnum] Hash code
116
86
  def hash
117
- [id, name, credential, pens_credential, status].hash
87
+ [id, data].hash
118
88
  end
119
89
 
120
90
  # Builds the object from hash