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

data/lib/recurly/resources/billing_info_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.

data/lib/recurly/resources/coupon.rb

@@ -20,11 +20,11 @@ module Recurly
 
       # @!attribute coupon_type
       #   @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
-      define_attribute :coupon_type, String, { :enum => ["single_code", "bulk"] }
+      define_attribute :coupon_type, 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 discount
       #   @return [CouponDiscount]
@@ -32,7 +32,7 @@ module Recurly
 
       # @!attribute duration
       #   @return [String] - "single_use" coupons applies to the first invoice only. - "temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.
-      define_attribute :duration, String, { :enum => ["forever", "single_use", "temporal"] }
+      define_attribute :duration, String
 
       # @!attribute expired_at
       #   @return [DateTime] The date and time the coupon was expired early or reached its `max_redemptions`.
@@ -44,15 +44,15 @@ module Recurly
 
       # @!attribute free_trial_unit
       #   @return [String] Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.
-      define_attribute :free_trial_unit, String, { :enum => ["day", "week", "month"] }
+      define_attribute :free_trial_unit, String
 
       # @!attribute hosted_page_description
       #   @return [String] This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
       define_attribute :hosted_page_description, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Coupon ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute invoice_description
       #   @return [String] Description of the coupon on the invoice.
@@ -70,9 +70,9 @@ module Recurly
       #   @return [String] The internal name for the coupon.
       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 plans
       #   @return [Array[PlanMini]] Plans
@@ -88,11 +88,11 @@ module Recurly
 
       # @!attribute redemption_resource
       #   @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
-      define_attribute :redemption_resource, String, { :enum => ["account", "subscription"] }
+      define_attribute :redemption_resource, String
 
       # @!attribute state
       #   @return [String] Indicates if the coupon is redeemable, and if it is not, why.
-      define_attribute :state, String, { :enum => ["redeemable", "maxed_out", "expired"] }
+      define_attribute :state, String
 
       # @!attribute temporal_amount
       #   @return [Integer] If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
@@ -100,19 +100,19 @@ module Recurly
 
       # @!attribute temporal_unit
       #   @return [String] If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
-      define_attribute :temporal_unit, String, { :enum => ["day", "week", "month", "year"] }
+      define_attribute :temporal_unit, String
 
       # @!attribute unique_code_template
       #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated.
       define_attribute :unique_code_template, String
 
-      # @!attribute [r] unique_coupon_codes_count
+      # @!attribute unique_coupon_codes_count
       #   @return [Integer] When this number reaches `max_redemptions` the coupon will no longer be redeemable.
-      define_attribute :unique_coupon_codes_count, Integer, { :read_only => true }
+      define_attribute :unique_coupon_codes_count, Integer
 
-      # @!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/coupon_discount.rb

@@ -20,7 +20,7 @@ module Recurly
 
       # @!attribute type
       #   @return [String]
-      define_attribute :type, String, { :enum => ["percent", "fixed", "free_trial"] }
+      define_attribute :type, String
     end
   end
 end

data/lib/recurly/resources/coupon_discount_trial.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute unit
       #   @return [String] Temporal unit of the free trial
-      define_attribute :unit, String, { :enum => ["day", "week", "month"] }
+      define_attribute :unit, String
     end
   end
 end

data/lib/recurly/resources/coupon_mini.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute coupon_type
       #   @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
-      define_attribute :coupon_type, String, { :enum => ["single_code", "bulk"] }
+      define_attribute :coupon_type, String
 
       # @!attribute discount
       #   @return [CouponDiscount]
@@ -22,21 +22,21 @@ module Recurly
       #   @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] Coupon ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute name
       #   @return [String] The internal name for the coupon.
       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 state
       #   @return [String] Indicates if the coupon is redeemable, and if it is not, why.
-      define_attribute :state, String, { :enum => ["redeemable", "maxed_out", "expired"] }
+      define_attribute :state, String
     end
   end
 end

data/lib/recurly/resources/coupon_redemption.rb

@@ -6,17 +6,17 @@ module Recurly
   module Resources
     class CouponRedemption < Resource
 
-      # @!attribute account_id
-      #   @return [String] The Account ID on which the coupon was applied.
-      define_attribute :account_id, String
+      # @!attribute account
+      #   @return [AccountMini] The Account on which the coupon was applied.
+      define_attribute :account, :AccountMini
 
       # @!attribute coupon
       #   @return [Coupon]
       define_attribute :coupon, :Coupon
 
-      # @!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 currency
       #   @return [String] 3-letter ISO 4217 currency code.
@@ -26,13 +26,13 @@ module Recurly
       #   @return [String] The amount that was discounted upon the application of the coupon, formatted with the currency.
       define_attribute :discounted, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Coupon Redemption ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Will always be `coupon`.
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!attribute removed_at
       #   @return [DateTime] The date and time the redemption was removed from the account (un-redeemed).
@@ -40,11 +40,11 @@ module Recurly
 
       # @!attribute state
       #   @return [String] Coupon Redemption state
-      define_attribute :state, String, { :enum => ["active", "inactive"] }
+      define_attribute :state, 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/coupon_redemption_mini.rb

