orb-billing 1.16.0 → 1.18.0

data/rbi/orb/resources/invoices.rbi

@@ -402,6 +402,70 @@ module Orb
       )
       end
 
+      # This endpoint triggers a regeneration of the PDF for a finalized invoice.
+      #
+      # The invoice must be finalized (`issued`, `paid`, `synced`, or `void`) and must
+      # already have an existing PDF. The original PDF is archived (not permanently
+      # deleted) to maintain an audit trail.
+      #
+      # **Important Legal Considerations:**
+      #
+      # Regenerating invoice PDFs may not be permitted in all jurisdictions. Many tax
+      # authorities require that issued invoices remain unmodified. Before using this
+      # endpoint, ensure that:
+      #
+      # - Your local tax regulations permit modification of issued billing documents
+      # - You have a legitimate business reason (e.g., fixing template errors, updating
+      #   branding)
+      # - You maintain proper records of the original PDF (archived automatically by
+      #   Orb)
+      #
+      # Recommended use cases:
+      #
+      # - Correcting template rendering issues
+      # - Applying updated company branding
+      # - Updating customer data that was incorrect at issuance
+      sig do
+        params(
+          invoice_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
+      end
+      def regenerate_invoice_pdf(invoice_id, request_options: {})
+      end
+
+      # This endpoint triggers a regeneration of the receipt PDF for a paid invoice.
+      #
+      # The invoice must be in `paid` status and must already have an existing receipt
+      # PDF. The original PDF is archived (not permanently deleted) to maintain an audit
+      # trail.
+      #
+      # **Important Legal Considerations:**
+      #
+      # Regenerating receipt PDFs may not be permitted in all jurisdictions. Many tax
+      # authorities require that issued receipts remain unmodified. Before using this
+      # endpoint, ensure that:
+      #
+      # - Your local tax regulations permit modification of issued billing documents
+      # - You have a legitimate business reason (e.g., fixing template errors, updating
+      #   branding)
+      # - You maintain proper records of the original PDF (archived automatically by
+      #   Orb)
+      #
+      # Recommended use cases:
+      #
+      # - Correcting template rendering issues
+      # - Applying updated company branding
+      # - Updating customer data that was incorrect at issuance
+      sig do
+        params(
+          invoice_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Invoice)
+      end
+      def regenerate_receipt_pdf(invoice_id, request_options: {})
+      end
+
       # This endpoint allows an invoice's status to be set to the `void` status. This
       # can only be done to invoices that are in the `issued` status.
       #

data/sig/orb/models/alert_delete_params.rbs

@@ -0,0 +1,24 @@
+module Orb
+  module Models
+    type alert_delete_params =
+      { alert_configuration_id: String }
+      & Orb::Internal::Type::request_parameters
+
+    class AlertDeleteParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor alert_configuration_id: String
+
+      def initialize: (
+        alert_configuration_id: String,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        alert_configuration_id: String,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models/customer_create_portal_session_by_external_id_params.rbs

@@ -0,0 +1,40 @@
+module Orb
+  module Models
+    type customer_create_portal_session_by_external_id_params =
+      {
+        external_customer_id: String,
+        expires_in_minutes: Integer,
+        invalidate_existing: bool
+      }
+      & Orb::Internal::Type::request_parameters
+
+    class CustomerCreatePortalSessionByExternalIDParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor external_customer_id: String
+
+      attr_reader expires_in_minutes: Integer?
+
+      def expires_in_minutes=: (Integer) -> Integer
+
+      attr_reader invalidate_existing: bool?
+
+      def invalidate_existing=: (bool) -> bool
+
+      def initialize: (
+        external_customer_id: String,
+        ?expires_in_minutes: Integer,
+        ?invalidate_existing: bool,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        external_customer_id: String,
+        expires_in_minutes: Integer,
+        invalidate_existing: bool,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models/customer_create_portal_session_by_external_id_response.rbs

@@ -0,0 +1,40 @@
+module Orb
+  module Models
+    type customer_create_portal_session_by_external_id_response =
+      {
+        id: String,
+        created_at: Time,
+        customer_id: String,
+        expires_at: Time?,
+        url: String
+      }
+
+    class CustomerCreatePortalSessionByExternalIDResponse < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor customer_id: String
+
+      attr_accessor expires_at: Time?
+
+      attr_accessor url: String
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        customer_id: String,
+        expires_at: Time?,
+        url: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        customer_id: String,
+        expires_at: Time?,
+        url: String
+      }
+    end
+  end
+end

data/sig/orb/models/customer_create_portal_session_params.rbs

@@ -0,0 +1,40 @@
+module Orb
+  module Models
+    type customer_create_portal_session_params =
+      {
+        customer_id: String,
+        expires_in_minutes: Integer,
+        invalidate_existing: bool
+      }
+      & Orb::Internal::Type::request_parameters
+
+    class CustomerCreatePortalSessionParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor customer_id: String
+
+      attr_reader expires_in_minutes: Integer?
+
+      def expires_in_minutes=: (Integer) -> Integer
+
+      attr_reader invalidate_existing: bool?
+
+      def invalidate_existing=: (bool) -> bool
+
+      def initialize: (
+        customer_id: String,
+        ?expires_in_minutes: Integer,
+        ?invalidate_existing: bool,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        customer_id: String,
+        expires_in_minutes: Integer,
+        invalidate_existing: bool,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models/customer_create_portal_session_response.rbs

@@ -0,0 +1,40 @@
+module Orb
+  module Models
+    type customer_create_portal_session_response =
+      {
+        id: String,
+        created_at: Time,
+        customer_id: String,
+        expires_at: Time?,
+        url: String
+      }
+
+    class CustomerCreatePortalSessionResponse < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor customer_id: String
+
+      attr_accessor expires_at: Time?
+
+      attr_accessor url: String
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        customer_id: String,
+        expires_at: Time?,
+        url: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        customer_id: String,
+        expires_at: Time?,
+        url: String
+      }
+    end
+  end
+end

data/sig/orb/models/event_ingest_params.rbs

@@ -1,11 +1,7 @@
 module Orb
   module Models
     type event_ingest_params =
-      {
-        events: ::Array[Orb::EventIngestParams::Event],
-        backfill_id: String?,
-        debug: bool
-      }
+      { events: ::Array[Orb::EventIngestParams::Event], backfill_id: String? }
       & Orb::Internal::Type::request_parameters
 
     class EventIngestParams < Orb::Internal::Type::BaseModel
@@ -16,21 +12,15 @@ module Orb
 
       attr_accessor backfill_id: String?
 
-      attr_reader debug: bool?
-
-      def debug=: (bool) -> bool
-
       def initialize: (
         events: ::Array[Orb::EventIngestParams::Event],
         ?backfill_id: String?,
-        ?debug: bool,
         ?request_options: Orb::request_opts
       ) -> void
 
       def to_hash: -> {
         events: ::Array[Orb::EventIngestParams::Event],
         backfill_id: String?,
-        debug: bool,
         request_options: Orb::RequestOptions
       }
 

data/sig/orb/models/event_ingest_response.rbs

@@ -2,23 +2,18 @@ module Orb
   module Models
     type event_ingest_response =
       {
-        validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed],
-        debug: Orb::Models::EventIngestResponse::Debug?
+        validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed]
       }
 
     class EventIngestResponse < Orb::Internal::Type::BaseModel
       attr_accessor validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed]
 
