recurly 2.17.11 → 4.18.0

data/lib/recurly/resources/tax_detail.rb

@@ -0,0 +1,26 @@
+# 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 Resources
+    class TaxDetail < Resource
+
+      # @!attribute rate
+      #   @return [Float] Provides the tax rate for the region.
+      define_attribute :rate, Float
+
+      # @!attribute region
+      #   @return [String] Provides the tax region applied on an invoice. For Canadian Sales Tax, this will be either the 2 letter province code or country code.
+      define_attribute :region, String
+
+      # @!attribute tax
+      #   @return [Float] The total tax applied for this tax type.
+      define_attribute :tax, Float
+
+      # @!attribute type
+      #   @return [String] Provides the tax type for the region. For Canadian Sales Tax, this will be GST, HST, QST or PST.
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/tax_info.rb

@@ -0,0 +1,26 @@
+# 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 Resources
+    class TaxInfo < Resource
+
+      # @!attribute rate
+      #   @return [Float] Rate
+      define_attribute :rate, Float
+
+      # @!attribute region
+      #   @return [String] Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST.
+      define_attribute :region, String
+
+      # @!attribute tax_details
+      #   @return [Array[TaxDetail]] Provides additional tax details for Canadian Sales Tax when there is tax applied at both the country and province levels. This will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItem.
+      define_attribute :tax_details, Array, { :item_type => :TaxDetail }
+
+      # @!attribute type
+      #   @return [String] Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries.
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/tier.rb

@@ -0,0 +1,22 @@
+# 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 Resources
+    class Tier < Resource
+
+      # @!attribute currencies
+      #   @return [Array[TierPricing]] Tier pricing
+      define_attribute :currencies, Array, { :item_type => :TierPricing }
+
+      # @!attribute ending_quantity
+      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier.
+      define_attribute :ending_quantity, Integer
+
+      # @!attribute usage_percentage
+      #   @return [String] (deprecated) -- Use the percentage_tiers object instead.
+      define_attribute :usage_percentage, String
+    end
+  end
+end

data/lib/recurly/resources/tier_pricing.rb

@@ -0,0 +1,22 @@
+# 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 Resources
+    class TierPricing < Resource
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+      define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
+    end
+  end
+end

data/lib/recurly/resources/transaction.rb

