recurly 3.0.0.beta.3 → 3.0.0.beta.4

data/lib/recurly/errors/api_errors.rb

@@ -1,3 +1,7 @@
+# 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 Errors
     class BadRequestError < Errors::APIError; end

data/lib/recurly/errors/network_errors.rb

@@ -2,7 +2,7 @@ module Recurly
   module Errors
     class NetworkError < StandardError; end
     class TimeoutError < NetworkError; end
-    class ConnectionFailed < NetworkError; end
+    class ConnectionFailedError < NetworkError; end
     class SSLError < NetworkError; end
   end
 end

data/lib/recurly/pager.rb

@@ -113,7 +113,11 @@ module Recurly
     end
 
     def build_path(path, options)
-      "#{path}?#{URI.encode_www_form(options)}"
+      if options.empty?
+        path
+      else
+        "#{path}?#{URI.encode_www_form(options)}"
+      end
     end
   end
 end

data/lib/recurly/requests/account_acquisition_cost.rb

@@ -0,0 +1,18 @@
+# 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 AccountAcquisitionCost < Request
+
+      # @!attribute amount
+      #   @return [Float] The amount of the corresponding currency used to acquire the account.
+      define_attribute :amount, Float
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+    end
+  end
+end

data/lib/recurly/requests/account_acquisition_updatable.rb

@@ -1,3 +1,7 @@
+# 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 AccountAcquisitionUpdatable < Request
@@ -8,7 +12,7 @@ module Recurly
 
       # @!attribute channel
       #   @return [String] The channel through which the account was acquired.
-      define_attribute :channel, String, {:enum => ["referral", "social_media", "email", "paid_search", "organic_search", "direct_traffic", "marketing_content", "blog", "events", "outbound_sales", "advertising", "public_relations", "other"]}
+      define_attribute :channel, String, { :enum => ["referral", "social_media", "email", "paid_search", "organic_search", "direct_traffic", "marketing_content", "blog", "events", "outbound_sales", "advertising", "public_relations", "other"] }
 
       # @!attribute cost
       #   @return [Hash] Account balance

data/lib/recurly/requests/account_create.rb

@@ -1,3 +1,7 @@
+# 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 AccountCreate < Request
@@ -10,6 +14,10 @@ module Recurly
       #   @return [Address]
       define_attribute :address, :Address
 
+      # @!attribute bill_to
+      #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+      define_attribute :bill_to, String, { :enum => ["self", "parent"] }
+
       # @!attribute billing_info
       #   @return [BillingInfoCreate]
       define_attribute :billing_info, :BillingInfoCreate
@@ -28,12 +36,16 @@ module Recurly
 
       # @!attribute custom_fields
       #   @return [Array[CustomField]]
-      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute exemption_certificate
+      #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+      define_attribute :exemption_certificate, String
+
       # @!attribute first_name
       #   @return [String]
       define_attribute :first_name, String
@@ -42,13 +54,21 @@ module Recurly
       #   @return [String]
       define_attribute :last_name, String
 
