feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-828c91953d2351040fdd4d90a3d9eafd09f9d240c4f6ce0441b7a10c06c1c722.yml
-openapi_spec_hash: c82bc88563f80f600e59e22014d4cec4
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-cbce25283cb9c3282e03e08b7ee81395436af7d0eb480ffcbab307b5bf1c92a0.yml
+openapi_spec_hash: c286edf46db95dee05eb6f180ac24ab0
 config_hash: 1f73a949b649ecfe6ec68ba1bb459dc2

lib/orb/models/subscription_change_apply_params.rb

@@ -20,21 +20,47 @@ class SubscriptionChangeApplyParams < Orb::Internal::Type::BaseModel
       #   @return [Boolean, nil]
       optional :mark_as_paid, Orb::Internal::Type::Boolean, nil?: true
 
+      # @!attribute payment_external_id
+      #   An optional external ID to associate with the payment. Only applicable when
+      #   mark_as_paid is true.
+      #
+      #   @return [String, nil]
+      optional :payment_external_id, String, nil?: true
+
+      # @!attribute payment_notes
+      #   Optional notes about the payment. Only applicable when mark_as_paid is true.
+      #
+      #   @return [String, nil]
+      optional :payment_notes, String, nil?: true
+
+      # @!attribute payment_received_date
+      #   A date string to specify the date the payment was received. Only applicable when
+      #   mark_as_paid is true. If not provided, defaults to the current date.
+      #
+      #   @return [Date, nil]
+      optional :payment_received_date, Date, nil?: true
+
       # @!attribute previously_collected_amount
       #   Amount already collected to apply to the customer's balance. If mark_as_paid is
       #   also provided, credit the difference to the customer's balance.
       #
       #   @return [String, nil]
       optional :previously_collected_amount, String, nil?: true
 
-      # @!method initialize(description: nil, mark_as_paid: nil, previously_collected_amount: nil, request_options: {})
+      # @!method initialize(description: nil, mark_as_paid: nil, payment_external_id: nil, payment_notes: nil, payment_received_date: nil, previously_collected_amount: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionChangeApplyParams} for more details.
       #
       #   @param description [String, nil] Description to apply to the balance transaction representing this credit.
       #
       #   @param mark_as_paid [Boolean, nil] Mark all pending invoices that are payable as paid. If amount is also provided,
       #
+      #   @param payment_external_id [String, nil] An optional external ID to associate with the payment. Only applicable when mark
+      #
+      #   @param payment_notes [String, nil] Optional notes about the payment. Only applicable when mark_as_paid is true.
+      #
+      #   @param payment_received_date [Date, nil] A date string to specify the date the payment was received. Only applicable when
+      #
       #   @param previously_collected_amount [String, nil] Amount already collected to apply to the customer's balance. If mark_as_paid is
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

lib/orb/resources/subscription_changes.rb

@@ -37,14 +37,20 @@ def retrieve(subscription_change_id, params = {})
       # is passed with a request to this endpoint, any eligible invoices that were
       # created will be issued immediately if they only contain in-advance fees.
       #
-      # @overload apply(subscription_change_id, description: nil, mark_as_paid: nil, previously_collected_amount: nil, request_options: {})
+      # @overload apply(subscription_change_id, description: nil, mark_as_paid: nil, payment_external_id: nil, payment_notes: nil, payment_received_date: nil, previously_collected_amount: nil, request_options: {})
       #
       # @param subscription_change_id [String]
       #
       # @param description [String, nil] Description to apply to the balance transaction representing this credit.
       #
       # @param mark_as_paid [Boolean, nil] Mark all pending invoices that are payable as paid. If amount is also provided,
       #
+      # @param payment_external_id [String, nil] An optional external ID to associate with the payment. Only applicable when mark
+      #
+      # @param payment_notes [String, nil] Optional notes about the payment. Only applicable when mark_as_paid is true.
+      #
+      # @param payment_received_date [Date, nil] A date string to specify the date the payment was received. Only applicable when
+      #
       # @param previously_collected_amount [String, nil] Amount already collected to apply to the customer's balance. If mark_as_paid is
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]

rbi/orb/models/subscription_change_apply_params.rbi

@@ -20,6 +20,20 @@ module Orb
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :mark_as_paid
 
+      # An optional external ID to associate with the payment. Only applicable when
+      # mark_as_paid is true.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payment_external_id
+
+      # Optional notes about the payment. Only applicable when mark_as_paid is true.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payment_notes
+
+      # A date string to specify the date the payment was received. Only applicable when
+      # mark_as_paid is true. If not provided, defaults to the current date.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :payment_received_date
+
       # Amount already collected to apply to the customer's balance. If mark_as_paid is
       # also provided, credit the difference to the customer's balance.
       sig { returns(T.nilable(String)) }
