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

data/lib/orb/resources/customers/credits/top_ups.rb

@@ -6,12 +6,12 @@ module Orb
       class Credits
         class TopUps
           # This endpoint allows you to create a new top-up for a specified customer's
-          #   balance. While this top-up is active, the customer's balance will added in
-          #   increments of the specified amount whenever the balance reaches the specified
-          #   threshold.
+          # balance. While this top-up is active, the customer's balance will added in
+          # increments of the specified amount whenever the balance reaches the specified
+          # threshold.
           #
-          #   If a top-up already exists for this customer in the same currency, the existing
-          #   top-up will be replaced.
+          # If a top-up already exists for this customer in the same currency, the existing
+          # top-up will be replaced.
           #
           # @overload create(customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
           #
@@ -65,7 +65,7 @@ module Orb
           end
 
           # This deactivates the top-up and voids any invoices associated with pending
-          #   credit blocks purchased through the top-up.
+          # credit blocks purchased through the top-up.
           #
           # @overload delete(top_up_id, customer_id:, request_options: {})
           #
@@ -91,12 +91,12 @@ module Orb
           end
 
           # This endpoint allows you to create a new top-up for a specified customer's
-          #   balance. While this top-up is active, the customer's balance will added in
-          #   increments of the specified amount whenever the balance reaches the specified
-          #   threshold.
+          # balance. While this top-up is active, the customer's balance will added in
+          # increments of the specified amount whenever the balance reaches the specified
+          # threshold.
           #
-          #   If a top-up already exists for this customer in the same currency, the existing
-          #   top-up will be replaced.
+          # If a top-up already exists for this customer in the same currency, the existing
+          # top-up will be replaced.
           #
           # @overload create_by_external_id(external_customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
           #
@@ -126,7 +126,7 @@ module Orb
           end
 
           # This deactivates the top-up and voids any invoices associated with pending
-          #   credit blocks purchased through the top-up.
+          # credit blocks purchased through the top-up.
           #
           # @overload delete_by_external_id(top_up_id, external_customer_id:, request_options: {})
           #

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

@@ -12,11 +12,11 @@ module Orb
 
         # Returns a paginated list of unexpired, non-zero credit blocks for a customer.
         #
-        #   If `include_all_blocks` is set to `true`, all credit blocks (including expired
-        #   and depleted blocks) will be included in the response.
+        # If `include_all_blocks` is set to `true`, all credit blocks (including expired
+        # and depleted blocks) will be included in the response.
         #
-        #   Note that `currency` defaults to credits if not specified. To use a real world
-        #   currency, set `currency` to an ISO 4217 string.
+        # Note that `currency` defaults to credits if not specified. To use a real world
+        # currency, set `currency` to an ISO 4217 string.
         #
         # @overload list(customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
         #
@@ -44,11 +44,11 @@ module Orb
 
         # Returns a paginated list of unexpired, non-zero credit blocks for a customer.
         #
-        #   If `include_all_blocks` is set to `true`, all credit blocks (including expired
-        #   and depleted blocks) will be included in the response.
+        # If `include_all_blocks` is set to `true`, all credit blocks (including expired
+        # and depleted blocks) will be included in the response.
         #
-        #   Note that `currency` defaults to credits if not specified. To use a real world
-        #   currency, set `currency` to an ISO 4217 string.
+        # Note that `currency` defaults to credits if not specified. To use a real world
+        # currency, set `currency` to an ISO 4217 string.
         #
         # @overload list_by_external_id(external_customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {})
         #

data/lib/orb/resources/customers.rb

@@ -13,17 +13,17 @@ module Orb
       attr_reader :balance_transactions
 
       # This operation is used to create an Orb customer, who is party to the core
-      #   billing relationship. See [Customer](/core-concepts##customer) for an overview
-      #   of the customer resource.
+      # billing relationship. See [Customer](/core-concepts##customer) for an overview
+      # of the customer resource.
       #
