recurly 3.17.0 → 4.1.0

data/lib/recurly/requests/subscription_change_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class SubscriptionChangeCreate < Request
 
       # @!attribute add_ons
-      #   @return [Array[SubscriptionAddOnUpdate]] If this value is omitted your existing add-ons will be removed. If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on's ID: `{"id": "abc123"}`.  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.  - If an `id` is passed, any attributes not passed in will pull from the   existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the   current values of the plan add-on - Attributes passed in as part of the request will override either of the   above scenarios
+      #   @return [Array[SubscriptionAddOnUpdate]] If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `{"id": "abc123"}`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.'  If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request.  - If an `id` is passed, any attributes not passed in will pull from the   existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the   current values of the plan add-on - Attributes passed in as part of the request will override either of the   above scenarios
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
 
       # @!attribute collection_method

data/lib/recurly/requests/subscription_create.rb

@@ -26,9 +26,9 @@ module Recurly
       #   @return [String] Collection method
       define_attribute :collection_method, String
 
-      # @!attribute coupon_code
-      #   @return [String] Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.
-      define_attribute :coupon_code, String
+      # @!attribute coupon_codes
+      #   @return [Array[String]] A list of coupon_codes to be redeemed on the subscription or account during the purchase.
+      define_attribute :coupon_codes, Array, { :item_type => String }
 
       # @!attribute credit_customer_notes
       #   @return [String] If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.

data/lib/recurly/requests/subscription_purchase.rb

@@ -59,7 +59,7 @@ module Recurly
       define_attribute :trial_ends_at, DateTime
 
       # @!attribute unit_amount
-      #   @return [Float] Override the unit amount of the subscription plan by setting this value in cents. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+      #   @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/tier.rb

@@ -7,12 +7,16 @@ module Recurly
     class Tier < Request
 
       # @!attribute currencies
-      #   @return [Array[Pricing]] Tier pricing
-      define_attribute :currencies, Array, { :item_type => :Pricing }
+      #   @return [Array[TierPricing]] Tier pricing
+      define_attribute :currencies, Array, { :item_type => :TierPricing }
 
       # @!attribute ending_quantity
-      #   @return [Integer] Ending quantity
+      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons, but for percentage type usage add ons, represents the site default currency in its minimum divisible unit.
       define_attribute :ending_quantity, Integer
+
+      # @!attribute usage_percentage
+      #   @return [String] Decimal usage percentage.
+      define_attribute :usage_percentage, String
     end
   end
 end

data/lib/recurly/requests/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 Requests
+    class TierPricing < Request
+
+      # @!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/add_on.rb

@@ -91,7 +91,7 @@ module Recurly
       define_attribute :tax_code, String
 
       # @!attribute tier_type
-      #   @return [String] The type of tiering used by the Add-on.
+      #   @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

data/lib/recurly/resources/add_on_pricing.rb

@@ -11,8 +11,12 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute unit_amount
-      #   @return [Float] Unit price
+      #   @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/address.rb

@@ -14,14 +14,6 @@ module Recurly
       #   @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 phone
       #   @return [String] Phone number
       define_attribute :phone, String

data/lib/recurly/resources/address_with_name.rb

@@ -0,0 +1,46 @@
+# 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 AddressWithName < Resource
+
+      # @!attribute city
+      #   @return [String] City
+      define_attribute :city, 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 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

data/lib/recurly/resources/billing_info.rb

@@ -14,6 +14,10 @@ module Recurly
       #   @return [Address]
       define_attribute :address, :Address
 
+      # @!attribute backup_payment_method
+      #   @return [Boolean] The `backup_payment_method` indicator is used to designate a billing info as a backup on the account that will be tried if the billing info marked `primary_payment_method` fails.
+      define_attribute :backup_payment_method, :Boolean
+
       # @!attribute company
       #   @return [String]
       define_attribute :company, String

data/lib/recurly/resources/coupon.rb

@@ -11,21 +11,13 @@ module Recurly
       define_attribute :applies_to_all_items, :Boolean
 
       # @!attribute applies_to_all_plans