-      attr_accessor debug: Orb::Models::EventIngestResponse::Debug?
-
       def initialize: (
-        validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed],
-        ?debug: Orb::Models::EventIngestResponse::Debug?
+        validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed]
       ) -> void
 
       def to_hash: -> {
-        validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed],
-        debug: Orb::Models::EventIngestResponse::Debug?
+        validation_failed: ::Array[Orb::Models::EventIngestResponse::ValidationFailed]
       }
 
       type validation_failed =
@@ -39,24 +34,6 @@ module Orb
           validation_errors: ::Array[String]
         }
       end
-
-      type debug = { duplicate: ::Array[String], ingested: ::Array[String] }
-
-      class Debug < Orb::Internal::Type::BaseModel
-        attr_accessor duplicate: ::Array[String]
-
-        attr_accessor ingested: ::Array[String]
-
-        def initialize: (
-          duplicate: ::Array[String],
-          ingested: ::Array[String]
-        ) -> void
-
-        def to_hash: -> {
-          duplicate: ::Array[String],
-          ingested: ::Array[String]
-        }
-      end
     end
   end
 end

data/sig/orb/models/invoice_regenerate_invoice_pdf_params.rbs

@@ -0,0 +1,23 @@
+module Orb
+  module Models
+    type invoice_regenerate_invoice_pdf_params =
+      { invoice_id: String } & Orb::Internal::Type::request_parameters
+
+    class InvoiceRegenerateInvoicePdfParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor invoice_id: String
+
+      def initialize: (
+        invoice_id: String,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        invoice_id: String,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models/invoice_regenerate_receipt_pdf_params.rbs

@@ -0,0 +1,23 @@
+module Orb
+  module Models
+    type invoice_regenerate_receipt_pdf_params =
+      { invoice_id: String } & Orb::Internal::Type::request_parameters
+
+    class InvoiceRegenerateReceiptPdfParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor invoice_id: String
+
+      def initialize: (
+        invoice_id: String,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        invoice_id: String,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models.rbs

@@ -17,6 +17,8 @@ module Orb
 
   class AlertCreateForSubscriptionParams = Orb::Models::AlertCreateForSubscriptionParams
 
+  class AlertDeleteParams = Orb::Models::AlertDeleteParams
+
   class AlertDisableParams = Orb::Models::AlertDisableParams
 
   class AlertEnableParams = Orb::Models::AlertEnableParams
@@ -99,6 +101,10 @@ module Orb
 
   class CustomerCreateParams = Orb::Models::CustomerCreateParams
 
+  class CustomerCreatePortalSessionByExternalIDParams = Orb::Models::CustomerCreatePortalSessionByExternalIDParams
+
+  class CustomerCreatePortalSessionParams = Orb::Models::CustomerCreatePortalSessionParams
+
   class CustomerDeleteParams = Orb::Models::CustomerDeleteParams
 
   class CustomerFetchByExternalIDParams = Orb::Models::CustomerFetchByExternalIDParams
@@ -187,6 +193,10 @@ module Orb
 
   class InvoicePayParams = Orb::Models::InvoicePayParams
 
+  class InvoiceRegenerateInvoicePdfParams = Orb::Models::InvoiceRegenerateInvoicePdfParams
+
+  class InvoiceRegenerateReceiptPdfParams = Orb::Models::InvoiceRegenerateReceiptPdfParams
+
   class InvoiceTiny = Orb::Models::InvoiceTiny
 
   class InvoiceUpdateParams = Orb::Models::InvoiceUpdateParams

data/sig/orb/resources/alerts.rbs

@@ -27,6 +27,11 @@ module Orb
         ?request_options: Orb::request_opts
       ) -> Orb::Internal::Page[Orb::Alert]
 
+      def delete: (
+        String alert_configuration_id,
+        ?request_options: Orb::request_opts
+      ) -> nil
+
       def create_for_customer: (
         String customer_id,
         currency: String,

data/sig/orb/resources/customers.rbs

@@ -71,6 +71,20 @@ module Orb
         ?request_options: Orb::request_opts
       ) -> nil
 
+      def create_portal_session: (
+        String customer_id,
+        ?expires_in_minutes: Integer,
+        ?invalidate_existing: bool,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::CustomerCreatePortalSessionResponse
+
+      def create_portal_session_by_external_id: (
+        String external_customer_id,
+        ?expires_in_minutes: Integer,
+        ?invalidate_existing: bool,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::CustomerCreatePortalSessionByExternalIDResponse
+
       def fetch: (
         String customer_id,
         ?request_options: Orb::request_opts

data/sig/orb/resources/events.rbs

@@ -23,7 +23,6 @@ module Orb
       def ingest: (
         events: ::Array[Orb::EventIngestParams::Event],
         ?backfill_id: String?,
-        ?debug: bool,
         ?request_options: Orb::request_opts
       ) -> Orb::Models::EventIngestResponse
 

data/sig/orb/resources/invoices.rbs

@@ -115,6 +115,16 @@ module Orb
         ?request_options: Orb::request_opts
       ) -> Orb::Invoice
 
+      def regenerate_invoice_pdf: (
+        String invoice_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Invoice
+
+      def regenerate_receipt_pdf: (
+        String invoice_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Invoice
+
       def `void`: (
         String invoice_id,
         ?request_options: Orb::request_opts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Orb
@@ -77,6 +77,7 @@ files:
 - lib/orb/models/alert_create_for_customer_params.rb
 - lib/orb/models/alert_create_for_external_customer_params.rb
 - lib/orb/models/alert_create_for_subscription_params.rb
+- lib/orb/models/alert_delete_params.rb
 - lib/orb/models/alert_disable_params.rb
 - lib/orb/models/alert_enable_params.rb
 - lib/orb/models/alert_list_params.rb
@@ -123,6 +124,10 @@ files:
 - lib/orb/models/custom_expiration.rb
 - lib/orb/models/customer.rb
 - lib/orb/models/customer_create_params.rb
+- lib/orb/models/customer_create_portal_session_by_external_id_params.rb
+- lib/orb/models/customer_create_portal_session_by_external_id_response.rb
+- lib/orb/models/customer_create_portal_session_params.rb
+- lib/orb/models/customer_create_portal_session_response.rb
 - lib/orb/models/customer_delete_params.rb
 - lib/orb/models/customer_fetch_by_external_id_params.rb
 - lib/orb/models/customer_fetch_params.rb
@@ -224,6 +229,8 @@ files:
 - lib/orb/models/invoice_list_summary_response.rb
 - lib/orb/models/invoice_mark_paid_params.rb
 - lib/orb/models/invoice_pay_params.rb
+- lib/orb/models/invoice_regenerate_invoice_pdf_params.rb
+- lib/orb/models/invoice_regenerate_receipt_pdf_params.rb
 - lib/orb/models/invoice_tiny.rb
 - lib/orb/models/invoice_update_params.rb
 - lib/orb/models/invoice_void_params.rb
@@ -517,6 +524,7 @@ files:
 - rbi/orb/models/alert_create_for_customer_params.rbi
 - rbi/orb/models/alert_create_for_external_customer_params.rbi
 - rbi/orb/models/alert_create_for_subscription_params.rbi
+- rbi/orb/models/alert_delete_params.rbi
 - rbi/orb/models/alert_disable_params.rbi
 - rbi/orb/models/alert_enable_params.rbi
 - rbi/orb/models/alert_list_params.rbi
@@ -563,6 +571,10 @@ files:
 - rbi/orb/models/custom_expiration.rbi
 - rbi/orb/models/customer.rbi
 - rbi/orb/models/customer_create_params.rbi
+- rbi/orb/models/customer_create_portal_session_by_external_id_params.rbi
+- rbi/orb/models/customer_create_portal_session_by_external_id_response.rbi
+- rbi/orb/models/customer_create_portal_session_params.rbi
+- rbi/orb/models/customer_create_portal_session_response.rbi
 - rbi/orb/models/customer_delete_params.rbi
 - rbi/orb/models/customer_fetch_by_external_id_params.rbi
 - rbi/orb/models/customer_fetch_params.rbi
@@ -664,6 +676,8 @@ files:
 - rbi/orb/models/invoice_list_summary_response.rbi
 - rbi/orb/models/invoice_mark_paid_params.rbi
 - rbi/orb/models/invoice_pay_params.rbi
+- rbi/orb/models/invoice_regenerate_invoice_pdf_params.rbi
+- rbi/orb/models/invoice_regenerate_receipt_pdf_params.rbi
 - rbi/orb/models/invoice_tiny.rbi
 - rbi/orb/models/invoice_update_params.rbi
 - rbi/orb/models/invoice_void_params.rbi
@@ -956,6 +970,7 @@ files:
 - sig/orb/models/alert_create_for_customer_params.rbs
 - sig/orb/models/alert_create_for_external_customer_params.rbs
 - sig/orb/models/alert_create_for_subscription_params.rbs
+- sig/orb/models/alert_delete_params.rbs
 - sig/orb/models/alert_disable_params.rbs
 - sig/orb/models/alert_enable_params.rbs
 - sig/orb/models/alert_list_params.rbs
@@ -1002,6 +1017,10 @@ files:
 - sig/orb/models/custom_expiration.rbs
 - sig/orb/models/customer.rbs
 - sig/orb/models/customer_create_params.rbs
+- sig/orb/models/customer_create_portal_session_by_external_id_params.rbs
+- sig/orb/models/customer_create_portal_session_by_external_id_response.rbs
+- sig/orb/models/customer_create_portal_session_params.rbs
+- sig/orb/models/customer_create_portal_session_response.rbs
 - sig/orb/models/customer_delete_params.rbs
 - sig/orb/models/customer_fetch_by_external_id_params.rbs
 - sig/orb/models/customer_fetch_params.rbs
@@ -1103,6 +1122,8 @@ files:
 - sig/orb/models/invoice_list_summary_response.rbs
 - sig/orb/models/invoice_mark_paid_params.rbs
 - sig/orb/models/invoice_pay_params.rbs
+- sig/orb/models/invoice_regenerate_invoice_pdf_params.rbs
+- sig/orb/models/invoice_regenerate_receipt_pdf_params.rbs
 - sig/orb/models/invoice_tiny.rbs
 - sig/orb/models/invoice_update_params.rbs
 - sig/orb/models/invoice_void_params.rbs