recurly 3.0.0.beta.5 → 3.0.0

data/lib/recurly/errors.rb

@@ -26,6 +26,10 @@ module Recurly
       def status_code
         @response.status
       end
+
+      def get_response
+        @response
+      end
     end
   end
 

data/lib/recurly/http.rb

@@ -0,0 +1,43 @@
+module Recurly
+  module HTTP
+    class Response
+      attr_accessor :status, :body, :request,
+        :request_id, :rate_limit, :rate_limit_remaining,
+        :rate_limit_reset, :date, :proxy_metadata
+
+      def initialize(resp, request)
+        @request = request
+        @status = resp.status
+        @request_id = resp.headers["x-request-id"]
+        @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
+        if resp.body && !resp.body.empty?
+          @body = resp.body
+        else
+          @body = nil
+        end
+      end
+    end
+
+    class Request
+      attr_accessor :method, :path, :body
+
+      def initialize(method, path, body = nil)
+        @method = method
+        @path = path
+        if body && !body.empty?
+          @body = body
+        else
+          @body = nil
+        end
+      end
+
+      def ==(other)
+        method == other.method \
+          && path == other.path \
+          && body == other.body
+      end
+    end
+  end
+end

data/lib/recurly/pager.rb

@@ -71,14 +71,6 @@ module Recurly
 
     private
 
-    def from_json(data)
-      @data = data["data"].map do |resource_data|
-        JSONParser.from_json(resource_data)
-      end
-      @next = data["next"]
-      @has_more = data["has_more"]
-    end
-
     def item_enumerator
       Enumerator.new do |yielder|
         page_enumerator.each do |data|
@@ -103,8 +95,10 @@ module Recurly
     end
 
     def fetch_next!
-      response = @client.next_page(self)
-      from_json(JSON.parse(response.body))
+      page = @client.next_page(self)
+      @data = page.data.map { |d| JSONParser.from_json(d) }
+      @has_more = page.has_more
+      @next = page.next
     end
 
     def rewind!

data/lib/recurly/request.rb

@@ -5,7 +5,7 @@ module Recurly
   class Request
     extend Schema::SchemaFactory
     extend Schema::RequestCaster
-    extend Schema::JsonDeserializer
+    extend Schema::ResourceCaster
     include Schema::SchemaValidator
 
     attr_reader :attributes
@@ -14,14 +14,14 @@ module Recurly
       self.attributes == other_resource.attributes
     end
 
+    def to_s
+      self.inspect
+    end
+
     protected
 
     def initialize(attributes = {})
-      @attributes = self.class.cast(attributes.clone)
-    end
-
-    def to_s
-      self.inspect
+      @attributes = self.class.cast_request(attributes)
     end
 
     def schema

data/lib/recurly/requests.rb

@@ -0,0 +1,8 @@
+# Include all request files
+resources = File.join(File.dirname(__FILE__), "requests", "*.rb")
+Dir.glob(resources, &method(:require))
+
+module Recurly
+  module Requests
+  end
+end

data/lib/recurly/requests/account_acquisition_updatable.rb

@@ -15,8 +15,8 @@ module Recurly
       define_attribute :channel, String
 
       # @!attribute cost
-      #   @return [Hash] Account balance
-      define_attribute :cost, Hash
+      #   @return [AccountAcquisitionCost]
+      define_attribute :cost, :AccountAcquisitionCost
 
       # @!attribute subchannel
       #   @return [String] An arbitrary subchannel string representing a distinction/subcategory within a broader channel.

data/lib/recurly/requests/billing_info_create.rb

@@ -26,6 +26,10 @@ module Recurly
       #   @return [String] First name
       define_attribute :first_name, String
 
+      # @!attribute fraud_session_id
+      #   @return [String] Fraud Session ID
+      define_attribute :fraud_session_id, String
+
       # @!attribute ip_address
       #   @return [String] *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
       define_attribute :ip_address, String