-      #   This endpoint is critical in the following Orb functionality:
+      # This endpoint is critical in the following Orb functionality:
       #
-      #   - Automated charges can be configured by setting `payment_provider` and
-      #     `payment_provider_id` to automatically issue invoices
-      #   - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured
-      #     by setting `external_customer_id`
-      #   - [Timezone localization](/essentials/timezones) can be configured on a
-      #     per-customer basis by setting the `timezone` parameter
+      # - Automated charges can be configured by setting `payment_provider` and
+      #   `payment_provider_id` to automatically issue invoices
+      # - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured
+      #   by setting `external_customer_id`
+      # - [Timezone localization](/essentials/timezones) can be configured on a
+      #   per-customer basis by setting the `timezone` parameter
       #
       # @overload create(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {})
       #
@@ -62,10 +62,10 @@ module Orb
       end
 
       # This endpoint can be used to update the `payment_provider`,
-      #   `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
-      #   `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
-      #   `additional_emails` of an existing customer. Other fields on a customer are
-      #   currently immutable.
+      # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
+      # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
+      # `additional_emails` of an existing customer. Other fields on a customer are
+      # currently immutable.
       #
       # @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
       #
@@ -104,11 +104,11 @@ module Orb
       end
 
       # This endpoint returns a list of all customers for an account. The list of
-      #   customers is ordered starting from the most recently created customer. This
-      #   endpoint follows Orb's
-      #   [standardized pagination format](/api-reference/pagination).
+      # customers is ordered starting from the most recently created customer. This
+      # endpoint follows Orb's
+      # [standardized pagination format](/api-reference/pagination).
       #
-      #   See [Customer](/core-concepts##customer) for an overview of the customer model.
+      # See [Customer](/core-concepts##customer) for an overview of the customer model.
       #
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
       #
@@ -129,10 +129,10 @@ module Orb
           method: :get,
           path: "customers",
           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::Customer,
@@ -141,20 +141,20 @@ module Orb
       end
 
       # This performs a deletion of this customer, its subscriptions, and its invoices,
-      #   provided the customer does not have any issued invoices. Customers with issued
-      #   invoices cannot be deleted. This operation is irreversible. Note that this is a
-      #   _soft_ deletion, but the data will be inaccessible through the API and Orb
-      #   dashboard.
+      # provided the customer does not have any issued invoices. Customers with issued
+      # invoices cannot be deleted. This operation is irreversible. Note that this is a
+      # _soft_ deletion, but the data will be inaccessible through the API and Orb
+      # dashboard.
       #
-      #   For a hard-deletion, please reach out to the Orb team directly.
+      # For a hard-deletion, please reach out to the Orb team directly.
       #
-      #   **Note**: This operation happens asynchronously and can be expected to take a
-      #   few minutes to propagate to related resources. However, querying for the
-      #   customer on subsequent GET requests while deletion is in process will reflect
-      #   its deletion with a `deleted: true` property. Once the customer deletion has
-      #   been fully processed, the customer will not be returned in the API.
+      # **Note**: This operation happens asynchronously and can be expected to take a
+      # few minutes to propagate to related resources. However, querying for the
+      # customer on subsequent GET requests while deletion is in process will reflect
+      # its deletion with a `deleted: true` property. Once the customer deletion has
+      # been fully processed, the customer will not be returned in the API.
       #
-      #   On successful processing, this returns an empty dictionary (`{}`) in the API.
+      # On successful processing, this returns an empty dictionary (`{}`) in the API.
       #
       # @overload delete(customer_id, request_options: {})
       #
@@ -174,11 +174,11 @@ module Orb
       end
 
       # This endpoint is used to fetch customer details given an identifier. If the
-      #   `Customer` is in the process of being deleted, only the properties `id` and
-      #   `deleted: true` will be returned.
+      # `Customer` is in the process of being deleted, only the properties `id` and
+      # `deleted: true` will be returned.
       #
