recurly 4.80.0 → 4.81.0

data/lib/recurly/http/response.rb

@@ -0,0 +1,48 @@
+module Recurly
+  module HTTP
+    # The normalized response object every HTTP adapter must return from +#call+.
+    # It decouples the client from any particular transport library
+    # (+Net::HTTP+, Faraday, Typhoeus, ...).
+    #
+    # Header lookup is case-insensitive: keys are downcased on construction and
+    # +#[]+ downcases the lookup key.
+    class AdapterResponse
+      # @return [Integer] the numeric HTTP status code (e.g. 200)
+      attr_reader :status_code
+
+      # @return [Hash] response headers, keyed by downcased name
+      attr_reader :headers
+
+      # @return [String, nil] the raw response body
+      attr_reader :body
+
+      # @return [String, nil] the HTTP reason phrase (e.g. "Bad Gateway"), if the
+      #   adapter captured one. May be nil for adapters that do not surface it.
+      attr_reader :reason_phrase
+
+      def initialize(status_code:, headers:, body:, reason_phrase: nil)
+        @status_code = status_code
+        @headers = (headers || {}).each_with_object({}) do |(k, v), acc|
+          acc[k.to_s.downcase] = v
+        end
+        @body = body
+        @reason_phrase = reason_phrase
+      end
+
+      # Case-insensitive header lookup.
+      # @param name [String]
+      # @return [String, nil]
+      def [](name)
+        @headers[name.to_s.downcase]
+      end
+
+      # The status code as a String. +Errors::APIError.from_response+ keys
+      # +ERROR_MAP+ on the string status, so the object handed to it must expose
+      # a string +#code+.
+      # @return [String]
+      def code
+        @status_code.to_s
+      end
+    end
+  end
+end

data/lib/recurly/http.rb

@@ -6,9 +6,11 @@ module Recurly
         :rate_limit_reset, :date, :proxy_metadata,
         :content_type, :total_records
 
+      # @param resp [Recurly::HTTP::AdapterResponse] the normalized adapter response
+      # @param request [Recurly::HTTP::Request] the request wrapper (relative path)
       def initialize(resp, request)
         @request = Request.new(request.method, request.path, request.body)
-        @status = resp.code.to_i
+        @status = resp.status_code
         @request_id = resp["x-request-id"]
         @rate_limit = resp["x-ratelimit-limit"].to_i
         @rate_limit_remaining = resp["x-ratelimit-remaining"].to_i
@@ -17,7 +19,7 @@ module Recurly
         if resp["content-type"]
           @content_type = resp["content-type"].split(";").first
         else
-          @content_type = resp.content_type
+          @content_type = nil
         end
         if resp.body && !resp.body.empty?
           @body = resp.body

data/lib/recurly/requests/coupon_create.rb

@@ -79,9 +79,17 @@ module Recurly
       define_attribute :plan_codes, Array, { :item_type => String }
 
       # @!attribute redeem_by_date
-      #   @return [String] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+      #   @return [String] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time. Mutually exclusive with redeem_by_interval_unit/redeem_by_interval_amount.
       define_attribute :redeem_by_date, String
 
+      # @!attribute redeem_by_interval_amount
+      #   @return [Integer] Quantity of redeem_by_interval_unit. Must be paired with redeem_by_interval_unit.
+      define_attribute :redeem_by_interval_amount, Integer
+
+      # @!attribute redeem_by_interval_unit
+      #   @return [String] Unit of the relative redemption window. Must be paired with redeem_by_interval_amount. Mutually exclusive with redeem_by_date. Bulk coupons only.
+      define_attribute :redeem_by_interval_unit, String
+
       # @!attribute redemption_resource
       #   @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
       define_attribute :redemption_resource, String

data/lib/recurly/requests/coupon_update.rb

@@ -27,8 +27,16 @@ module Recurly
       define_attribute :name, String
 
       # @!attribute redeem_by_date
-      #   @return [String] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+      #   @return [String] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time. Mutually exclusive with redeem_by_interval_unit/redeem_by_interval_amount.
       define_attribute :redeem_by_date, String
+
+      # @!attribute redeem_by_interval_amount
+      #   @return [Integer] Quantity of redeem_by_interval_unit. Must be paired with redeem_by_interval_unit.
+      define_attribute :redeem_by_interval_amount, Integer
+
+      # @!attribute redeem_by_interval_unit
+      #   @return [String] Unit of the relative redemption window. Must be paired with redeem_by_interval_amount. Mutually exclusive with redeem_by_date. Bulk coupons only.
+      define_attribute :redeem_by_interval_unit, String
     end
   end
 end

data/lib/recurly/requests/invoice_create.rb

