stackone_client 0.39.0 → 0.39.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc7e76bd7dc74ea2683bd7379e628b4bd11fb26a8b9c3e5ad625413d7bfd1e5
-  data.tar.gz: e1e81b45097cbdcde82412e5960a7e989f2c3eb5c9cb369805ee26186b4a4ad7
+  metadata.gz: a992c451f730ac0df3e0aabc008af24a9e040ef292250db6d2a3f9f26b38e4d5
+  data.tar.gz: 765d8b21d0513f49a6fb393908900478ccbb70478cf09a0c0d0f2ef241a45aeb
 SHA512:
-  metadata.gz: 801aa8f8073144fa8022effa9e81f22ff43eab1d7365abf6ec8302af6436aeca67ee292bd4078e907e5a3f4352d53ae0fe2e833b845d47d7bd892db826abcee0
-  data.tar.gz: 9b27410e7cc3382d0a5a77442379a91467ebd311aacfb65657b4bf5184d3183c99a6e7d5007ea96cf314aec627301dabdcf0a1c77d304ad61f82bb5ac013ec2f
+  metadata.gz: dd49c6b52f19ceb8321f23003bf8a32dbd0cb992781bb8ed987c6f6b8e81934971d14836b19786c867f07c53fda33c14ba315bc14468eb4af41bc0b16147a89d
+  data.tar.gz: 83f6b145946ef52cd167c99eb85a001f9aa8e82df754c63798a27c6a8c6d7640fbff03d468a9a36267ae8e1b73c45a445a9701ea9d33c3a00903d1134f1f7a30

data/lib/stack_one/lms.rb

@@ -42,7 +42,10 @@ module StackOne
 
     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)
-      # batch_upsert_content - Batch Upsert Content
+      # 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. 
+      # 
+      # 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
@@ -345,6 +348,11 @@ module StackOne
     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)
       # 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,
@@ -653,6 +661,9 @@ module StackOne
     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)
       # 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,
@@ -961,6 +972,9 @@ module StackOne
     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)
       # 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,
@@ -1270,6 +1284,11 @@ module StackOne
     sig { params(request: Models::Operations::LmsGetAssignmentRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsGetAssignmentResponse) }
     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)
       url = Utils.generate_url(
@@ -1856,6 +1875,7 @@ module StackOne
     sig { params(request: Models::Operations::LmsGetCompletionRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsGetCompletionResponse) }
     def get_completion(request:, retries: nil, timeout_ms: nil)
       # get_completion - Get Completion
+      # Retrieve a completed learning record 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)
       url = Utils.generate_url(
@@ -2149,6 +2169,11 @@ module StackOne
     sig { params(request: Models::Operations::LmsGetContentRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsGetContentResponse) }
     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)
       url = Utils.generate_url(
@@ -2442,6 +2467,9 @@ module StackOne
     sig { params(request: Models::Operations::LmsGetCourseRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsGetCourseResponse) }
     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)
       url = Utils.generate_url(
@@ -3321,6 +3349,11 @@ module StackOne
     sig { params(request: Models::Operations::LmsGetUserAssignmentRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsGetUserAssignmentResponse) }
     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)
       url = Utils.generate_url(
@@ -3614,6 +3647,9 @@ module StackOne
     sig { params(request: Models::Operations::LmsGetUserCompletionRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsGetUserCompletionResponse) }
     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)
       url = Utils.generate_url(
@@ -3907,6 +3943,11 @@ module StackOne
     sig { params(request: Models::Operations::LmsListAssignmentsRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsListAssignmentsResponse) }
     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)
       url = "#{base_url}/unified/lms/assignments"
@@ -4541,6 +4582,7 @@ module StackOne
     sig { params(request: Models::Operations::LmsListCompletionsRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsListCompletionsResponse) }
     def list_completions(request:, retries: nil, timeout_ms: nil)
       # list_completions - List Completions
+      # Retrieve a list of completed learning records. These are the records of a user completing learning objects.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/unified/lms/completions"
@@ -4857,6 +4899,11 @@ module StackOne
     sig { params(request: Models::Operations::LmsListContentRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsListContentResponse) }
     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)
       url = "#{base_url}/unified/lms/content"
@@ -5173,6 +5220,9 @@ module StackOne
     sig { params(request: Models::Operations::LmsListCoursesRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsListCoursesResponse) }
     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)
       url = "#{base_url}/unified/lms/courses"