@@ -29,6 +43,9 @@ module Orb
         params(
           description: T.nilable(String),
           mark_as_paid: T.nilable(T::Boolean),
+          payment_external_id: T.nilable(String),
+          payment_notes: T.nilable(String),
+          payment_received_date: T.nilable(Date),
           previously_collected_amount: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -39,6 +56,14 @@ module Orb
         # Mark all pending invoices that are payable as paid. If amount is also provided,
         # mark as paid and credit the difference to the customer's balance.
         mark_as_paid: nil,
+        # An optional external ID to associate with the payment. Only applicable when
+        # mark_as_paid is true.
+        payment_external_id: nil,
+        # Optional notes about the payment. Only applicable when mark_as_paid is true.
+        payment_notes: nil,
+        # A date string to specify the date the payment was received. Only applicable when
+        # mark_as_paid is true. If not provided, defaults to the current date.
+        payment_received_date: nil,
         # Amount already collected to apply to the customer's balance. If mark_as_paid is
         # also provided, credit the difference to the customer's balance.
         previously_collected_amount: nil,
@@ -51,6 +76,9 @@ module Orb
           {
             description: T.nilable(String),
             mark_as_paid: T.nilable(T::Boolean),
+            payment_external_id: T.nilable(String),
+            payment_notes: T.nilable(String),
+            payment_received_date: T.nilable(Date),
             previously_collected_amount: T.nilable(String),
             request_options: Orb::RequestOptions
           }

rbi/orb/resources/subscription_changes.rbi

@@ -29,6 +29,9 @@ module Orb
           subscription_change_id: String,
           description: T.nilable(String),
           mark_as_paid: T.nilable(T::Boolean),
+          payment_external_id: T.nilable(String),
+          payment_notes: T.nilable(String),
+          payment_received_date: T.nilable(Date),
           previously_collected_amount: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::Models::SubscriptionChangeApplyResponse)
@@ -40,6 +43,14 @@ module Orb
         # Mark all pending invoices that are payable as paid. If amount is also provided,
         # mark as paid and credit the difference to the customer's balance.
         mark_as_paid: nil,
+        # An optional external ID to associate with the payment. Only applicable when
+        # mark_as_paid is true.
+        payment_external_id: nil,
+        # Optional notes about the payment. Only applicable when mark_as_paid is true.
+        payment_notes: nil,
+        # A date string to specify the date the payment was received. Only applicable when
+        # mark_as_paid is true. If not provided, defaults to the current date.
+        payment_received_date: nil,
         # Amount already collected to apply to the customer's balance. If mark_as_paid is
         # also provided, credit the difference to the customer's balance.
         previously_collected_amount: nil,

sig/orb/models/subscription_change_apply_params.rbs

@@ -4,6 +4,9 @@ module Orb
       {
         description: String?,
         mark_as_paid: bool?,
+        payment_external_id: String?,
+        payment_notes: String?,
+        payment_received_date: Date?,
         previously_collected_amount: String?
       }
       & Orb::Internal::Type::request_parameters
@@ -16,18 +19,30 @@ module Orb
 
       attr_accessor mark_as_paid: bool?
 
+      attr_accessor payment_external_id: String?
+
+      attr_accessor payment_notes: String?
+
+      attr_accessor payment_received_date: Date?
+
       attr_accessor previously_collected_amount: String?
 
       def initialize: (
         ?description: String?,
         ?mark_as_paid: bool?,
+        ?payment_external_id: String?,
+        ?payment_notes: String?,
+        ?payment_received_date: Date?,
         ?previously_collected_amount: String?,
         ?request_options: Orb::request_opts
       ) -> void
 
       def to_hash: -> {
         description: String?,
         mark_as_paid: bool?,
+        payment_external_id: String?,
+        payment_notes: String?,
+        payment_received_date: Date?,
         previously_collected_amount: String?,
         request_options: Orb::RequestOptions
       }

sig/orb/resources/subscription_changes.rbs

@@ -10,6 +10,9 @@ module Orb
         String subscription_change_id,
         ?description: String?,
         ?mark_as_paid: bool?,
+        ?payment_external_id: String?,
+        ?payment_notes: String?,
+        ?payment_received_date: Date?,
         ?previously_collected_amount: String?,
         ?request_options: Orb::request_opts
       ) -> Orb::Models::SubscriptionChangeApplyResponse