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

data/lib/recurly/resources/error.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 Resources
     class Error < Resource
@@ -8,11 +12,11 @@ module Recurly
 
       # @!attribute params
       #   @return [Array[Hash]] Parameter specific errors
-      define_attribute :params, Array, {:item_type => Hash}
+      define_attribute :params, Array, { :item_type => Hash }
 
       # @!attribute type
       #   @return [String] Type
-      define_attribute :type, String, {:enum => ["bad_request", "internal_server_error", "immutable_subscription", "invalid_api_key", "invalid_api_version", "invalid_content_type", "invalid_permissions", "invalid_token", "not_found", "simultaneous_request", "transaction", "unauthorized", "unavailable_in_api_version", "unknown_api_version", "validation", "missing_feature"]}
+      define_attribute :type, String, { :enum => ["bad_request", "internal_server_error", "immutable_subscription", "invalid_api_key", "invalid_api_version", "invalid_content_type", "invalid_permissions", "invalid_token", "not_found", "simultaneous_request", "transaction", "unauthorized", "unavailable_in_api_version", "unknown_api_version", "validation", "missing_feature"] }
     end
   end
 end

data/lib/recurly/resources/error_may_have_transaction.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 Resources
     class ErrorMayHaveTransaction < Resource
@@ -8,7 +12,7 @@ module Recurly
 
       # @!attribute params
       #   @return [Array[Hash]] Parameter specific errors
-      define_attribute :params, Array, {:item_type => Hash}
+      define_attribute :params, Array, { :item_type => Hash }
 
       # @!attribute transaction_error
       #   @return [Hash] This is only included on errors with `type=transaction`.
@@ -16,7 +20,7 @@ module Recurly
 
       # @!attribute type
       #   @return [String] Type
-      define_attribute :type, String, {:enum => ["bad_request", "internal_server_error", "immutable_subscription", "invalid_api_key", "invalid_api_version", "invalid_content_type", "invalid_permissions", "invalid_token", "not_found", "simultaneous_request", "transaction", "unauthorized", "unavailable_in_api_version", "unknown_api_version", "validation", "missing_feature"]}
+      define_attribute :type, String, { :enum => ["bad_request", "internal_server_error", "immutable_subscription", "invalid_api_key", "invalid_api_version", "invalid_content_type", "invalid_permissions", "invalid_token", "not_found", "simultaneous_request", "transaction", "unauthorized", "unavailable_in_api_version", "unknown_api_version", "validation", "missing_feature"] }
     end
   end
 end

data/lib/recurly/resources/fraud_info.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 FraudInfo < Resource
+
+      # @!attribute decision
+      #   @return [String] Kount decision
+      define_attribute :decision, String, { :enum => ["approve", "review", "decline", "escalate"] }
+
+      # @!attribute risk_rules_triggered
+      #   @return [Hash] Kount rules
+      define_attribute :risk_rules_triggered, Hash
+
+      # @!attribute score
+      #   @return [Integer] Kount score
+      define_attribute :score, Integer
+    end
+  end
+end

data/lib/recurly/resources/invoice.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 Resources
     class Invoice < Resource
@@ -7,8 +11,8 @@ module Recurly
       define_attribute :account, :AccountMini
 
       # @!attribute address
-      #   @return [Address]
-      define_attribute :address, :Address
+      #   @return [InvoiceAddress]
+      define_attribute :address, :InvoiceAddress
 
       # @!attribute balance
       #   @return [Float] The outstanding balance remaining on this invoice.
@@ -20,15 +24,15 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.
-      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
 
       # @!attribute [r] created_at
       #   @return [DateTime] Created at
-      define_attribute :created_at, DateTime, {:read_only => true}
+      define_attribute :created_at, DateTime, { :read_only => true }
 
       # @!attribute credit_payments
       #   @return [Array[CreditPayment]] Credit payments
-      define_attribute :credit_payments, Array, {:item_type => :CreditPayment}
+      define_attribute :credit_payments, Array, { :item_type => :CreditPayment }
 
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
@@ -48,7 +52,7 @@ module Recurly
 
       # @!attribute [r] id
       #   @return [String] Invoice ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute line_items
       #   @return [LineItemList]
@@ -64,11 +68,11 @@ module Recurly
 
       # @!attribute [r] object
       #   @return [String] Object type
-      define_attribute :object, String, {:read_only => true}
+      define_attribute :object, String, { :read_only => true }
 
       # @!attribute origin
       #   @return [String] The event that created the invoice.
-      define_attribute :origin, String, {:enum => ["purchase", "line_item_refund", "open_amount_refund", "renewal", "immediate_change", "termination", "credit", "gift_card", "write_off"]}
+      define_attribute :origin, String, { :enum => ["purchase", "line_item_refund", "open_amount_refund", "renewal", "immediate_change", "termination", "credit", "gift_card", "write_off"] }
 
       # @!attribute paid
       #   @return [Float] The total amount of successful payments transaction on this invoice.
