recurly 3.0.0 → 3.1.0

data/lib/recurly/http.rb

@@ -3,7 +3,8 @@ module Recurly
     class Response
       attr_accessor :status, :body, :request,
         :request_id, :rate_limit, :rate_limit_remaining,
-        :rate_limit_reset, :date, :proxy_metadata
+        :rate_limit_reset, :date, :proxy_metadata,
+        :content_type
 
       def initialize(resp, request)
         @request = request
@@ -12,6 +13,7 @@ module Recurly
         @rate_limit = resp.headers["x-ratelimit-limit"].to_i
         @rate_limit_remaining = resp.headers["x-ratelimit-remaining"].to_i
         @rate_limit_reset = Time.at(resp.headers["x-ratelimit-reset"].to_i).to_datetime
+        @content_type = resp.headers["content-type"].split(";").first if resp.headers["content-type"]
         if resp.body && !resp.body.empty?
           @body = resp.body
         else

data/lib/recurly/requests/account_create.rb

@@ -74,6 +74,10 @@ module Recurly
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
       define_attribute :tax_exempt, :Boolean
 
+      # @!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
+
       # @!attribute username
       #   @return [String] A secondary value for the account.
       define_attribute :username, String

data/lib/recurly/requests/account_purchase.rb

@@ -74,6 +74,10 @@ module Recurly
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
       define_attribute :tax_exempt, :Boolean
 
+      # @!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
+
       # @!attribute username
       #   @return [String] A secondary value for the account.
       define_attribute :username, String

data/lib/recurly/requests/account_update.rb

@@ -62,6 +62,10 @@ module Recurly
       #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
       define_attribute :tax_exempt, :Boolean
 
+      # @!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
+
       # @!attribute username
       #   @return [String] A secondary value for the account.
       define_attribute :username, String

data/lib/recurly/requests/billing_info_create.rb

@@ -50,10 +50,18 @@ module Recurly
       #   @return [String] PayPal billing agreement ID
       define_attribute :paypal_billing_agreement_id, String
 
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, String
+
       # @!attribute token_id
       #   @return [String] A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token).
       define_attribute :token_id, 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
+
       # @!attribute vat_number
       #   @return [String] VAT number
       define_attribute :vat_number, String

data/lib/recurly/requests/invoice_collect.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 InvoiceCollect < Request
+
+      # @!attribute three_d_secure_action_result_token_id
+      #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
+      define_attribute :three_d_secure_action_result_token_id, 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
+    end
+  end
+end

data/lib/recurly/requests/item_create.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 Requests
+    class ItemCreate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the item.
+      define_attribute :code, String
+
+      # @!attribute currencies
+      #   @return [Array[Pricing]] Item Pricing
+      define_attribute :currencies, Array, { :item_type => :Pricing }
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute description
+      #   @return [String] Optional, description.
+      define_attribute :description, String
+
+      # @!attribute external_sku
+      #   @return [String] Optional, stock keeping unit to link the item to other inventory systems.
+      define_attribute :external_sku, String
+
+      # @!attribute name
+      #   @return [String] This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+      define_attribute :name, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the item, `false` applies tax on the item.
+      define_attribute :tax_exempt, :Boolean
+    end
+  end
+end

data/lib/recurly/requests/item_update.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 Requests
+    class ItemUpdate < Request
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the item.
+      define_attribute :code, String
+
+      # @!attribute currencies
+      #   @return [Array[Pricing]] Item Pricing
+      define_attribute :currencies, Array, { :item_type => :Pricing }
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute description
+      #   @return [String] Optional, description.
+      define_attribute :description, String
+
+      # @!attribute external_sku
+      #   @return [String] Optional, stock keeping unit to link the item to other inventory systems.
+      define_attribute :external_sku, String
+
+      # @!attribute name
+      #   @return [String] This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+      define_attribute :name, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the item, `false` applies tax on the item.
+      define_attribute :tax_exempt, :Boolean
+    end
+  end
+end

data/lib/recurly/requests/line_item_create.rb

@@ -6,30 +6,46 @@ module Recurly
   module Requests
     class LineItemCreate < Request
 
+      # @!attribute accounting_code
+      #   @return [String] Accounting Code for the `LineItem`. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
+      define_attribute :accounting_code, String
+
       # @!attribute credit_reason_code
       #   @return [String] The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.
       define_attribute :credit_reason_code, String
 
       # @!attribute currency
-      #   @return [String] 3-letter ISO 4217 currency code.
+      #   @return [String] 3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.
       define_attribute :currency, String
 
       # @!attribute description
-      #   @return [String] Description that appears on the invoice.
+      #   @return [String] Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.
       define_attribute :description, String
 
       # @!attribute end_date
       #   @return [DateTime] If this date is provided, it indicates the end of a time range.
       define_attribute :end_date, DateTime
 
+      # @!attribute item_code
+      #   @return [String] Unique code to identify an item, when the Catalog feature is enabled.
+      define_attribute :item_code, String
+
+      # @!attribute item_id
+      #   @return [String] Available when the Catalog feature is enabled.
+      define_attribute :item_id, String
+
       # @!attribute product_code
-      #   @return [String] Optional field to track a product code or SKU for the line item. This can be used to later reporting on product purchases. For Vertex tax calculations, this field will be used as the Vertex `product` field.
+      #   @return [String] Optional field to track a product code or SKU for the line item. This can be used to later reporting on product purchases. For Vertex tax calculations, this field will be used as the Vertex `product` field. If `item_code`/`item_id` is part of the request then `product_code` must be absent.
       define_attribute :product_code, String
 
       # @!attribute quantity
       #   @return [Integer] This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.
       define_attribute :quantity, Integer
 
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
       # @!attribute start_date
       #   @return [DateTime] If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date. Defaults to the current date-time.
       define_attribute :start_date, DateTime
