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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 249d2973800ed2fb6c87fe4e0c7b22208082baef56fa69146ebd6b6eb464fd0f
-  data.tar.gz: e3db0fd166e2f0e698bc3487a9e69d6b0461bdab175a105624f43b4b230c150d
+  metadata.gz: c0a5b2b706493559363ab625bd5acbef451386a515a1c473447f7583006750a7
+  data.tar.gz: 392dbe182794cc49819c6bc483e80d2dfc99fe3f96c5148fc644e43e9ffdc917
 SHA512:
-  metadata.gz: ce5534719e3cfa2faa48435c2ec0b84910f1f1cfb4e5679c43ae6cbe4d218855479bac17e467d723799ccf1953197a7cfe9a89442f5b904bcb252a66490b9fb8
-  data.tar.gz: fed3c6b0e6311ab74defabad0b7fa99f6b464de6dce1af15f2212e7c4725211eba89aae5fd4747611ebab9b778a5c036a3b7b8a1d808fdf8609f6b2af28869fe
+  metadata.gz: d8cecd00cd1de61ce8349e487ec416372c135b5f90ef81d7acc42a0512d6a9b615d10bcdb37f2f334ea5c65cf01a5c31addb775ef116ba43eb880eabe0c0ebe9
+  data.tar.gz: 61a0a748eece61489f3fb1e2c14c99d011505be14d7ed1aa0f1bee41469ae77ab19b8fbaf3f1c19c084b907cdff82afbad9e0bd0c0a0839aeb031a1ef120d7ca

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 0.1.0.pre.alpha.37"
+gem "orb-billing", "~> 0.1.0.pre.alpha.38"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/client.rb

@@ -60,6 +60,9 @@ module Orb
     # @return [Orb::Resources::DimensionalPriceGroups]
     attr_reader :dimensional_price_groups
 
+    # @return [Orb::Resources::SubscriptionChanges]
+    attr_reader :subscription_changes
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -124,6 +127,7 @@ module Orb
       @subscriptions = Orb::Resources::Subscriptions.new(client: self)
       @alerts = Orb::Resources::Alerts.new(client: self)
       @dimensional_price_groups = Orb::Resources::DimensionalPriceGroups.new(client: self)
+      @subscription_changes = Orb::Resources::SubscriptionChanges.new(client: self)
     end
   end
 end

data/lib/orb/internal/transport/base_client.rb

@@ -393,7 +393,7 @@ module Orb
         end
 
         # Execute the request specified by `req`. This is the method that all resource
-        #   methods call into.
+        # methods call into.
         #
         # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Orb::Internal::Type::Unknown, options: {})
         #

data/lib/orb/internal/transport/pooled_net_requester.rb

@@ -6,7 +6,7 @@ module Orb
       # @api private
       class PooledNetRequester
         # from the golang stdlib
-        #   https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+        # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
         KEEP_ALIVE_TIMEOUT = 30
 
         class << self

data/lib/orb/internal/type/base_model.rb

@@ -19,7 +19,7 @@ module Orb
           # @api private
           #
           # Assumes superclass fields are totally defined before fields are accessed /
-          #   defined on subclasses.
+          # defined on subclasses.
           #
           # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
           def known_fields
@@ -143,7 +143,7 @@ module Orb
           # @api private
           #
           # `request_only` attributes not excluded from `.#coerce` when receiving responses
-          #   even if well behaved servers should not send them
+          # even if well behaved servers should not send them
           #
           # @param blk [Proc]
           private def request_only(&blk)
@@ -258,7 +258,6 @@ module Orb
               return super
             end
 
-            is_param = singleton_class <= Orb::Internal::Type::RequestParameters::Converter
             acc = {}
 
             coerced.each do |key, val|
@@ -267,21 +266,19 @@ module Orb
               in nil
                 acc.store(name, super(val))
               else
-                mode, type_fn = field.fetch_values(:mode, :type_fn)
+                api_name, mode, type_fn = field.fetch_values(:api_name, :mode, :type_fn)
                 case mode
                 in :coerce
                   next
                 else
                   target = type_fn.call
-                  api_name = is_param ? name : field.fetch(:api_name)
                   acc.store(api_name, Orb::Internal::Type::Converter.dump(target, val))
                 end
               end
             end
 
