feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-f7e741bc6e0175fd96a9db5348092b90a77b0985154c0814bb681ad5dccdf19a.yml
-openapi_spec_hash: b348a9ef407a8e91dd770fcb219d4ac5
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-46ed24a601021d59f2e481c290509da2c05ee7be34eba58448b78b035392cbc4.yml
+openapi_spec_hash: afe19f94bb37ddaf7344fac1b1e64730
 config_hash: 5146b12344dae76238940989dac1e8a0

lib/finch_api/models/jobs/automated_create_response.rb

@@ -11,32 +11,40 @@ class AutomatedCreateResponse < FinchAPI::Internal::Type::BaseModel
         #   @return [Integer]
         required :allowed_refreshes, Integer
 
+        # @!attribute remaining_refreshes
+        #   The number of remaining refreshes available (per hour, fixed window)
+        #
+        #   @return [Integer]
+        required :remaining_refreshes, Integer
+
         # @!attribute job_id
         #   The id of the job that has been created.
         #
-        #   @return [String]
-        required :job_id, String
+        #   @return [String, nil]
+        optional :job_id, String
 
         # @!attribute job_url
         #   The url that can be used to retrieve the job status
         #
-        #   @return [String]
-        required :job_url, String
+        #   @return [String, nil]
+        optional :job_url, String
 
-        # @!attribute remaining_refreshes
-        #   The number of remaining refreshes available (per hour, fixed window)
+        # @!attribute retry_at
+        #   ISO 8601 timestamp indicating when to retry the request
         #
-        #   @return [Integer]
-        required :remaining_refreshes, Integer
+        #   @return [String, nil]
+        optional :retry_at, String
 
-        # @!method initialize(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:)
+        # @!method initialize(allowed_refreshes:, remaining_refreshes:, job_id: nil, job_url: nil, retry_at: nil)
         #   @param allowed_refreshes [Integer] The number of allowed refreshes per hour (per hour, fixed window)
         #
+        #   @param remaining_refreshes [Integer] The number of remaining refreshes available (per hour, fixed window)
+        #
         #   @param job_id [String] The id of the job that has been created.
         #
         #   @param job_url [String] The url that can be used to retrieve the job status
         #
-        #   @param remaining_refreshes [Integer] The number of remaining refreshes available (per hour, fixed window)
+        #   @param retry_at [String] ISO 8601 timestamp indicating when to retry the request
       end
     end
   end

rbi/finch_api/models/jobs/automated_create_response.rbi

@@ -16,45 +16,62 @@ module FinchAPI
         sig { returns(Integer) }
         attr_accessor :allowed_refreshes
 
+        # The number of remaining refreshes available (per hour, fixed window)
+        sig { returns(Integer) }
+        attr_accessor :remaining_refreshes
+
         # The id of the job that has been created.
-        sig { returns(String) }
-        attr_accessor :job_id
+        sig { returns(T.nilable(String)) }
+        attr_reader :job_id
+
+        sig { params(job_id: String).void }
+        attr_writer :job_id
 
         # The url that can be used to retrieve the job status
-        sig { returns(String) }
-        attr_accessor :job_url
+        sig { returns(T.nilable(String)) }
+        attr_reader :job_url
 
-        # The number of remaining refreshes available (per hour, fixed window)
-        sig { returns(Integer) }
-        attr_accessor :remaining_refreshes
+        sig { params(job_url: String).void }
+        attr_writer :job_url
+
+        # ISO 8601 timestamp indicating when to retry the request
+        sig { returns(T.nilable(String)) }
+        attr_reader :retry_at
+
+        sig { params(retry_at: String).void }
+        attr_writer :retry_at
 
         sig do
           params(
             allowed_refreshes: Integer,
+            remaining_refreshes: Integer,
             job_id: String,
             job_url: String,
-            remaining_refreshes: Integer
+            retry_at: String
           ).returns(T.attached_class)
         end
         def self.new(
           # The number of allowed refreshes per hour (per hour, fixed window)
           allowed_refreshes:,
+          # The number of remaining refreshes available (per hour, fixed window)
+          remaining_refreshes:,
           # The id of the job that has been created.
-          job_id:,
+          job_id: nil,
           # The url that can be used to retrieve the job status
-          job_url:,
-          # The number of remaining refreshes available (per hour, fixed window)
-          remaining_refreshes:
+          job_url: nil,
+          # ISO 8601 timestamp indicating when to retry the request
+          retry_at: nil
         )
         end
 
         sig do
           override.returns(
             {
               allowed_refreshes: Integer,
+              remaining_refreshes: Integer,
               job_id: String,
               job_url: String,
-              remaining_refreshes: Integer
+              retry_at: String
             }
           )
         end

sig/finch_api/models/jobs/automated_create_response.rbs

@@ -4,32 +4,43 @@ module FinchAPI
       type automated_create_response =
         {
           allowed_refreshes: Integer,
+          remaining_refreshes: Integer,
           job_id: String,
           job_url: String,
-          remaining_refreshes: Integer
+          retry_at: String
         }
 
       class AutomatedCreateResponse < FinchAPI::Internal::Type::BaseModel
         attr_accessor allowed_refreshes: Integer
 
-        attr_accessor job_id: String
+        attr_accessor remaining_refreshes: Integer
 
-        attr_accessor job_url: String
+        attr_reader job_id: String?
 
-        attr_accessor remaining_refreshes: Integer
+        def job_id=: (String) -> String
+
+        attr_reader job_url: String?
+
+        def job_url=: (String) -> String
+
+        attr_reader retry_at: String?
+
+        def retry_at=: (String) -> String
 
         def initialize: (
           allowed_refreshes: Integer,
-          job_id: String,
-          job_url: String,
-          remaining_refreshes: Integer
+          remaining_refreshes: Integer,
+          ?job_id: String,
+          ?job_url: String,
+          ?retry_at: String
         ) -> void
 
         def to_hash: -> {
           allowed_refreshes: Integer,
+          remaining_refreshes: Integer,
           job_id: String,
           job_url: String,
-          remaining_refreshes: Integer
+          retry_at: String
         }
       end
     end

test/finch_api/resources/jobs/automated_test.rb

@@ -14,9 +14,10 @@ def test_create_required_params
     assert_pattern do
       response => {
         allowed_refreshes: Integer,
-        job_id: String,
-        job_url: String,
-        remaining_refreshes: Integer
+        remaining_refreshes: Integer,
+        job_id: String | nil,
+        job_url: String | nil,
+        retry_at: String | nil
       }
     end
   end