-      #   See the [Customer resource](/core-concepts#customer) for a full discussion of
-      #   the Customer model.
+      # See the [Customer resource](/core-concepts#customer) for a full discussion of
+      # the Customer model.
       #
       # @overload fetch(customer_id, request_options: {})
       #
@@ -198,10 +198,10 @@ module Orb
       end
 
       # This endpoint is used to fetch customer details given an `external_customer_id`
-      #   (see [Customer ID Aliases](/events-and-metrics/customer-aliases)).
+      # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)).
       #
-      #   Note that the resource and semantics of this endpoint exactly mirror
-      #   [Get Customer](fetch-customer).
+      # Note that the resource and semantics of this endpoint exactly mirror
+      # [Get Customer](fetch-customer).
       #
       # @overload fetch_by_external_id(external_customer_id, request_options: {})
       #
@@ -222,26 +222,23 @@ module Orb
 
       # Sync Orb's payment methods for the customer with their gateway.
       #
-      #   This method can be called before taking an action that may cause the customer to
-      #   be charged, ensuring that the most up-to-date payment method is charged.
+      # This method can be called before taking an action that may cause the customer to
+      # be charged, ensuring that the most up-to-date payment method is charged.
       #
-      #   **Note**: This functionality is currently only available for Stripe.
+      # **Note**: This functionality is currently only available for Stripe.
       #
-      # @overload sync_payment_methods_from_gateway(external_customer_id, request_options: {})
+      # @overload sync_payment_methods_from_gateway(customer_id, request_options: {})
       #
-      # @param external_customer_id [String]
+      # @param customer_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams
-      def sync_payment_methods_from_gateway(external_customer_id, params = {})
+      def sync_payment_methods_from_gateway(customer_id, params = {})
         @client.request(
           method: :post,
-          path: [
-            "customers/external_customer_id/%1$s/sync_payment_methods_from_gateway",
-            external_customer_id
-          ],
+          path: ["customers/%1$s/sync_payment_methods_from_gateway", customer_id],
           model: NilClass,
           options: params[:request_options]
         )
@@ -249,32 +246,35 @@ module Orb
 
       # Sync Orb's payment methods for the customer with their gateway.
       #
-      #   This method can be called before taking an action that may cause the customer to
-      #   be charged, ensuring that the most up-to-date payment method is charged.
+      # This method can be called before taking an action that may cause the customer to
+      # be charged, ensuring that the most up-to-date payment method is charged.
       #
-      #   **Note**: This functionality is currently only available for Stripe.
+      # **Note**: This functionality is currently only available for Stripe.
       #
-      # @overload sync_payment_methods_from_gateway_by_external_customer_id(customer_id, request_options: {})
+      # @overload sync_payment_methods_from_gateway_by_external_customer_id(external_customer_id, request_options: {})
       #
-      # @param customer_id [String]
+      # @param external_customer_id [String]
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see Orb::Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams
-      def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, params = {})
+      def sync_payment_methods_from_gateway_by_external_customer_id(external_customer_id, params = {})
         @client.request(
           method: :post,
-          path: ["customers/%1$s/sync_payment_methods_from_gateway", customer_id],
+          path: [
+            "customers/external_customer_id/%1$s/sync_payment_methods_from_gateway",
+            external_customer_id
+          ],
           model: NilClass,
           options: params[:request_options]
         )
       end
 
       # This endpoint is used to update customer details given an `external_customer_id`
-      #   (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the
-      #   resource and semantics of this endpoint exactly mirror
-      #   [Update Customer](update-customer).
+      # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the
+      # resource and semantics of this endpoint exactly mirror
+      # [Update Customer](update-customer).
       #
       # @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
       #

data/lib/orb/resources/dimensional_price_groups.rb

@@ -7,13 +7,13 @@ module Orb
       attr_reader :external_dimensional_price_group_id
 
       # A dimensional price group is used to partition the result of a billable metric
