orb-billing 1.43.0 → 1.44.0

data/rbi/orb/models/plan_edited_webhook_event.rbi

@@ -0,0 +1,259 @@
+# typed: strong
+
+module Orb
+  module Models
+    class PlanEditedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::PlanEditedWebhookEvent, Orb::Internal::AnyHash)
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The time at which this event was created, to the second.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      # subscribed to by a customer. Plans define the billing behavior of the
+      # subscription. You can see more about how to configure prices in the
+      # [Price resource](/reference/price).
+      sig { returns(Orb::Plan) }
+      attr_reader :plan
+
+      sig { params(plan: Orb::Plan::OrHash).void }
+      attr_writer :plan
+
+      sig { returns(Orb::PlanEditedWebhookEvent::Properties) }
+      attr_reader :properties
+
+      sig do
+        params(properties: Orb::PlanEditedWebhookEvent::Properties::OrHash).void
+      end
+      attr_writer :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::PlanEditedWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when a plan's name, description, external plan ID, metadata or status is
+      # edited.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          plan: Orb::Plan::OrHash,
+          properties: Orb::PlanEditedWebhookEvent::Properties::OrHash,
+          type: Orb::PlanEditedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of this webhook event.
+        id:,
+        # The time at which this event was created, to the second.
+        created_at:,
+        # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+        # subscribed to by a customer. Plans define the billing behavior of the
+        # subscription. You can see more about how to configure prices in the
+        # [Price resource](/reference/price).
+        plan:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            plan: Orb::Plan,
+            properties: Orb::PlanEditedWebhookEvent::Properties,
+            type: Orb::PlanEditedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Properties < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::PlanEditedWebhookEvent::Properties,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # metadata values are non-null on the wire, as on the price event.
+        sig do
+          returns(Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes)
+        end
+        attr_reader :previous_attributes
+
+        sig do
+          params(
+            previous_attributes:
+              Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::OrHash
+          ).void
+        end
+        attr_writer :previous_attributes
+
+        sig do
+          params(
+            previous_attributes:
+              Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # metadata values are non-null on the wire, as on the price event.
+          previous_attributes:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              previous_attributes:
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class PreviousAttributes < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :external_plan_id
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_accessor :metadata
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          sig do
+            returns(
+              T.nilable(
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :status
+
+          # metadata values are non-null on the wire, as on the price event.
+          sig do
+            params(
+              description: T.nilable(String),
+              external_plan_id: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              name: T.nilable(String),
+              status:
+                T.nilable(
+                  Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::OrSymbol
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            description: nil,
+            external_plan_id: nil,
+            metadata: nil,
+            name: nil,
+            status: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                description: T.nilable(String),
+                external_plan_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, String]),
+                name: T.nilable(String),
+                status:
+                  T.nilable(
+                    Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Status
+            extend Orb::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ACTIVE =
+              T.let(
+                :active,
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+              )
+            ARCHIVED =
+              T.let(
+                :archived,
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+              )
+            DRAFT =
+              T.let(
+                :draft,
+                Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::PlanEditedWebhookEvent::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PLAN_EDITED =
+          T.let(:"plan.edited", Orb::PlanEditedWebhookEvent::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Orb::PlanEditedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/tax_amount.rbi

@@ -17,11 +17,17 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :tax_rate_percentage
 
+      # Why this tax was or was not charged, such as reverse_charge or customer_exempt.
+      # Null on tax calculated before reasons were recorded.
+      sig { returns(T.nilable(Orb::TaxAmount::TaxReason::TaggedSymbol)) }
+      attr_accessor :tax_reason
+
       sig do
         params(
           amount: String,
           tax_rate_description: String,
-          tax_rate_percentage: T.nilable(String)
+          tax_rate_percentage: T.nilable(String),
+          tax_reason: T.nilable(Orb::TaxAmount::TaxReason::OrSymbol)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -30,7 +36,10 @@ module Orb
         # The human-readable description of the applied tax rate.
         tax_rate_description:,
         # The tax rate percentage, out of 100.
-        tax_rate_percentage:
+        tax_rate_percentage:,
+        # Why this tax was or was not charged, such as reverse_charge or customer_exempt.
+        # Null on tax calculated before reasons were recorded.
+        tax_reason: nil
       )
       end
 
@@ -39,12 +48,41 @@ module Orb
           {
             amount: String,
             tax_rate_description: String,
-            tax_rate_percentage: T.nilable(String)
+            tax_rate_percentage: T.nilable(String),
+            tax_reason: T.nilable(Orb::TaxAmount::TaxReason::TaggedSymbol)
           }
         )
       end
       def to_hash
       end
+
+      # Why this tax was or was not charged, such as reverse_charge or customer_exempt.
+      # Null on tax calculated before reasons were recorded.
+      module TaxReason
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Orb::TaxAmount::TaxReason) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TAXED = T.let(:taxed, Orb::TaxAmount::TaxReason::TaggedSymbol)
+        REVERSE_CHARGE =
+          T.let(:reverse_charge, Orb::TaxAmount::TaxReason::TaggedSymbol)
+        CUSTOMER_EXEMPT =
+          T.let(:customer_exempt, Orb::TaxAmount::TaxReason::TaggedSymbol)
+        PRODUCT_EXEMPT =
+          T.let(:product_exempt, Orb::TaxAmount::TaxReason::TaggedSymbol)
+        NOT_REGISTERED =
+          T.let(:not_registered, Orb::TaxAmount::TaxReason::TaggedSymbol)
+        ZERO_RATED = T.let(:zero_rated, Orb::TaxAmount::TaxReason::TaggedSymbol)
+        NOT_TAXED_OTHER =
+          T.let(:not_taxed_other, Orb::TaxAmount::TaxReason::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Orb::TaxAmount::TaxReason::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/orb/models/unwrap_webhook_event.rbi

@@ -58,7 +58,9 @@ module Orb
             Orb::MetricEventsDroppedByWatermarkWebhookEvent,
             Orb::PaymentMethodCreatedWebhookEvent,
             Orb::PaymentMethodDeletedWebhookEvent,
+            Orb::PlanCreatedWebhookEvent,
             Orb::PlanDefaultVersionSetWebhookEvent,
+            Orb::PlanEditedWebhookEvent,
             Orb::PlanVersionCreatedWebhookEvent,
             Orb::PriceEditedWebhookEvent,
             Orb::ResourceEventTestWebhookEvent,

data/rbi/orb/models/webhook_endpoint.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpoint < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Orb::WebhookEndpoint, Orb::Internal::AnyHash) }
+
+      # The Orb-assigned unique identifier for the webhook endpoint.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The time the webhook endpoint was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Whether Orb sends webhook events to this endpoint.
+      sig { returns(T::Boolean) }
+      attr_accessor :enabled
+
+      # The webhook event types sent to this endpoint. If null, all event types are
+      # sent.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :enabled_event_types
+
+      # The HTTPS URL that Orb sends webhook events to.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # A webhook endpoint is an HTTPS URL that Orb sends
+      # [webhook events](/integrations-and-exports/webhooks) to.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          enabled: T::Boolean,
+          enabled_event_types: T.nilable(T::Array[String]),
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Orb-assigned unique identifier for the webhook endpoint.
+        id:,
+        # The time the webhook endpoint was created.
+        created_at:,
+        # Whether Orb sends webhook events to this endpoint.
+        enabled:,
+        # The webhook event types sent to this endpoint. If null, all event types are
+        # sent.
+        enabled_event_types:,
+        # The HTTPS URL that Orb sends webhook events to.
+        url:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            enabled: T::Boolean,
+            enabled_event_types: T.nilable(T::Array[String]),
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/webhook_endpoint_create_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpointCreateParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::WebhookEndpointCreateParams, Orb::Internal::AnyHash)
+        end
+
+      # The HTTPS URL that Orb sends webhook events to.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # The webhook event types to send to this endpoint. If omitted or null, all event
+      # types are sent.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :enabled_event_types
+
+      sig do
+        params(
+          url: String,
+          enabled_event_types: T.nilable(T::Array[String]),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The HTTPS URL that Orb sends webhook events to.
+        url:,
+        # The webhook event types to send to this endpoint. If omitted or null, all event
+        # types are sent.
+        enabled_event_types: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            url: String,
+            enabled_event_types: T.nilable(T::Array[String]),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/webhook_endpoint_delete_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpointDeleteParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::WebhookEndpointDeleteParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :webhook_endpoint_id
+
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(webhook_endpoint_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { webhook_endpoint_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/webhook_endpoint_disable_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpointDisableParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::WebhookEndpointDisableParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :webhook_endpoint_id
+
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(webhook_endpoint_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { webhook_endpoint_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/webhook_endpoint_enable_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpointEnableParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::WebhookEndpointEnableParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :webhook_endpoint_id
+
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(webhook_endpoint_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { webhook_endpoint_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/webhook_endpoint_list_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpointListParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::WebhookEndpointListParams, Orb::Internal::AnyHash)
+        end
+
+      # Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # from the initial request.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cursor
+
+      # The number of items to fetch. Defaults to 20.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          cursor: T.nilable(String),
+          limit: Integer,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
+        cursor: nil,
+        # The number of items to fetch. Defaults to 20.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: T.nilable(String),
+            limit: Integer,
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/orb/models/webhook_endpoint_retrieve_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Orb
+  module Models
+    class WebhookEndpointRetrieveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::WebhookEndpointRetrieveParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :webhook_endpoint_id
+
+      sig do
+        params(
+          webhook_endpoint_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(webhook_endpoint_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { webhook_endpoint_id: String, request_options: Orb::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end