-            known_fields.each do |name, field|
-              mode, const = field.fetch_values(:mode, :const)
-              api_name = is_param ? name : field.fetch(:api_name)
+            known_fields.each_value do |field|
+              api_name, mode, const = field.fetch_values(:api_name, :mode, :const)
               next if mode == :coerce || acc.key?(api_name) || const == Orb::Internal::OMIT
               acc.store(api_name, const)
             end
@@ -291,11 +288,11 @@ module Orb
         end
 
         # Returns the raw value associated with the given key, if found. Otherwise, nil is
-        #   returned.
+        # returned.
         #
-        #   It is valid to lookup keys that are not in the API spec, for example to access
-        #   undocumented features. This method does not parse response data into
-        #   higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
+        # It is valid to lookup keys that are not in the API spec, for example to access
+        # undocumented features. This method does not parse response data into
+        # higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
         #
         # @param key [Symbol]
         #
@@ -310,12 +307,12 @@ module Orb
 
         # Returns a Hash of the data underlying this object. O(1)
         #
-        #   Keys are Symbols and values are the raw values from the response. The return
-        #   value indicates which values were ever set on the object. i.e. there will be a
-        #   key in this hash if they ever were, even if the set value was nil.
+        # Keys are Symbols and values are the raw values from the response. The return
+        # value indicates which values were ever set on the object. i.e. there will be a
+        # key in this hash if they ever were, even if the set value was nil.
         #
-        #   This method is not recursive. The returned value is shared by the object, so it
-        #   should not be mutated.
+        # This method is not recursive. The returned value is shared by the object, so it
+        # should not be mutated.
         #
         # @return [Hash{Symbol=>Object}]
         def to_h = @data

data/lib/orb/internal/type/converter.rb

@@ -3,7 +3,6 @@
 module Orb
   module Internal
     module Type
-      # rubocop:disable Metrics/ModuleLength
       # @api private
       module Converter
         # rubocop:disable Lint/UnusedMethodArgument
@@ -76,37 +75,37 @@ module Orb
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
           #
-          #   1. if the given `value` conforms to `target` already, return the given `value`
-          #   2. if it's possible and safe to convert the given `value` to `target`, then the
-          #      converted value
-          #   3. otherwise, the given `value` unaltered
+          # 1. if the given `value` conforms to `target` already, return the given `value`
+          # 2. if it's possible and safe to convert the given `value` to `target`, then the
+          #    converted value
+          # 3. otherwise, the given `value` unaltered
           #
-          #   The coercion process is subject to improvement between minor release versions.
-          #   See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
+          # The coercion process is subject to improvement between minor release versions.
+          # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
           #
           # @param target [Orb::Internal::Type::Converter, Class]
           #
           # @param value [Object]
           #
           # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-          #   coercion strategy when we have to decide between multiple possible conversion
-          #   targets:
+          # coercion strategy when we have to decide between multiple possible conversion
+          # targets:
           #
-          #   - `true`: the conversion must be exact, with minimum coercion.
-          #   - `false`: the conversion can be approximate, with some coercion.
-          #   - `:strong`: the conversion must be exact, with no coercion, and raise an error
-          #     if not possible.
+          # - `true`: the conversion must be exact, with minimum coercion.
+          # - `false`: the conversion can be approximate, with some coercion.
+          # - `:strong`: the conversion must be exact, with no coercion, and raise an error
+          #   if not possible.
           #
-          #   The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
-          #   any given conversion attempt, the exactness will be updated based on how closely
-          #   the value recursively matches the target type:
+          # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
+          # any given conversion attempt, the exactness will be updated based on how closely
+          # the value recursively matches the target type:
           #
-          #   - `yes`: the value can be converted to the target type with minimum coercion.
-          #   - `maybe`: the value can be converted to the target type with some reasonable
-          #     coercion.
-          #   - `no`: the value cannot be converted to the target type.
+          # - `yes`: the value can be converted to the target type with minimum coercion.
+          # - `maybe`: the value can be converted to the target type with some reasonable
+          #   coercion.
+          # - `no`: the value cannot be converted to the target type.
           #
-          #   See implementation below for more details.
+          # See implementation below for more details.
           #
           #   @option state [Boolean, :strong] :strictness
           #
@@ -218,7 +217,6 @@ module Orb
           end
         end
       end
-      # rubocop:enable Metrics/ModuleLength
     end
   end
 end

data/lib/orb/internal/type/enum.rb

@@ -6,15 +6,15 @@ module Orb
       # @api private
       #
       # A value from among a specified list of options. OpenAPI enum values map to Ruby