@@ -5805,6 +5855,11 @@ module StackOne
     sig { params(request: Models::Operations::LmsListUserAssignmentsRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsListUserAssignmentsResponse) }
     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)
       url = Utils.generate_url(
@@ -6129,6 +6184,9 @@ module StackOne
     sig { params(request: Models::Operations::LmsListUserCompletionsRequest, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsListUserCompletionsResponse) }
     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)
       url = Utils.generate_url(
@@ -6766,7 +6824,10 @@ module StackOne
 
     sig { params(lms_create_content_request_dto: Models::Shared::LmsCreateContentRequestDto, id: ::String, x_account_id: ::String, retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::LmsUpdateContentResponse) }
     def update_content(lms_create_content_request_dto:, id:, x_account_id:, retries: nil, timeout_ms: nil)
-      # update_content - Update Content
+      # update_content - Update External Linking Learning Objects
+      # Update an external linking learning object that redirects users to a provider platform for consumption and progress tracking. 
+      # 
+      # See [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.
       request = Models::Operations::LmsUpdateContentRequest.new(
         lms_create_content_request_dto: lms_create_content_request_dto,
         id: id,
@@ -7074,7 +7135,10 @@ module StackOne
 
     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)
-      # upsert_content - Upsert Content
+      # 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. 
+      # 
+      # 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

data/lib/stack_one/models/shared/createemploymentapimodel.rb

@@ -35,11 +35,11 @@ module StackOne
         field :job_title, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('job_title') } }
         # The currency used for pay
         field :pay_currency, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_currency') } }
-        # The pay frequency
+        # How often the employee is paid
         field :pay_frequency, Crystalline::Nilable.new(Models::Shared::PayFrequency), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_frequency') } }
-        # The pay period
+        # The time period over which the pay rate is calculated
         field :pay_period, Crystalline::Nilable.new(Models::Shared::PayPeriod), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_period') } }
-        # The pay rate for the employee
+        # The amount of compensation for the employee
         field :pay_rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_rate') } }
         # The payroll code of the employee
         field :payroll_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('payroll_code') } }

data/lib/stack_one/models/shared/employment.rb

@@ -57,11 +57,11 @@ module StackOne
         field :manager, Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::EmploymentManagerApiModel)), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('manager') } }
         # The currency used for pay
         field :pay_currency, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_currency') } }
-        # The pay frequency
+        # How often the employee is paid
         field :pay_frequency, Crystalline::Nilable.new(Models::Shared::EmploymentPayFrequency), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_frequency') } }
-        # The pay period
+        # The time period over which the pay rate is calculated
         field :pay_period, Crystalline::Nilable.new(Models::Shared::EmploymentPayPeriod), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_period') } }
-        # The pay rate for the employee
+        # The amount of compensation for the employee
         field :pay_rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_rate') } }
         # The payroll code of the employee
         field :payroll_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('payroll_code') } }

data/lib/stack_one/models/shared/employment_pay_frequency.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay frequency
+      # How often the employee is paid
       class EmploymentPayFrequency
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/employment_pay_period.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay period
+      # The time period over which the pay rate is calculated
       class EmploymentPayPeriod
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/hriscreateemployeerequestdto_employment.rb

@@ -37,11 +37,11 @@ module StackOne
         field :passthrough, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } }
         # The currency used for pay
         field :pay_currency, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_currency') } }
-        # The pay frequency
+        # How often the employee is paid
         field :pay_frequency, Crystalline::Nilable.new(Models::Shared::HrisCreateEmployeeRequestDtoPayFrequency), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_frequency') } }
-        # The pay period
+        # The time period over which the pay rate is calculated
         field :pay_period, Crystalline::Nilable.new(Models::Shared::HrisCreateEmployeeRequestDtoPayPeriod), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_period') } }
-        # The pay rate for the employee
+        # The amount of compensation for the employee
         field :pay_rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_rate') } }
         # The payroll code of the employee
         field :payroll_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('payroll_code') } }

data/lib/stack_one/models/shared/hriscreateemployeerequestdto_pay_frequency.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay frequency
+      # How often the employee is paid
       class HrisCreateEmployeeRequestDtoPayFrequency
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/hriscreateemployeerequestdto_pay_period.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay period
+      # The time period over which the pay rate is calculated
       class HrisCreateEmployeeRequestDtoPayPeriod
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/hriscreateemploymentrequestdto.rb

@@ -37,11 +37,11 @@ module StackOne
         field :passthrough, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } }
         # The currency used for pay
         field :pay_currency, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_currency') } }
-        # The pay frequency
+        # How often the employee is paid
         field :pay_frequency, Crystalline::Nilable.new(Models::Shared::HrisCreateEmploymentRequestDtoPayFrequency), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_frequency') } }