+      # @!attribute parent_account_code
+      #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_code, String
+
+      # @!attribute parent_account_id
+      #   @return [String] The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_id, String
+
       # @!attribute preferred_locale
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
-      define_attribute :preferred_locale, String, {:enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"]}
+      define_attribute :preferred_locale, String, { :enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"] }
 
       # @!attribute shipping_addresses
       #   @return [Array[ShippingAddressCreate]]
-      define_attribute :shipping_addresses, Array, {:item_type => :ShippingAddressCreate}
+      define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddressCreate }
 
       # @!attribute tax_exempt
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.

data/lib/recurly/requests/account_update.rb

@@ -1,3 +1,7 @@
+# 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 AccountUpdate < Request
@@ -6,6 +10,10 @@ module Recurly
       #   @return [Address]
       define_attribute :address, :Address
 
+      # @!attribute bill_to
+      #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
+      define_attribute :bill_to, String, { :enum => ["self", "parent"] }
+
       # @!attribute billing_info
       #   @return [BillingInfoCreate]
       define_attribute :billing_info, :BillingInfoCreate
@@ -20,12 +28,16 @@ module Recurly
 
       # @!attribute custom_fields
       #   @return [Array[CustomField]]
-      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute email
       #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
       define_attribute :email, String
 
+      # @!attribute exemption_certificate
+      #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
+      define_attribute :exemption_certificate, String
+
       # @!attribute first_name
       #   @return [String]
       define_attribute :first_name, String
@@ -34,9 +46,17 @@ module Recurly
       #   @return [String]
       define_attribute :last_name, String
 
+      # @!attribute parent_account_code
+      #   @return [String] The account code of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_code, String
+
+      # @!attribute parent_account_id
+      #   @return [String] The UUID of the parent account to be associated with this account. Passing an empty value removes any existing parent association from this account. If both `parent_account_code` and `parent_account_id` are passed, the non-blank value in `parent_account_id` will be used. Only one level of parent child relationship is allowed. You cannot assign a parent account that itself has a parent account.
+      define_attribute :parent_account_id, String
+
       # @!attribute preferred_locale
       #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
-      define_attribute :preferred_locale, String, {:enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"]}
+      define_attribute :preferred_locale, String, { :enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"] }
 
       # @!attribute tax_exempt
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.

data/lib/recurly/requests/add_on_create.rb

@@ -1,3 +1,7 @@
+# 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 AddOnCreate < Request
@@ -11,8 +15,8 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[Hash]] Add-on pricing
-      define_attribute :currencies, Array, {:item_type => Hash}
+      #   @return [Array[AddOnPricing]] Add-on pricing
+      define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity
       #   @return [Integer] Default quantity for the hosted pages.
@@ -28,7 +32,7 @@ module Recurly
 
       # @!attribute [r] plan_id
       #   @return [String] Plan ID
-      define_attribute :plan_id, String, {:read_only => true}
+      define_attribute :plan_id, String, { :read_only => true }
 
       # @!attribute tax_code
       #   @return [String] Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.

data/lib/recurly/requests/add_on_pricing.rb

@@ -0,0 +1,18 @@
+# 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 AddOnPricing < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit price
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/add_on_update.rb

@@ -1,3 +1,7 @@
+# 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 AddOnUpdate < Request
@@ -11,8 +15,8 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[Hash]] Add-on pricing
-      define_attribute :currencies, Array, {:item_type => Hash}
+      #   @return [Array[AddOnPricing]] Add-on pricing
+      define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity
       #   @return [Integer] Default quantity for the hosted pages.
@@ -24,7 +28,7 @@ module Recurly
 
       # @!attribute [r] id
       #   @return [String] Add-on ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute name
       #   @return [String] Describes your add-on and will appear in subscribers' invoices.

data/lib/recurly/requests/address.rb

@@ -1,3 +1,7 @@
+# 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 Address < Request

data/lib/recurly/requests/billing_info_create.rb

@@ -1,3 +1,7 @@
+# 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 BillingInfoCreate < Request

data/lib/recurly/requests/coupon_bulk_create.rb

@@ -1,3 +1,7 @@
+# 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 CouponBulkCreate < Request

data/lib/recurly/requests/coupon_create.rb

@@ -1,3 +1,7 @@
+# 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 CouponCreate < Request
@@ -16,11 +20,11 @@ module Recurly
 
       # @!attribute coupon_type
       #   @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
-      define_attribute :coupon_type, String, {:enum => ["single_code", "bulk"]}
+      define_attribute :coupon_type, String, { :enum => ["single_code", "bulk"] }
 
       # @!attribute currencies
-      #   @return [Array[Hash]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
-      define_attribute :currencies, Array, {:item_type => Hash}
+      #   @return [Array[CouponPricing]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
+      define_attribute :currencies, Array, { :item_type => :CouponPricing }
 
       # @!attribute discount_percent
       #   @return [Integer] The percent of the price discounted by the coupon.  Required if `discount_type` is `percent`.
@@ -28,11 +32,11 @@ module Recurly
 
       # @!attribute discount_type
       #   @return [String] The type of discount provided by the coupon (how the amount discounted is calculated)
-      define_attribute :discount_type, String, {:enum => ["percent", "fixed", "free_trial"]}
+      define_attribute :discount_type, String, { :enum => ["percent", "fixed", "free_trial"] }
 
       # @!attribute duration
       #   @return [String] This field does not apply when the discount_type is `free_trial`. - "single_use" coupons applies to the first invoice only. - "temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes. - "forever" coupons will apply to invoices forever.
-      define_attribute :duration, String, {:enum => ["forever", "single_use", "temporal"]}
+      define_attribute :duration, String, { :enum => ["forever", "single_use", "temporal"] }
 
       # @!attribute free_trial_amount
       #   @return [Integer] Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
@@ -40,7 +44,7 @@ module Recurly
 
       # @!attribute free_trial_unit
       #   @return [String] Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.  Required if `discount_type` is `free_trial`.
-      define_attribute :free_trial_unit, String, {:enum => ["day", "week", "month"]}
+      define_attribute :free_trial_unit, String, { :enum => ["day", "week", "month"] }
 
       # @!attribute hosted_description
       #   @return [String] This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
@@ -64,7 +68,7 @@ module Recurly
 
       # @!attribute plan_codes
       #   @return [Array[String]] List of plan codes to which this coupon applies. See `applies_to_all_plans`
-      define_attribute :plan_codes, Array, {:item_type => String}
+      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.
@@ -72,7 +76,7 @@ module Recurly
 
       # @!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, {:enum => ["account", "subscription"]}
+      define_attribute :redemption_resource, String, { :enum => ["account", "subscription"] }
 
       # @!attribute temporal_amount
       #   @return [Integer] If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
@@ -80,7 +84,7 @@ module Recurly
 
       # @!attribute temporal_unit
       #   @return [String] If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
-      define_attribute :temporal_unit, String, {:enum => ["day", "week", "month", "year"]}
+      define_attribute :temporal_unit, String, { :enum => ["day", "week", "month", "year"] }
 
       # @!attribute unique_code_template
       #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated. - You must start the template with your coupon_code wrapped in single quotes. - Outside of single quotes, use a 9 for a character that you want to be a random number. - Outside of single quotes, use an "x" for a character that you want to be a random letter. - Outside of single quotes, use an * for a character that you want to be a random number or letter. - Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +. For example: "'abc-'****'-def'"

data/lib/recurly/requests/coupon_pricing.rb

@@ -0,0 +1,18 @@
+# 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 CouponPricing < Request
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute discount
+      #   @return [Float] The fixed discount (in dollars) for the corresponding currency.
+      define_attribute :discount, Float
+    end
+  end
+end

data/lib/recurly/requests/coupon_redemption_create.rb

@@ -1,3 +1,7 @@
+# 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 CouponRedemptionCreate < Request

data/lib/recurly/requests/coupon_update.rb

@@ -1,3 +1,7 @@
+# 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 CouponUpdate < Request

data/lib/recurly/requests/external_refund.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 Requests
+    class ExternalRefund < Request
+
+      # @!attribute description
+      #   @return [String] Used as the refund transactions' description.
+      define_attribute :description, String
+
+      # @!attribute payment_method
+      #   @return [String] Payment method used for external refund transaction.
+      define_attribute :payment_method, String, { :enum => ["credit_card", "paypal", "amazon", "roku", "ach", "apple_pay", "sepadirectdebit", "eft", "wire_transfer", "money_order", "check", "other"] }
+
+      # @!attribute refunded_at
+      #   @return [DateTime] Date the external refund payment was made. Defaults to the current date-time.
+      define_attribute :refunded_at, DateTime
+    end
+  end
+end

data/lib/recurly/requests/invoice_address.rb

@@ -0,0 +1,54 @@
+# 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 InvoiceAddress < Request
+
+      # @!attribute city
+      #   @return [String] City
+      define_attribute :city, String
+
+      # @!attribute company
+      #   @return [String] Company
+      define_attribute :company, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO code.
+      define_attribute :country, String
+
+      # @!attribute first_name
+      #   @return [String] First name
+      define_attribute :first_name, String
+
+      # @!attribute last_name
+      #   @return [String] Last name
+      define_attribute :last_name, String
+
+      # @!attribute name_on_account
+      #   @return [String] Name on account
+      define_attribute :name_on_account, String
+
+      # @!attribute phone
+      #   @return [String] Phone number
+      define_attribute :phone, String
+
+      # @!attribute postal_code
+      #   @return [String] Zip or postal code.
+      define_attribute :postal_code, String
+
+      # @!attribute region
+      #   @return [String] State or province.
+      define_attribute :region, String
+
+      # @!attribute street1
+      #   @return [String] Street 1
+      define_attribute :street1, String
+
+      # @!attribute street2
+      #   @return [String] Street 2
+      define_attribute :street2, String
+    end
+  end
+end