@@ -43,11 +59,11 @@ module Recurly
       define_attribute :tax_exempt, :Boolean
 
       # @!attribute type
-      #   @return [String] Line item type.
+      #   @return [String] Line item type. If `item_code`/`item_id` is present then `type` should not be present. If `item_code`/`item_id` is not present then `type` is required.
       define_attribute :type, String
 
       # @!attribute unit_amount
-      #   @return [Float] A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`.
+      #   @return [Float] A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`. If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/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 Pricing < 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/purchase_create.rb

@@ -62,6 +62,10 @@ module Recurly
       #   @return [String] Terms and conditions to be put on the purchase invoice.
       define_attribute :terms_and_conditions, 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
+
       # @!attribute vat_reverse_charge_notes
       #   @return [String] VAT reverse charge notes for cross border European tax settlement.
       define_attribute :vat_reverse_charge_notes, String

data/lib/recurly/requests/subscription_cancel.rb

@@ -0,0 +1,14 @@
+# 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 SubscriptionCancel < Request
+
+      # @!attribute timeframe
+      #   @return [String] The timeframe parameter controls when the expiration takes place. The `bill_date` timeframe causes the subscription to expire when the subscription is scheduled to bill next. The `term_end` timeframe causes the subscription to continue to bill until the end of the subscription term, then expire.
+      define_attribute :timeframe, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_change_create.rb

@@ -43,9 +43,13 @@ module Recurly
       define_attribute :shipping, :SubscriptionChangeShippingCreate
 
       # @!attribute timeframe
-      #   @return [String] The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now, when the subscription is next billed, or when the subscription renews. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to "renewal" so the change takes affect at the end of the current subscription term.
+      #   @return [String] The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now, when the subscription is next billed, or when the subscription term ends. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to `term_end` or `bill_date` so the change takes effect at a scheduled billing date. The `renewal` timeframe option is accepted as an alias for `term_end`.
       define_attribute :timeframe, 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
+
       # @!attribute unit_amount
       #   @return [Float] Optionally, sets custom pricing for the subscription, overriding the plan's default unit amount. The subscription's current currency will be used.
       define_attribute :unit_amount, Float

data/lib/recurly/requests/subscription_create.rb

@@ -86,6 +86,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_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
+
       # @!attribute trial_ends_at
       #   @return [DateTime] If set, overrides the default trial behavior for the subscription. The date must be in the future.
       define_attribute :trial_ends_at, DateTime

data/lib/recurly/requests/subscription_update.rb

@@ -27,7 +27,7 @@ module Recurly
       define_attribute :net_terms, Integer
 
       # @!attribute next_bill_date
-      #   @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires.
+      #   @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.
       define_attribute :next_bill_date, DateTime
 
       # @!attribute po_number

data/lib/recurly/resources/binary_file.rb

@@ -0,0 +1,14 @@
+# 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 BinaryFile < Resource
+
+      # @!attribute data
+      #   @return [String]
+      define_attribute :data, String
+    end
+  end
+end

data/lib/recurly/resources/item.rb

@@ -0,0 +1,74 @@
+# 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 Item < Resource
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @return [String] Unique code to identify the item.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currencies
+      #   @return [Array[Pricing]] Item Pricing
+      define_attribute :currencies, Array, { :item_type => :Pricing }
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Optional, description.
+      define_attribute :description, String
+
+      # @!attribute external_sku
+      #   @return [String] Optional, stock keeping unit to link the item to other inventory systems.
+      define_attribute :external_sku, String
+
+      # @!attribute id
+      #   @return [String] Item ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] This name describes your item and will appear on the invoice when it's purchased on a one time basis.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute state
+      #   @return [String] The current state of the item.
+      define_attribute :state, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the item, `false` applies tax on the item.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/line_item.rb

@@ -66,6 +66,14 @@ module Recurly
       #   @return [String] Once the line item has been invoiced this will be the invoice's number. If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.
       define_attribute :invoice_number, String
 
+      # @!attribute item_code
+      #   @return [String] Unique code to identify an item, when the Catalog feature is enabled.
+      define_attribute :item_code, String
+
+      # @!attribute item_id
+      #   @return [String] Available when the Catalog feature is enabled.
+      define_attribute :item_id, String
+
       # @!attribute legacy_category
       #   @return [String] Category to describe the role of a line item on a legacy invoice: - "charges" refers to charges being billed for on this invoice. - "credits" refers to refund or proration credits. This portion of the invoice can be considered a credit memo. - "applied_credits" refers to previous credits applied to this invoice. See their original_line_item_id to determine where the credit first originated. - "carryforwards" can be ignored. They exist to consume any remaining credit balance. A new credit with the same amount will be created and placed back on the account.
       define_attribute :legacy_category, String
@@ -95,7 +103,7 @@ module Recurly
       define_attribute :previous_line_item_id, String
 
       # @!attribute product_code
-      #   @return [String] For plan related line items this will be the plan's code, for add-on related line items it will be the add-on's code.
+      #   @return [String] For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line itmes it will be the item's `external_sku`.
       define_attribute :product_code, String
 
       # @!attribute proration_rate
@@ -114,6 +122,10 @@ module Recurly
       #   @return [Integer] For refund charges, the quantity being refunded. For non-refund charges, the total quantity refunded (possibly over multiple refunds).
       define_attribute :refunded_quantity, Integer
 
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
       # @!attribute shipping_address
       #   @return [ShippingAddress]
       define_attribute :shipping_address, :ShippingAddress