stackone_client 0.5.9 → 0.6.0

data/lib/stack_one/utils/retries.rb

@@ -0,0 +1,95 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday/retry'
+require 'sorbet-runtime'
+
+module StackOne
+  module Utils
+    class BackoffStrategy
+      extend T::Sig
+
+      sig { returns(T.nilable(::Float)) }
+      attr_accessor :exponent
+
+      sig { returns(T.nilable(::Integer)) }
+      attr_accessor :initial_interval
+
+      sig { returns(T.nilable(::Integer)) }
+      attr_accessor :max_elapsed_time
+
+      sig { returns(T.nilable(::Integer)) }
+      attr_accessor :max_interval
+
+      sig do
+        params(
+          exponent: T.nilable(::Float),
+          initial_interval: T.nilable(::Integer),
+          max_elapsed_time: T.nilable(::Integer),
+          max_interval: T.nilable(::Integer)
+        ).void
+      end
+      def initialize(exponent: nil, initial_interval: nil, max_elapsed_time: nil, max_interval: nil)
+        @exponent = T.let(exponent, T.nilable(::Float))
+        @initial_interval = T.let(initial_interval, T.nilable(::Integer))
+        @max_elapsed_time = T.let(max_elapsed_time, T.nilable(::Integer))
+        @max_interval = T.let(max_interval, T.nilable(::Integer))
+      end
+    end
+
+    class RetryConfig
+      extend T::Sig
+
+      sig { returns(T.nilable(BackoffStrategy)) }
+      attr_accessor :backoff
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :retry_connection_errors
+
+      sig { returns(T.nilable(::String)) }
+      attr_accessor :strategy
+
+      sig do
+        params(
+          backoff: T.nilable(BackoffStrategy),
+          retry_connection_errors: T.nilable(T::Boolean),
+          strategy: T.nilable(::String)
+        ).void
+      end
+      def initialize(backoff: nil, retry_connection_errors: nil, strategy: nil)
+        @backoff = T.let(backoff, T.nilable(BackoffStrategy))
+        @retry_connection_errors = T.let(retry_connection_errors, T.nilable(T::Boolean))
+        @strategy = T.let(strategy, T.nilable(::String))
+      end
+
+      sig { params(initial_time: ::Time).returns(::Hash) }
+      def to_faraday_retry_options(initial_time:)
+        retry_options = {
+          # must overwrite default max of 2 retries and it must be positive
+          max: 1_000_000_000,
+          # ensure all HTTP methods are retried, especially via retry_if
+          methods: [],
+        }
+
+        if @retry_connection_errors
+          retry_options[:exceptions] = Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ConnectionFailed]
+        end
+
+        if @strategy == 'backoff' && @backoff
+          retry_options[:backoff_factor] = @backoff.exponent unless @backoff.exponent.nil?
+          retry_options[:interval] = (@backoff.initial_interval.to_f / 1000) unless @backoff.initial_interval.nil?
+          retry_options[:max_interval] = @backoff.max_interval unless @backoff.max_interval.nil?
+
+          unless @backoff.max_elapsed_time.nil?
+            stop_time = initial_time + (@backoff.max_elapsed_time.to_f / 1000)
+            retry_options[:retry_if] = ->(_env, _exc) { Time.now < stop_time }
+          end
+        end
+
+        retry_options
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackone_client
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.6.0
 platform: ruby
 authors:
 - StackOne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.2
+        version: 1.73.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.73.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.60.2
+        version: 0.37.1
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -1008,6 +1036,7 @@ files:
 - lib/stack_one/models/shared/hriscreateemployeerequestdto.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_avatar.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_country.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_employment.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_employment_contract_type.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_employment_status.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_employment_type.rb
@@ -1016,12 +1045,19 @@ files:
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_home_location.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_marital_status.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_national_identity_number.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_pay_frequency.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_pay_period.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_preferred_language.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_country.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_employment_contract_type.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_employment_employment_contract_type_value.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_employment_employment_type_value.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_employment_pay_period_value.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_employment_type.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_employment_type_value.rb
+- lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_employment_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_ethnicity_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_gender_value.rb
-- lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_home_location_state_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_home_location_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_marital_status_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_national_identity_number_type_value.rb
@@ -1029,7 +1065,6 @@ files:
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_preferred_language_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_work_location_country.rb
-- lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_work_location_state_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_schemas_work_location_value.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_state.rb
 - lib/stack_one/models/shared/hriscreateemployeerequestdto_type.rb
@@ -1099,6 +1134,7 @@ files:
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_avatar.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_country.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_employment.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_employment_contract_type.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_employment_status.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_employment_type.rb
@@ -1107,12 +1143,19 @@ files:
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_home_location.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_marital_status.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_national_identity_number.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_pay_frequency.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_pay_period.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_preferred_language.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_country.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_employment_contract_type.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_employment_employment_contract_type_value.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_employment_employment_type_value.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_employment_pay_period_value.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_employment_type.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_employment_type_value.rb
+- lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_employment_value.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_ethnicity_value.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_gender_value.rb
-- lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_home_location_state_value.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_home_location_value.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_marital_status_value.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_national_identity_number_type_value.rb
@@ -1121,7 +1164,6 @@ files:
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_state.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_value.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_work_location_country.rb
-- lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_work_location_state_value.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_schemas_work_location_value.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_state.rb
 - lib/stack_one/models/shared/hrisupdateemployeerequestdto_type.rb
@@ -1412,6 +1454,7 @@ files:
 - lib/stack_one/models/shared/updateemployeeapimodel.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_avatar.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_country.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_employment.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_employment_contract_type.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_employment_status.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_employment_type.rb
@@ -1420,12 +1463,19 @@ files:
 - lib/stack_one/models/shared/updateemployeeapimodel_home_location.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_marital_status.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_national_identity_number.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_pay_frequency.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_pay_period.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_preferred_language.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_country.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_schemas_employment_contract_type.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_schemas_employment_employment_contract_type_value.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_schemas_employment_employment_type_value.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_schemas_employment_pay_period_value.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_schemas_employment_type.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_employment_type_value.rb
+- lib/stack_one/models/shared/updateemployeeapimodel_schemas_employment_value.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_ethnicity_value.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_gender_value.rb
-- lib/stack_one/models/shared/updateemployeeapimodel_schemas_home_location_state_value.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_home_location_value.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_marital_status_value.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_national_identity_number_type_value.rb
@@ -1434,7 +1484,6 @@ files:
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_state.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_value.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_work_location_country.rb
-- lib/stack_one/models/shared/updateemployeeapimodel_schemas_work_location_state_value.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_schemas_work_location_value.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_state.rb
 - lib/stack_one/models/shared/updateemployeeapimodel_type.rb
@@ -1464,6 +1513,7 @@ files:
 - lib/stack_one/proxy.rb
 - lib/stack_one/sdkconfiguration.rb
 - lib/stack_one/stackone.rb
+- lib/stack_one/utils/retries.rb
 - lib/stack_one/utils/utils.rb
 - lib/stackone_client.rb
 homepage: https://github.com/StackOneHQ/stackone-client-ruby.git