orb-billing 0.5.2 → 0.5.4

data/sig/orb/models/invoice.rbs

@@ -20,7 +20,7 @@ module Orb
         invoice_date: Time,
         invoice_number: String,
         invoice_pdf: String?,
-        invoice_source: Orb::Invoice::invoice_source,
+        invoice_source: Orb::Models::Invoice::invoice_source,
         issue_failed_at: Time?,
         issued_at: Time?,
         line_items: ::Array[Orb::Invoice::LineItem],
@@ -36,7 +36,7 @@ module Orb
         payment_started_at: Time?,
         scheduled_issue_at: Time?,
         shipping_address: Orb::Invoice::ShippingAddress?,
-        status: Orb::Invoice::status,
+        status: Orb::Models::Invoice::status,
         subscription: Orb::Invoice::Subscription?,
         subtotal: String,
         sync_failed_at: Time?,
@@ -82,7 +82,7 @@ module Orb
 
       attr_accessor invoice_pdf: String?
 
-      attr_accessor invoice_source: Orb::Invoice::invoice_source
+      attr_accessor invoice_source: Orb::Models::Invoice::invoice_source
 
       attr_accessor issue_failed_at: Time?
 
@@ -114,7 +114,7 @@ module Orb
 
       attr_accessor shipping_address: Orb::Invoice::ShippingAddress?
 
-      attr_accessor status: Orb::Invoice::status
+      attr_accessor status: Orb::Models::Invoice::status
 
       attr_accessor subscription: Orb::Invoice::Subscription?
 
@@ -147,7 +147,7 @@ module Orb
         invoice_date: Time,
         invoice_number: String,
         invoice_pdf: String?,
-        invoice_source: Orb::Invoice::invoice_source,
+        invoice_source: Orb::Models::Invoice::invoice_source,
         issue_failed_at: Time?,
         issued_at: Time?,
         line_items: ::Array[Orb::Invoice::LineItem],
@@ -163,7 +163,7 @@ module Orb
         payment_started_at: Time?,
         scheduled_issue_at: Time?,
         shipping_address: Orb::Invoice::ShippingAddress?,
-        status: Orb::Invoice::status,
+        status: Orb::Models::Invoice::status,
         subscription: Orb::Invoice::Subscription?,
         subtotal: String,
         sync_failed_at: Time?,
@@ -172,6 +172,50 @@ module Orb
         will_auto_issue: bool
       ) -> void
 
+      def to_hash: -> {
+        id: String,
+        amount_due: String,
+        auto_collection: Orb::Invoice::AutoCollection,
+        billing_address: Orb::Invoice::BillingAddress?,
+        created_at: Time,
+        credit_notes: ::Array[Orb::Invoice::CreditNote],
+        currency: String,
+        customer: Orb::Invoice::Customer,
+        customer_balance_transactions: ::Array[Orb::Invoice::CustomerBalanceTransaction],
+        customer_tax_id: Orb::Invoice::CustomerTaxID?,
+        discount: top,
+        discounts: ::Array[Orb::Models::invoice_level_discount],
+        due_date: Time?,
+        eligible_to_issue_at: Time?,
+        hosted_invoice_url: String?,
+        invoice_date: Time,
+        invoice_number: String,
+        invoice_pdf: String?,
+        invoice_source: Orb::Models::Invoice::invoice_source,
+        issue_failed_at: Time?,
+        issued_at: Time?,
+        line_items: ::Array[Orb::Invoice::LineItem],
+        maximum: Orb::Invoice::Maximum?,
+        maximum_amount: String?,
+        memo: String?,
+        metadata: ::Hash[Symbol, String],
+        minimum: Orb::Invoice::Minimum?,
+        minimum_amount: String?,
+        paid_at: Time?,
+        payment_attempts: ::Array[Orb::Invoice::PaymentAttempt],
+        payment_failed_at: Time?,
+        payment_started_at: Time?,
+        scheduled_issue_at: Time?,
+        shipping_address: Orb::Invoice::ShippingAddress?,
+        status: Orb::Models::Invoice::status,
+        subscription: Orb::Invoice::Subscription?,
+        subtotal: String,
+        sync_failed_at: Time?,
+        total: String,
+        voided_at: Time?,
+        will_auto_issue: bool
+      }
+
       type auto_collection =
         {
           enabled: bool?,
@@ -195,6 +239,13 @@ module Orb
           num_attempts: Integer?,
           previously_attempted_at: Time?
         ) -> void
