orb-billing 0.1.0.pre.alpha.38 → 0.1.1

data/rbi/lib/orb/resources/invoice_line_items.rbi

@@ -4,7 +4,7 @@ module Orb
   module Resources
     class InvoiceLineItems
       # This creates a one-off fixed fee invoice line item on an Invoice. This can only
-      #   be done for invoices that are in a `draft` status.
+      # be done for invoices that are in a `draft` status.
       sig do
         params(
           amount: String,
@@ -25,20 +25,17 @@ module Orb
         # The id of the Invoice to add this line item.
         invoice_id:,
         # The item name associated with this line item. If an item with the same name
-        #   exists in Orb, that item will be associated with the line item.
+        # exists in Orb, that item will be associated with the line item.
         name:,
         # The number of units on the line item
         quantity:,
         # A date string to specify the line item's start date in the customer's timezone.
         start_date:,
         request_options: {}
-      )
-      end
-
+      ); end
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/orb/resources/invoices.rbi

@@ -30,43 +30,42 @@ module Orb
       end
       def create(
         # An ISO 4217 currency string. Must be the same as the customer's currency if it
-        #   is set.
+        # is set.
         currency:,
         # Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
-        #   set to the current time in the customer's timezone.
+        # set to the current time in the customer's timezone.
         invoice_date:,
         line_items:,
         # Determines the difference between the invoice issue date for subscription
-        #   invoices as the date that they are due. A value of '0' here represents that the
-        #   invoice is due on issue, whereas a value of 30 represents that the customer has
-        #   30 days to pay the invoice.
+        # invoices as the date that they are due. A value of '0' here represents that the
+        # invoice is due on issue, whereas a value of 30 represents that the customer has
+        # 30 days to pay the invoice.
         net_terms:,
         # The id of the `Customer` to create this invoice for. One of `customer_id` and
-        #   `external_customer_id` are required.
+        # `external_customer_id` are required.
         customer_id: nil,
         # An optional discount to attach to the invoice.
         discount: nil,
         # The `external_customer_id` of the `Customer` to create this invoice for. One of
-        #   `customer_id` and `external_customer_id` are required.
+        # `customer_id` and `external_customer_id` are required.
         external_customer_id: nil,
         # An optional memo to attach to the invoice.
         memo: nil,
         # 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`.
+        # by setting the value to `null`, and the entire metadata mapping can be cleared
+        # by setting `metadata` to `null`.
         metadata: nil,
-        # When true, this invoice will automatically be issued upon creation. When false,
-        #   the resulting invoice will require manual review to issue. Defaulted to false.
+        # When true, this invoice will be submitted for issuance upon creation. When
+        # false, the resulting invoice will require manual review to issue. Defaulted to
+        # false.
         will_auto_issue: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint allows you to update the `metadata` property on an invoice. If you
-      #   pass null for the metadata value, it will clear any existing metadata for that
-      #   invoice.
+      # pass null for the metadata value, it will clear any existing metadata for that
+      # invoice.
       #
-      #   `metadata` can be modified regardless of invoice state.
+      # `metadata` can be modified regardless of invoice state.
       sig do
         params(
           invoice_id: String,
@@ -78,26 +77,24 @@ module Orb
       def update(
         invoice_id,
         # 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`.
+        # by setting the value to `null`, and the entire metadata mapping can be cleared
+        # by setting `metadata` to `null`.
         metadata: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an
-      #   account in a list format.
+      # account in a list format.
       #
-      #   The list of invoices is ordered starting from the most recently issued invoice
-      #   date. The response also includes
-      #   [`pagination_metadata`](/api-reference/pagination), which lets the caller
-      #   retrieve the next page of results if they exist.
+      # The list of invoices is ordered starting from the most recently issued invoice
+      # date. The response also includes
+      # [`pagination_metadata`](/api-reference/pagination), which lets the caller
+      # retrieve the next page of results if they exist.
       #
-      #   By default, this only returns invoices that are `issued`, `paid`, or `synced`.
+      # By default, this only returns invoices that are `issued`, `paid`, or `synced`.
       #
-      #   When fetching any `draft` invoices, this returns the last-computed invoice
-      #   values for each draft invoice, which may not always be up-to-date since Orb
-      #   regularly refreshes invoices asynchronously.
+      # When fetching any `draft` invoices, this returns the last-computed invoice
+      # values for each draft invoice, which may not always be up-to-date since Orb
+      # regularly refreshes invoices asynchronously.
       sig do
         params(
           amount: T.nilable(String),
@@ -128,15 +125,15 @@ module Orb
         amount_gt: nil,
         amount_lt: nil,
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
-        #   from the initial request.
+        # from the initial request.
         cursor: nil,
         customer_id: nil,
         date_type: nil,
         due_date: nil,
         # 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.
+        # 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.
         due_date_window: nil,
         due_date_gt: nil,
         due_date_lt: nil,
@@ -151,11 +148,9 @@ module Orb
         status: nil,
         subscription_id: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an
-      #   identifier.
+      # identifier.
       sig do
         params(
           invoice_id: String,
@@ -163,12 +158,11 @@ module Orb
         )
           .returns(Orb::Models::Invoice)
       end
-      def fetch(invoice_id, request_options: {})
-      end
+      def fetch(invoice_id, request_options: {}); end
 
       # This endpoint can be used to fetch the upcoming
-      #   [invoice](/core-concepts#invoice) for the current billing period given a
-      #   subscription.
+      # [invoice](/core-concepts#invoice) for the current billing period given a
+      # subscription.
       sig do
         params(
           subscription_id: String,
@@ -176,15 +170,14 @@ module Orb
         )
           .returns(Orb::Models::InvoiceFetchUpcomingResponse)
       end
-      def fetch_upcoming(subscription_id:, request_options: {})
-      end
+      def fetch_upcoming(subscription_id:, request_options: {}); end
 
       # This endpoint allows an eligible invoice to be issued manually. This is only
-      #   possible with invoices where status is `draft`, `will_auto_issue` is false, and
-      #   an `eligible_to_issue_at` is a time in the past. Issuing an invoice could
-      #   possibly trigger side effects, some of which could be customer-visible (e.g.
-      #   sending emails, auto-collecting payment, syncing the invoice to external
-      #   providers, etc).
+      # possible with invoices where status is `draft`, `will_auto_issue` is false, and
+      # an `eligible_to_issue_at` is a time in the past. Issuing an invoice could
+      # possibly trigger side effects, some of which could be customer-visible (e.g.
+      # sending emails, auto-collecting payment, syncing the invoice to external
+      # providers, etc).
       sig do
         params(
           invoice_id: String,
@@ -196,17 +189,15 @@ module Orb
       def issue(
         invoice_id,
         # If true, the invoice will be issued synchronously. If false, the invoice will be
-        #   issued asynchronously. The synchronous option is only available for invoices
-        #   that have no usage fees. If the invoice is configured to sync to an external
-        #   provider, a successful response from this endpoint guarantees the invoice is
-        #   present in the provider.
+        # issued asynchronously. The synchronous option is only available for invoices
+        # that have no usage fees. If the invoice is configured to sync to an external
+        # provider, a successful response from this endpoint guarantees the invoice is
+        # present in the provider.
         synchronous: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint allows an invoice's status to be set the `paid` status. This can
-      #   only be done to invoices that are in the `issued` status.
+      # only be done to invoices that are in the `issued` status.
       sig do
         params(
           invoice_id: String,
@@ -226,11 +217,9 @@ module Orb
         # An optional note to associate with the payment.
         notes: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint collects payment for an invoice using the customer's default
-      #   payment method. This action can only be taken on invoices with status "issued".
+      # payment method. This action can only be taken on invoices with status "issued".
       sig do
         params(
           invoice_id: String,
@@ -238,20 +227,19 @@ module Orb
         )
           .returns(Orb::Models::Invoice)
       end
-      def pay(invoice_id, request_options: {})
-      end
+      def pay(invoice_id, request_options: {}); end
 
       # This endpoint allows an invoice's status to be set the `void` status. This can
-      #   only be done to invoices that are in the `issued` status.
+      # only be done to invoices that are in the `issued` status.
       #
-      #   If the associated invoice has used the customer balance to change the amount
-      #   due, the customer balance operation will be reverted. For example, if the
-      #   invoice used $10 of customer balance, that amount will be added back to the
-      #   customer balance upon voiding.
+      # If the associated invoice has used the customer balance to change the amount
+      # due, the customer balance operation will be reverted. For example, if the
+      # invoice used $10 of customer balance, that amount will be added back to the
+      # customer balance upon voiding.
       #
-      #   If the invoice was used to purchase a credit block, but the invoice is not yet
-      #   paid, the credit block will be voided. If the invoice was created due to a
-      #   top-up, the top-up will be disabled.
+      # If the invoice was used to purchase a credit block, but the invoice is not yet
+      # paid, the credit block will be voided. If the invoice was created due to a
+      # top-up, the top-up will be disabled.
       sig do
         params(
           invoice_id: String,
@@ -259,13 +247,11 @@ module Orb
         )
           .returns(Orb::Models::Invoice)
       end
-      def void(invoice_id, request_options: {})
-      end
+      def void(invoice_id, request_options: {}); end
 
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/orb/resources/items.rbi

@@ -12,9 +12,7 @@ module Orb
         # The name of the item.
         name:,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint can be used to update properties on the Item.
       sig do
         params(
@@ -25,11 +23,10 @@ module Orb
         )
           .returns(Orb::Models::Item)
       end
-      def update(item_id, external_connections: nil, name: nil, request_options: {})
-      end
+      def update(item_id, external_connections: nil, name: nil, request_options: {}); end
 
       # This endpoint returns a list of all Items, ordered in descending order by
-      #   creation time.
+      # creation time.
       sig do
         params(
           cursor: T.nilable(String),
@@ -40,14 +37,12 @@ module Orb
       end
       def list(
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
-        #   from the initial request.
+        # from the initial request.
         cursor: nil,
         # The number of items to fetch. Defaults to 20.
         limit: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint returns an item identified by its item_id.
       sig do
         params(
@@ -56,13 +51,11 @@ module Orb
         )
           .returns(Orb::Models::Item)
       end
-      def fetch(item_id, request_options: {})
-      end
+      def fetch(item_id, request_options: {}); end
 
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/orb/resources/metrics.rbi

@@ -4,8 +4,8 @@ module Orb
   module Resources
     class Metrics
       # This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
-      #   string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
-      #   description of constructing SQL queries with examples.
+      # string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
+      # description of constructing SQL queries with examples.
       sig do
         params(
           description: T.nilable(String),
@@ -27,16 +27,14 @@ module Orb
         # A sql string defining the metric.
         sql:,
         # 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`.
+        # by setting the value to `null`, and the entire metadata mapping can be cleared
+        # by setting `metadata` to `null`.
         metadata: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint allows you to update the `metadata` property on a metric. If you
-      #   pass `null` for the metadata value, it will clear any existing metadata for that
-      #   invoice.
+      # pass `null` for the metadata value, it will clear any existing metadata for that
+      # invoice.
       sig do
         params(
           metric_id: String,
@@ -48,16 +46,14 @@ module Orb
       def update(
         metric_id,
         # 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`.
+        # by setting the value to `null`, and the entire metadata mapping can be cleared
+        # by setting `metadata` to `null`.
         metadata: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint is used to fetch [metric](/core-concepts##metric) details given a
-      #   metric identifier. It returns information about the metrics including its name,
-      #   description, and item.
+      # metric identifier. It returns information about the metrics including its name,
+      # description, and item.
       sig do
         params(
           created_at_gt: T.nilable(Time),
@@ -76,16 +72,14 @@ module Orb
         created_at_lt: nil,
         created_at_lte: nil,
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
-        #   from the initial request.
+        # from the initial request.
         cursor: nil,
         # The number of items to fetch. Defaults to 20.
         limit: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       # This endpoint is used to list [metrics](/core-concepts#metric). It returns
-      #   information about the metrics including its name, description, and item.
+      # information about the metrics including its name, description, and item.
       sig do
         params(
           metric_id: String,
@@ -93,13 +87,11 @@ module Orb
         )
           .returns(Orb::Models::BillableMetric)
       end
-      def fetch(metric_id, request_options: {})
-      end
+      def fetch(metric_id, request_options: {}); end
 
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
+      def self.new(client:); end
     end
   end
 end

data/rbi/lib/orb/resources/plans/external_plan_id.rbi

@@ -5,9 +5,9 @@ module Orb
     class Plans
       class ExternalPlanID
         # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
-        #   existing plan.
+        # existing plan.
         #
-        #   Other fields on a customer are currently immutable.
+        # Other fields on a customer are currently immutable.
         sig do
           params(
             other_external_plan_id: String,
@@ -20,33 +20,31 @@ module Orb
         def update(
           other_external_plan_id,
           # An optional user-defined ID for this plan resource, used throughout the system
-          #   as an alias for this Plan. Use this field to identify a plan by an existing
-          #   identifier in your system.
+          # as an alias for this Plan. Use this field to identify a plan by an existing
+          # identifier in your system.
           external_plan_id: nil,
           # 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`.
+          # by setting the value to `null`, and the entire metadata mapping can be cleared
+          # by setting `metadata` to `null`.
           metadata: nil,
           request_options: {}
-        )
-        end
-
+        ); end
         # This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details
-        #   given an external_plan_id identifier. It returns information about the prices
-        #   included in the plan and their configuration, as well as the product that the
-        #   plan is attached to.
+        # given an external_plan_id identifier. It returns information about the prices
+        # included in the plan and their configuration, as well as the product that the
+        # plan is attached to.
         #
-        #   If multiple plans are found to contain the specified external_plan_id, the
-        #   active plans will take priority over archived ones, and among those, the
-        #   endpoint will return the most recently created plan.
+        # If multiple plans are found to contain the specified external_plan_id, the
+        # active plans will take priority over archived ones, and among those, the
+        # endpoint will return the most recently created plan.
         #
-        #   ## Serialized prices
+        # ## Serialized prices
         #
-        #   Orb supports a few different pricing models out of the box. Each of these models
-        #   is serialized differently in a given [Price](/core-concepts#plan-and-price)
-        #   object. The `model_type` field determines the key for the configuration object
-        #   that is present. A detailed explanation of price types can be found in the
-        #   [Price schema](/core-concepts#plan-and-price). "
+        # Orb supports a few different pricing models out of the box. Each of these models
+        # is serialized differently in a given [Price](/core-concepts#plan-and-price)
+        # object. The `model_type` field determines the key for the configuration object
+        # that is present. A detailed explanation of price types can be found in the
+        # [Price schema](/core-concepts#plan-and-price). "
         sig do
           params(
             external_plan_id: String,
@@ -54,13 +52,11 @@ module Orb
           )
             .returns(Orb::Models::Plan)
         end
-        def fetch(external_plan_id, request_options: {})
-        end
+        def fetch(external_plan_id, request_options: {}); end
 
         # @api private
         sig { params(client: Orb::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
+        def self.new(client:); end
       end
     end
   end