-      #   values in the SDK as follows:
+      # values in the SDK as follows:
       #
-      #   1. boolean => true | false
-      #   2. integer => Integer
-      #   3. float => Float
-      #   4. string => Symbol
+      # 1. boolean => true | false
+      # 2. integer => Integer
+      # 3. float => Float
+      # 4. string => Symbol
       #
-      #   We can therefore convert string values to Symbols, but can't convert other
-      #   values safely.
+      # We can therefore convert string values to Symbols, but can't convert other
+      # values safely.
       #
       # @example
       #   # `billing_cycle_relative_date` is a `Orb::Models::BillingCycleRelativeDate`
@@ -66,7 +66,7 @@ module Orb
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member
-        #   of the enum.
+        # of the enum.
         #
         # @param value [String, Symbol, Object]
         #

data/lib/orb/internal/util.rb

@@ -2,8 +2,6 @@
 
 module Orb
   module Internal
-    # rubocop:disable Metrics/ModuleLength
-
     # @api private
     module Util
       # @api private
@@ -154,7 +152,7 @@ module Orb
         # @api private
         #
         # Recursively merge one hash with another. If the values at a given key are not
-        #   both hashes, just take the new value.
+        # both hashes, just take the new value.
         #
         # @param values [Array<Object>]
         #
@@ -694,7 +692,5 @@ module Orb
         end
       end
     end
-
-    # rubocop:enable Metrics/ModuleLength
   end
 end

data/lib/orb/models/alert.rb

@@ -54,7 +54,7 @@ module Orb
 
       # @!attribute thresholds
       #   The thresholds that define the conditions under which the alert will be
-      #     triggered.
+      #   triggered.
       #
       #   @return [Array<Orb::Models::Alert::Threshold>, nil]
       required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Alert::Threshold] }, nil?: true
@@ -67,10 +67,10 @@ module Orb
 
       # @!parse
       #   # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
-      #   #   usage, or credit balance and trigger webhooks when a threshold is exceeded.
+      #   # usage, or credit balance and trigger webhooks when a threshold is exceeded.
       #   #
-      #   #   Alerts created through the API can be scoped to either customers or
-      #   #   subscriptions.
+      #   # Alerts created through the API can be scoped to either customers or
+      #   # subscriptions.
       #   #
       #   # @param id [String]
       #   # @param created_at [Time]
@@ -136,8 +136,8 @@ module Orb
 
         # @!attribute 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.
         #
         #   @return [String, nil]
         required :external_plan_id, String, nil?: true
@@ -185,15 +185,15 @@ module Orb
       class Threshold < Orb::Internal::Type::BaseModel
         # @!attribute value
         #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #     fire at or below this value. For usage and cost alerts, the alert will fire at
-        #     or above this value.
+        #   fire at or below this value. For usage and cost alerts, the alert will fire at
+        #   or above this value.
         #
         #   @return [Float]
         required :value, Float
 
         # @!parse
         #   # Thresholds are used to define the conditions under which an alert will be
-        #   #   triggered.
+        #   # triggered.
         #   #
         #   # @param value [Float]
         #   #

data/lib/orb/models/alert_create_for_customer_params.rb

@@ -56,15 +56,15 @@ module Orb
       class Threshold < Orb::Internal::Type::BaseModel
         # @!attribute value
         #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #     fire at or below this value. For usage and cost alerts, the alert will fire at
-        #     or above this value.
+        #   fire at or below this value. For usage and cost alerts, the alert will fire at
+        #   or above this value.
         #
         #   @return [Float]
         required :value, Float
 
         # @!parse
         #   # Thresholds are used to define the conditions under which an alert will be
-        #   #   triggered.
+        #   # triggered.
         #   #
         #   # @param value [Float]
         #   #

data/lib/orb/models/alert_create_for_external_customer_params.rb

@@ -56,15 +56,15 @@ module Orb
       class Threshold < Orb::Internal::Type::BaseModel
         # @!attribute value
         #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #     fire at or below this value. For usage and cost alerts, the alert will fire at
-        #     or above this value.
+        #   fire at or below this value. For usage and cost alerts, the alert will fire at
+        #   or above this value.
         #
         #   @return [Float]
         required :value, Float
 
         # @!parse
         #   # Thresholds are used to define the conditions under which an alert will be
-        #   #   triggered.
+        #   # triggered.
         #   #
         #   # @param value [Float]
         #   #

data/lib/orb/models/alert_create_for_subscription_params.rb

