recurly 3.0.0.beta.4 → 3.0.0.beta.5

data/lib/recurly/resources/line_item.rb

@@ -36,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
 
       # @!attribute currency
       #   @return [String] 3-letter ISO 4217 currency code.
@@ -68,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
 
       # @!attribute object
       #   @return [String] Object type
@@ -76,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
 
       # @!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.
@@ -124,7 +124,7 @@ module Recurly
 
       # @!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
 
       # @!attribute subscription_id
       #   @return [String] If the line item is a charge or credit for a subscription, this is its ID.
@@ -139,7 +139,7 @@ module Recurly
       define_attribute :tax, Float
 
       # @!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.
+      #   @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 `P0000000` is `physical`, `D0000000` is `digital`, and an empty string is `unknown`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt
@@ -156,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
 
       # @!attribute unit_amount
       #   @return [Float] Positive amount for a charge, negative amount for a credit.

data/lib/recurly/resources/plan.rb

@@ -18,17 +18,17 @@ module Recurly
       #   @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
       define_attribute :code, String
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] Created at
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
       # @!attribute currencies
       #   @return [Array[PlanPricing]] Pricing
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
-      # @!attribute [r] deleted_at
+      # @!attribute deleted_at
       #   @return [DateTime] Deleted at
-      define_attribute :deleted_at, DateTime, { :read_only => true }
+      define_attribute :deleted_at, DateTime
 
       # @!attribute description
       #   @return [String] Optional description, not displayed.
@@ -38,9 +38,9 @@ module Recurly
       #   @return [PlanHostedPages] Hosted pages settings
       define_attribute :hosted_pages, :PlanHostedPages
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Plan ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute interval_length
       #   @return [Integer] Length of the plan's billing interval in `interval_unit`.
@@ -48,26 +48,26 @@ 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
 
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
       define_attribute :name, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!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.
       define_attribute :setup_fee_accounting_code, String
 
-      # @!attribute [r] state
+      # @!attribute state
       #   @return [String] The current state of the plan.
-      define_attribute :state, String, { :read_only => true, :enum => ["active", "inactive"] }
+      define_attribute :state, String
 
       # @!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.
+      #   @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 `P0000000` is `physical`, `D0000000` is `digital`, and an empty string is `unknown`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt
@@ -84,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
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] Last updated at
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
     end
   end
 end

data/lib/recurly/resources/plan_mini.rb

@@ -10,17 +10,17 @@ module Recurly
       #   @return [String] Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
       define_attribute :code, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Plan ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
       define_attribute :name, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
     end
   end
 end

data/lib/recurly/resources/settings.rb

@@ -6,17 +6,17 @@ module Recurly
   module Resources
     class Settings < Resource
 
-      # @!attribute [r] accepted_currencies
+      # @!attribute accepted_currencies
       #   @return [Array[String]]
-      define_attribute :accepted_currencies, Array, { :item_type => String, :read_only => true }
+      define_attribute :accepted_currencies, Array, { :item_type => String }
 
-      # @!attribute [r] billing_address_requirement
+      # @!attribute billing_address_requirement
       #   @return [String] - full:      Full Address (Street, City, State, Postal Code and Country) - streetzip: Street and Postal Code only - zip:       Postal Code only - none:      No Address
-      define_attribute :billing_address_requirement, String, { :read_only => true, :enum => ["full", "streetzip", "zip", "none"] }
+      define_attribute :billing_address_requirement, String
 
-      # @!attribute [r] default_currency
+      # @!attribute default_currency
       #   @return [String] The default 3-letter ISO 4217 currency code.
-      define_attribute :default_currency, String, { :read_only => true }
+      define_attribute :default_currency, String
     end
   end
 end

data/lib/recurly/resources/shipping_address.rb

@@ -6,9 +6,9 @@ module Recurly
   module Resources
     class ShippingAddress < Resource
 
-      # @!attribute [r] account_id
+      # @!attribute account_id
       #   @return [String] Account ID
-      define_attribute :account_id, String, { :read_only => true }
+      define_attribute :account_id, String
 
       # @!attribute city
       #   @return [String]
@@ -22,9 +22,9 @@ module Recurly
       #   @return [String] Country, 2-letter ISO code.
       define_attribute :country, String
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] Created at
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
       # @!attribute email
       #   @return [String]
