orb-billing 0.1.3 → 0.3.0

data/lib/orb/resources/customers.rb

@@ -12,6 +12,9 @@ module Orb
       # @return [Orb::Resources::Customers::BalanceTransactions]
       attr_reader :balance_transactions
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CustomerCreateParams} for more details.
+      #
       # 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.
@@ -27,24 +30,52 @@ module Orb
       #
       # @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: {})
       #
-      # @param email [String]
-      # @param name [String]
+      # @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
+      # ...
+      #
+      # @param name [String] The full name of the customer
+      #
       # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil]
-      # @param additional_emails [Array<String>, nil]
-      # @param auto_collection [Boolean, nil]
+      #
+      # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
+      # ...
+      #
+      # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
+      # ...
+      #
       # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil]
-      # @param currency [String, nil]
+      #
+      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
+      # ...
+      #
       # @param email_delivery [Boolean, nil]
-      # @param external_customer_id [String, nil]
-      # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
-      # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil]
-      # @param payment_provider_id [String, nil]
+      #
+      # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
+      # ...
+      #
+      # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
+      # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # ...
+      #
+      # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
+      # ...
+      #
       # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil]
+      #
       # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
+      #
       # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
-      # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil]
-      # @param timezone [String, nil]
+      #
+      # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # ...
+      #
+      # @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Customer]
@@ -61,6 +92,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CustomerUpdateParams} for more details.
+      #
       # 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
@@ -70,23 +104,49 @@ module Orb
       # @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: {})
       #
       # @param customer_id [String]
+      #
       # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
-      # @param additional_emails [Array<String>, nil]
-      # @param auto_collection [Boolean, nil]
+      #
+      # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
+      # ...
+      #
+      # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
+      # ...
+      #
       # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
-      # @param currency [String, nil]
-      # @param email [String, nil]
+      #
+      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
+      # ...
+      #
+      # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
+      #
       # @param email_delivery [Boolean, nil]
-      # @param external_customer_id [String, nil]
-      # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
-      # @param name [String, nil]
-      # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil]
-      # @param payment_provider_id [String, nil]
+      #
+      # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
+      # ...
+      #
+      # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
+      # @param name [String, nil] The full name of the customer
+      #
+      # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # ...
+      #
+      # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
+      # ...
+      #
       # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
+      #
       # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
+      #
       # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
-      # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil]
+      #
+      # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Customer]
@@ -103,6 +163,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CustomerListParams} for more details.
+      #
       # 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
@@ -113,11 +176,18 @@ module Orb
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
       #
       # @param created_at_gt [Time, nil]
+      #
       # @param created_at_gte [Time, nil]
+      #
       # @param created_at_lt [Time, nil]
+      #
       # @param created_at_lte [Time, nil]
-      # @param cursor [String, nil]
-      # @param limit [Integer]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::Customer>]
@@ -271,6 +341,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
+      #
       # 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
@@ -279,23 +352,49 @@ module Orb
       # @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: {})
       #
       # @param id [String]
+      #
       # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
-      # @param additional_emails [Array<String>, nil]
-      # @param auto_collection [Boolean, nil]
+      #
+      # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
+      # ...
+      #
+      # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
+      # ...
+      #
       # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
-      # @param currency [String, nil]
-      # @param email [String, nil]
+      #
+      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
+      # ...
+      #
+      # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
+      #
       # @param email_delivery [Boolean, nil]
-      # @param external_customer_id [String, nil]
-      # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
-      # @param name [String, nil]
-      # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil]
-      # @param payment_provider_id [String, nil]
+      #
+      # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
+      # ...
+      #
+      # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
+      # @param name [String, nil] The full name of the customer
+      #
+      # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
+      # ...
+      #
+      # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
+      # ...
+      #
       # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
+      #
       # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
+      #
       # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil]
-      # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil]
+      #
+      # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Customer]

data/lib/orb/resources/dimensional_price_groups.rb

@@ -6,6 +6,9 @@ module Orb
       # @return [Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID]
       attr_reader :external_dimensional_price_group_id
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::DimensionalPriceGroupCreateParams} for more details.
+      #
       # 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.
@@ -18,10 +21,16 @@ module Orb
       # @overload create(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
       #
       # @param billable_metric_id [String]
-      # @param dimensions [Array<String>]
+      #
+      # @param dimensions [Array<String>] The set of keys (in order) used to disambiguate prices in the group.
+      #
       # @param name [String]
+      #
       # @param external_dimensional_price_group_id [String, nil]
-      # @param metadata [Hash{Symbol=>String, nil}, nil]
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::DimensionalPriceGroup]
@@ -57,12 +66,18 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::DimensionalPriceGroupListParams} for more details.
+      #
       # List dimensional price groups
       #
       # @overload list(cursor: nil, limit: nil, request_options: {})
       #
-      # @param cursor [String, nil]
-      # @param limit [Integer]
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::DimensionalPriceGroup>]

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

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Events
       class Backfills
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Events::BackfillCreateParams} for more details.
+        #
         # 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:
@@ -44,13 +47,27 @@ module Orb
         #
         # @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: {})
         #