@@ -0,0 +1,162 @@
+# 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 Resources
+    class Transaction < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      define_attribute :account, :AccountMini
+
+      # @!attribute amount
+      #   @return [Float] Total transaction amount sent to the payment gateway.
+      define_attribute :amount, Float
+
+      # @!attribute avs_check
+      #   @return [String] When processed, result from checking the overall AVS on the transaction.
+      define_attribute :avs_check, String
+
+      # @!attribute backup_payment_method_used
+      #   @return [Boolean] Indicates if the transaction was completed using a backup payment
+      define_attribute :backup_payment_method_used, :Boolean
+
+      # @!attribute billing_address
+      #   @return [AddressWithName]
+      define_attribute :billing_address, :AddressWithName
+
+      # @!attribute collected_at
+      #   @return [DateTime] Collected at, or if not collected yet, the time the transaction was created.
+      define_attribute :collected_at, DateTime
+
+      # @!attribute collection_method
+      #   @return [String] The method by which the payment was collected.
+      define_attribute :collection_method, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute customer_message
+      #   @return [String] For declined (`success=false`) transactions, the message displayed to the customer.
+      define_attribute :customer_message, String
+
+      # @!attribute customer_message_locale
+      #   @return [String] Language code for the message
+      define_attribute :customer_message_locale, String
+
+      # @!attribute cvv_check
+      #   @return [String] When processed, result from checking the CVV/CVC value on the transaction.
+      define_attribute :cvv_check, String
+
+      # @!attribute gateway_approval_code
+      #   @return [String] Transaction approval code from the payment gateway.
+      define_attribute :gateway_approval_code, String
+
+      # @!attribute gateway_message
+      #   @return [String] Transaction message from the payment gateway.
+      define_attribute :gateway_message, String
+
+      # @!attribute gateway_reference
+      #   @return [String] Transaction reference number from the payment gateway.
+      define_attribute :gateway_reference, String
+
+      # @!attribute gateway_response_code
+      #   @return [String] For declined transactions (`success=false`), this field lists the gateway error code.
+      define_attribute :gateway_response_code, String
+
+      # @!attribute gateway_response_time
+      #   @return [Float] Time, in seconds, for gateway to process the transaction.
+      define_attribute :gateway_response_time, Float
+
+      # @!attribute gateway_response_values
+      #   @return [Hash] The values in this field will vary from gateway to gateway.
+      define_attribute :gateway_response_values, Hash
+
+      # @!attribute id
+      #   @return [String] Transaction ID
+      define_attribute :id, String
+
+      # @!attribute invoice
+      #   @return [InvoiceMini] Invoice mini details
+      define_attribute :invoice, :InvoiceMini
+
+      # @!attribute ip_address_country
+      #   @return [String] Origin IP address country, 2-letter ISO 3166-1 alpha-2 code, if known by Recurly.
+      define_attribute :ip_address_country, String
+
+      # @!attribute ip_address_v4
+      #   @return [String] IP address provided when the billing information was collected:  - When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address. - When the merchant enters billing information using the API, the merchant may provide an IP address. - When the merchant enters billing information using the UI, no IP address is recorded.
+      define_attribute :ip_address_v4, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute origin
+      #   @return [String] Describes how the transaction was triggered.
+      define_attribute :origin, String
+
+      # @!attribute original_transaction_id
+      #   @return [String] If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.
+      define_attribute :original_transaction_id, String
+
+      # @!attribute payment_gateway
+      #   @return [TransactionPaymentGateway]
+      define_attribute :payment_gateway, :TransactionPaymentGateway
+
+      # @!attribute payment_method
+      #   @return [PaymentMethod]
+      define_attribute :payment_method, :PaymentMethod
+
+      # @!attribute refunded
+      #   @return [Boolean] Indicates if part or all of this transaction was refunded.
+      define_attribute :refunded, :Boolean
+
+      # @!attribute status
+      #   @return [String] The current transaction status. Note that the status may change, e.g. a `pending` transaction may become `declined` or `success` may later become `void`.
+      define_attribute :status, String
+
+      # @!attribute status_code
+      #   @return [String] Status code
+      define_attribute :status_code, String
+
+      # @!attribute status_message
+      #   @return [String] For declined (`success=false`) transactions, the message displayed to the merchant.
+      define_attribute :status_message, String
+
+      # @!attribute subscription_ids
+      #   @return [Array[String]] If the transaction is charging or refunding for one or more subscriptions, these are their IDs.
+      define_attribute :subscription_ids, Array, { :item_type => String }
+
+      # @!attribute success
+      #   @return [Boolean] Did this transaction complete successfully?
+      define_attribute :success, :Boolean
+
+      # @!attribute type
+      #   @return [String] - `authorization` – verifies billing information and places a hold on money in the customer's account. - `capture` – captures funds held by an authorization and completes a purchase. - `purchase` – combines the authorization and capture in one transaction. - `refund` – returns all or a portion of the money collected in a previous transaction to the customer. - `verify` – a $0 or $1 transaction used to verify billing information which is immediately voided.
+      define_attribute :type, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+
+      # @!attribute uuid
+      #   @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
+      define_attribute :uuid, String
+
+      # @!attribute voided_at
+      #   @return [DateTime] Voided at
+      define_attribute :voided_at, DateTime
+
+      # @!attribute voided_by_invoice
+      #   @return [InvoiceMini] Invoice mini details
+      define_attribute :voided_by_invoice, :InvoiceMini
+    end
+  end
+end

data/lib/recurly/resources/transaction_error.rb

@@ -0,0 +1,38 @@
+# 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 Resources
+    class TransactionError < Resource
+
+      # @!attribute category
+      #   @return [String] Category
+      define_attribute :category, String
+
+      # @!attribute code
+      #   @return [String] Code
+      define_attribute :code, String
+
+      # @!attribute merchant_advice
+      #   @return [String] Merchant message
+      define_attribute :merchant_advice, String
+
+      # @!attribute message
+      #   @return [String] Customer message
+      define_attribute :message, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute three_d_secure_action_token_id
+      #   @return [String] Returned when 3-D Secure authentication is required for a transaction. Pass this value to Recurly.js so it can continue the challenge flow.
+      define_attribute :three_d_secure_action_token_id, String
+
+      # @!attribute transaction_id
+      #   @return [String] Transaction ID
+      define_attribute :transaction_id, String
+    end
+  end
+end

