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

data/lib/orb/resources/alerts.rb

@@ -46,15 +46,15 @@ module Orb
 
       # This endpoint returns a list of alerts within Orb.
       #
-      #   The request must specify one of `customer_id`, `external_customer_id`, or
-      #   `subscription_id`.
+      # The request must specify one of `customer_id`, `external_customer_id`, or
+      # `subscription_id`.
       #
-      #   If querying by subscripion_id, the endpoint will return the subscription level
-      #   alerts as well as the plan level alerts associated with the subscription.
+      # If querying by subscripion_id, the endpoint will return the subscription level
+      # alerts as well as the plan level alerts associated with the subscription.
       #
-      #   The list of alerts is ordered starting from the most recently created alert.
-      #   This endpoint follows Orb's
-      #   [standardized pagination format](/api-reference/pagination).
+      # The list of alerts is ordered starting from the most recently created alert.
+      # This endpoint follows Orb's
+      # [standardized pagination format](/api-reference/pagination).
       #
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {})
       #
@@ -78,10 +78,10 @@ module Orb
           method: :get,
           path: "alerts",
           query: parsed.transform_keys(
-            created_at_gt: :"created_at[gt]",
-            created_at_gte: :"created_at[gte]",
-            created_at_lt: :"created_at[lt]",
-            created_at_lte: :"created_at[lte]"
+            created_at_gt: "created_at[gt]",
+            created_at_gte: "created_at[gte]",
+            created_at_lt: "created_at[lt]",
+            created_at_lte: "created_at[lte]"
           ),
           page: Orb::Internal::Page,
           model: Orb::Models::Alert,
@@ -90,13 +90,13 @@ module Orb
       end
 
       # This endpoint creates a new alert to monitor a customer's credit balance. There
-      #   are three types of alerts that can be scoped to customers:
-      #   `credit_balance_depleted`, `credit_balance_dropped`, and
-      #   `credit_balance_recovered`. Customers can have a maximum of one of each type of
-      #   alert per [credit balance currency](/product-catalog/prepurchase).
-      #   `credit_balance_dropped` alerts require a list of thresholds to be provided
-      #   while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
-      #   require thresholds.
+      # are three types of alerts that can be scoped to customers:
+      # `credit_balance_depleted`, `credit_balance_dropped`, and
+      # `credit_balance_recovered`. Customers can have a maximum of one of each type of
+      # alert per [credit balance currency](/product-catalog/prepurchase).
+      # `credit_balance_dropped` alerts require a list of thresholds to be provided
+      # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
+      # require thresholds.
       #
       # @overload create_for_customer(customer_id, currency:, type:, thresholds: nil, request_options: {})
       #
@@ -121,13 +121,13 @@ module Orb
       end
 
       # This endpoint creates a new alert to monitor a customer's credit balance. There
-      #   are three types of alerts that can be scoped to customers:
-      #   `credit_balance_depleted`, `credit_balance_dropped`, and
-      #   `credit_balance_recovered`. Customers can have a maximum of one of each type of
-      #   alert per [credit balance currency](/product-catalog/prepurchase).
-      #   `credit_balance_dropped` alerts require a list of thresholds to be provided
-      #   while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
-      #   require thresholds.
+      # are three types of alerts that can be scoped to customers:
+      # `credit_balance_depleted`, `credit_balance_dropped`, and
+      # `credit_balance_recovered`. Customers can have a maximum of one of each type of
+      # alert per [credit balance currency](/product-catalog/prepurchase).
+      # `credit_balance_dropped` alerts require a list of thresholds to be provided
+      # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
+      # require thresholds.
       #
       # @overload create_for_external_customer(external_customer_id, currency:, type:, thresholds: nil, request_options: {})
       #
@@ -153,15 +153,15 @@ module Orb
 
       # This endpoint is used to create alerts at the subscription level.
       #
-      #   Subscription level alerts can be one of two types: `usage_exceeded` or
-      #   `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and
-      #   is triggered when the usage of that metric exceeds predefined thresholds during
-      #   the current billing cycle. A `cost_exceeded` alert is triggered when the total
-      #   amount due during the current billing cycle surpasses predefined thresholds.
-      #   `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each
-      #   subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
-      #   per metric that is a part of the subscription. Alerts are triggered based on
-      #   usage or cost conditions met during the current billing cycle.
+      # Subscription level alerts can be one of two types: `usage_exceeded` or
+      # `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and
+      # is triggered when the usage of that metric exceeds predefined thresholds during
+      # the current billing cycle. A `cost_exceeded` alert is triggered when the total
+      # amount due during the current billing cycle surpasses predefined thresholds.
+      # `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each
+      # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
+      # per metric that is a part of the subscription. Alerts are triggered based on
+      # usage or cost conditions met during the current billing cycle.
       #
       # @overload create_for_subscription(subscription_id, thresholds:, type:, metric_id: nil, request_options: {})
       #
