orb-billing 0.1.0.pre.alpha.33

data/rbi/lib/orb/models/invoice_list_params.rbi

@@ -0,0 +1,187 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceListParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :amount
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :amount_gt
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :amount_lt
+
+      # 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
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_id
+
+      sig { returns(T.nilable(Orb::Models::InvoiceListParams::DateType::OrSymbol)) }
+      attr_accessor :date_type
+
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :due_date
+
+      # Filters invoices by their due dates within a specific time range in the past.
+      #   Specify the range as a number followed by 'd' (days) or 'm' (months). For
+      #   example, '7d' filters invoices due in the last 7 days, and '2m' filters those
+      #   due in the last 2 months.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :due_date_window
+
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :due_date_gt
+
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :due_date_lt
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_customer_id
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :invoice_date_gt
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :invoice_date_gte
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :invoice_date_lt
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :invoice_date_lte
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_recurring
+
+      # 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 { returns(T.nilable(T::Array[Orb::Models::InvoiceListParams::Status::OrSymbol])) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :subscription_id
+
+      sig do
+        params(
+          amount: T.nilable(String),
+          amount_gt: T.nilable(String),
+          amount_lt: T.nilable(String),
+          cursor: T.nilable(String),
+          customer_id: T.nilable(String),
+          date_type: T.nilable(Orb::Models::InvoiceListParams::DateType::OrSymbol),
+          due_date: T.nilable(Date),
+          due_date_window: T.nilable(String),
+          due_date_gt: T.nilable(Date),
+          due_date_lt: T.nilable(Date),
+          external_customer_id: T.nilable(String),
+          invoice_date_gt: T.nilable(Time),
+          invoice_date_gte: T.nilable(Time),
+          invoice_date_lt: T.nilable(Time),
+          invoice_date_lte: T.nilable(Time),
+          is_recurring: T.nilable(T::Boolean),
+          limit: Integer,
+          status: T.nilable(T::Array[Orb::Models::InvoiceListParams::Status::OrSymbol]),
+          subscription_id: T.nilable(String),
+          request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        amount: nil,
+        amount_gt: nil,
+        amount_lt: nil,
+        cursor: nil,
+        customer_id: nil,
+        date_type: nil,
+        due_date: nil,
+        due_date_window: nil,
+        due_date_gt: nil,
+        due_date_lt: nil,
+        external_customer_id: nil,
+        invoice_date_gt: nil,
+        invoice_date_gte: nil,
+        invoice_date_lt: nil,
+        invoice_date_lte: nil,
+        is_recurring: nil,
+        limit: nil,
+        status: nil,
+        subscription_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              amount: T.nilable(String),
+              amount_gt: T.nilable(String),
+              amount_lt: T.nilable(String),
+              cursor: T.nilable(String),
+              customer_id: T.nilable(String),
+              date_type: T.nilable(Orb::Models::InvoiceListParams::DateType::OrSymbol),
+              due_date: T.nilable(Date),
+              due_date_window: T.nilable(String),
+              due_date_gt: T.nilable(Date),
+              due_date_lt: T.nilable(Date),
+              external_customer_id: T.nilable(String),
+              invoice_date_gt: T.nilable(Time),
+              invoice_date_gte: T.nilable(Time),
+              invoice_date_lt: T.nilable(Time),
+              invoice_date_lte: T.nilable(Time),
+              is_recurring: T.nilable(T::Boolean),
+              limit: Integer,
+              status: T.nilable(T::Array[Orb::Models::InvoiceListParams::Status::OrSymbol]),
+              subscription_id: T.nilable(String),
+              request_options: Orb::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      module DateType
+        extend Orb::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceListParams::DateType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) }
+
+        DUE_DATE = T.let(:due_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol)
+        INVOICE_DATE = T.let(:invoice_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol)
+
+        sig { override.returns(T::Array[Orb::Models::InvoiceListParams::DateType::TaggedSymbol]) }
+        def self.values
+        end
+      end
+
+      module Status
+        extend Orb::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceListParams::Status::TaggedSymbol) }
+
+        DRAFT = T.let(:draft, Orb::Models::InvoiceListParams::Status::TaggedSymbol)
+        ISSUED = T.let(:issued, Orb::Models::InvoiceListParams::Status::TaggedSymbol)
+        PAID = T.let(:paid, Orb::Models::InvoiceListParams::Status::TaggedSymbol)
+        SYNCED = T.let(:synced, Orb::Models::InvoiceListParams::Status::TaggedSymbol)
+        VOID = T.let(:void, Orb::Models::InvoiceListParams::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[Orb::Models::InvoiceListParams::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/invoice_mark_paid_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceMarkPaidParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # A date string to specify the date of the payment.
+      sig { returns(Date) }
+      attr_accessor :payment_received_date
+
+      # An optional external ID to associate with the payment.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # An optional note to associate with the payment.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      sig do
+        params(
+          payment_received_date: Date,
+          external_id: T.nilable(String),
+          notes: T.nilable(String),
+          request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(payment_received_date:, external_id: nil, notes: nil, request_options: {})
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              payment_received_date: Date,
+              external_id: T.nilable(String),
+              notes: T.nilable(String),
+              request_options: Orb::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/invoice_pay_params.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoicePayParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      sig do
+        params(request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({request_options: Orb::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/invoice_update_params.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceUpdateParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # User-specified key/value pairs for the resource. Individual keys can be removed
+      #   by setting the value to `null`, and the entire metadata mapping can be cleared
+      #   by setting `metadata` to `null`.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_accessor :metadata
+
+      sig do
+        params(
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(metadata: nil, request_options: {})
+      end
+
+      sig do
+        override
+          .returns({
+                     metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+                     request_options: Orb::RequestOptions
+                   })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/invoice_void_params.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Orb
+  module Models
+    class InvoiceVoidParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      sig do
+        params(request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({request_options: Orb::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/item.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Orb
+  module Models
+    class Item < Orb::BaseModel
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(T::Array[Orb::Models::Item::ExternalConnection]) }
+      attr_accessor :external_connections
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The Item resource represents a sellable product or good. Items are associated
+      #   with all line items, billable metrics, and prices and are used for defining
+      #   external sync behavior for invoices and tax calculation purposes.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          external_connections: T::Array[T.any(Orb::Models::Item::ExternalConnection, Orb::Util::AnyHash)],
+          name: String
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(id:, created_at:, external_connections:, name:)
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              id: String,
+              created_at: Time,
+              external_connections: T::Array[Orb::Models::Item::ExternalConnection],
+              name: String
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class ExternalConnection < Orb::BaseModel
+        sig { returns(Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) }
+        attr_accessor :external_connection_name
+
+        sig { returns(String) }
+        attr_accessor :external_entity_id
+
+        sig do
+          params(
+            external_connection_name: Orb::Models::Item::ExternalConnection::ExternalConnectionName::OrSymbol,
+            external_entity_id: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(external_connection_name:, external_entity_id:)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                external_connection_name: Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol,
+                external_entity_id: String
+              }
+            )
+        end
+        def to_hash
+        end
+
+        module ExternalConnectionName
+          extend Orb::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, String, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) }
+
+          STRIPE = T.let(:stripe, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          QUICKBOOKS =
+            T.let(:quickbooks, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          BILL_COM =
+            T.let(:"bill.com", Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          NETSUITE = T.let(:netsuite, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          TAXJAR = T.let(:taxjar, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          AVALARA = T.let(:avalara, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          ANROK = T.let(:anrok, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+
+          sig { override.returns(T::Array[Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/item_create_params.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Orb
+  module Models
+    class ItemCreateParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # The name of the item.
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig do
+        params(name: String, request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(name:, request_options: {})
+      end
+
+      sig { override.returns({name: String, request_options: Orb::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/item_fetch_params.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Orb
+  module Models
+    class ItemFetchParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      sig do
+        params(request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({request_options: Orb::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/item_list_params.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Orb
+  module Models
+    class ItemListParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # 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: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(cursor: nil, 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/lib/orb/models/item_update_params.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Orb
+  module Models
+    class ItemUpdateParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      sig { returns(T.nilable(T::Array[Orb::Models::ItemUpdateParams::ExternalConnection])) }
+      attr_accessor :external_connections
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig do
+        params(
+          external_connections: T.nilable(T::Array[T.any(Orb::Models::ItemUpdateParams::ExternalConnection, Orb::Util::AnyHash)]),
+          name: T.nilable(String),
+          request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(external_connections: nil, name: nil, request_options: {})
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              external_connections: T.nilable(T::Array[Orb::Models::ItemUpdateParams::ExternalConnection]),
+              name: T.nilable(String),
+              request_options: Orb::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class ExternalConnection < Orb::BaseModel
+        sig { returns(Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::OrSymbol) }
+        attr_accessor :external_connection_name
+
+        sig { returns(String) }
+        attr_accessor :external_entity_id
+
+        sig do
+          params(
+            external_connection_name: Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::OrSymbol,
+            external_entity_id: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(external_connection_name:, external_entity_id:)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                external_connection_name: Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::OrSymbol,
+                external_entity_id: String
+              }
+            )
+        end
+        def to_hash
+        end
+
+        module ExternalConnectionName
+          extend Orb::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName) }
+          OrSymbol =
+            T.type_alias do
+              T.any(
+                Symbol,
+                String,
+                Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol
+              )
+            end
+
+          STRIPE =
+            T.let(:stripe, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          QUICKBOOKS =
+            T.let(
+              :quickbooks,
+              Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol
+            )
+          BILL_COM =
+            T.let(
+              :"bill.com",
+              Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol
+            )
+          NETSUITE =
+            T.let(:netsuite, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          TAXJAR =
+            T.let(:taxjar, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          AVALARA =
+            T.let(:avalara, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+          ANROK =
+            T.let(:anrok, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol)
+
+          sig do
+            override
+              .returns(T::Array[Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol])
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/metric_create_params.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Orb
+  module Models
+    class MetricCreateParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # A description of the metric.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The id of the item
+      sig { returns(String) }
+      attr_accessor :item_id
+
+      # The name of the metric.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # A sql string defining the metric.
+      sig { returns(String) }
+      attr_accessor :sql
+
+      # User-specified key/value pairs for the resource. Individual keys can be removed
+      #   by setting the value to `null`, and the entire metadata mapping can be cleared
+      #   by setting `metadata` to `null`.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_accessor :metadata
+
+      sig do
+        params(
+          description: T.nilable(String),
+          item_id: String,
+          name: String,
+          sql: String,
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(description:, item_id:, name:, sql:, metadata: nil, request_options: {})
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              description: T.nilable(String),
+              item_id: String,
+              name: String,
+              sql: String,
+              metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+              request_options: Orb::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lib/orb/models/metric_fetch_params.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module Orb
+  module Models
+    class MetricFetchParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      sig do
+        params(request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({request_options: Orb::RequestOptions}) }
+      def to_hash
+      end
+    end
+  end
+end