+
+        def to_hash: -> {
+          enabled: bool?,
+          next_attempt_at: Time?,
+          num_attempts: Integer?,
+          previously_attempted_at: Time?
+        }
       end
 
       type billing_address =
@@ -228,6 +279,15 @@ module Orb
           postal_code: String?,
           state: String?
         ) -> void
+
+        def to_hash: -> {
+          city: String?,
+          country: String?,
+          :line1 => String?,
+          :line2 => String?,
+          postal_code: String?,
+          state: String?
+        }
       end
 
       type credit_note =
@@ -265,6 +325,16 @@ module Orb
           type: String,
           voided_at: Time?
         ) -> void
+
+        def to_hash: -> {
+          id: String,
+          credit_note_number: String,
+          memo: String?,
+          reason: String,
+          total: String,
+          type: String,
+          voided_at: Time?
+        }
       end
 
       type customer = { id: String, external_customer_id: String? }
@@ -275,12 +345,14 @@ module Orb
         attr_accessor external_customer_id: String?
 
         def initialize: (id: String, external_customer_id: String?) -> void
+
+        def to_hash: -> { id: String, external_customer_id: String? }
       end
 
       type customer_balance_transaction =
         {
           id: String,
-          action: Orb::Invoice::CustomerBalanceTransaction::action,
+          action: Orb::Models::Invoice::CustomerBalanceTransaction::action,
           amount: String,
           created_at: Time,
           credit_note: Orb::Invoice::CustomerBalanceTransaction::CreditNote?,
@@ -288,13 +360,13 @@ module Orb
           ending_balance: String,
           invoice: Orb::Invoice::CustomerBalanceTransaction::Invoice?,
           starting_balance: String,
-          type: Orb::Invoice::CustomerBalanceTransaction::type_
+          type: Orb::Models::Invoice::CustomerBalanceTransaction::type_
         }
 
       class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
         attr_accessor id: String
 
-        attr_accessor action: Orb::Invoice::CustomerBalanceTransaction::action
+        attr_accessor action: Orb::Models::Invoice::CustomerBalanceTransaction::action
 
         attr_accessor amount: String
 
@@ -310,11 +382,11 @@ module Orb
 
         attr_accessor starting_balance: String
 
-        attr_accessor type: Orb::Invoice::CustomerBalanceTransaction::type_
+        attr_accessor type: Orb::Models::Invoice::CustomerBalanceTransaction::type_
 
         def initialize: (
           id: String,
-          action: Orb::Invoice::CustomerBalanceTransaction::action,
+          action: Orb::Models::Invoice::CustomerBalanceTransaction::action,
           amount: String,
           created_at: Time,
           credit_note: Orb::Invoice::CustomerBalanceTransaction::CreditNote?,
@@ -322,9 +394,22 @@ module Orb
           ending_balance: String,
           invoice: Orb::Invoice::CustomerBalanceTransaction::Invoice?,
           starting_balance: String,
-          type: Orb::Invoice::CustomerBalanceTransaction::type_
+          type: Orb::Models::Invoice::CustomerBalanceTransaction::type_
         ) -> void
 
+        def to_hash: -> {
+          id: String,
+          action: Orb::Models::Invoice::CustomerBalanceTransaction::action,
+          amount: String,
+          created_at: Time,
+          credit_note: Orb::Invoice::CustomerBalanceTransaction::CreditNote?,
+          description: String?,
+          ending_balance: String,
+          invoice: Orb::Invoice::CustomerBalanceTransaction::Invoice?,
+          starting_balance: String,
+          type: Orb::Models::Invoice::CustomerBalanceTransaction::type_
+        }
+
         type action =
           :applied_to_invoice
           | :manual_adjustment
