stackone_client 0.39.4 → 0.40.0

data/lib/stack_one/iam.rb

@@ -40,12 +40,13 @@ module StackOne
     end
 
 
-    sig { params(id: ::String, x_account_id: ::String, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::IamDeleteUserResponse) }
-    def delete_user(id:, x_account_id:, retries: nil, timeout_ms: nil)
+    sig { params(id: ::String, x_account_id: ::String, prefer: T.nilable(::String), retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::IamDeleteUserResponse) }
+    def delete_user(id:, x_account_id:, prefer: nil, retries: nil, timeout_ms: nil)
       # delete_user - Delete User
       request = Models::Operations::IamDeleteUserRequest.new(
         id: id,
-        x_account_id: x_account_id
+        x_account_id: x_account_id,
+        prefer: prefer
       )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -1639,6 +1640,7 @@ module StackOne
 
             sdk.list_groups(
               request: Models::Operations::IamListGroupsRequest.new(
+                prefer: request.prefer,
                 expand: request.expand,
                 fields_: request.fields_,
                 filter: request.filter,
@@ -1956,6 +1958,7 @@ module StackOne
 
             sdk.list_policies(
               request: Models::Operations::IamListPoliciesRequest.new(
+                prefer: request.prefer,
                 expand: request.expand,
                 fields_: request.fields_,
                 filter: request.filter,
@@ -2273,6 +2276,7 @@ module StackOne
 
             sdk.list_roles(
               request: Models::Operations::IamListRolesRequest.new(
+                prefer: request.prefer,
                 expand: request.expand,
                 fields_: request.fields_,
                 filter: request.filter,
@@ -2590,6 +2594,7 @@ module StackOne
 
             sdk.list_users(
               request: Models::Operations::IamListUsersRequest.new(
+                prefer: request.prefer,
                 expand: request.expand,
                 fields_: request.fields_,
                 filter: request.filter,
@@ -2788,13 +2793,14 @@ module StackOne
     end
 
 
-    sig { params(iam_update_user_request_dto: Models::Shared::IamUpdateUserRequestDto, id: ::String, x_account_id: ::String, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::IamUpdateUserResponse) }
-    def update_user(iam_update_user_request_dto:, id:, x_account_id:, retries: nil, timeout_ms: nil)
+    sig { params(iam_update_user_request_dto: Models::Shared::IamUpdateUserRequestDto, id: ::String, x_account_id: ::String, prefer: T.nilable(::String), retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::IamUpdateUserResponse) }
+    def update_user(iam_update_user_request_dto:, id:, x_account_id:, prefer: nil, retries: nil, timeout_ms: nil)
       # update_user - Update User
       request = Models::Operations::IamUpdateUserRequest.new(
         iam_update_user_request_dto: iam_update_user_request_dto,
         id: id,
-        x_account_id: x_account_id
+        x_account_id: x_account_id,
+        prefer: prefer
       )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -2810,7 +2816,7 @@ module StackOne
       headers['content-type'] = req_content_type
       raise StandardError, 'request body is required' if data.nil? && form.nil?
 
-      if form
+      if form && !form.empty?
         body = Utils.encode_form(form)
       elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
         body = URI.encode_www_form(T.cast(data, T::Hash[Symbol, Object]))

data/lib/stack_one/lms.rb

@@ -40,17 +40,18 @@ module StackOne
     end
 
 
-    sig { params(lms_batch_upsert_content_request_dto: Models::Shared::LmsBatchUpsertContentRequestDto, x_account_id: ::String, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsBatchUpsertContentResponse) }
-    def batch_upsert_content(lms_batch_upsert_content_request_dto:, x_account_id:, retries: nil, timeout_ms: nil)
+    sig { params(lms_batch_upsert_content_request_dto: Models::Shared::LmsBatchUpsertContentRequestDto, x_account_id: ::String, prefer: T.nilable(::String), retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsBatchUpsertContentResponse) }
+    def batch_upsert_content(lms_batch_upsert_content_request_dto:, x_account_id:, prefer: nil, retries: nil, timeout_ms: nil)
       # batch_upsert_content - Batch Upsert External Linking Learning Objects
       # Batch upsert multiple external linking learning objects that redirect users to a provider platform for consumption and progress tracking. 
-      # 
+      #
       # **Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content. 
-      # 
+      #
       # See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.
       request = Models::Operations::LmsBatchUpsertContentRequest.new(
         lms_batch_upsert_content_request_dto: lms_batch_upsert_content_request_dto,
-        x_account_id: x_account_id
+        x_account_id: x_account_id,
+        prefer: prefer
       )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -61,7 +62,7 @@ module StackOne
       headers['content-type'] = req_content_type
       raise StandardError, 'request body is required' if data.nil? && form.nil?
 
-      if form
+      if form && !form.empty?
         body = Utils.encode_form(form)
       elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
         body = URI.encode_www_form(T.cast(data, T::Hash[Symbol, Object]))
@@ -347,18 +348,19 @@ module StackOne
     end
 
 
-    sig { params(lms_create_assignment_request_dto: Models::Shared::LmsCreateAssignmentRequestDto, id: ::String, x_account_id: ::String, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsCreateUserAssignmentResponse) }
-    def create_user_assignment(lms_create_assignment_request_dto:, id:, x_account_id:, retries: nil, timeout_ms: nil)
+    sig { params(lms_create_assignment_request_dto: Models::Shared::LmsCreateAssignmentRequestDto, id: ::String, x_account_id: ::String, prefer: T.nilable(::String), retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsCreateUserAssignmentResponse) }
+    def create_user_assignment(lms_create_assignment_request_dto:, id:, x_account_id:, prefer: nil, retries: nil, timeout_ms: nil)
       # create_user_assignment - Create User Assignment
       # Create an assignment type learning record for a user. 
-      # 
+      #
       # This is the record linking a user to a learning object. 
-      # 
+      #
       # It can be pending or in progress.
       request = Models::Operations::LmsCreateUserAssignmentRequest.new(
         lms_create_assignment_request_dto: lms_create_assignment_request_dto,
         id: id,
-        x_account_id: x_account_id
+        x_account_id: x_account_id,
+        prefer: prefer
       )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -374,7 +376,7 @@ module StackOne
       headers['content-type'] = req_content_type
       raise StandardError, 'request body is required' if data.nil? && form.nil?
 
-      if form
+      if form && !form.empty?
         body = Utils.encode_form(form)
       elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
         body = URI.encode_www_form(T.cast(data, T::Hash[Symbol, Object]))
@@ -660,16 +662,17 @@ module StackOne
     end
 
 
-    sig { params(lms_create_completion_request_dto: Models::Shared::LmsCreateCompletionRequestDto, id: ::String, x_account_id: ::String, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsCreateUserCompletionResponse) }
-    def create_user_completion(lms_create_completion_request_dto:, id:, x_account_id:, retries: nil, timeout_ms: nil)
+    sig { params(lms_create_completion_request_dto: Models::Shared::LmsCreateCompletionRequestDto, id: ::String, x_account_id: ::String, prefer: T.nilable(::String), retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsCreateUserCompletionResponse) }
+    def create_user_completion(lms_create_completion_request_dto:, id:, x_account_id:, prefer: nil, retries: nil, timeout_ms: nil)
       # create_user_completion - Create User Completion
       # Create a completed learning record for a user. 
-      # 
+      #
       # This is the record of a user completing a learning object.
       request = Models::Operations::LmsCreateUserCompletionRequest.new(
         lms_create_completion_request_dto: lms_create_completion_request_dto,
         id: id,
-        x_account_id: x_account_id
+        x_account_id: x_account_id,
+        prefer: prefer
       )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -685,7 +688,7 @@ module StackOne
       headers['content-type'] = req_content_type
       raise StandardError, 'request body is required' if data.nil? && form.nil?
 
-      if form
+      if form && !form.empty?
         body = Utils.encode_form(form)
       elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
         body = URI.encode_www_form(T.cast(data, T::Hash[Symbol, Object]))
@@ -971,16 +974,17 @@ module StackOne
     end
 
 
-    sig { params(id: ::String, sub_resource_id: ::String, x_account_id: ::String, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsDeleteUserCompletionResponse) }
-    def delete_user_completion(id:, sub_resource_id:, x_account_id:, retries: nil, timeout_ms: nil)
+    sig { params(id: ::String, sub_resource_id: ::String, x_account_id: ::String, prefer: T.nilable(::String), retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsDeleteUserCompletionResponse) }
+    def delete_user_completion(id:, sub_resource_id:, x_account_id:, prefer: nil, retries: nil, timeout_ms: nil)
       # delete_user_completion - Delete User Completion
       # Delete a completion type learning record for a user. 
-      # 
+      #
       # This is a record of a user completing a learning object.
       request = Models::Operations::LmsDeleteUserCompletionRequest.new(
         id: id,
         sub_resource_id: sub_resource_id,
-        x_account_id: x_account_id
+        x_account_id: x_account_id,
+        prefer: prefer
       )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -1287,9 +1291,9 @@ module StackOne
     def get_assignment(request:, retries: nil, timeout_ms: nil)
       # get_assignment - Get Assignment
       # Retrieve an assignment type learning record by its identifier. 
-      # 
+      #
       # This is the record linking a user to a learning object. 
-      # 
+      #
       # It can be pending, in progress, or completed.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -2172,9 +2176,9 @@ module StackOne
     def get_content(request:, retries: nil, timeout_ms: nil)
       # get_content - Get Content
       # Retrieve a content type learning object by its identifier. 
-      # 
+      #
       # These are the most granular learning objects (e.g. video, document, podcast) on a platform. 
-      # 
+      #
       # Only content objects for which the platform supports progress and completion tracking are returned.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -2470,7 +2474,7 @@ module StackOne
     def get_course(request:, retries: nil, timeout_ms: nil)
       # get_course - Get Course
       # Retrieve a course type learning object by its identifier. 
-      # 
+      #
       # These are collections of content type learning objects that are grouped together for a specific learning purpose.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -3352,9 +3356,9 @@ module StackOne
     def get_user_assignment(request:, retries: nil, timeout_ms: nil)
       # get_user_assignment - Get User Assignment
       # Retrieve an assignment type learning record for a user by its identifier. 
-      # 
+      #
       # This is the record linking a user to a learning object. 
-      # 
+      #
       # It can be pending, in progress, or completed.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -3650,7 +3654,7 @@ module StackOne
     def get_user_completion(request:, retries: nil, timeout_ms: nil)
       # get_user_completion - Get User Completion
       # Retrieve a completed learning record for a user by its identifier. 
-      # 
+      #
       # This is the record of a user completing a learning object.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -3946,9 +3950,9 @@ module StackOne
     def list_assignments(request:, retries: nil, timeout_ms: nil)
       # list_assignments - List Assignments
       # Retrieve a list of assignment type learning records. 
-      # 
+      #
       # These are the records linking a user to a learning object. 
-      # 
+      #
       # They can be pending, in progress, or completed.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -4066,6 +4070,7 @@ module StackOne
 
             sdk.list_assignments(
               request: Models::Operations::LmsListAssignmentsRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 next_: next_cursor,
@@ -4384,6 +4389,7 @@ module StackOne
 
             sdk.list_categories(
               request: Models::Operations::LmsListCategoriesRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 next_: next_cursor,
@@ -4701,6 +4707,7 @@ module StackOne
 
             sdk.list_completions(
               request: Models::Operations::LmsListCompletionsRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 next_: next_cursor,
@@ -4902,9 +4909,9 @@ module StackOne
     def list_content(request:, retries: nil, timeout_ms: nil)
       # list_content - List Content
       # Retrieve a list of content type learning objects. 
-      # 
+      #
       # These are the most granular learning objects (e.g. video, document, podcast) on a platform. 
-      # 
+      #
       # Only content objects for which the platform supports progress and completion tracking are returned.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -5022,6 +5029,7 @@ module StackOne
 
             sdk.list_content(
               request: Models::Operations::LmsListContentRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 next_: next_cursor,
@@ -5223,7 +5231,7 @@ module StackOne
     def list_courses(request:, retries: nil, timeout_ms: nil)
       # list_courses - List Courses
       # Retrieve a list of course type learning objects. 
-      # 
+      #
       # These are collections of content type learning objects that are grouped together for a specific learning purpose.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -5341,6 +5349,7 @@ module StackOne
 
             sdk.list_courses(
               request: Models::Operations::LmsListCoursesRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 next_: next_cursor,
@@ -5657,6 +5666,7 @@ module StackOne
 
             sdk.list_skills(
               request: Models::Operations::LmsListSkillsRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 next_: next_cursor,
@@ -5858,9 +5868,9 @@ module StackOne
     def list_user_assignments(request:, retries: nil, timeout_ms: nil)
       # list_user_assignments - List User Assignments
       # Retrieve a list of assignment type learning records for a user. 
-      # 
+      #
       # These are the records linking a user to learning objects. 
-      # 
+      #
       # They can be pending, in progress, or completed.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -5983,6 +5993,7 @@ module StackOne
 
             sdk.list_user_assignments(
               request: Models::Operations::LmsListUserAssignmentsRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 id: request.id,
@@ -6187,7 +6198,7 @@ module StackOne
     def list_user_completions(request:, retries: nil, timeout_ms: nil)
       # list_user_completions - List User Completions
       # Retrieve a list of completed learning records for a user. 
-      # 
+      #
       # These are the records of a user completing learning objects.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -6310,6 +6321,7 @@ module StackOne
 
             sdk.list_user_completions(
               request: Models::Operations::LmsListUserCompletionsRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 id: request.id,
@@ -6627,6 +6639,7 @@ module StackOne
 
             sdk.list_users(
               request: Models::Operations::LmsListUsersRequest.new(
+                prefer: request.prefer,
                 fields_: request.fields_,
                 filter: request.filter,
                 next_: next_cursor,
@@ -6824,17 +6837,18 @@ module StackOne
     end
 
 
-    sig { params(lms_upsert_content_request_dto: Models::Shared::LmsUpsertContentRequestDto, x_account_id: ::String, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsUpsertContentResponse) }
-    def upsert_content(lms_upsert_content_request_dto:, x_account_id:, retries: nil, timeout_ms: nil)
+    sig { params(lms_upsert_content_request_dto: Models::Shared::LmsUpsertContentRequestDto, x_account_id: ::String, prefer: T.nilable(::String), retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsUpsertContentResponse) }
+    def upsert_content(lms_upsert_content_request_dto:, x_account_id:, prefer: nil, retries: nil, timeout_ms: nil)
       # upsert_content - Upsert External Linking Learning Objects
       # Create or update an external linking learning object that redirects users to a provider platform for consumption and progress tracking. 
-      # 
+      #
       # **Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content. 
-      # 
+      #
       # See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.
       request = Models::Operations::LmsUpsertContentRequest.new(
         lms_upsert_content_request_dto: lms_upsert_content_request_dto,
-        x_account_id: x_account_id
+        x_account_id: x_account_id,
+        prefer: prefer
       )
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
@@ -6845,7 +6859,7 @@ module StackOne
       headers['content-type'] = req_content_type
       raise StandardError, 'request body is required' if data.nil? && form.nil?
 
-      if form
+      if form && !form.empty?
         body = Utils.encode_form(form)
       elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
         body = URI.encode_www_form(T.cast(data, T::Hash[Symbol, Object]))