-        # The pay period
+        # The time period over which the pay rate is calculated
         field :pay_period, Crystalline::Nilable.new(Models::Shared::HrisCreateEmploymentRequestDtoPayPeriod), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_period') } }
-        # The pay rate for the employee
+        # The amount of compensation for the employee
         field :pay_rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_rate') } }
         # The payroll code of the employee
         field :payroll_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('payroll_code') } }

data/lib/stack_one/models/shared/hriscreateemploymentrequestdto_pay_frequency.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay frequency
+      # How often the employee is paid
       class HrisCreateEmploymentRequestDtoPayFrequency
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/hriscreateemploymentrequestdto_pay_period.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay period
+      # The time period over which the pay rate is calculated
       class HrisCreateEmploymentRequestDtoPayPeriod
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/hrisupdateemployeerequestdto_employment.rb

@@ -37,11 +37,11 @@ module StackOne
         field :passthrough, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } }
         # The currency used for pay
         field :pay_currency, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_currency') } }
-        # The pay frequency
+        # How often the employee is paid
         field :pay_frequency, Crystalline::Nilable.new(Models::Shared::HrisUpdateEmployeeRequestDtoPayFrequency), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_frequency') } }
-        # The pay period
+        # The time period over which the pay rate is calculated
         field :pay_period, Crystalline::Nilable.new(Models::Shared::HrisUpdateEmployeeRequestDtoPayPeriod), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_period') } }
-        # The pay rate for the employee
+        # The amount of compensation for the employee
         field :pay_rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_rate') } }
         # The payroll code of the employee
         field :payroll_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('payroll_code') } }

data/lib/stack_one/models/shared/hrisupdateemployeerequestdto_pay_frequency.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay frequency
+      # How often the employee is paid
       class HrisUpdateEmployeeRequestDtoPayFrequency
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/hrisupdateemployeerequestdto_pay_period.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay period
+      # The time period over which the pay rate is calculated
       class HrisUpdateEmployeeRequestDtoPayPeriod
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/hrisupdateemploymentrequestdto.rb

@@ -35,11 +35,11 @@ module StackOne
         field :passthrough, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('passthrough') } }
         # The currency used for pay
         field :pay_currency, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_currency') } }
-        # The pay frequency
+        # How often the employee is paid
         field :pay_frequency, Crystalline::Nilable.new(Models::Shared::HrisUpdateEmploymentRequestDtoPayFrequency), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_frequency') } }
-        # The pay period
+        # The time period over which the pay rate is calculated
         field :pay_period, Crystalline::Nilable.new(Models::Shared::HrisUpdateEmploymentRequestDtoPayPeriod), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_period') } }
-        # The pay rate for the employee
+        # The amount of compensation for the employee
         field :pay_rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('pay_rate') } }
         # The payroll code of the employee
         field :payroll_code, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::StackOne::Utils.field_name('payroll_code') } }

data/lib/stack_one/models/shared/hrisupdateemploymentrequestdto_pay_frequency.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay frequency
+      # How often the employee is paid
       class HrisUpdateEmploymentRequestDtoPayFrequency
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/hrisupdateemploymentrequestdto_pay_period.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay period
+      # The time period over which the pay rate is calculated
       class HrisUpdateEmploymentRequestDtoPayPeriod
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/linkedaccount_status.rb

@@ -15,6 +15,9 @@ module StackOne
         enums do
           ACTIVE = new('active')
           INACTIVE = new('inactive')
+          SUSPENDED = new('suspended')
+          ARCHIVED = new('archived')
+          EXPIRED = new('expired')
           ERROR = new('error')
         end
       end

data/lib/stack_one/models/shared/pay_frequency.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay frequency
+      # How often the employee is paid
       class PayFrequency
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/models/shared/pay_period.rb

@@ -8,7 +8,7 @@ module StackOne
   module Models
     module Shared
     
-      # The pay period
+      # The time period over which the pay rate is calculated
       class PayPeriod
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/stack_one/sdkconfiguration.rb

@@ -89,9 +89,9 @@ module StackOne
       end
       @language = 'ruby'
       @openapi_doc_version = '1.0.0'
-      @sdk_version = '0.39.0'
-      @gen_version = '2.745.2'
-      @user_agent = 'speakeasy-sdk/ruby 0.39.0 2.745.2 1.0.0 stackone_client'
+      @sdk_version = '0.39.1'
+      @gen_version = '2.755.6'
+      @user_agent = 'speakeasy-sdk/ruby 0.39.1 2.755.6 1.0.0 stackone_client'
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackone_client
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.39.1
 platform: ruby
 authors:
 - StackOne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-11-10 00:00:00.000000000 Z
+date: 2025-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64