@@ -349,7 +434,7 @@ module Orb
           OVERPAYMENT_REFUND: :overpayment_refund
           EXTERNAL_PAYMENT: :external_payment
 
-          def self?.values: -> ::Array[Orb::Invoice::CustomerBalanceTransaction::action]
+          def self?.values: -> ::Array[Orb::Models::Invoice::CustomerBalanceTransaction::action]
         end
 
         type credit_note = { id: String }
@@ -358,6 +443,8 @@ module Orb
           attr_accessor id: String
 
           def initialize: (id: String) -> void
+
+          def to_hash: -> { id: String }
         end
 
         type invoice = { id: String }
@@ -366,6 +453,8 @@ module Orb
           attr_accessor id: String
 
           def initialize: (id: String) -> void
+
+          def to_hash: -> { id: String }
         end
 
         type type_ = :increment | :decrement
@@ -376,30 +465,36 @@ module Orb
           INCREMENT: :increment
           DECREMENT: :decrement
 
-          def self?.values: -> ::Array[Orb::Invoice::CustomerBalanceTransaction::type_]
+          def self?.values: -> ::Array[Orb::Models::Invoice::CustomerBalanceTransaction::type_]
         end
       end
 
       type customer_tax_id =
         {
-          country: Orb::Invoice::CustomerTaxID::country,
-          type: Orb::Invoice::CustomerTaxID::type_,
+          country: Orb::Models::Invoice::CustomerTaxID::country,
+          type: Orb::Models::Invoice::CustomerTaxID::type_,
           value: String
         }
 
       class CustomerTaxID < Orb::Internal::Type::BaseModel
-        attr_accessor country: Orb::Invoice::CustomerTaxID::country
+        attr_accessor country: Orb::Models::Invoice::CustomerTaxID::country
 
-        attr_accessor type: Orb::Invoice::CustomerTaxID::type_
+        attr_accessor type: Orb::Models::Invoice::CustomerTaxID::type_
 
         attr_accessor value: String
 
         def initialize: (
-          country: Orb::Invoice::CustomerTaxID::country,
-          type: Orb::Invoice::CustomerTaxID::type_,
+          country: Orb::Models::Invoice::CustomerTaxID::country,
+          type: Orb::Models::Invoice::CustomerTaxID::type_,
           value: String
         ) -> void
 
+        def to_hash: -> {
+          country: Orb::Models::Invoice::CustomerTaxID::country,
+          type: Orb::Models::Invoice::CustomerTaxID::type_,
+          value: String
+        }
+
         type country =
           :AD
           | :AE
@@ -562,7 +657,7 @@ module Orb
           VN: :VN
           ZA: :ZA
 
-          def self?.values: -> ::Array[Orb::Invoice::CustomerTaxID::country]
+          def self?.values: -> ::Array[Orb::Models::Invoice::CustomerTaxID::country]
         end
 
         type type_ =
@@ -713,7 +808,7 @@ module Orb
           VN_TIN: :vn_tin
           ZA_VAT: :za_vat
 
-          def self?.values: -> ::Array[Orb::Invoice::CustomerTaxID::type_]
+          def self?.values: -> ::Array[Orb::Models::Invoice::CustomerTaxID::type_]
         end
       end
 
@@ -726,14 +821,14 @@ module Orb
         PARTIAL: :partial
         ONE_OFF: :one_off
 