data/lib/recurly/resources/transaction_payment_gateway.rb

@@ -0,0 +1,26 @@
+# 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 Resources
+    class TransactionPaymentGateway < Resource
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String]
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute type
+      #   @return [String]
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/unique_coupon_code.rb

@@ -0,0 +1,50 @@
+# 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 Resources
+    class UniqueCouponCode < Resource
+
+      # @!attribute bulk_coupon_code
+      #   @return [String] The Coupon code of the parent Bulk Coupon
+      define_attribute :bulk_coupon_code, String
+
+      # @!attribute bulk_coupon_id
+      #   @return [String] The Coupon ID of the parent Bulk Coupon
+      define_attribute :bulk_coupon_id, String
+
+      # @!attribute code
+      #   @return [String] The code the customer enters to redeem the coupon.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute expired_at
+      #   @return [DateTime] The date and time the coupon was expired early or reached its `max_redemptions`.
+      define_attribute :expired_at, DateTime
+
+      # @!attribute id
+      #   @return [String] Unique Coupon Code ID
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute redeemed_at
+      #   @return [DateTime] The date and time the unique coupon code was redeemed.
+      define_attribute :redeemed_at, DateTime
+
+      # @!attribute state
+      #   @return [String] Indicates if the unique coupon code is redeemable or why not.
+      define_attribute :state, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/unique_coupon_code_params.rb

@@ -0,0 +1,26 @@
+# 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 Resources
+    class UniqueCouponCodeParams < Resource
+
+      # @!attribute begin_time
+      #   @return [DateTime] The date-time to be included when listing UniqueCouponCodes
+      define_attribute :begin_time, DateTime
+
+      # @!attribute limit
+      #   @return [Integer] The number of UniqueCouponCodes that will be generated
+      define_attribute :limit, Integer
+
+      # @!attribute order
+      #   @return [String] Sort order to list newly generated UniqueCouponCodes (should always be `asc`)
+      define_attribute :order, String
+
+      # @!attribute sort
+      #   @return [String] Sort field to list newly generated UniqueCouponCodes (should always be `created_at`)
+      define_attribute :sort, String
+    end
+  end
+end

data/lib/recurly/resources/usage.rb

@@ -0,0 +1,78 @@
+# 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 Resources
+    class Usage < Resource
+
+      # @!attribute amount
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. No decimals allowed, we will strip them. If the usage-based add-on is billed with a percentage, your usage will be a monetary amount you will want to format in cents. (e.g., $5.00 is "500").
+      define_attribute :amount, Float
+
+      # @!attribute billed_at
+      #   @return [DateTime] When the usage record was billed on an invoice.
+      define_attribute :billed_at, DateTime
+
+      # @!attribute created_at
+      #   @return [DateTime] When the usage record was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute measured_unit_id
+      #   @return [String] The ID of the measured unit associated with the add-on the usage record is for.
+      define_attribute :measured_unit_id, String
+
+      # @!attribute merchant_tag
+      #   @return [String] Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
+      define_attribute :merchant_tag, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute percentage_tiers
+      #   @return [Array[SubscriptionAddOnPercentageTier]] The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []
+      define_attribute :percentage_tiers, Array, { :item_type => :SubscriptionAddOnPercentageTier }
+
+      # @!attribute recording_timestamp
+      #   @return [DateTime] When the usage was recorded in your system.
+      define_attribute :recording_timestamp, DateTime
+
+      # @!attribute tier_type
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      define_attribute :tier_type, String
+
+      # @!attribute tiers
+      #   @return [Array[SubscriptionAddOnTier]] The tiers and prices of the subscription based on the usage_timestamp. If tier_type = flat, tiers = []
+      define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit price
+      define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Unit price that can optionally support a sub-cent value.
+      define_attribute :unit_amount_decimal, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the usage record was billed on an invoice.
+      define_attribute :updated_at, DateTime
+
+      # @!attribute usage_percentage
+      #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.
+      define_attribute :usage_percentage, Float
+
+      # @!attribute usage_timestamp
+      #   @return [DateTime] When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
+      define_attribute :usage_timestamp, DateTime
+
+      # @!attribute usage_type
+      #   @return [String] Type of usage, returns usage type if `add_on_type` is `usage`.
+      define_attribute :usage_type, String
+    end
+  end
+end