@@ -50,6 +50,10 @@ module Recurly
       #   @return [String] This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
       define_attribute :terms_and_conditions, String
 
+      # @!attribute transaction_descriptor_suffix
+      #   @return [String] Optionally overrides the suffix component of the composed transaction descriptor. If omitted, the suffix is derived from the subscription's plan name or the invoice description, with a Trial prefix on Visa trial conversions. Subject to gateway availability and payment method support.
+      define_attribute :transaction_descriptor_suffix, String
+
       # @!attribute vat_reverse_charge_notes
       #   @return [String] VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
       define_attribute :vat_reverse_charge_notes, String

data/lib/recurly/requests/recovery_billing_info_create.rb

@@ -42,12 +42,16 @@ module Recurly
       #   @return [Array[PaymentGatewayReferences]] Array of Payment Gateway References, each a reference to a third-party gateway object of varying types.
       define_attribute :payment_gateway_references, Array, { :item_type => :PaymentGatewayReferences }
 
+      # @!attribute payment_method
+      #   @return [RecoveryPaymentMethodCreate] Merchant-supplied fallback payment method metadata. Recurly's own gateway-token lookup is authoritative and will override any of these fields it can determine itself; these fields are only used to fill gaps when that lookup is unavailable.
+      define_attribute :payment_method, :RecoveryPaymentMethodCreate
+
       # @!attribute primary_payment_method
       #   @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. An account can have a maximum of 1 primary. If a user sets a different payment method as a primary, then the existing primary will no longer be marked as such.
       define_attribute :primary_payment_method, :Boolean
 
       # @!attribute transactions
-      #   @return [Array[RecoveryTransactionCreate]] Transactions from previous collection attempts for this payment method.
+      #   @return [Array[RecoveryTransactionCreate]] Transactions from previous collection attempts for this payment method. Optional, unless this billing_info is the primary payment method and the account's dunning campaign skips Recurly's own retry attempts entirely -- in that case at least one entry is required.
       define_attribute :transactions, Array, { :item_type => :RecoveryTransactionCreate }
     end
   end

data/lib/recurly/requests/recovery_invoice_create.rb

@@ -29,6 +29,10 @@ module Recurly
       # @!attribute po_number
       #   @return [String] This identifies the PO number associated with the subscription.
       define_attribute :po_number, String
+
+      # @!attribute transaction_descriptor_suffix
+      #   @return [String] Optionally overrides the suffix component of the composed transaction descriptor. If omitted, the suffix is derived from the subscription's plan name or the invoice description, with a Trial prefix on Visa trial conversions. Subject to gateway availability and payment method support.
+      define_attribute :transaction_descriptor_suffix, String
     end
   end
 end

data/lib/recurly/requests/recovery_payment_method_create.rb

@@ -0,0 +1,34 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class RecoveryPaymentMethodCreate < Request
+
+      # @!attribute card_type
+      #   @return [String] The card brand (e.g. `Visa`, `MasterCard`). Present for `credit_card`, `apple_pay`, and `google_pay`/`google_pay_device_pan`; omitted for `paypal_billing_agreement`.
+      define_attribute :card_type, String
+
+      # @!attribute exp_month
+      #   @return [Integer] Expiration month.
+      define_attribute :exp_month, Integer
+
+      # @!attribute exp_year
+      #   @return [Integer] Expiration year.
+      define_attribute :exp_year, Integer
+
+      # @!attribute first_six
+      #   @return [String] For a plain card, the card's own first six digits (BIN).  For a tokenized wallet payment (`apple_pay`, `google_pay`, or `google_pay_device_pan`), this is the DPAN's (the wallet/device token's own number) first six digits — **not** the underlying card's (FPAN). The FPAN is never accepted or represented; no separate wallet-specific field is provided.
+      define_attribute :first_six, String
+
+      # @!attribute last_four
+      #   @return [String] The card's (or, for a tokenized wallet payment, the DPAN's) last four digits. See `first_six` for the DPAN-vs-FPAN distinction on wallets.
+      define_attribute :last_four, String
+
+      # @!attribute object
+      #   @return [String] The payment method type.
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_create.rb

@@ -138,6 +138,10 @@ module Recurly
       #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
       define_attribute :total_billing_cycles, Integer
 
+      # @!attribute transaction_descriptor_suffix
+      #   @return [String] Optionally overrides the suffix component of the composed transaction descriptor. If omitted, the suffix is derived from the subscription's plan name or the invoice description, with a Trial prefix on Visa trial conversions. Subject to gateway availability and payment method support.
+      define_attribute :transaction_descriptor_suffix, String
+
       # @!attribute transaction_type
       #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
       define_attribute :transaction_type, String