-        def self?.values: -> ::Array[Orb::Invoice::invoice_source]
+        def self?.values: -> ::Array[Orb::Models::Invoice::invoice_source]
       end
 
       type line_item =
         {
           id: String,
           adjusted_subtotal: String,
-          adjustments: ::Array[Orb::Invoice::LineItem::adjustment],
+          adjustments: ::Array[Orb::Models::Invoice::LineItem::adjustment],
           amount: String,
           credits_applied: String,
           discount: Orb::Models::discount?,
@@ -749,7 +844,7 @@ module Orb
           price: Orb::Models::price?,
           quantity: Float,
           start_date: Time,
-          sub_line_items: ::Array[Orb::Invoice::LineItem::sub_line_item],
+          sub_line_items: ::Array[Orb::Models::Invoice::LineItem::sub_line_item],
           subtotal: String,
           tax_amounts: ::Array[Orb::Invoice::LineItem::TaxAmount],
           usage_customer_ids: ::Array[String]?
@@ -760,7 +855,7 @@ module Orb
 
         attr_accessor adjusted_subtotal: String
 
-        attr_accessor adjustments: ::Array[Orb::Invoice::LineItem::adjustment]
+        attr_accessor adjustments: ::Array[Orb::Models::Invoice::LineItem::adjustment]
 
         attr_accessor amount: String
 
@@ -792,7 +887,7 @@ module Orb
 
         attr_accessor start_date: Time
 
-        attr_accessor sub_line_items: ::Array[Orb::Invoice::LineItem::sub_line_item]
+        attr_accessor sub_line_items: ::Array[Orb::Models::Invoice::LineItem::sub_line_item]
 
         attr_accessor subtotal: String
 
@@ -803,7 +898,7 @@ module Orb
         def initialize: (
           id: String,
           adjusted_subtotal: String,
-          adjustments: ::Array[Orb::Invoice::LineItem::adjustment],
+          adjustments: ::Array[Orb::Models::Invoice::LineItem::adjustment],
           amount: String,
           credits_applied: String,
           discount: Orb::Models::discount?,
@@ -819,12 +914,37 @@ module Orb
           price: Orb::Models::price?,
           quantity: Float,
           start_date: Time,
-          sub_line_items: ::Array[Orb::Invoice::LineItem::sub_line_item],
+          sub_line_items: ::Array[Orb::Models::Invoice::LineItem::sub_line_item],
           subtotal: String,
           tax_amounts: ::Array[Orb::Invoice::LineItem::TaxAmount],
           usage_customer_ids: ::Array[String]?
         ) -> void
 
+        def to_hash: -> {
+          id: String,
+          adjusted_subtotal: String,
+          adjustments: ::Array[Orb::Models::Invoice::LineItem::adjustment],
+          amount: String,
+          credits_applied: String,
+          discount: Orb::Models::discount?,
+          end_date: Time,
+          filter: String?,
+          grouping: String?,
+          maximum: Orb::Invoice::LineItem::Maximum?,
+          maximum_amount: String?,
+          minimum: Orb::Invoice::LineItem::Minimum?,
+          minimum_amount: String?,
+          name: String,
+          partially_invoiced_amount: String,
+          price: Orb::Models::price?,
+          quantity: Float,
+          start_date: Time,
+          sub_line_items: ::Array[Orb::Models::Invoice::LineItem::sub_line_item],
+          subtotal: String,
+          tax_amounts: ::Array[Orb::Invoice::LineItem::TaxAmount],
+          usage_customer_ids: ::Array[String]?
+        }
+
         type adjustment =
           Orb::Invoice::LineItem::Adjustment::UsageDiscount
           | Orb::Invoice::LineItem::Adjustment::AmountDiscount
@@ -870,6 +990,16 @@ module Orb
               usage_discount: Float,
               ?adjustment_type: :usage_discount
             ) -> void
+
+            def to_hash: -> {
+              id: String,
+              adjustment_type: :usage_discount,
+              amount: String,
+              applies_to_price_ids: ::Array[String],
+              is_invoice_level: bool,
+              reason: String?,
+              usage_discount: Float
+            }
           end
 
           type amount_discount =
@@ -907,6 +1037,16 @@ module Orb
               reason: String?,
               ?adjustment_type: :amount_discount
             ) -> void
+
+            def to_hash: -> {
+              id: String,
+              adjustment_type: :amount_discount,
+              amount: String,
+              amount_discount: String,
+              applies_to_price_ids: ::Array[String],
+              is_invoice_level: bool,
+              reason: String?
+            }
           end
 
           type percentage_discount =
@@ -944,6 +1084,16 @@ module Orb
               reason: String?,
               ?adjustment_type: :percentage_discount
             ) -> void