data/lib/recurly/requests/custom_field.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 CustomField < Request
+
+      # @!attribute name
+      #   @return [String] Fields must be created in the UI before values can be assigned to them.
+      define_attribute :name, String
+
+      # @!attribute value
+      #   @return [String] Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
+      define_attribute :value, String
+    end
+  end
+end

data/lib/recurly/requests/invoice_create.rb

@@ -34,10 +34,6 @@ module Recurly
       #   @return [String] This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
       define_attribute :terms_and_conditions, String
 
-      # @!attribute type
-      #   @return [String] Specify a type to limit the type of line items that will be invoiced.
-      define_attribute :type, String
-
       # @!attribute vat_reverse_charge_notes
       #   @return [String] VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.
       define_attribute :vat_reverse_charge_notes, String

data/lib/recurly/requests/invoice_refund.rb

@@ -15,8 +15,8 @@ module Recurly
       define_attribute :credit_customer_notes, String
 
       # @!attribute external_refund
-      #   @return [Hash] Indicates that the refund was settled outside of Recurly, and a manual transaction should be created to track it in Recurly.  Required when: - refunding a manually collected charge invoice, and `refund_method` is not `all_credit` - refunding a credit invoice that refunded manually collecting invoices - refunding a credit invoice for a partial amount  This field can only be included when the Credit Invoices feature is enabled.
-      define_attribute :external_refund, Hash
+      #   @return [ExternalRefund] Indicates that the refund was settled outside of Recurly, and a manual transaction should be created to track it in Recurly.  Required when: - refunding a manually collected charge invoice, and `refund_method` is not `all_credit` - refunding a credit invoice that refunded manually collecting invoices - refunding a credit invoice for a partial amount  This field can only be included when the Credit Invoices feature is enabled.
+      define_attribute :external_refund, :ExternalRefund
 
       # @!attribute line_items
       #   @return [Array[LineItemRefund]] The line items to be refunded. This is required when `type=line_items`.

data/lib/recurly/requests/line_item_create.rb

@@ -22,6 +22,10 @@ module Recurly
       #   @return [DateTime] If this date is provided, it indicates the end of a time range.
       define_attribute :end_date, DateTime
 
+      # @!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.
+      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

data/lib/recurly/requests/purchase_create.rb

@@ -50,13 +50,9 @@ module Recurly
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
 
-      # @!attribute shipping_address
-      #   @return [ShippingAddressCreate]
-      define_attribute :shipping_address, :ShippingAddressCreate
-
-      # @!attribute shipping_address_id
-      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `shipping_address` are both present, `shipping_address` will take precedence.
-      define_attribute :shipping_address_id, String
+      # @!attribute shipping
+      #   @return [ShippingPurchase]
+      define_attribute :shipping, :ShippingPurchase
 
       # @!attribute subscriptions
       #   @return [Array[SubscriptionPurchase]] A list of subscriptions to be created with the purchase.

data/lib/recurly/requests/shipping_fee_create.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 ShippingFeeCreate < Request
+
+      # @!attribute amount
+      #   @return [Float] This is priced in the purchase's currency.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [String] The code of the shipping method used to deliver the purchase. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [String] The id of the shipping method used to deliver the purchase. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/shipping_purchase.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 ShippingPurchase < Request
+
+      # @!attribute address
+      #   @return [ShippingAddressCreate]
+      define_attribute :address, :ShippingAddressCreate
+
+      # @!attribute address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `shipping_address` are both present, `shipping_address` will take precedence.
+      define_attribute :address_id, String
+
+      # @!attribute fees
+      #   @return [Array[ShippingFeeCreate]] A list of shipping fees to be created as charges with the purchase.
+      define_attribute :fees, Array, { :item_type => :ShippingFeeCreate }
+    end
+  end
+end

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -10,16 +10,12 @@ module Recurly
       #   @return [String] Add-on code
       define_attribute :code, String
 
-      # @!attribute id
-      #   @return [String] Setting this field allows you to reference an existing add-on.
-      define_attribute :id, String
-
       # @!attribute quantity
-      #   @return [Integer] Optionally override the default quantity.
+      #   @return [Integer] Quantity
       define_attribute :quantity, Integer
 
       # @!attribute unit_amount