-      #   by a set of dimensions. Prices in a price group must specify the parition used
-      #   to derive their usage.
+      # by a set of dimensions. Prices in a price group must specify the parition used
+      # to derive their usage.
       #
-      #   For example, suppose we have a billable metric that measures the number of
-      #   widgets used and we want to charge differently depending on the color of the
-      #   widget. We can create a price group with a dimension "color" and two prices: one
-      #   that charges $10 per red widget and one that charges $20 per blue widget.
+      # For example, suppose we have a billable metric that measures the number of
+      # widgets used and we want to charge differently depending on the color of the
+      # widget. We can create a price group with a dimension "color" and two prices: one
+      # that charges $10 per red widget and one that charges $20 per blue widget.
       #
       # @overload create(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
       #

data/lib/orb/resources/events/backfills.rb

@@ -5,42 +5,42 @@ module Orb
     class Events
       class Backfills
         # Creating the backfill enables adding or replacing past events, even those that
-        #   are older than the ingestion grace period. Performing a backfill in Orb involves
-        #   3 steps:
-        #
-        #   1. Create the backfill, specifying its parameters.
-        #   2. [Ingest](ingest) usage events, referencing the backfill (query parameter
-        #      `backfill_id`).
-        #   3. [Close](close-backfill) the backfill, propagating the update in past usage
-        #      throughout Orb.
-        #
-        #   Changes from a backfill are not reflected until the backfill is closed, so you
-        #   won’t need to worry about your customers seeing partially updated usage data.
-        #   Backfills are also reversible, so you’ll be able to revert a backfill if you’ve
-        #   made a mistake.
-        #
-        #   This endpoint will return a backfill object, which contains an `id`. That `id`
-        #   can then be used as the `backfill_id` query parameter to the event ingestion
-        #   endpoint to associate ingested events with this backfill. The effects (e.g.
-        #   updated usage graphs) of this backfill will not take place until the backfill is
-        #   closed.
-        #
-        #   If the `replace_existing_events` is `true`, existing events in the backfill's
-        #   timeframe will be replaced with the newly ingested events associated with the
-        #   backfill. If `false`, newly ingested events will be added to the existing
-        #   events.
-        #
-        #   If a `customer_id` or `external_customer_id` is specified, the backfill will
-        #   only affect events for that customer. If neither is specified, the backfill will
-        #   affect all customers.
-        #
-        #   When `replace_existing_events` is `true`, this indicates that existing events in
-        #   the timeframe should no longer be counted towards invoiced usage. In this
-        #   scenario, the parameter `filter` can be optionally added which enables filtering
-        #   using
-        #   [computed properties](/extensibility/advanced-metrics#computed-properties). The
-        #   expressiveness of computed properties allows you to deprecate existing events
-        #   based on both a period of time and specific property values.
+        # are older than the ingestion grace period. Performing a backfill in Orb involves
+        # 3 steps:
+        #
+        # 1. Create the backfill, specifying its parameters.
+        # 2. [Ingest](ingest) usage events, referencing the backfill (query parameter
+        #    `backfill_id`).
+        # 3. [Close](close-backfill) the backfill, propagating the update in past usage
+        #    throughout Orb.
+        #
+        # Changes from a backfill are not reflected until the backfill is closed, so you
+        # won’t need to worry about your customers seeing partially updated usage data.
+        # Backfills are also reversible, so you’ll be able to revert a backfill if you’ve
+        # made a mistake.
+        #
+        # This endpoint will return a backfill object, which contains an `id`. That `id`
+        # can then be used as the `backfill_id` query parameter to the event ingestion
+        # endpoint to associate ingested events with this backfill. The effects (e.g.
+        # updated usage graphs) of this backfill will not take place until the backfill is
+        # closed.
+        #
+        # If the `replace_existing_events` is `true`, existing events in the backfill's
+        # timeframe will be replaced with the newly ingested events associated with the
+        # backfill. If `false`, newly ingested events will be added to the existing
+        # events.
+        #
+        # If a `customer_id` or `external_customer_id` is specified, the backfill will
+        # only affect events for that customer. If neither is specified, the backfill will
+        # affect all customers.
+        #
+        # When `replace_existing_events` is `true`, this indicates that existing events in
+        # the timeframe should no longer be counted towards invoiced usage. In this
+        # scenario, the parameter `filter` can be optionally added which enables filtering
+        # using
+        # [computed properties](/extensibility/advanced-metrics#computed-properties). The
+        # expressiveness of computed properties allows you to deprecate existing events
+        # based on both a period of time and specific property values.
         #
         # @overload create(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {})
         #