@@ -186,8 +186,8 @@ module Orb
       end
 
       # This endpoint allows you to disable an alert. To disable a plan-level alert for
-      #   a specific subscription, you must include the `subscription_id`. The
-      #   `subscription_id` is not required for customer or subscription level alerts.
+      # a specific subscription, you must include the `subscription_id`. The
+      # `subscription_id` is not required for customer or subscription level alerts.
       #
       # @overload disable(alert_configuration_id, subscription_id: nil, request_options: {})
       #
@@ -210,8 +210,8 @@ module Orb
       end
 
       # This endpoint allows you to enable an alert. To enable a plan-level alert for a
-      #   specific subscription, you must include the `subscription_id`. The
-      #   `subscription_id` is not required for customer or subscription level alerts.
+      # specific subscription, you must include the `subscription_id`. The
+      # `subscription_id` is not required for customer or subscription level alerts.
       #
       # @overload enable(alert_configuration_id, subscription_id: nil, request_options: {})
       #

data/lib/orb/resources/coupons/subscriptions.rb

@@ -5,9 +5,9 @@ module Orb
     class Coupons
       class Subscriptions
         # This endpoint returns a list of all subscriptions that have redeemed a given
-        #   coupon as a [paginated](/api-reference/pagination) list, ordered starting from
-        #   the most recently created subscription. For a full discussion of the
-        #   subscription resource, see [Subscription](/core-concepts#subscription).
+        # coupon as a [paginated](/api-reference/pagination) list, ordered starting from
+        # the most recently created subscription. For a full discussion of the
+        # subscription resource, see [Subscription](/core-concepts#subscription).
         #
         # @overload list(coupon_id, cursor: nil, limit: nil, request_options: {})
         #

data/lib/orb/resources/coupons.rb

@@ -7,7 +7,7 @@ module Orb
       attr_reader :subscriptions
 
       # This endpoint allows the creation of coupons, which can then be redeemed at
-      #   subscription creation or plan change.
+      # subscription creation or plan change.
       #
       # @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
       #
@@ -33,10 +33,10 @@ module Orb
 
       # This endpoint returns a list of all coupons for an account in a list format.
       #
-      #   The list of coupons is ordered starting from the most recently created coupon.
-      #   The response also includes `pagination_metadata`, which lets the caller retrieve
-      #   the next page of results if they exist. More information about pagination can be
-      #   found in the Pagination-metadata schema.
+      # The list of coupons is ordered starting from the most recently created coupon.
+      # The response also includes `pagination_metadata`, which lets the caller retrieve
+      # the next page of results if they exist. More information about pagination can be
+      # found in the Pagination-metadata schema.
       #
       # @overload list(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
       #
@@ -62,8 +62,8 @@ module Orb
       end
 
       # This endpoint allows a coupon to be archived. Archived coupons can no longer be
-      #   redeemed, and will be hidden from lists of active coupons. Additionally, once a
-      #   coupon is archived, its redemption code can be reused for a different coupon.
+      # redeemed, and will be hidden from lists of active coupons. Additionally, once a
+      # coupon is archived, its redemption code can be reused for a different coupon.
       #
       # @overload archive(coupon_id, request_options: {})
       #
@@ -83,8 +83,8 @@ module Orb
       end
 
       # This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption
-      #   code, use the [List coupons](list-coupons) endpoint with the redemption_code
-      #   parameter.
+      # code, use the [List coupons](list-coupons) endpoint with the redemption_code
+      # parameter.
       #
       # @overload fetch(coupon_id, request_options: {})
       #

data/lib/orb/resources/credit_notes.rb

@@ -4,7 +4,7 @@ module Orb
   module Resources
     class CreditNotes
       # This endpoint is used to create a single
-      #   [`Credit Note`](/invoicing/credit-notes).
+      # [`Credit Note`](/invoicing/credit-notes).
       #
       # @overload create(line_items:, memo: nil, reason: nil, request_options: {})
       #
@@ -28,8 +28,8 @@ module Orb
       end
 
       # Get a paginated list of CreditNotes. Users can also filter by customer_id,
-      #   subscription_id, or external_customer_id. The credit notes will be returned in
-      #   reverse chronological order by `creation_time`.
+      # subscription_id, or external_customer_id. The credit notes will be returned in
+      # reverse chronological order by `creation_time`.
       #
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
       #