@@ -40,15 +40,15 @@ module Orb
       class Threshold < Orb::Internal::Type::BaseModel
         # @!attribute value
         #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #     fire at or below this value. For usage and cost alerts, the alert will fire at
-        #     or above this value.
+        #   fire at or below this value. For usage and cost alerts, the alert will fire at
+        #   or above this value.
         #
         #   @return [Float]
         required :value, Float
 
         # @!parse
         #   # Thresholds are used to define the conditions under which an alert will be
-        #   #   triggered.
+        #   # triggered.
         #   #
         #   # @param value [Float]
         #   #

data/lib/orb/models/alert_list_params.rb

@@ -11,26 +11,26 @@ module Orb
       # @!attribute created_at_gt
       #
       #   @return [Time, nil]
-      optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true
+      optional :created_at_gt, Time, nil?: true
 
       # @!attribute created_at_gte
       #
       #   @return [Time, nil]
-      optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true
+      optional :created_at_gte, Time, nil?: true
 
       # @!attribute created_at_lt
       #
       #   @return [Time, nil]
-      optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true
+      optional :created_at_lt, Time, nil?: true
 
       # @!attribute created_at_lte
       #
       #   @return [Time, nil]
-      optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true
+      optional :created_at_lte, Time, nil?: true
 
       # @!attribute cursor
       #   Cursor for pagination. This can be populated by the `next_cursor` value returned
-      #     from the initial request.
+      #   from the initial request.
       #
       #   @return [String, nil]
       optional :cursor, String, nil?: true

data/lib/orb/models/alert_update_params.rb

@@ -25,15 +25,15 @@ module Orb
       class Threshold < Orb::Internal::Type::BaseModel
         # @!attribute value
         #   The value at which an alert will fire. For credit balance alerts, the alert will
-        #     fire at or below this value. For usage and cost alerts, the alert will fire at
-        #     or above this value.
+        #   fire at or below this value. For usage and cost alerts, the alert will fire at
+        #   or above this value.
         #
         #   @return [Float]
         required :value, Float
 
         # @!parse
         #   # Thresholds are used to define the conditions under which an alert will be
-        #   #   triggered.
+        #   # triggered.
         #   #
         #   # @param value [Float]
         #   #

data/lib/orb/models/amount_discount.rb

@@ -11,7 +11,7 @@ module Orb
 
       # @!attribute applies_to_price_ids
       #   List of price_ids that this discount applies to. For plan/plan phase discounts,
-      #     this can be a subset of prices.
+      #   this can be a subset of prices.
       #
       #   @return [Array<String>]
       required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]

data/lib/orb/models/billable_metric.rb

@@ -16,17 +16,17 @@ module Orb
 
       # @!attribute item
       #   The Item resource represents a sellable product or good. Items are associated
-      #     with all line items, billable metrics, and prices and are used for defining
-      #     external sync behavior for invoices and tax calculation purposes.
+      #   with all line items, billable metrics, and prices and are used for defining
+      #   external sync behavior for invoices and tax calculation purposes.
       #
       #   @return [Orb::Models::Item]
       required :item, -> { Orb::Models::Item }
 
       # @!attribute metadata
       #   User specified key-value pairs for the resource. If not present, this defaults
-      #     to an empty dictionary. Individual keys can be removed by setting the value to
-      #     `null`, and the entire metadata mapping can be cleared by setting `metadata` to
-      #     `null`.
+      #   to an empty dictionary. Individual keys can be removed by setting the value to
+      #   `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+      #   `null`.
       #
       #   @return [Hash{Symbol=>String}]
       required :metadata, Orb::Internal::Type::HashOf[String]
@@ -43,8 +43,8 @@ module Orb
 
       # @!parse
       #   # The Metric resource represents a calculation of a quantity based on events.
-      #   #   Metrics are defined by the query that transforms raw usage events into
-      #   #   meaningful values for your customers.
+      #   # Metrics are defined by the query that transforms raw usage events into
+      #   # meaningful values for your customers.
       #   #
       #   # @param id [String]
       #   # @param description [String, nil]

data/lib/orb/models/coupon.rb

@@ -12,7 +12,7 @@ module Orb
 
       # @!attribute archived_at
       #   An archived coupon can no longer be redeemed. Active coupons will have a value
-      #     of null for `archived_at`; this field will be non-null for archived coupons.
+      #   of null for `archived_at`; this field will be non-null for archived coupons.
       #
       #   @return [Time, nil]
       required :archived_at, Time, nil?: true