data/lib/recurly/requests/subscription_update.rb

@@ -77,6 +77,10 @@ module Recurly
       # @!attribute terms_and_conditions
       #   @return [String] Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
       define_attribute :terms_and_conditions, String
+
+      # @!attribute transaction_descriptor_suffix
+      #   @return [String] Optionally overrides the suffix component of the composed transaction descriptor. If omitted, the suffix is derived from the subscription's plan name or the invoice description, with a Trial prefix on Visa trial conversions. Subject to gateway availability and payment method support.
+      define_attribute :transaction_descriptor_suffix, String
     end
   end
 end

data/lib/recurly/resources/coupon.rb

@@ -87,9 +87,17 @@ module Recurly
       define_attribute :plans, Array, { :item_type => :PlanMini }
 
       # @!attribute redeem_by
-      #   @return [DateTime] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+      #   @return [DateTime] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time. Null for bulk coupons configured with a relative redeem-by interval (see redeem_by_interval_unit and redeem_by_interval_amount).
       define_attribute :redeem_by, DateTime
 
+      # @!attribute redeem_by_interval_amount
+      #   @return [Integer] For a bulk coupon with a relative redeem-by, the number of redeem_by_interval_unit intervals after a code's generation that it remains redeemable. Null unless the coupon uses a relative redeem-by.
+      define_attribute :redeem_by_interval_amount, Integer
+
+      # @!attribute redeem_by_interval_unit
+      #   @return [String] For a bulk coupon with a relative redeem-by, the unit of the interval after which each generated unique code expires. Null unless the coupon uses a relative redeem-by.
+      define_attribute :redeem_by_interval_unit, String
+
       # @!attribute redemption_resource
       #   @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
       define_attribute :redemption_resource, String

data/lib/recurly/resources/payment_method.rb

@@ -35,7 +35,7 @@ module Recurly
       define_attribute :exp_year, Integer
 
       # @!attribute first_six
-      #   @return [String] Credit card number's first six digits.
+      #   @return [String] Credit card number's first six digits.  For a tokenized wallet payment (`apple_pay`, `google_pay`, or `google_pay_device_pan`), this is the DPAN's (the wallet/device token's own number) first six digits, not the underlying card's (FPAN).
       define_attribute :first_six, String
 
       # @!attribute funding_source
@@ -55,7 +55,7 @@ module Recurly
       define_attribute :gateway_token, String
 
       # @!attribute last_four
-      #   @return [String] Credit card number's last four digits. Will refer to bank account if payment method is ACH.
+      #   @return [String] Credit card number's last four digits. Will refer to bank account if payment method is ACH.  For a tokenized wallet payment (`apple_pay`, `google_pay`, or `google_pay_device_pan`), this is the DPAN's last four digits, not the underlying card's (FPAN).
       define_attribute :last_four, String
 
       # @!attribute last_two

data/lib/recurly/resources/transaction.rb

@@ -134,6 +134,10 @@ module Recurly
       #   @return [TransactionPaymentGateway]
       define_attribute :payment_gateway, :TransactionPaymentGateway
 
+      # @!attribute payment_gateway_references
+      #   @return [Array[PaymentGatewayReferences]] Array of Payment Gateway References captured at transaction time, each a reference to a third-party gateway object of varying types.
+      define_attribute :payment_gateway_references, Array, { :item_type => :PaymentGatewayReferences }
+
       # @!attribute payment_method
       #   @return [PaymentMethod]
       define_attribute :payment_method, :PaymentMethod

data/lib/recurly/resources/unique_coupon_code.rb

@@ -34,6 +34,10 @@ module Recurly
       #   @return [String] Object type
       define_attribute :object, String
 
+      # @!attribute redeem_by_date
+      #   @return [DateTime] Absolute expiry computed and stored at code-generation time. Set only for Window (relative redeem-by) coupons. Null for Anytime coupons and Specific Date coupons — those resolve expiry from the parent coupon's redeem_by at redemption time, not at code-generation time.
+      define_attribute :redeem_by_date, DateTime
+
       # @!attribute redeemed_at
       #   @return [DateTime] The date and time the unique coupon code was redeemed.
       define_attribute :redeemed_at, DateTime

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "4.80.0"
+  VERSION = "4.81.0"
 end

data/lib/recurly.rb

@@ -6,8 +6,12 @@ require "recurly/pager"
 require "recurly/requests"
 require "recurly/resources"
 require "recurly/http"
+require "recurly/http/http_method"
+require "recurly/http/response"
 require "recurly/errors"
 require "recurly/connection_pool"
+require "recurly/http/adapter"
+require "recurly/http/default_http_adapter"
 require "recurly/client"
 require "recurly/webhooks"