-        # @param timeframe_end [Time]
-        # @param timeframe_start [Time]
-        # @param close_time [Time, nil]
-        # @param customer_id [String, nil]
-        # @param deprecation_filter [String, nil]
-        # @param external_customer_id [String, nil]
-        # @param replace_existing_events [Boolean]
+        # @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default
+        # ...
+        #
+        # @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau
+        # ...
+        #
+        # @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil
+        # ...
+        #
+        # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting
+        # ...
+        #
+        # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+        # ...
+        #
+        # @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt
+        # ...
+        #
+        # @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e
+        # ...
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Events::BackfillCreateResponse]
@@ -67,6 +84,9 @@ module Orb
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Events::BackfillListParams} for more details.
+        #
         # This endpoint returns a list of all backfills in a list format.
         #
         # The list of backfills is ordered starting from the most recently created
@@ -77,8 +97,11 @@ module Orb
         #
         # @overload list(cursor: nil, limit: nil, request_options: {})
         #
-        # @param cursor [String, nil]
-        # @param limit [Integer]
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Events::BackfillListResponse>]

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

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Events
       class Volume
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Events::VolumeListParams} for more details.
+        #
         # This endpoint returns the event volume for an account in a
         # [paginated list format](/api-reference/pagination).
         #
@@ -20,10 +23,17 @@ module Orb
         #
         # @overload list(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {})
         #
-        # @param timeframe_start [Time]
-        # @param cursor [String, nil]
-        # @param limit [Integer]
-        # @param timeframe_end [Time]
+        # @param timeframe_start [Time] The start of the timeframe, inclusive, in which to return event volume. All date
+        # ...
+        #
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
+        # @param timeframe_end [Time] The end of the timeframe, exclusive, in which to return event volume. If not spe
+        # ...
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Events::EventVolumes]

data/lib/orb/resources/events.rb

@@ -9,6 +9,9 @@ module Orb
       # @return [Orb::Resources::Events::Volume]
       attr_reader :volume
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::EventUpdateParams} for more details.
+      #
       # This endpoint is used to amend a single usage event with a given `event_id`.
       # `event_id` refers to the `idempotency_key` passed in during ingestion. The event
       # will maintain its existing `event_id` after the amendment.
@@ -58,11 +61,20 @@ module Orb
       # @overload update(event_id, event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {})
       #
       # @param event_id [String]
-      # @param event_name [String]
-      # @param properties [Object]
-      # @param timestamp [Time]
-      # @param customer_id [String, nil]
-      # @param external_customer_id [String, nil]
+      #
+      # @param event_name [String] A name to meaningfully identify the action or event type.
+      #
+      # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
+      # ...
+      #
+      # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
+      # ...
+      #
+      # @param customer_id [String, nil] The Orb Customer identifier
+      #
+      # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::EventUpdateResponse]
@@ -137,6 +149,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::EventIngestParams} for more details.
+      #
       # Orb's event ingestion model and API is designed around two core principles:
       #
       # 1. **Data fidelity**: The accuracy of your billing model depends on a robust
@@ -344,9 +359,14 @@ module Orb
       #
       # @overload ingest(events:, backfill_id: nil, debug: nil, request_options: {})
       #
-      # @param events [Array<Orb::Models::EventIngestParams::Event>]
-      # @param backfill_id [String, nil]
-      # @param debug [Boolean]
+      # @param events [Array<Orb::Models::EventIngestParams::Event>] Body param:
+      #
+      # @param backfill_id [String, nil] Query param: If this ingestion request is part of a backfill, this parameter tie
+      # ...
+      #
+      # @param debug [Boolean] Query param: Flag to enable additional debug information in the endpoint respons
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::EventIngestResponse]
@@ -365,6 +385,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::EventSearchParams} for more details.
+      #
       # This endpoint returns a filtered set of events for an account in a
       # [paginated list format](/api-reference/pagination).
       #
@@ -383,9 +406,15 @@ module Orb
       #
       # @overload search(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {})
       #
-      # @param event_ids [Array<String>]
-      # @param timeframe_end [Time, nil]
-      # @param timeframe_start [Time, nil]
+      # @param event_ids [Array<String>] This is an explicit array of IDs to filter by. Note that an event's ID is the id
+      # ...
+      #
+      # @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified
+      # ...
+      #
+      # @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::EventSearchResponse]

data/lib/orb/resources/invoice_line_items.rb

@@ -3,17 +3,27 @@
 module Orb
   module Resources
     class InvoiceLineItems
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::InvoiceLineItemCreateParams} for more details.
+      #
       # 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.
       #
       # @overload create(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {})
       #
-      # @param amount [String]
-      # @param end_date [Date]
-      # @param invoice_id [String]
-      # @param name [String]
-      # @param quantity [Float]
-      # @param start_date [Date]
+      # @param amount [String] The total amount in the invoice's currency to add to the line item.
+      #
+      # @param end_date [Date] A date string to specify the line item's end date in the customer's timezone.
+      #
+      # @param invoice_id [String] The id of the Invoice to add this line item.
+      #
+      # @param name [String] The item name associated with this line item. If an item with the same name exis
+      # ...
+      #
+      # @param quantity [Float] The number of units on the line item
+      #
+      # @param start_date [Date] A date string to specify the line item's start date in the customer's timezone.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::InvoiceLineItemCreateResponse]