-      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
+      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` will list the applicable plans.
       define_attribute :applies_to_all_plans, :Boolean
 
       # @!attribute applies_to_non_plan_charges
       #   @return [Boolean] The coupon is valid for one-time, non-plan charges if true.
       define_attribute :applies_to_non_plan_charges, :Boolean
 
-      # @!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
@@ -94,18 +86,10 @@ module Recurly
       #   @return [Array[PlanMini]] A list of plans for which this coupon applies. This will be `null` if `applies_to_all_plans=true`.
       define_attribute :plans, Array, { :item_type => :PlanMini }
 
-      # @!attribute plans_names
-      #   @return [Array[String]] A list of plan names for which this coupon applies.
-      define_attribute :plans_names, Array, { :item_type => String }
-
       # @!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.
       define_attribute :redeem_by, DateTime
 
-      # @!attribute redeemed_at
-      #   @return [DateTime] The date and time the unique coupon code was redeemed. This is only present for bulk coupons.
-      define_attribute :redeemed_at, DateTime
-
       # @!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
@@ -126,6 +110,10 @@ module Recurly
       #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated.
       define_attribute :unique_code_template, String
 
+      # @!attribute unique_coupon_code
+      #   @return [Hash] Will be populated when the Coupon being returned is a `UniqueCouponCode`.
+      define_attribute :unique_coupon_code, Hash
+
       # @!attribute unique_coupon_codes_count
       #   @return [Integer] When this number reaches `max_redemptions` the coupon will no longer be redeemable.
       define_attribute :unique_coupon_codes_count, Integer

data/lib/recurly/resources/coupon_redemption.rb

@@ -42,6 +42,10 @@ module Recurly
       #   @return [String] Coupon Redemption state
       define_attribute :state, String
 
+      # @!attribute subscription_id
+      #   @return [String] Subscription ID
+      define_attribute :subscription_id, String
+
       # @!attribute updated_at
       #   @return [DateTime] Last updated at
       define_attribute :updated_at, DateTime

data/lib/recurly/resources/invoice.rb

@@ -54,13 +54,17 @@ module Recurly
       #   @return [DateTime] Date invoice is due. This is the date the net terms are reached.
       define_attribute :due_at, DateTime
 
+      # @!attribute has_more_line_items
+      #   @return [Boolean] Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
+      define_attribute :has_more_line_items, :Boolean
+
       # @!attribute id
       #   @return [String] Invoice ID
       define_attribute :id, String
 
       # @!attribute line_items
-      #   @return [LineItemList]
-      define_attribute :line_items, :LineItemList
+      #   @return [Array[LineItem]] Line Items
+      define_attribute :line_items, Array, { :item_type => :LineItem }
 
       # @!attribute net_terms
       #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.

data/lib/recurly/resources/line_item.rb

@@ -186,6 +186,10 @@ module Recurly
       #   @return [Float] Positive amount for a charge, negative amount for a credit.
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Positive amount for a charge, negative amount for a credit.
+      define_attribute :unit_amount_decimal, String
+
       # @!attribute updated_at
       #   @return [DateTime] When the line item was last changed.
       define_attribute :updated_at, DateTime

data/lib/recurly/resources/plan.rb

@@ -103,7 +103,7 @@ module Recurly
       define_attribute :trial_length, Integer
 
       # @!attribute trial_requires_billing_info
-      #   @return [Boolean] Allow free trial subscriptions to be created without billing info.
+      #   @return [Boolean] Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.
       define_attribute :trial_requires_billing_info, :Boolean
 
       # @!attribute trial_unit

data/lib/recurly/resources/subscription_add_on.rb

@@ -43,7 +43,7 @@ module Recurly
       define_attribute :subscription_id, String
 
       # @!attribute tier_type
-      #   @return [String] The type of tiering used by the Add-on.
+      #   @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
@@ -51,9 +51,13 @@ module Recurly
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
-      #   @return [Float] This is priced in the subscription's currency.
+      #   @return [Float] Supports up to 2 decimal places.
       define_attribute :unit_amount, Float
 
+      # @!attribute unit_amount_decimal
+      #   @return [String] Supports up to 9 decimal places.
+      define_attribute :unit_amount_decimal, String
+
       # @!attribute updated_at
       #   @return [DateTime] Updated at
       define_attribute :updated_at, DateTime

data/lib/recurly/resources/subscription_add_on_tier.rb

@@ -11,8 +11,12 @@ module Recurly
       define_attribute :ending_quantity, Integer
 
       # @!attribute unit_amount
-      #   @return [Float] Unit amount
+      #   @return [Float] Allows up to 2 decimal places. Optionally, override the tiers' default unit amount.
       define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places.  Optionally, override tiers' default unit amount. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
     end
   end
 end

data/lib/recurly/resources/subscription_change.rb

@@ -54,10 +54,6 @@ module Recurly
       #   @return [String] Revenue schedule type
       define_attribute :revenue_schedule_type, String
 
-      # @!attribute setup_fee_revenue_schedule_type
-      #   @return [String] Setup fee revenue schedule type
-      define_attribute :setup_fee_revenue_schedule_type, String
-
       # @!attribute shipping
       #   @return [SubscriptionShipping] Subscription shipping details
       define_attribute :shipping, :SubscriptionShipping

data/lib/recurly/resources/tier.rb

@@ -7,12 +7,16 @@ module Recurly
     class Tier < Resource
 
       # @!attribute currencies
-      #   @return [Array[Pricing]] Tier pricing
-      define_attribute :currencies, Array, { :item_type => :Pricing }
+      #   @return [Array[TierPricing]] Tier pricing
+      define_attribute :currencies, Array, { :item_type => :TierPricing }
 
       # @!attribute ending_quantity
-      #   @return [Integer] Ending quantity
+      #   @return [Integer] Ending quantity for the tier.  This represents a unit amount for unit-priced add ons, but for percentage type usage add ons, represents the site default currency in its minimum divisible unit.
       define_attribute :ending_quantity, Integer
+
+      # @!attribute usage_percentage
+      #   @return [String] Decimal usage percentage.
+      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

@@ -18,9 +18,13 @@ module Recurly
       #   @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 [Address]
-      define_attribute :billing_address, :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.

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

@@ -39,7 +39,7 @@ module Recurly
       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).
+      #   @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
@@ -50,6 +50,10 @@ module Recurly
       #   @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