data/lib/recurly/resources/user.rb

@@ -0,0 +1,42 @@
+# 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 Resources
+    class User < Resource
+
+      # @!attribute created_at
+      #   @return [DateTime]
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime]
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute email
+      #   @return [String]
+      define_attribute :email, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute time_zone
+      #   @return [String]
+      define_attribute :time_zone, String
+    end
+  end
+end

data/lib/recurly/resources.rb

@@ -0,0 +1,18 @@
+# Include all resource files
+resources = File.join(File.dirname(__FILE__), "resources", "*.rb")
+Dir.glob(resources, &method(:require))
+
+module Recurly
+  module Resources
+    class Empty < Resource
+    end
+
+    class Page < Resource
+      # leave data untyped
+      define_attribute :data, Array, item_type: Hash
+      define_attribute :has_more, :Boolean
+      define_attribute :next, String
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/schema/file_parser.rb

@@ -0,0 +1,13 @@
+module Recurly
+  # This is a wrapper class to help parse http response into Recurly objects.
+  class FileParser
+
+    # Parses the json body into a recurly object.
+    #
+    # @param body [String] The data string to cast.
+    # @return [Resource]
+    def self.parse(body)
+      Recurly::Resources::BinaryFile.cast(data: body)
+    end
+  end
+end

data/lib/recurly/schema/json_parser.rb

@@ -0,0 +1,72 @@
+require "json"
+
+module Recurly
+  # This is a wrapper class to help parse http response into Recurly objects.
+  class JSONParser
+
+    # Parses the json body into a recurly object.
+    #
+    # @param client [Client] The Recurly client which made the request.
+    # @param body [String] The JSON string to parse.
+    # @return [Resource]
+    def self.parse(client, body)
+      data = JSON.parse(body)
+      from_json(data).tap do |object|
+        object.client = client if object.requires_client?
+      end
+    end
+
+    # Converts the parsed JSON into a Recurly object.
+    #
+    # *TODO*: Instead of inferring this type from the `object`
+    # attribute. We should instead "register" the response type
+    # in the client/operations code. The `get`, `post`, etc methods
+    # could explicitly state their response types.
+    #
+    # @param data [Hash] The parsed JSON data
+    # @return [Error,Resource]
+    def self.from_json(data)
+      type = if data.has_key?("error")
+          "error_may_have_transaction"
+        else
+          data["object"]
+        end
+      klazz = self.recurly_class(type)
+
+      unless klazz
+        raise ArgumentError, "Unknown resource for json type #{type}"
+      end
+
+      data = data["error"] if klazz == Resources::ErrorMayHaveTransaction
+
+      klazz.cast(data)
+    end
+
+    # Returns the Recurly ruby class responsible for the Recurly json key.
+    #
+    # @example
+    #   JSONParser.recurly_class('list')
+    #   #=> Recurly::Page
+    # @example
+    #   JSONParser.recurly_class('shipping_address')
+    #   #=> Recurly::Resources::ShippingAddress
+    #
+    # @param type [String] The JSON key.
+    # @return [Resource,Pager,nil]
+    def self.recurly_class(type)
+      case type
+      when nil
+        nil
+      when "list"
+        Resources::Page
+      else
+        type_camelized = type.split("_").map(&:capitalize).join
+        if Resources.const_defined?(type_camelized, false)
+          Resources.const_get(type_camelized, false)
+        elsif Recurly::STRICT_MODE
+          raise ArgumentError, "Could not find Recurly Resource responsible for key #{type}"
+        end
+      end
+    end
+  end
+end