@@ -24,14 +24,14 @@ module Orb
 
       # @!attribute duration_in_months
       #   This allows for a coupon's discount to apply for a limited time (determined in
-      #     months); a `null` value here means "unlimited time".
+      #   months); a `null` value here means "unlimited time".
       #
       #   @return [Integer, nil]
       required :duration_in_months, Integer, nil?: true
 
       # @!attribute max_redemptions
       #   The maximum number of redemptions allowed for this coupon before it is
-      #     exhausted; `null` here means "unlimited".
+      #   exhausted; `null` here means "unlimited".
       #
       #   @return [Integer, nil]
       required :max_redemptions, Integer, nil?: true
@@ -50,10 +50,10 @@ module Orb
 
       # @!parse
       #   # A coupon represents a reusable discount configuration that can be applied either
-      #   #   as a fixed or percentage amount to an invoice or subscription. Coupons are
-      #   #   activated using a redemption code, which applies the discount to a subscription
-      #   #   or invoice. The duration of a coupon determines how long it remains available
-      #   #   for use by end users.
+      #   # as a fixed or percentage amount to an invoice or subscription. Coupons are
+      #   # activated using a redemption code, which applies the discount to a subscription
+      #   # or invoice. The duration of a coupon determines how long it remains available
+      #   # for use by end users.
       #   #
       #   # @param id [String]
       #   # @param archived_at [Time, nil]

data/lib/orb/models/coupon_create_params.rb

@@ -21,14 +21,14 @@ module Orb
 
       # @!attribute duration_in_months
       #   This allows for a coupon's discount to apply for a limited time (determined in
-      #     months); a `null` value here means "unlimited time".
+      #   months); a `null` value here means "unlimited time".
       #
       #   @return [Integer, nil]
       optional :duration_in_months, Integer, nil?: true
 
       # @!attribute max_redemptions
       #   The maximum number of redemptions allowed for this coupon before it is
-      #     exhausted;`null` here means "unlimited".
+      #   exhausted;`null` here means "unlimited".
       #
       #   @return [Integer, nil]
       optional :max_redemptions, Integer, nil?: true

data/lib/orb/models/coupon_list_params.rb

@@ -10,7 +10,7 @@ module Orb
 
       # @!attribute cursor
       #   Cursor for pagination. This can be populated by the `next_cursor` value returned
-      #     from the initial request.
+      #   from the initial request.
       #
       #   @return [String, nil]
       optional :cursor, String, nil?: true
@@ -33,7 +33,7 @@ module Orb
 
       # @!attribute show_archived
       #   Show archived coupons as well (by default, this endpoint only returns active
-      #     coupons).
+      #   coupons).
       #
       #   @return [Boolean, nil]
       optional :show_archived, Orb::Internal::Type::Boolean, nil?: true

data/lib/orb/models/coupons/subscription_list_params.rb

@@ -11,7 +11,7 @@ module Orb
 
         # @!attribute cursor
         #   Cursor for pagination. This can be populated by the `next_cursor` value returned
-        #     from the initial request.
+        #   from the initial request.
         #
         #   @return [String, nil]
         optional :cursor, String, nil?: true

data/lib/orb/models/credit_note.rb

@@ -103,7 +103,7 @@ module Orb
 
       # @!parse
       #   # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
-      #   #   been applied to a particular invoice.
+      #   # been applied to a particular invoice.
       #   #
       #   # @param id [String]
       #   # @param created_at [Time]

data/lib/orb/models/credit_note_list_params.rb

@@ -11,26 +11,26 @@ module Orb
       # @!attribute created_at_gt
       #
       #   @return [Time, nil]
-      optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true
+      optional :created_at_gt, Time, nil?: true
 
       # @!attribute created_at_gte
       #
       #   @return [Time, nil]
-      optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true
+      optional :created_at_gte, Time, nil?: true
 
       # @!attribute created_at_lt
       #
       #   @return [Time, nil]
-      optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true
+      optional :created_at_lt, Time, nil?: true
 
       # @!attribute created_at_lte
       #
       #   @return [Time, nil]
-      optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true
+      optional :created_at_lte, Time, nil?: true
 
       # @!attribute cursor
       #   Cursor for pagination. This can be populated by the `next_cursor` value returned
-      #     from the initial request.
+      #   from the initial request.
       #
       #   @return [String, nil]
       optional :cursor, String, nil?: true