-      #   @return [Float] Override the default unit amount of the add-on by setting this value.
+      #   @return [Float] Optionally, override the add-on's default unit amount.
       define_attribute :unit_amount, Float
     end
   end

data/lib/recurly/requests/subscription_add_on_update.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 Requests
+    class SubscriptionAddOnUpdate < Request
+
+      # @!attribute code
+      #   @return [String] Add-on code
+      define_attribute :code, String
+
+      # @!attribute id
+      #   @return [String] Set this to include or modify an existing subscription add-on.
+      define_attribute :id, String
+
+      # @!attribute quantity
+      #   @return [Integer] Quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute unit_amount
+      #   @return [Float] Optionally, override the add-on's default unit amount.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_change_create.rb

@@ -7,8 +7,8 @@ module Recurly
     class SubscriptionChangeCreate < Request
 
       # @!attribute add_ons
-      #   @return [Array[SubscriptionAddOnCreate]] If you set this value you include all the add-ons and their quantities and amounts. The values you include will replace the previous values entirely.
-      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnCreate }
+      #   @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"}`.
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
 
       # @!attribute collection_method
       #   @return [String] Collection method
@@ -38,8 +38,12 @@ module Recurly
       #   @return [Integer] Optionally override the default quantity of 1.
       define_attribute :quantity, Integer
 
+      # @!attribute shipping
+      #   @return [SubscriptionChangeShippingCreate]
+      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 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 billing cycle.
+      #   @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.
       define_attribute :timeframe, String
 
       # @!attribute unit_amount

data/lib/recurly/requests/subscription_change_shipping_create.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 SubscriptionChangeShippingCreate < Request
+
+      # @!attribute amount
+      #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [String] The code of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [String] The id of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_create.rb

@@ -70,13 +70,9 @@ module Recurly
       #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
       define_attribute :renewal_billing_cycles, Integer
 
-      # @!attribute shipping_address
-      #   @return [ShippingAddressCreate] Create a shipping address on the account and assign it to the subscription.
-      define_attribute :shipping_address, :ShippingAddressCreate
-
-      # @!attribute shipping_address_id
-      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If this and `shipping_address` are both present, `shipping_address` will take precedence.
-      define_attribute :shipping_address_id, String
+      # @!attribute shipping
+      #   @return [SubscriptionShippingCreate] Create a shipping address on the account and assign it to the subscription.
+      define_attribute :shipping, :SubscriptionShippingCreate
 
       # @!attribute starts_at
       #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
@@ -95,7 +91,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/subscription_shipping_create.rb

@@ -0,0 +1,30 @@
+# 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 SubscriptionShippingCreate < Request
+
+      # @!attribute address
+      #   @return [ShippingAddressCreate]
+      define_attribute :address, :ShippingAddressCreate
+
+      # @!attribute address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If `address_id` and `address` are both present, `address` will be used.
+      define_attribute :address_id, String
+
+      # @!attribute amount
+      #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [String] The code of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [String] The id of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_shipping_update.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 SubscriptionShippingUpdate < Request
+
+      # @!attribute address
+      #   @return [ShippingAddressCreate]
+      define_attribute :address, :ShippingAddressCreate
+
+      # @!attribute address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses.
+      define_attribute :address_id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_update.rb

@@ -42,13 +42,9 @@ module Recurly
       #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
       define_attribute :renewal_billing_cycles, Integer
 
-      # @!attribute shipping_address
-      #   @return [ShippingAddressCreate] Create a shipping address on the account and assign it to the subscription. If this and `shipping_address_id` are both present, `shipping_address_id` will take precedence.
-      define_attribute :shipping_address, :ShippingAddressCreate
-
-      # @!attribute shipping_address_id
-      #   @return [String] Assign a shipping address from the account's existing shipping addresses.
-      define_attribute :shipping_address_id, String
+      # @!attribute shipping
+      #   @return [SubscriptionShippingUpdate]
+      define_attribute :shipping, :SubscriptionShippingUpdate
 
       # @!attribute terms_and_conditions
       #   @return [String] Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.