+
+            def to_hash: -> {
+              id: String,
+              adjustment_type: :percentage_discount,
+              amount: String,
+              applies_to_price_ids: ::Array[String],
+              is_invoice_level: bool,
+              percentage_discount: Float,
+              reason: String?
+            }
           end
 
           type minimum =
@@ -985,6 +1135,17 @@ module Orb
               reason: String?,
               ?adjustment_type: :minimum
             ) -> void
+
+            def to_hash: -> {
+              id: String,
+              adjustment_type: :minimum,
+              amount: String,
+              applies_to_price_ids: ::Array[String],
+              is_invoice_level: bool,
+              item_id: String,
+              minimum_amount: String,
+              reason: String?
+            }
           end
 
           type maximum =
@@ -1022,9 +1183,19 @@ module Orb
               reason: String?,
               ?adjustment_type: :maximum
             ) -> void
+
+            def to_hash: -> {
+              id: String,
+              adjustment_type: :maximum,
+              amount: String,
+              applies_to_price_ids: ::Array[String],
+              is_invoice_level: bool,
+              maximum_amount: String,
+              reason: String?
+            }
           end
 
-          def self?.variants: -> ::Array[Orb::Invoice::LineItem::adjustment]
+          def self?.variants: -> ::Array[Orb::Models::Invoice::LineItem::adjustment]
         end
 
         type maximum =
@@ -1039,6 +1210,11 @@ module Orb
             applies_to_price_ids: ::Array[String],
             maximum_amount: String
           ) -> void
+
+          def to_hash: -> {
+            applies_to_price_ids: ::Array[String],
+            maximum_amount: String
+          }
         end
 
         type minimum =
@@ -1053,6 +1229,11 @@ module Orb
             applies_to_price_ids: ::Array[String],
             minimum_amount: String
           ) -> void
+
+          def to_hash: -> {
+            applies_to_price_ids: ::Array[String],
+            minimum_amount: String
+          }
         end
 
         type sub_line_item =
@@ -1095,6 +1276,15 @@ module Orb
               ?type: :matrix
             ) -> void
 
+            def to_hash: -> {
+              amount: String,
+              grouping: Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping?,
+              matrix_config: Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig,
+              name: String,
+              quantity: Float,
+              type: :matrix
+            }
+
             type grouping = { key: String, value: String? }
 
             class Grouping < Orb::Internal::Type::BaseModel
@@ -1103,6 +1293,8 @@ module Orb
               attr_accessor value: String?
 
               def initialize: (key: String, value: String?) -> void
+
+              def to_hash: -> { key: String, value: String? }
             end
 
             type matrix_config = { dimension_values: ::Array[String?] }
@@ -1111,6 +1303,8 @@ module Orb
               attr_accessor dimension_values: ::Array[String?]
 
               def initialize: (dimension_values: ::Array[String?]) -> void
+
+              def to_hash: -> { dimension_values: ::Array[String?] }
             end
           end
 
@@ -1146,6 +1340,15 @@ module Orb
               ?type: :tier
             ) -> void
 
+            def to_hash: -> {
+              amount: String,
+              grouping: Orb::Invoice::LineItem::SubLineItem::Tier::Grouping?,
+              name: String,
+              quantity: Float,
+              tier_config: Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig,
+              type: :tier
+            }
+
             type grouping = { key: String, value: String? }
 
             class Grouping < Orb::Internal::Type::BaseModel
@@ -1154,6 +1357,8 @@ module Orb
               attr_accessor value: String?
 
               def initialize: (key: String, value: String?) -> void
+
+              def to_hash: -> { key: String, value: String? }
             end
 
             type tier_config =
@@ -1171,6 +1376,12 @@ module Orb
                 last_unit: Float?,
                 unit_amount: String
               ) -> void
+
+              def to_hash: -> {
+                first_unit: Float,
+                last_unit: Float?,
+                unit_amount: String
+              }
             end
           end
 
@@ -1202,6 +1413,14 @@ module Orb
               ?type: :"'null'"
             ) -> void
 
+            def to_hash: -> {
+              amount: String,
+              grouping: Orb::Invoice::LineItem::SubLineItem::Null::Grouping?,
+              name: String,
+              quantity: Float,
+              type: :"'null'"
+            }
+
             type grouping = { key: String, value: String? }
 
             class Grouping < Orb::Internal::Type::BaseModel