@@ -88,11 +92,11 @@ module Recurly
 
       # @!attribute state
       #   @return [String] Invoice state
-      define_attribute :state, String, {:enum => ["pending", "processing", "past_due", "paid", "failed"]}
+      define_attribute :state, String, { :enum => ["pending", "processing", "past_due", "paid", "failed"] }
 
       # @!attribute subscription_ids
       #   @return [Array[String]] If the invoice is charging or refunding for one or more subscriptions, these are their IDs.
-      define_attribute :subscription_ids, Array, {:item_type => String}
+      define_attribute :subscription_ids, Array, { :item_type => String }
 
       # @!attribute subtotal
       #   @return [Float] The summation of charges, discounts, and credits, before tax.
@@ -116,15 +120,15 @@ module Recurly
 
       # @!attribute transactions
       #   @return [Array[Transaction]] Transactions
-      define_attribute :transactions, Array, {:item_type => :Transaction}
+      define_attribute :transactions, Array, { :item_type => :Transaction }
 
       # @!attribute type
       #   @return [String] Invoices are either charge, credit, or legacy invoices.
-      define_attribute :type, String, {:enum => ["charge", "credit", "legacy"]}
+      define_attribute :type, String, { :enum => ["charge", "credit", "legacy"] }
 
       # @!attribute [r] updated_at
       #   @return [DateTime] Last updated at
-      define_attribute :updated_at, DateTime, {:read_only => true}
+      define_attribute :updated_at, DateTime, { :read_only => true }
 
       # @!attribute vat_number
       #   @return [String] VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.

data/lib/recurly/resources/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 Resources
+    class InvoiceAddress < Resource
+
+      # @!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

data/lib/recurly/resources/invoice_collection.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 Resources
     class InvoiceCollection < Resource
@@ -8,7 +12,7 @@ module Recurly
 
       # @!attribute credit_invoices
       #   @return [Array[Invoice]] Credit invoices
-      define_attribute :credit_invoices, Array, {:item_type => :Invoice}
+      define_attribute :credit_invoices, Array, { :item_type => :Invoice }
 
       # @!attribute object
       #   @return [String] Object type

data/lib/recurly/resources/invoice_mini.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 Resources
     class InvoiceMini < Resource
@@ -16,11 +20,11 @@ module Recurly
 
       # @!attribute state
       #   @return [String] Invoice state
-      define_attribute :state, String, {:enum => ["pending", "processing", "past_due", "paid", "failed"]}
+      define_attribute :state, String, { :enum => ["pending", "processing", "past_due", "paid", "failed"] }
 
       # @!attribute type
       #   @return [String] Invoice type
-      define_attribute :type, String, {:enum => ["charge", "credit", "legacy"]}
+      define_attribute :type, String, { :enum => ["charge", "credit", "legacy"] }
     end
   end
 end

data/lib/recurly/resources/line_item.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 Resources
     class LineItem < Resource
@@ -32,7 +36,7 @@ module Recurly
 
       # @!attribute credit_reason_code
       #   @return [String] The reason the credit was given when line item is `type=credit`.
-      define_attribute :credit_reason_code, String, {:enum => ["general", "service", "promotional", "refund", "gift_card", "write_off"]}
+      define_attribute :credit_reason_code, String, { :enum => ["general", "service", "promotional", "refund", "gift_card", "write_off"] }
 
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
@@ -64,7 +68,7 @@ module Recurly
 
       # @!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, {:enum => ["charge", "credit", "applied_credit", "carryforward"]}
+      define_attribute :legacy_category, String, { :enum => ["charge", "credit", "applied_credit", "carryforward"] }
 
       # @!attribute object
       #   @return [String] Object type
@@ -72,7 +76,7 @@ module Recurly
 
       # @!attribute origin
       #   @return [String] A credit created from an original charge will have the value of the charge's origin.
-      define_attribute :origin, String, {:enum => ["plan", "plan_trial", "setup_fee", "add_on_trial", "add_on", "debit", "one_time", "credit", "coupon", "carryforward"]}
+      define_attribute :origin, String, { :enum => ["plan", "plan_trial", "setup_fee", "add_on_trial", "add_on", "debit", "one_time", "credit", "coupon", "carryforward"] }
 
       # @!attribute original_line_item_invoice_id
       #   @return [String] The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.
@@ -110,13 +114,17 @@ 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 shipping_address
+      #   @return [ShippingAddress]
+      define_attribute :shipping_address, :ShippingAddress
+
       # @!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.
       define_attribute :start_date, DateTime
 
       # @!attribute state
       #   @return [String] Pending line items are charges or credits on an account that have not been applied to an invoice yet. Invoiced line items will always have an `invoice_id` value.
