orb-billing 1.45.0 → 1.46.0

data/sig/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbs

@@ -0,0 +1,638 @@
+module Orb
+  module Models
+    module Webhooks
+      type invoice_dunning_schedule_created_standard_webhook_event =
+        {
+          id: String,
+          created_at: Time,
+          invoice: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice,
+          payload_style: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::payload_style,
+          properties: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties,
+          type: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::type_
+        }
+
+      class InvoiceDunningScheduleCreatedStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor invoice: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice
+
+        attr_accessor payload_style: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::payload_style
+
+        attr_accessor properties: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties
+
+        attr_accessor type: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::type_
+
+        def initialize: (
+          id: String,
+          created_at: Time,
+          invoice: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice,
+          payload_style: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::payload_style,
+          properties: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties,
+          type: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::type_
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Time,
+          invoice: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice,
+          payload_style: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::payload_style,
+          properties: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties,
+          type: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::type_
+        }
+
+        type invoice =
+          {
+            id: String,
+            amount_due: String,
+            auto_collection: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::AutoCollection,
+            billing_address: Orb::Address?,
+            created_at: Time,
+            credit_notes: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::CreditNote],
+            currency: String,
+            customer: Orb::CustomerMinified,
+            customer_balance_transactions: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::invoice_source,
+            issue_failed_at: Time?,
+            issued_at: Time?,
+            memo: String?,
+            metadata: ::Hash[Symbol, String],
+            paid_at: Time?,
+            payment_attempts: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::PaymentAttempt],
+            payment_failed_at: Time?,
+            payment_received_at: Time?,
+            payment_started_at: Time?,
+            scheduled_issue_at: Time?,
+            shipping_address: Orb::Address?,
+            status: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::AutoCollection
+
+          attr_accessor billing_address: Orb::Address?
+
+          attr_accessor created_at: Time
+
+          attr_accessor credit_notes: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::CreditNote]
+
+          attr_accessor currency: String
+
+          attr_accessor customer: Orb::CustomerMinified
+
+          attr_accessor customer_balance_transactions: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::PaymentAttempt]
+
+          attr_accessor payment_failed_at: Time?
+
+          attr_accessor payment_received_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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::AutoCollection,
+            billing_address: Orb::Address?,
+            created_at: Time,
+            credit_notes: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::CreditNote],
+            currency: String,
+            customer: Orb::CustomerMinified,
+            customer_balance_transactions: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::invoice_source,
+            issue_failed_at: Time?,
+            issued_at: Time?,
+            memo: String?,
+            metadata: ::Hash[Symbol, String],
+            paid_at: Time?,
+            payment_attempts: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::PaymentAttempt],
+            payment_failed_at: Time?,
+            payment_received_at: Time?,
+            payment_started_at: Time?,
+            scheduled_issue_at: Time?,
+            shipping_address: Orb::Address?,
+            status: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::AutoCollection,
+            billing_address: Orb::Address?,
+            created_at: Time,
+            credit_notes: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::CreditNote],
+            currency: String,
+            customer: Orb::CustomerMinified,
+            customer_balance_transactions: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::invoice_source,
+            issue_failed_at: Time?,
+            issued_at: Time?,
+            memo: String?,
+            metadata: ::Hash[Symbol, String],
+            paid_at: Time?,
+            payment_attempts: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::PaymentAttempt],
+            payment_failed_at: Time?,
+            payment_received_at: Time?,
+            payment_started_at: Time?,
+            scheduled_issue_at: Time?,
+            shipping_address: Orb::Address?,
+            status: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::type_
+            }
+
+          class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            attr_accessor action: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::type_
+
+            def initialize: (
+              id: String,
+              action: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::type_
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              action: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::invoice_source]
+          end
+
+          type payment_attempt =
+            {
+              id: String,
+              amount: String,
+              created_at: Time,
+              payment_provider: Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::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::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::status]
+          end
+        end
+
+        type payload_style = :expanded | :standard
+
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED: :expanded
+          STANDARD: :standard
+
+          def self?.values: -> ::Array[Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::payload_style]
+        end
+
+        type properties =
+          {
+            dunning_schedule: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties::DunningSchedule,
+            dunning_steps: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties::DunningStep],
+            source: String
+          }
+
+        class Properties < Orb::Internal::Type::BaseModel
+          attr_accessor dunning_schedule: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties::DunningSchedule
+
+          attr_accessor dunning_steps: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties::DunningStep]
+
+          attr_accessor source: String
+
+          def initialize: (
+            dunning_schedule: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties::DunningSchedule,
+            dunning_steps: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties::DunningStep],
+            source: String
+          ) -> void
+
+          def to_hash: -> {
+            dunning_schedule: Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties::DunningSchedule,
+            dunning_steps: ::Array[Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Properties::DunningStep],
+            source: String
+          }
+
+          type dunning_schedule =
+            {
+              completion_time: Time?,
+              created_at: Time?,
+              invoice_id: String,
+              modified_at: Time?,
+              start_time: Time?,
+              status: String
+            }
+
+          class DunningSchedule < Orb::Internal::Type::BaseModel
+            attr_accessor completion_time: Time?
+
+            attr_accessor created_at: Time?
+
+            attr_accessor invoice_id: String
+
+            attr_accessor modified_at: Time?
+
+            attr_accessor start_time: Time?
+
+            attr_accessor status: String
+
+            def initialize: (
+              completion_time: Time?,
+              created_at: Time?,
+              invoice_id: String,
+              modified_at: Time?,
+              start_time: Time?,
+              status: String
+            ) -> void
+
+            def to_hash: -> {
+              completion_time: Time?,
+              created_at: Time?,
+              invoice_id: String,
+              modified_at: Time?,
+              start_time: Time?,
+              status: String
+            }
+          end
+
+          type dunning_step =
+            {
+              actions: ::Array[String],
+              created_at: Time?,
+              execution_time: Time?,
+              manually_triggered_at: Time?,
+              modified_at: Time?,
+              status: String,
+              step_number: Integer?,
+              timestamp: Time?
+            }
+
+          class DunningStep < Orb::Internal::Type::BaseModel
+            attr_accessor actions: ::Array[String]
+
+            attr_accessor created_at: Time?
+
+            attr_accessor execution_time: Time?
+
+            attr_accessor manually_triggered_at: Time?
+
+            attr_accessor modified_at: Time?
+
+            attr_accessor status: String
+
+            attr_accessor step_number: Integer?
+
+            attr_accessor timestamp: Time?
+
+            def initialize: (
+              actions: ::Array[String],
+              created_at: Time?,
+              execution_time: Time?,
+              manually_triggered_at: Time?,
+              modified_at: Time?,
+              status: String,
+              step_number: Integer?,
+              timestamp: Time?
+            ) -> void
+
+            def to_hash: -> {
+              actions: ::Array[String],
+              created_at: Time?,
+              execution_time: Time?,
+              manually_triggered_at: Time?,
+              modified_at: Time?,
+              status: String,
+              step_number: Integer?,
+              timestamp: Time?
+            }
+          end
+        end
+
+        type type_ = :"invoice.dunning_schedule_created"
+
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          INVOICE_DUNNING_SCHEDULE_CREATED: :"invoice.dunning_schedule_created"
+
+          def self?.values: -> ::Array[Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::type_]
+        end
+      end
+    end
+  end
+end