@@ -1210,10 +1429,12 @@ module Orb
               attr_accessor value: String?
 
               def initialize: (key: String, value: String?) -> void
+
+              def to_hash: -> { key: String, value: String? }
             end
           end
 
-          def self?.variants: -> ::Array[Orb::Invoice::LineItem::sub_line_item]
+          def self?.variants: -> ::Array[Orb::Models::Invoice::LineItem::sub_line_item]
         end
 
         type tax_amount =
@@ -1235,6 +1456,12 @@ module Orb
             tax_rate_description: String,
             tax_rate_percentage: String?
           ) -> void
+
+          def to_hash: -> {
+            amount: String,
+            tax_rate_description: String,
+            tax_rate_percentage: String?
+          }
         end
       end
 
@@ -1250,6 +1477,11 @@ module Orb
           applies_to_price_ids: ::Array[String],
           maximum_amount: String
         ) -> void
+
+        def to_hash: -> {
+          applies_to_price_ids: ::Array[String],
+          maximum_amount: String
+        }
       end
 
       type minimum =
@@ -1264,6 +1496,11 @@ module Orb
           applies_to_price_ids: ::Array[String],
           minimum_amount: String
         ) -> void
+
+        def to_hash: -> {
+          applies_to_price_ids: ::Array[String],
+          minimum_amount: String
+        }
       end
 
       type payment_attempt =
@@ -1271,7 +1508,7 @@ module Orb
           id: String,
           amount: String,
           created_at: Time,
-          payment_provider: Orb::Invoice::PaymentAttempt::payment_provider?,
+          payment_provider: Orb::Models::Invoice::PaymentAttempt::payment_provider?,
           payment_provider_id: String?,
           succeeded: bool
         }
@@ -1283,7 +1520,7 @@ module Orb
 
         attr_accessor created_at: Time
 
-        attr_accessor payment_provider: Orb::Invoice::PaymentAttempt::payment_provider?
+        attr_accessor payment_provider: Orb::Models::Invoice::PaymentAttempt::payment_provider?
 
         attr_accessor payment_provider_id: String?
 
@@ -1293,11 +1530,20 @@ module Orb
           id: String,
           amount: String,
           created_at: Time,
-          payment_provider: Orb::Invoice::PaymentAttempt::payment_provider?,
+          payment_provider: Orb::Models::Invoice::PaymentAttempt::payment_provider?,
           payment_provider_id: String?,
           succeeded: bool
         ) -> void
 
+        def to_hash: -> {
+          id: String,
+          amount: String,
+          created_at: Time,
+          payment_provider: Orb::Models::Invoice::PaymentAttempt::payment_provider?,
+          payment_provider_id: String?,
+          succeeded: bool
+        }
+
         type payment_provider = :stripe
 
         module PaymentProvider
@@ -1305,7 +1551,7 @@ module Orb
 
           STRIPE: :stripe
 
-          def self?.values: -> ::Array[Orb::Invoice::PaymentAttempt::payment_provider]
+          def self?.values: -> ::Array[Orb::Models::Invoice::PaymentAttempt::payment_provider]
         end
       end
 
@@ -1340,6 +1586,15 @@ module Orb
           postal_code: String?,
           state: String?
         ) -> void
+
+        def to_hash: -> {
+          city: String?,
+          country: String?,
+          :line1 => String?,
+          :line2 => String?,
+          postal_code: String?,
+          state: String?
+        }
       end
 
       type status = :issued | :paid | :synced | :void | :draft
@@ -1353,7 +1608,7 @@ module Orb
         VOID: :void
         DRAFT: :draft
 
-        def self?.values: -> ::Array[Orb::Invoice::status]
+        def self?.values: -> ::Array[Orb::Models::Invoice::status]
       end
 
       type subscription = { id: String }
@@ -1362,6 +1617,8 @@ module Orb
         attr_accessor id: String
 
         def initialize: (id: String) -> void
+
+        def to_hash: -> { id: String }
       end
     end
   end