orb-billing 1.35.0 → 1.37.0

data/sig/orb/models/invoice_issued_summary_webhook_event.rbs

@@ -0,0 +1,504 @@
+module Orb
+  module Models
+    type invoice_issued_summary_webhook_event =
+      {
+        id: String,
+        created_at: Time,
+        invoice: Orb::InvoiceIssuedSummaryWebhookEvent::Invoice,
+        properties: Orb::InvoiceIssuedSummaryWebhookEvent::Properties,
+        type: Orb::Models::InvoiceIssuedSummaryWebhookEvent::type_
+      }
+
+    class InvoiceIssuedSummaryWebhookEvent < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor invoice: Orb::InvoiceIssuedSummaryWebhookEvent::Invoice
+
+      attr_accessor properties: Orb::InvoiceIssuedSummaryWebhookEvent::Properties
+
+      attr_accessor type: Orb::Models::InvoiceIssuedSummaryWebhookEvent::type_
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        invoice: Orb::InvoiceIssuedSummaryWebhookEvent::Invoice,
+        properties: Orb::InvoiceIssuedSummaryWebhookEvent::Properties,
+        type: Orb::Models::InvoiceIssuedSummaryWebhookEvent::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        invoice: Orb::InvoiceIssuedSummaryWebhookEvent::Invoice,
+        properties: Orb::InvoiceIssuedSummaryWebhookEvent::Properties,
+        type: Orb::Models::InvoiceIssuedSummaryWebhookEvent::type_
+      }
+
+      type invoice =
+        {
+          id: String,
+          amount_due: String,
+          auto_collection: Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::AutoCollection,
+          billing_address: Orb::Address?,
+          created_at: Time,
+          credit_notes: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CreditNote],
+          currency: String,
+          customer: Orb::CustomerMinified,
+          customer_balance_transactions: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction],
+          customer_tax_id: Orb::CustomerTaxID?,
+          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::InvoiceIssuedSummaryWebhookEvent::Invoice::invoice_source,
+          issue_failed_at: Time?,
+          issued_at: Time?,
+          memo: String?,
+          metadata: ::Hash[Symbol, String],
+          paid_at: Time?,
+          payment_attempts: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt],
+          payment_failed_at: Time?,
+          payment_started_at: Time?,
+          scheduled_issue_at: Time?,
+          shipping_address: Orb::Address?,
+          status: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::status,
+          subscription: Orb::SubscriptionMinified?,
+          sync_failed_at: Time?,
+          total: String,
+          voided_at: Time?,
+          will_auto_issue: bool
+        }
+
+      class Invoice < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor amount_due: String
+
+        attr_accessor auto_collection: Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::AutoCollection
+
+        attr_accessor billing_address: Orb::Address?
+
+        attr_accessor created_at: Time
+
+        attr_accessor credit_notes: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CreditNote]
+
+        attr_accessor currency: String
+
+        attr_accessor customer: Orb::CustomerMinified
+
+        attr_accessor customer_balance_transactions: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction]
+
+        attr_accessor customer_tax_id: Orb::CustomerTaxID?
+
+        attr_accessor due_date: Time?
+
+        attr_accessor eligible_to_issue_at: Time?
+
+        attr_accessor hosted_invoice_url: String?
+
+        attr_accessor invoice_date: Time
+
+        attr_accessor invoice_number: String
+
+        attr_accessor invoice_pdf: String?
+
+        attr_accessor invoice_source: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::invoice_source
+
+        attr_accessor issue_failed_at: Time?
+
+        attr_accessor issued_at: Time?
+
+        attr_accessor memo: String?
+
+        attr_accessor metadata: ::Hash[Symbol, String]
+
+        attr_accessor paid_at: Time?
+
+        attr_accessor payment_attempts: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt]
+
+        attr_accessor payment_failed_at: Time?
+
+        attr_accessor payment_started_at: Time?
+
+        attr_accessor scheduled_issue_at: Time?
+
+        attr_accessor shipping_address: Orb::Address?
+
+        attr_accessor status: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::status
+
+        attr_accessor subscription: Orb::SubscriptionMinified?
+
+        attr_accessor sync_failed_at: Time?
+
+        attr_accessor total: String
+
+        attr_accessor voided_at: Time?
+
+        attr_accessor will_auto_issue: bool
+
+        def initialize: (
+          id: String,
+          amount_due: String,
+          auto_collection: Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::AutoCollection,
+          billing_address: Orb::Address?,
+          created_at: Time,
+          credit_notes: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CreditNote],
+          currency: String,
+          customer: Orb::CustomerMinified,
+          customer_balance_transactions: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction],
+          customer_tax_id: Orb::CustomerTaxID?,
+          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::InvoiceIssuedSummaryWebhookEvent::Invoice::invoice_source,
+          issue_failed_at: Time?,
+          issued_at: Time?,
+          memo: String?,
+          metadata: ::Hash[Symbol, String],
+          paid_at: Time?,
+          payment_attempts: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt],
+          payment_failed_at: Time?,
+          payment_started_at: Time?,
+          scheduled_issue_at: Time?,
+          shipping_address: Orb::Address?,
+          status: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::status,
+          subscription: Orb::SubscriptionMinified?,
+          sync_failed_at: Time?,
+          total: String,
+          voided_at: Time?,
+          will_auto_issue: bool
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          amount_due: String,
+          auto_collection: Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::AutoCollection,
+          billing_address: Orb::Address?,
+          created_at: Time,
+          credit_notes: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CreditNote],
+          currency: String,
+          customer: Orb::CustomerMinified,
+          customer_balance_transactions: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction],
+          customer_tax_id: Orb::CustomerTaxID?,
+          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::InvoiceIssuedSummaryWebhookEvent::Invoice::invoice_source,
+          issue_failed_at: Time?,
+          issued_at: Time?,
+          memo: String?,
+          metadata: ::Hash[Symbol, String],
+          paid_at: Time?,
+          payment_attempts: ::Array[Orb::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt],
+          payment_failed_at: Time?,
+          payment_started_at: Time?,
+          scheduled_issue_at: Time?,
+          shipping_address: Orb::Address?,
+          status: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::status,
+          subscription: Orb::SubscriptionMinified?,
+          sync_failed_at: Time?,
+          total: String,
+          voided_at: Time?,
+          will_auto_issue: bool
+        }
+
+        type auto_collection =
+          {
+            enabled: bool?,
+            next_attempt_at: Time?,
+            num_attempts: Integer?,
+            previously_attempted_at: Time?
+          }
+
+        class AutoCollection < Orb::Internal::Type::BaseModel
+          attr_accessor enabled: bool?
+
+          attr_accessor next_attempt_at: Time?
+
+          attr_accessor num_attempts: Integer?
+
+          attr_accessor previously_attempted_at: Time?
+
+          def initialize: (
+            enabled: bool?,
+            next_attempt_at: Time?,
+            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 credit_note =
+          {
+            id: String,
+            credit_note_number: String,
+            memo: String?,
+            reason: String,
+            total: String,
+            type: String,
+            voided_at: Time?
+          }
+
+        class CreditNote < Orb::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor credit_note_number: String
+
+          attr_accessor memo: String?
+
+          attr_accessor reason: String
+
+          attr_accessor total: String
+
+          attr_accessor type: String
+
+          attr_accessor voided_at: Time?
+
+          def initialize: (
+            id: String,
+            credit_note_number: String,
+            memo: String?,
+            reason: String,
+            total: String,
+            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_balance_transaction =
+          {
+            id: String,
+            action: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::action,
+            amount: String,
+            created_at: Time,
+            credit_note: Orb::CreditNoteTiny?,
+            description: String?,
+            ending_balance: String,
+            invoice: Orb::InvoiceTiny?,
+            starting_balance: String,
+            type: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::type_
+          }
+
+        class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor action: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::action
+
+          attr_accessor amount: String
+
+          attr_accessor created_at: Time
+
+          attr_accessor credit_note: Orb::CreditNoteTiny?
+
+          attr_accessor description: String?
+
+          attr_accessor ending_balance: String
+
+          attr_accessor invoice: Orb::InvoiceTiny?
+
+          attr_accessor starting_balance: String
+
+          attr_accessor type: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::type_
+
+          def initialize: (
+            id: String,
+            action: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::action,
+            amount: String,
+            created_at: Time,
+            credit_note: Orb::CreditNoteTiny?,
+            description: String?,
+            ending_balance: String,
+            invoice: Orb::InvoiceTiny?,
+            starting_balance: String,
+            type: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::type_
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            action: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::action,
+            amount: String,
+            created_at: Time,
+            credit_note: Orb::CreditNoteTiny?,
+            description: String?,
+            ending_balance: String,
+            invoice: Orb::InvoiceTiny?,
+            starting_balance: String,
+            type: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::type_
+          }
+
+          type action =
+            :applied_to_invoice
+            | :manual_adjustment
+            | :prorated_refund
+            | :revert_prorated_refund
+            | :return_from_voiding
+            | :credit_note_applied
+            | :credit_note_voided
+            | :overpayment_refund
+            | :external_payment
+            | :small_invoice_carryover
+            | :prepaid_commit_cancel
+
+          module Action
+            extend Orb::Internal::Type::Enum
+
+            APPLIED_TO_INVOICE: :applied_to_invoice
+            MANUAL_ADJUSTMENT: :manual_adjustment
+            PRORATED_REFUND: :prorated_refund
+            REVERT_PRORATED_REFUND: :revert_prorated_refund
+            RETURN_FROM_VOIDING: :return_from_voiding
+            CREDIT_NOTE_APPLIED: :credit_note_applied
+            CREDIT_NOTE_VOIDED: :credit_note_voided
+            OVERPAYMENT_REFUND: :overpayment_refund
+            EXTERNAL_PAYMENT: :external_payment
+            SMALL_INVOICE_CARRYOVER: :small_invoice_carryover
+            PREPAID_COMMIT_CANCEL: :prepaid_commit_cancel
+
+            def self?.values: -> ::Array[Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::action]
+          end
+
+          type type_ = :increment | :decrement
+
+          module Type
+            extend Orb::Internal::Type::Enum
+
+            INCREMENT: :increment
+            DECREMENT: :decrement
+
+            def self?.values: -> ::Array[Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::type_]
+          end
+        end
+
+        type invoice_source = :subscription | :partial | :one_off
+
+        module InvoiceSource
+          extend Orb::Internal::Type::Enum
+
+          SUBSCRIPTION: :subscription
+          PARTIAL: :partial
+          ONE_OFF: :one_off
+
+          def self?.values: -> ::Array[Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::invoice_source]
+        end
+
+        type payment_attempt =
+          {
+            id: String,
+            amount: String,
+            created_at: Time,
+            payment_provider: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::payment_provider?,
+            payment_provider_id: String?,
+            receipt_pdf: String?,
+            succeeded: bool
+          }
+
+        class PaymentAttempt < Orb::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor amount: String
+
+          attr_accessor created_at: Time
+
+          attr_accessor payment_provider: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::payment_provider?
+
+          attr_accessor payment_provider_id: String?
+
+          attr_accessor receipt_pdf: String?
+
+          attr_accessor succeeded: bool
+
+          def initialize: (
+            id: String,
+            amount: String,
+            created_at: Time,
+            payment_provider: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::payment_provider?,
+            payment_provider_id: String?,
+            receipt_pdf: String?,
+            succeeded: bool
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            amount: String,
+            created_at: Time,
+            payment_provider: Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::payment_provider?,
+            payment_provider_id: String?,
+            receipt_pdf: String?,
+            succeeded: bool
+          }
+
+          type payment_provider = :stripe | :adyen
+
+          module PaymentProvider
+            extend Orb::Internal::Type::Enum
+
+            STRIPE: :stripe
+            ADYEN: :adyen
+
+            def self?.values: -> ::Array[Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::PaymentAttempt::payment_provider]
+          end
+        end
+
+        type status = :issued | :paid | :synced | :void | :draft
+
+        module Status
+          extend Orb::Internal::Type::Enum
+
+          ISSUED: :issued
+          PAID: :paid
+          SYNCED: :synced
+          VOID: :void
+          DRAFT: :draft
+
+          def self?.values: -> ::Array[Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::status]
+        end
+      end
+
+      type properties = { automatically_marked_as_paid: bool }
+
+      class Properties < Orb::Internal::Type::BaseModel
+        attr_accessor automatically_marked_as_paid: bool
+
+        def initialize: (automatically_marked_as_paid: bool) -> void
+
+        def to_hash: -> { automatically_marked_as_paid: bool }
+      end
+
+      type type_ = :"invoice.issued_summary"
+
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_ISSUED_SUMMARY: :"invoice.issued_summary"
+
+        def self?.values: -> ::Array[Orb::Models::InvoiceIssuedSummaryWebhookEvent::type_]
+      end
+    end
+  end
+end

data/sig/orb/models/invoice_issued_webhook_event.rbs

@@ -0,0 +1,60 @@
+module Orb
+  module Models
+    type invoice_issued_webhook_event =
+      {
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: Orb::InvoiceIssuedWebhookEvent::Properties,
+        type: Orb::Models::InvoiceIssuedWebhookEvent::type_
+      }
+
+    class InvoiceIssuedWebhookEvent < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor invoice: Orb::Invoice
+
+      attr_accessor properties: Orb::InvoiceIssuedWebhookEvent::Properties
+
+      attr_accessor type: Orb::Models::InvoiceIssuedWebhookEvent::type_
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: Orb::InvoiceIssuedWebhookEvent::Properties,
+        type: Orb::Models::InvoiceIssuedWebhookEvent::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: Orb::InvoiceIssuedWebhookEvent::Properties,
+        type: Orb::Models::InvoiceIssuedWebhookEvent::type_
+      }
+
+      type properties = { automatically_marked_as_paid: bool }
+
+      class Properties < Orb::Internal::Type::BaseModel
+        attr_accessor automatically_marked_as_paid: bool
+
+        def initialize: (automatically_marked_as_paid: bool) -> void
+
+        def to_hash: -> { automatically_marked_as_paid: bool }
+      end
+
+      type type_ = :"invoice.issued"
+
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_ISSUED: :"invoice.issued"
+
+        def self?.values: -> ::Array[Orb::Models::InvoiceIssuedWebhookEvent::type_]
+      end
+    end
+  end
+end

data/sig/orb/models/invoice_manually_marked_as_paid_webhook_event.rbs

@@ -0,0 +1,73 @@
+module Orb
+  module Models
+    type invoice_manually_marked_as_paid_webhook_event =
+      {
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: Orb::InvoiceManuallyMarkedAsPaidWebhookEvent::Properties,
+        type: Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::type_
+      }
+
+    class InvoiceManuallyMarkedAsPaidWebhookEvent < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor invoice: Orb::Invoice
+
+      attr_accessor properties: Orb::InvoiceManuallyMarkedAsPaidWebhookEvent::Properties
+
+      attr_accessor type: Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::type_
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: Orb::InvoiceManuallyMarkedAsPaidWebhookEvent::Properties,
+        type: Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: Orb::InvoiceManuallyMarkedAsPaidWebhookEvent::Properties,
+        type: Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::type_
+      }
+
+      type properties =
+        { external_id: String?, notes: String?, payment_received_date: Time? }
+
+      class Properties < Orb::Internal::Type::BaseModel
+        attr_accessor external_id: String?
+
+        attr_accessor notes: String?
+
+        attr_accessor payment_received_date: Time?
+
+        def initialize: (
+          external_id: String?,
+          notes: String?,
+          payment_received_date: Time?
+        ) -> void
+
+        def to_hash: -> {
+          external_id: String?,
+          notes: String?,
+          payment_received_date: Time?
+        }
+      end
+
+      type type_ = :"invoice.manually_marked_as_paid"
+
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_MANUALLY_MARKED_AS_PAID: :"invoice.manually_marked_as_paid"
+
+        def self?.values: -> ::Array[Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent::type_]
+      end
+    end
+  end
+end

data/sig/orb/models/invoice_manually_marked_as_void_webhook_event.rbs

@@ -0,0 +1,50 @@
+module Orb
+  module Models
+    type invoice_manually_marked_as_void_webhook_event =
+      {
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: top,
+        type: Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent::type_
+      }
+
+    class InvoiceManuallyMarkedAsVoidWebhookEvent < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor invoice: Orb::Invoice
+
+      attr_accessor properties: top
+
+      attr_accessor type: Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent::type_
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: top,
+        type: Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        invoice: Orb::Invoice,
+        properties: top,
+        type: Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent::type_
+      }
+
+      type type_ = :"invoice.manually_marked_as_void"
+
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_MANUALLY_MARKED_AS_VOID: :"invoice.manually_marked_as_void"
+
+        def self?.values: -> ::Array[Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent::type_]
+      end
+    end
+  end
+end