@@ -69,11 +69,11 @@ module Orb
 
         # This endpoint returns a list of all backfills in a list format.
         #
-        #   The list of backfills is ordered starting from the most recently created
-        #   backfill. The response also includes
-        #   [`pagination_metadata`](/api-reference/pagination), 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](pagination).
+        # The list of backfills is ordered starting from the most recently created
+        # backfill. The response also includes
+        # [`pagination_metadata`](/api-reference/pagination), 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](pagination).
         #
         # @overload list(cursor: nil, limit: nil, request_options: {})
         #
@@ -97,9 +97,9 @@ module Orb
         end
 
         # Closing a backfill makes the updated usage visible in Orb. Upon closing a
-        #   backfill, Orb will asynchronously reflect the updated usage in invoice amounts
-        #   and usage graphs. Once all of the updates are complete, the backfill's status
-        #   will transition to `reflected`.
+        # backfill, Orb will asynchronously reflect the updated usage in invoice amounts
+        # and usage graphs. Once all of the updates are complete, the backfill's status
+        # will transition to `reflected`.
         #
         # @overload close(backfill_id, request_options: {})
         #
@@ -138,12 +138,12 @@ module Orb
         end
 
         # Reverting a backfill undoes all the effects of closing the backfill. If the
-        #   backfill is reflected, the status will transition to `pending_revert` while the
-        #   effects of the backfill are undone. Once all effects are undone, the backfill
-        #   will transition to `reverted`.
+        # backfill is reflected, the status will transition to `pending_revert` while the
+        # effects of the backfill are undone. Once all effects are undone, the backfill
+        # will transition to `reverted`.
         #
-        #   If a backfill is reverted before its closed, no usage will be updated as a
-        #   result of the backfill and it will immediately transition to `reverted`.
+        # If a backfill is reverted before its closed, no usage will be updated as a
+        # result of the backfill and it will immediately transition to `reverted`.
         #
         # @overload revert(backfill_id, request_options: {})
         #

data/lib/orb/resources/events/volume.rb

@@ -5,18 +5,18 @@ module Orb
     class Events
       class Volume
         # This endpoint returns the event volume for an account in a
-        #   [paginated list format](/api-reference/pagination).
+        # [paginated list format](/api-reference/pagination).
         #
-        #   The event volume is aggregated by the hour and the
-        #   [timestamp](/api-reference/event/ingest-events) field is used to determine which
-        #   hour an event is associated with. Note, this means that late-arriving events
-        #   increment the volume count for the hour window the timestamp is in, not the
-        #   latest hour window.
+        # The event volume is aggregated by the hour and the
+        # [timestamp](/api-reference/event/ingest-events) field is used to determine which
+        # hour an event is associated with. Note, this means that late-arriving events
+        # increment the volume count for the hour window the timestamp is in, not the
+        # latest hour window.
         #
-        #   Each item in the response contains the count of events aggregated by the hour
-        #   where the start and end time are hour-aligned and in UTC. When a specific
-        #   timestamp is passed in for either start or end time, the response includes the
-        #   hours the timestamp falls in.
+        # Each item in the response contains the count of events aggregated by the hour
+        # where the start and end time are hour-aligned and in UTC. When a specific
+        # timestamp is passed in for either start or end time, the response includes the
+        # hours the timestamp falls in.
         #
         # @overload list(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {})
         #