-      define_attribute :state, String, {:enum => ["pending", "invoiced"]}
+      define_attribute :state, String, { :enum => ["pending", "invoiced"] }
 
       # @!attribute subscription_id
       #   @return [String] If the line item is a charge or credit for a subscription, this is its ID.
@@ -148,7 +156,7 @@ module Recurly
 
       # @!attribute type
       #   @return [String] Charges are positive line items that debit the account. Credits are negative line items that credit the account.
-      define_attribute :type, String, {:enum => ["charge", "credit"]}
+      define_attribute :type, String, { :enum => ["charge", "credit"] }
 
       # @!attribute unit_amount
       #   @return [Float] Positive amount for a charge, negative amount for a credit.

data/lib/recurly/resources/line_item_list.rb

@@ -1,10 +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 LineItemList < Resource
 
       # @!attribute data
       #   @return [Array[LineItem]]
-      define_attribute :data, Array, {:item_type => :LineItem}
+      define_attribute :data, Array, { :item_type => :LineItem }
 
       # @!attribute has_more
       #   @return [Boolean] Indicates there are more results on subsequent pages.

data/lib/recurly/resources/plan.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 Resources
     class Plan < Resource
@@ -16,27 +20,27 @@ module Recurly
 
       # @!attribute [r] created_at
       #   @return [DateTime] Created at
-      define_attribute :created_at, DateTime, {:read_only => true}
+      define_attribute :created_at, DateTime, { :read_only => true }
 
       # @!attribute currencies
-      #   @return [Array[Hash]] Pricing
-      define_attribute :currencies, Array, {:item_type => Hash}
+      #   @return [Array[PlanPricing]] Pricing
+      define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
       # @!attribute [r] deleted_at
       #   @return [DateTime] Deleted at
-      define_attribute :deleted_at, DateTime, {:read_only => true}
+      define_attribute :deleted_at, DateTime, { :read_only => true }
 
       # @!attribute description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
 
       # @!attribute hosted_pages
-      #   @return [Hash] Hosted pages settings
-      define_attribute :hosted_pages, Hash
+      #   @return [PlanHostedPages] Hosted pages settings
+      define_attribute :hosted_pages, :PlanHostedPages
 
       # @!attribute [r] id
       #   @return [String] Plan ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute interval_length
       #   @return [Integer] Length of the plan's billing interval in `interval_unit`.
@@ -44,7 +48,7 @@ module Recurly
 
       # @!attribute interval_unit
       #   @return [String] Unit for the plan's billing interval.
-      define_attribute :interval_unit, String, {:enum => ["days", "months"]}
+      define_attribute :interval_unit, String, { :enum => ["days", "months"] }
 
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
@@ -52,7 +56,7 @@ module Recurly
 
       # @!attribute [r] object
       #   @return [String] Object type
-      define_attribute :object, String, {:read_only => true}
+      define_attribute :object, String, { :read_only => true }
 
       # @!attribute setup_fee_accounting_code
       #   @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
@@ -60,7 +64,7 @@ module Recurly
 
       # @!attribute [r] state
       #   @return [String] The current state of the plan.
-      define_attribute :state, String, {:read_only => true, :enum => ["active", "inactive"]}
+      define_attribute :state, String, { :read_only => true, :enum => ["active", "inactive"] }
 
       # @!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.
@@ -80,11 +84,11 @@ module Recurly
 
       # @!attribute trial_unit
       #   @return [String] Units for the plan's trial period.
-      define_attribute :trial_unit, String, {:enum => ["days", "months"]}
+      define_attribute :trial_unit, String, { :enum => ["days", "months"] }
 
       # @!attribute [r] updated_at
       #   @return [DateTime] Last updated at
-      define_attribute :updated_at, DateTime, {:read_only => true}
+      define_attribute :updated_at, DateTime, { :read_only => true }
     end
   end
 end

data/lib/recurly/resources/plan_hosted_pages.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 PlanHostedPages < Resource
+
+      # @!attribute bypass_confirmation
+      #   @return [Boolean] If `true`, the customer will be sent directly to your `success_url` after a successful signup, bypassing Recurly's hosted confirmation page.
+      define_attribute :bypass_confirmation, :Boolean
+
+      # @!attribute cancel_url
+      #   @return [String] URL to redirect to on canceled signup on the hosted payment pages.
+      define_attribute :cancel_url, String
+
+      # @!attribute display_quantity
+      #   @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the plan.
+      define_attribute :display_quantity, :Boolean
+
+      # @!attribute success_url
+      #   @return [String] URL to redirect to after signup on the hosted payment pages.
+      define_attribute :success_url, String
+    end
+  end
+end