@@ -10,25 +10,25 @@ module Recurly
       #   @return [CouponMini]
       define_attribute :coupon, :CouponMini
 
-      # @!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 discounted
       #   @return [String] The amount that was discounted upon the application of the coupon, formatted with the currency.
       define_attribute :discounted, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Coupon Redemption ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Will always be `coupon`.
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!attribute state
       #   @return [String] Invoice state
-      define_attribute :state, String, { :enum => ["active", "inactive"] }
+      define_attribute :state, String
     end
   end
 end

data/lib/recurly/resources/credit_payment.rb

@@ -12,7 +12,7 @@ module Recurly
 
       # @!attribute action
       #   @return [String] The action for which the credit was created.
-      define_attribute :action, String, { :enum => ["payment", "refund", "reduction", "write_off"] }
+      define_attribute :action, String
 
       # @!attribute amount
       #   @return [Float] Total credit payment amount applied to the charge invoice.
@@ -22,9 +22,9 @@ module Recurly
       #   @return [InvoiceMini]
       define_attribute :applied_to_invoice, :InvoiceMini
 
-      # @!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 currency
       #   @return [String] 3-letter ISO 4217 currency code.
@@ -50,17 +50,17 @@ module Recurly
       #   @return [Transaction]
       define_attribute :refund_transaction, :Transaction
 
-      # @!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
 
       # @!attribute uuid
       #   @return [String] The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
       define_attribute :uuid, String
 
-      # @!attribute [r] voided_at
+      # @!attribute voided_at
       #   @return [DateTime] Voided at
-      define_attribute :voided_at, DateTime, { :read_only => true }
+      define_attribute :voided_at, DateTime
     end
   end
 end

data/lib/recurly/resources/custom_field_definition.rb

@@ -6,45 +6,45 @@ module Recurly
   module Resources
     class CustomFieldDefinition < Resource
 
-      # @!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] Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.
-      define_attribute :deleted_at, DateTime, { :read_only => true }
+      define_attribute :deleted_at, DateTime
 
       # @!attribute display_name
       #   @return [String] Used to label the field when viewing and editing the field in Recurly's admin UI.
       define_attribute :display_name, String
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Custom field definition ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute name
       #   @return [String] Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.
       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 related_type
       #   @return [String] Related Recurly object type
-      define_attribute :related_type, String, { :enum => ["account", "subscription"] }
+      define_attribute :related_type, String
 
       # @!attribute tooltip
       #   @return [String] Displayed as a tooltip when editing the field in the Recurly admin UI.
       define_attribute :tooltip, 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
 
       # @!attribute user_access
       #   @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
-      define_attribute :user_access, String, { :enum => ["api_only", "read_only", "write"] }
+      define_attribute :user_access, String
     end
   end
 end

data/lib/recurly/resources/error.rb

@@ -16,7 +16,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
     end
   end
 end

data/lib/recurly/resources/error_may_have_transaction.rb

@@ -20,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
     end
   end
 end

data/lib/recurly/resources/fraud_info.rb

@@ -8,7 +8,7 @@ module Recurly
 
       # @!attribute decision
       #   @return [String] Kount decision
-      define_attribute :decision, String, { :enum => ["approve", "review", "decline", "escalate"] }
+      define_attribute :decision, String
 
       # @!attribute risk_rules_triggered
       #   @return [Hash] Kount rules

data/lib/recurly/resources/invoice.rb

@@ -24,11 +24,11 @@ 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
 
-      # @!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 credit_payments
       #   @return [Array[CreditPayment]] Credit payments
@@ -50,9 +50,9 @@ module Recurly
       #   @return [DateTime] Date invoice is due. This is the date the net terms are reached.
       define_attribute :due_at, DateTime
 
-      # @!attribute [r] id
+      # @!attribute id
       #   @return [String] Invoice ID
-      define_attribute :id, String, { :read_only => true }
+      define_attribute :id, String
 
       # @!attribute line_items
       #   @return [LineItemList]
@@ -66,13 +66,13 @@ module Recurly
       #   @return [String] 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 :number, String
 
-      # @!attribute [r] object
+      # @!attribute object
       #   @return [String] Object type
-      define_attribute :object, String, { :read_only => true }
+      define_attribute :object, String
 
       # @!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
 
       # @!attribute paid
       #   @return [Float] The total amount of successful payments transaction on this invoice.
@@ -92,7 +92,7 @@ module Recurly
 
       # @!attribute state
       #   @return [String] Invoice state
-      define_attribute :state, String, { :enum => ["pending", "processing", "past_due", "paid", "failed"] }
+      define_attribute :state, String
 
       # @!attribute subscription_ids
       #   @return [Array[String]] If the invoice is charging or refunding for one or more subscriptions, these are their IDs.
@@ -124,11 +124,11 @@ module Recurly
 
       # @!attribute type
       #   @return [String] Invoices are either charge, credit, or legacy invoices.
-      define_attribute :type, String, { :enum => ["charge", "credit", "legacy"] }
+      define_attribute :type, 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
 
       # @!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_mini.rb

@@ -20,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
 
       # @!attribute type
       #   @return [String] Invoice type
-      define_attribute :type, String, { :enum => ["charge", "credit", "legacy"] }
+      define_attribute :type, String
     end
   end
 end