@@ -50,10 +50,10 @@ module Orb
           method: :get,
           path: "credit_notes",
           query: parsed.transform_keys(
-            created_at_gt: :"created_at[gt]",
-            created_at_gte: :"created_at[gte]",
-            created_at_lt: :"created_at[lt]",
-            created_at_lte: :"created_at[lte]"
+            created_at_gt: "created_at[gt]",
+            created_at_gte: "created_at[gte]",
+            created_at_lt: "created_at[lt]",
+            created_at_lte: "created_at[lte]"
           ),
           page: Orb::Internal::Page,
           model: Orb::Models::CreditNote,
@@ -62,7 +62,7 @@ module Orb
       end
 
       # This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
-      #   given an identifier.
+      # given an identifier.
       #
       # @overload fetch(credit_note_id, request_options: {})
       #

data/lib/orb/resources/customers/balance_transactions.rb

@@ -5,7 +5,7 @@ module Orb
     class Customers
       class BalanceTransactions
         # Creates an immutable balance transaction that updates the customer's balance and
-        #   returns back the newly created transaction.
+        # returns back the newly created transaction.
         #
         # @overload create(customer_id, amount:, type:, description: nil, request_options: {})
         #
@@ -31,32 +31,32 @@ module Orb
 
         # ## The customer balance
         #
-        #   The customer balance is an amount in the customer's currency, which Orb
-        #   automatically applies to subsequent invoices. This balance can be adjusted
-        #   manually via Orb's webapp on the customer details page. You can use this balance
-        #   to provide a fixed mid-period credit to the customer. Commonly, this is done due
-        #   to system downtime/SLA violation, or an adhoc adjustment discussed with the
-        #   customer.
+        # The customer balance is an amount in the customer's currency, which Orb
+        # automatically applies to subsequent invoices. This balance can be adjusted
+        # manually via Orb's webapp on the customer details page. You can use this balance
+        # to provide a fixed mid-period credit to the customer. Commonly, this is done due
+        # to system downtime/SLA violation, or an adhoc adjustment discussed with the
+        # customer.
         #
-        #   If the balance is a positive value at the time of invoicing, it represents that
-        #   the customer has credit that should be used to offset the amount due on the next
-        #   issued invoice. In this case, Orb will automatically reduce the next invoice by
-        #   the balance amount, and roll over any remaining balance if the invoice is fully
-        #   discounted.
+        # If the balance is a positive value at the time of invoicing, it represents that
+        # the customer has credit that should be used to offset the amount due on the next
+        # issued invoice. In this case, Orb will automatically reduce the next invoice by
+        # the balance amount, and roll over any remaining balance if the invoice is fully
+        # discounted.
         #
-        #   If the balance is a negative value at the time of invoicing, Orb will increase
-        #   the invoice's amount due with a positive adjustment, and reset the balance to 0.
+        # If the balance is a negative value at the time of invoicing, Orb will increase
+        # the invoice's amount due with a positive adjustment, and reset the balance to 0.
         #
-        #   This endpoint retrieves all customer balance transactions in reverse
-        #   chronological order for a single customer, providing a complete audit trail of
-        #   all adjustments and invoice applications.
+        # This endpoint retrieves all customer balance transactions in reverse
+        # chronological order for a single customer, providing a complete audit trail of
+        # all adjustments and invoice applications.
         #
-        #   ## Eligibility
+        # ## Eligibility
         #
-        #   The customer balance can only be applied to invoices or adjusted manually if
-        #   invoices are not synced to a separate invoicing provider. If a payment gateway
-        #   such as Stripe is used, the balance will be applied to the invoice before
-        #   forwarding payment to the gateway.
+        # The customer balance can only be applied to invoices or adjusted manually if
+        # invoices are not synced to a separate invoicing provider. If a payment gateway
+        # such as Stripe is used, the balance will be applied to the invoice before
+        # forwarding payment to the gateway.
         #
         # @overload list(customer_id, cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {})
         #
@@ -78,10 +78,10 @@ module Orb
             method: :get,
             path: ["customers/%1$s/balance_transactions", customer_id],
             query: parsed.transform_keys(
-              operation_time_gt: :"operation_time[gt]",
-              operation_time_gte: :"operation_time[gte]",
-              operation_time_lt: :"operation_time[lt]",
-              operation_time_lte: :"operation_time[lte]"
+              operation_time_gt: "operation_time[gt]",
+              operation_time_gte: "operation_time[gte]",
+              operation_time_lt: "operation_time[lt]",
+              operation_time_lte: "operation_time[lte]"
             ),
             page: Orb::Internal::Page,
             model: Orb::Models::Customers::BalanceTransactionListResponse,