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

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

@@ -47,8 +47,12 @@ module Orb
           #   #
           #   # @param value [Object]
           #   #
+          #   # @param state [Hash{Symbol=>Object}] .
+          #   #
+          #   #   @option state [Boolean] :can_retry
+          #   #
           #   # @return [Object]
-          #   def dump(value) = super
+          #   def dump(value, state:) = super
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

data/lib/orb/internal/util.rb

@@ -2,8 +2,6 @@
 
 module Orb
   module Internal
-    # rubocop:disable Metrics/ModuleLength
-
     # @api private
     module Util
       # @api private
@@ -124,7 +122,7 @@ module Orb
         # @return [Hash{Object=>Object}, Object]
         def coerce_hash(input)
           case input
-          in NilClass | Array | Set | Enumerator
+          in NilClass | Array | Set | Enumerator | StringIO | IO
             input
           else
             input.respond_to?(:to_h) ? input.to_h : input
@@ -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>]
         #
@@ -350,10 +348,47 @@ module Orb
         end
       end
 
+      # @api private
+      class SerializationAdapter
+        # @return [Pathname, IO]
+        attr_reader :inner
+
+        # @param a [Object]
+        #
+        # @return [String]
+        def to_json(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_json(*a)
+
+        # @param a [Object]
+        #
+        # @return [String]
+        def to_yaml(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_yaml(*a)
+
+        # @api private
+        #
+        # @param inner [Pathname, IO]
+        def initialize(inner) = @inner = inner
+      end
+
       # @api private
       #
       # An adapter that satisfies the IO interface required by `::IO.copy_stream`
       class ReadIOAdapter
+        # @api private
+        #
+        # @return [Boolean, nil]
+        def close? = @closing
+
+        # @api private
+        def close
+          case @stream
+          in Enumerator
+            Orb::Internal::Util.close_fused!(@stream)
+          in IO if close?
+            @stream.close
+          else
+          end
+        end
+
         # @api private
         #
         # @param max_len [Integer, nil]
@@ -398,12 +433,21 @@ module Orb
 
         # @api private
         #
-        # @param stream [String, IO, StringIO, Enumerable<String>]
+        # @param src [String, Pathname, StringIO, Enumerable<String>]
         # @param blk [Proc]
         #
         # @yieldparam [String]
-        def initialize(stream, &blk)
-          @stream = stream.is_a?(String) ? StringIO.new(stream) : stream
+        def initialize(src, &blk)
+          @stream =
+            case src
+            in String
+              StringIO.new(src)
+            in Pathname
+              @closing = true
+              src.open(binmode: true)
+            else
+              src
+            end
           @buf = String.new.b
           @blk = blk
         end
@@ -416,9 +460,10 @@ module Orb
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
+            buf = String.new.b
             y.define_singleton_method(:write) do
-              self << _1.clone
-              _1.bytesize
+              self << buf.replace(_1)
+              buf.bytesize
             end
 
             blk.call(y)
@@ -433,29 +478,39 @@ module Orb
         # @param boundary [String]
         # @param key [Symbol, String]
         # @param val [Object]
-        private def write_multipart_chunk(y, boundary:, key:, val:)
+        # @param closing [Array<Proc>]
+        private def write_multipart_chunk(y, boundary:, key:, val:, closing:)
+          val = val.inner if val.is_a?(Orb::Internal::Util::SerializationAdapter)
+
           y << "--#{boundary}\r\n"
           y << "Content-Disposition: form-data"
           unless key.nil?
             name = ERB::Util.url_encode(key.to_s)
             y << "; name=\"#{name}\""
           end
-          if val.is_a?(IO)
+          case val
+          in Pathname | IO
             filename = ERB::Util.url_encode(File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
+          else
           end
           y << "\r\n"
           case val
+          in Pathname
+            y << "Content-Type: application/octet-stream\r\n\r\n"
+            io = val.open(binmode: true)
+            closing << io.method(:close)
+            IO.copy_stream(io, y)
           in IO
             y << "Content-Type: application/octet-stream\r\n\r\n"
-            IO.copy_stream(val.tap(&:rewind), y)
+            IO.copy_stream(val, y)
           in StringIO
             y << "Content-Type: application/octet-stream\r\n\r\n"
             y << val.string
           in String
             y << "Content-Type: application/octet-stream\r\n\r\n"
             y << val.to_s
-          in true | false | Integer | Float | Symbol
+          in _ if primitive?(val)
             y << "Content-Type: text/plain\r\n\r\n"
             y << val.to_s
           else
@@ -473,6 +528,7 @@ module Orb
         private def encode_multipart_streaming(body)
           boundary = SecureRandom.urlsafe_base64(60)
 
+          closing = []
           strio = writable_enum do |y|
             case body
             in Hash
@@ -480,19 +536,20 @@ module Orb
                 case val
                 in Array if val.all? { primitive?(_1) }
                   val.each do |v|
-                    write_multipart_chunk(y, boundary: boundary, key: key, val: v)
+                    write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
                 else
-                  write_multipart_chunk(y, boundary: boundary, key: key, val: val)
+                  write_multipart_chunk(y, boundary: boundary, key: key, val: val, closing: closing)
                 end
               end
             else
-              write_multipart_chunk(y, boundary: boundary, key: nil, val: body)
+              write_multipart_chunk(y, boundary: boundary, key: nil, val: body, closing: closing)
             end
             y << "--#{boundary}--\r\n"
           end
 
-          [boundary, strio]
+          fused_io = fused_enum(strio) { closing.each(&:call) }
+          [boundary, fused_io]
         end
 
         # @api private
@@ -503,21 +560,21 @@ module Orb
         # @return [Object]
         def encode_content(headers, body)
           content_type = headers["content-type"]
+          body = body.inner if body.is_a?(Orb::Internal::Util::SerializationAdapter)
+
           case [content_type, body]
-          in [%r{^application/(?:vnd\.api\+)?json}, _] unless body.nil?
+          in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.fast_generate(body)]
-          in [%r{^application/(?:x-)?jsonl}, Enumerable]
+          in [%r{^application/(?:x-)?jsonl}, Enumerable] unless body.is_a?(StringIO) || body.is_a?(IO)
             [headers, body.lazy.map { JSON.fast_generate(_1) }]
-          in [%r{^multipart/form-data}, Hash | IO | StringIO]
+          in [%r{^multipart/form-data}, Hash | Pathname | StringIO | IO]
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
             [headers, strio]
-          in [_, IO]
-            [headers, body.tap(&:rewind)]
-          in [_, StringIO]
-            [headers, body.string]
           in [_, Symbol | Numeric]
             [headers, body.to_s]
+          in [_, StringIO]
+            [headers, body.string]
           else
             [headers, body]
           end
@@ -694,7 +751,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