@@ -34,9 +34,9 @@ module Recurly
       #   @return [String]
       define_attribute :first_name, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Shipping Address ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute last_name
       #   @return [String]
@@ -66,9 +66,9 @@ module Recurly
       #   @return [String]
       define_attribute :street2, String
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] Updated at
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
 
       # @!attribute vat_number
       #   @return [String]

data/lib/recurly/resources/site.rb

@@ -10,45 +10,45 @@ module Recurly
       #   @return [Address]
       define_attribute :address, :Address
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] Created at
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
-      # @!attribute [r] deleted_at
+      # @!attribute deleted_at
       #   @return [DateTime] Deleted at
-      define_attribute :deleted_at, DateTime, { :read_only => true }
+      define_attribute :deleted_at, DateTime
 
       # @!attribute features
       #   @return [Array[String]] A list of features enabled for the site.
       define_attribute :features, Array, { :item_type => String }
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Site ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
-      # @!attribute [r] mode
+      # @!attribute mode
       #   @return [String] Mode
-      define_attribute :mode, String, { :read_only => true, :enum => ["development", "production", "sandbox"] }
+      define_attribute :mode, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
-      # @!attribute [r] public_api_key
+      # @!attribute public_api_key
       #   @return [String] This value is used to configure RecurlyJS to submit tokenized billing information.
-      define_attribute :public_api_key, String, { :read_only => true }
+      define_attribute :public_api_key, String
 
       # @!attribute settings
       #   @return [Settings]
       define_attribute :settings, :Settings
 
-      # @!attribute [r] subdomain
+      # @!attribute subdomain
       #   @return [String]
-      define_attribute :subdomain, String, { :read_only => true }
+      define_attribute :subdomain, String
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] Updated at
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
     end
   end
 end

data/lib/recurly/resources/subscription.rb

@@ -36,7 +36,7 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] Collection method
-      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
+      define_attribute :collection_method, String
 
       # @!attribute coupon_redemptions
       #   @return [Array[CouponRedemptionMini]] Coupon redemptions
@@ -132,7 +132,7 @@ module Recurly
 
       # @!attribute state
       #   @return [String] State
-      define_attribute :state, String, { :enum => ["active", "canceled", "expired", "failed", "future", "paused"] }
+      define_attribute :state, String
 
       # @!attribute subtotal
       #   @return [Float] Estimated total, before tax.

data/lib/recurly/resources/subscription_change.rb

@@ -6,9 +6,9 @@ module Recurly
   module Resources
     class SubscriptionChange < Resource
 
-      # @!attribute [r] activate_at
+      # @!attribute activate_at
       #   @return [DateTime] Activated at
-      define_attribute :activate_at, DateTime, { :read_only => true }
+      define_attribute :activate_at, DateTime
 
       # @!attribute activated
       #   @return [Boolean] Returns `true` if the subscription change is activated.
@@ -18,13 +18,13 @@ module Recurly
       #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
       define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] Created at
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
-      # @!attribute [r] deleted_at
+      # @!attribute deleted_at
       #   @return [DateTime] Deleted at
-      define_attribute :deleted_at, DateTime, { :read_only => true }
+      define_attribute :deleted_at, DateTime
 
       # @!attribute id
       #   @return [String] The ID of the Subscription Change.
@@ -50,9 +50,9 @@ module Recurly
       #   @return [Float] Unit amount
       define_attribute :unit_amount, Float
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] Updated at
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
     end
   end
 end

data/lib/recurly/resources/transaction.rb

@@ -16,7 +16,7 @@ module Recurly
 
       # @!attribute avs_check
       #   @return [String] When processed, result from checking the overall AVS on the transaction.
-      define_attribute :avs_check, String, { :enum => ["A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z"] }
+      define_attribute :avs_check, String
 
       # @!attribute billing_address
       #   @return [Address]
@@ -28,7 +28,7 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] The method by which the payment was collected.
-      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
+      define_attribute :collection_method, String
 
       # @!attribute created_at
       #   @return [DateTime] Created at
@@ -48,7 +48,7 @@ module Recurly
 
       # @!attribute cvv_check
       #   @return [String] When processed, result from checking the CVV/CVC value on the transaction.
-      define_attribute :cvv_check, String, { :enum => ["D", "I", "M", "N", "P", "S", "U", "X"] }
+      define_attribute :cvv_check, String
 
       # @!attribute gateway_approval_code
       #   @return [String] Transaction approval code from the payment gateway.
