orb-billing 0.1.0.pre.alpha.33

data/lib/orb/models/invoice_list_params.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Invoices#list
+    class InvoiceListParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute amount
+      #
+      #   @return [String, nil]
+      optional :amount, String, nil?: true
+
+      # @!attribute amount_gt
+      #
+      #   @return [String, nil]
+      optional :amount_gt, String, api_name: :"amount[gt]", nil?: true
+
+      # @!attribute amount_lt
+      #
+      #   @return [String, nil]
+      optional :amount_lt, String, api_name: :"amount[lt]", nil?: true
+
+      # @!attribute cursor
+      #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #     from the initial request.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute customer_id
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute date_type
+      #
+      #   @return [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
+      optional :date_type, enum: -> { Orb::Models::InvoiceListParams::DateType }, nil?: true
+
+      # @!attribute due_date
+      #
+      #   @return [Date, nil]
+      optional :due_date, Date, nil?: true
+
+      # @!attribute due_date_window
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :due_date_window, String, nil?: true
+
+      # @!attribute due_date_gt
+      #
+      #   @return [Date, nil]
+      optional :due_date_gt, Date, api_name: :"due_date[gt]", nil?: true
+
+      # @!attribute due_date_lt
+      #
+      #   @return [Date, nil]
+      optional :due_date_lt, Date, api_name: :"due_date[lt]", nil?: true
+
+      # @!attribute external_customer_id
+      #
+      #   @return [String, nil]
+      optional :external_customer_id, String, nil?: true
+
+      # @!attribute invoice_date_gt
+      #
+      #   @return [Time, nil]
+      optional :invoice_date_gt, Time, api_name: :"invoice_date[gt]", nil?: true
+
+      # @!attribute invoice_date_gte
+      #
+      #   @return [Time, nil]
+      optional :invoice_date_gte, Time, api_name: :"invoice_date[gte]", nil?: true
+
+      # @!attribute invoice_date_lt
+      #
+      #   @return [Time, nil]
+      optional :invoice_date_lt, Time, api_name: :"invoice_date[lt]", nil?: true
+
+      # @!attribute invoice_date_lte
+      #
+      #   @return [Time, nil]
+      optional :invoice_date_lte, Time, api_name: :"invoice_date[lte]", nil?: true
+
+      # @!attribute is_recurring
+      #
+      #   @return [Boolean, nil]
+      optional :is_recurring, Orb::BooleanModel, nil?: true
+
+      # @!attribute [r] limit
+      #   The number of items to fetch. Defaults to 20.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :limit
+
+      # @!attribute status
+      #
+      #   @return [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
+      optional :status, -> { Orb::ArrayOf[enum: Orb::Models::InvoiceListParams::Status] }, nil?: true
+
+      # @!attribute subscription_id
+      #
+      #   @return [String, nil]
+      optional :subscription_id, String, nil?: true
+
+      # @!parse
+      #   # @param amount [String, nil]
+      #   # @param amount_gt [String, nil]
+      #   # @param amount_lt [String, nil]
+      #   # @param cursor [String, nil]
+      #   # @param customer_id [String, nil]
+      #   # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
+      #   # @param due_date [Date, nil]
+      #   # @param due_date_window [String, nil]
+      #   # @param due_date_gt [Date, nil]
+      #   # @param due_date_lt [Date, nil]
+      #   # @param external_customer_id [String, nil]
+      #   # @param invoice_date_gt [Time, nil]
+      #   # @param invoice_date_gte [Time, nil]
+      #   # @param invoice_date_lt [Time, nil]
+      #   # @param invoice_date_lte [Time, nil]
+      #   # @param is_recurring [Boolean, nil]
+      #   # @param limit [Integer]
+      #   # @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
+      #   # @param subscription_id [String, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     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: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      module DateType
+        extend Orb::Enum
+
+        DUE_DATE = :due_date
+        INVOICE_DATE = :invoice_date
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      module Status
+        extend Orb::Enum
+
+        DRAFT = :draft
+        ISSUED = :issued
+        PAID = :paid
+        SYNCED = :synced
+        VOID = :void
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/orb/models/invoice_mark_paid_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Invoices#mark_paid
+    class InvoiceMarkPaidParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute payment_received_date
+      #   A date string to specify the date of the payment.
+      #
+      #   @return [Date]
+      required :payment_received_date, Date
+
+      # @!attribute external_id
+      #   An optional external ID to associate with the payment.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute notes
+      #   An optional note to associate with the payment.
+      #
+      #   @return [String, nil]
+      optional :notes, String, nil?: true
+
+      # @!parse
+      #   # @param payment_received_date [Date]
+      #   # @param external_id [String, nil]
+      #   # @param notes [String, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(payment_received_date:, external_id: nil, notes: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/invoice_pay_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Invoices#pay
+    class InvoicePayParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/invoice_update_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Invoices#update
+    class InvoiceUpdateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute metadata
+      #   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`.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Orb::HashOf[String, nil?: true], nil?: true
+
+      # @!parse
+      #   # @param metadata [Hash{Symbol=>String, nil}, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/invoice_void_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Invoices#void
+    class InvoiceVoidParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/item.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Items#create
+    class Item < Orb::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute external_connections
+      #
+      #   @return [Array<Orb::Models::Item::ExternalConnection>]
+      required :external_connections, -> { Orb::ArrayOf[Orb::Models::Item::ExternalConnection] }
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!parse
+      #   # 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.
+      #   #
+      #   # @param id [String]
+      #   # @param created_at [Time]
+      #   # @param external_connections [Array<Orb::Models::Item::ExternalConnection>]
+      #   # @param name [String]
+      #   #
+      #   def initialize(id:, created_at:, external_connections:, name:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      class ExternalConnection < Orb::BaseModel
+        # @!attribute external_connection_name
+        #
+        #   @return [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
+        required :external_connection_name,
+                 enum: -> { Orb::Models::Item::ExternalConnection::ExternalConnectionName }
+
+        # @!attribute external_entity_id
+        #
+        #   @return [String]
+        required :external_entity_id, String
+
+        # @!parse
+        #   # @param external_connection_name [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
+        #   # @param external_entity_id [String]
+        #   #
+        #   def initialize(external_connection_name:, external_entity_id:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        # @see Orb::Models::Item::ExternalConnection#external_connection_name
+        module ExternalConnectionName
+          extend Orb::Enum
+
+          STRIPE = :stripe
+          QUICKBOOKS = :quickbooks
+          BILL_COM = :"bill.com"
+          NETSUITE = :netsuite
+          TAXJAR = :taxjar
+          AVALARA = :avalara
+          ANROK = :anrok
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/item_create_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Items#create
+    class ItemCreateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute name
+      #   The name of the item.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!parse
+      #   # @param name [String]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(name:, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/item_fetch_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Items#fetch
+    class ItemFetchParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/item_list_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Items#list
+    class ItemListParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute cursor
+      #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #     from the initial request.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute [r] limit
+      #   The number of items to fetch. Defaults to 20.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :limit
+
+      # @!parse
+      #   # @param cursor [String, nil]
+      #   # @param limit [Integer]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/item_update_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Items#update
+    class ItemUpdateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute external_connections
+      #
+      #   @return [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
+      optional :external_connections,
+               -> { Orb::ArrayOf[Orb::Models::ItemUpdateParams::ExternalConnection] },
+               nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!parse
+      #   # @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
+      #   # @param name [String, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(external_connections: nil, name: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      class ExternalConnection < Orb::BaseModel
+        # @!attribute external_connection_name
+        #
+        #   @return [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
+        required :external_connection_name,
+                 enum: -> { Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName }
+
+        # @!attribute external_entity_id
+        #
+        #   @return [String]
+        required :external_entity_id, String
+
+        # @!parse
+        #   # @param external_connection_name [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
+        #   # @param external_entity_id [String]
+        #   #
+        #   def initialize(external_connection_name:, external_entity_id:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        # @see Orb::Models::ItemUpdateParams::ExternalConnection#external_connection_name
+        module ExternalConnectionName
+          extend Orb::Enum
+
+          STRIPE = :stripe
+          QUICKBOOKS = :quickbooks
+          BILL_COM = :"bill.com"
+          NETSUITE = :netsuite
+          TAXJAR = :taxjar
+          AVALARA = :avalara
+          ANROK = :anrok
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/metric_create_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Metrics#create
+    class MetricCreateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute description
+      #   A description of the metric.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute item_id
+      #   The id of the item
+      #
+      #   @return [String]
+      required :item_id, String
+
+      # @!attribute name
+      #   The name of the metric.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute sql
+      #   A sql string defining the metric.
+      #
+      #   @return [String]
+      required :sql, String
+
+      # @!attribute metadata
+      #   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`.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Orb::HashOf[String, nil?: true], nil?: true
+
+      # @!parse
+      #   # @param description [String, nil]
+      #   # @param item_id [String]
+      #   # @param name [String]
+      #   # @param sql [String]
+      #   # @param metadata [Hash{Symbol=>String, nil}, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(description:, item_id:, name:, sql:, metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/metric_fetch_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Metrics#fetch
+    class MetricFetchParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/metric_list_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Metrics#list
+    class MetricListParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute created_at_gt
+      #
+      #   @return [Time, nil]
+      optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true
+
+      # @!attribute created_at_gte
+      #
+      #   @return [Time, nil]
+      optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true
+
+      # @!attribute created_at_lt
+      #
+      #   @return [Time, nil]
+      optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true
+
+      # @!attribute created_at_lte
+      #
+      #   @return [Time, nil]
+      optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true
+
+      # @!attribute cursor
+      #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #     from the initial request.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute [r] limit
+      #   The number of items to fetch. Defaults to 20.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :limit
+
+      # @!parse
+      #   # @param created_at_gt [Time, nil]
+      #   # @param created_at_gte [Time, nil]
+      #   # @param created_at_lt [Time, nil]
+      #   # @param created_at_lte [Time, nil]
+      #   # @param cursor [String, nil]
+      #   # @param limit [Integer]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     created_at_gt: nil,
+      #     created_at_gte: nil,
+      #     created_at_lt: nil,
+      #     created_at_lte: nil,
+      #     cursor: nil,
+      #     limit: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end