@@ -67,8 +67,8 @@ module Recurly
       define_attribute :gateway_response_code, String
 
       # @!attribute gateway_response_time
-      #   @return [Integer] Time, in seconds, for gateway to process the transaction.
-      define_attribute :gateway_response_time, Integer
+      #   @return [Float] Time, in seconds, for gateway to process the transaction.
+      define_attribute :gateway_response_time, Float
 
       # @!attribute gateway_response_values
       #   @return [Hash] The values in this field will vary from gateway to gateway.
@@ -96,7 +96,7 @@ module Recurly
 
       # @!attribute origin
       #   @return [String] Describes how the transaction was triggered.
-      define_attribute :origin, String, { :enum => ["api", "hpp", "merchant", "recurly_admin", "recurlyjs", "recurring", "transparent", "force_collect", "refunded_externally", "chargeback"] }
+      define_attribute :origin, String
 
       # @!attribute original_transaction_id
       #   @return [String] If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.
@@ -116,7 +116,7 @@ module Recurly
 
       # @!attribute status
       #   @return [String] The current transaction status. Note that the status may change, e.g. a `pending` transaction may become `declined` or `success` may later become `void`.
-      define_attribute :status, String, { :enum => ["pending", "scheduled", "processing", "success", "void", "declined", "error", "chargeback"] }
+      define_attribute :status, String
 
       # @!attribute status_code
       #   @return [String] Status code
@@ -136,7 +136,7 @@ module Recurly
 
       # @!attribute type
       #   @return [String] - `authorization` – verifies billing information and places a hold on money in the customer's account. - `capture` – captures funds held by an authorization and completes a purchase. - `purchase` – combines the authorization and capture in one transaction. - `refund` – returns all or a portion of the money collected in a previous transaction to the customer. - `verify` – a $0 or $1 transaction used to verify billing information which is immediately voided.
-      define_attribute :type, String, { :enum => ["authorization", "capture", "purchase", "refund", "verify"] }
+      define_attribute :type, String
 
       # @!attribute uuid
       #   @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

data/lib/recurly/resources/transaction_payment_method.rb

@@ -8,7 +8,7 @@ module Recurly
 
       # @!attribute card_type
       #   @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
-      define_attribute :card_type, String, { :enum => ["American Express", "Dankort", "Diners Club", "Discover", "Forbrugsforeningen", "JCB", "Laser", "Maestro", "MasterCard", "Test Card", "Unknown", "Visa"] }
+      define_attribute :card_type, String
 
       # @!attribute exp_month
       #   @return [Integer] Expiration month.
@@ -28,7 +28,7 @@ module Recurly
 
       # @!attribute object
       #   @return [String]
-      define_attribute :object, String, { :enum => ["credit_card", "paypal", "amazon", "roku", "ach", "apple_pay", "sepadirectdebit", "eft", "wire_transfer", "money_order", "check", "other"] }
+      define_attribute :object, String
     end
   end
 end

data/lib/recurly/resources/unique_coupon_code.rb

@@ -10,33 +10,33 @@ module Recurly
       #   @return [String] The code the customer enters to redeem the coupon.
       define_attribute :code, String
 
-      # @!attribute [r] created_at
+      # @!attribute created_at
       #   @return [DateTime] Created at
-      define_attribute :created_at, DateTime, { :read_only => true }
+      define_attribute :created_at, DateTime
 
       # @!attribute expired_at
       #   @return [DateTime] The date and time the coupon was expired early or reached its `max_redemptions`.
       define_attribute :expired_at, DateTime
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Unique Coupon Code ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
-      # @!attribute [r] redeemed_at
+      # @!attribute redeemed_at
       #   @return [DateTime] The date and time the unique coupon code was redeemed.
-      define_attribute :redeemed_at, DateTime, { :read_only => true }
+      define_attribute :redeemed_at, DateTime
 
       # @!attribute state
       #   @return [String] Indicates if the unique coupon code is redeemable or why not.
-      define_attribute :state, String, { :enum => ["redeemable", "maxed_out", "expired", "inactive"] }
+      define_attribute :state, String
 
-      # @!attribute [r] updated_at
+      # @!attribute updated_at
       #   @return [DateTime] Updated at
-      define_attribute :updated_at, DateTime, { :read_only => true }
+      define_attribute :updated_at, DateTime
     end
   end
 end