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

data/lib/recurly/resources/plan_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 PlanMini < Resource
@@ -8,7 +12,7 @@ module Recurly
 
       # @!attribute [r] id
       #   @return [String] Plan ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute name
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
@@ -16,7 +20,7 @@ module Recurly
 
       # @!attribute [r] object
       #   @return [String] Object type
-      define_attribute :object, String, {:read_only => true}
+      define_attribute :object, String, { :read_only => true }
     end
   end
 end

data/lib/recurly/resources/plan_pricing.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 PlanPricing < Resource
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute setup_fee
+      #   @return [Float] Amount of one-time setup fee automatically charged at the beginning of a subscription billing cycle. For subscription plans with a trial, the setup fee will be charged at the time of signup. Setup fees do not increase with the quantity of a subscription plan.
+      define_attribute :setup_fee, Float
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit price
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/resources/settings.rb

@@ -1,18 +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 Settings < Resource
 
       # @!attribute [r] accepted_currencies
       #   @return [Array[String]]
-      define_attribute :accepted_currencies, Array, {:item_type => String, :read_only => true}
+      define_attribute :accepted_currencies, Array, { :item_type => String, :read_only => true }
 
       # @!attribute [r] 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, { :read_only => true, :enum => ["full", "streetzip", "zip", "none"] }
 
       # @!attribute [r] 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, { :read_only => true }
     end
   end
 end

data/lib/recurly/resources/shipping_address.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 ShippingAddress < Resource
 
       # @!attribute [r] account_id
       #   @return [String] Account ID
-      define_attribute :account_id, String, {:read_only => true}
+      define_attribute :account_id, String, { :read_only => true }
 
       # @!attribute city
       #   @return [String]
@@ -20,7 +24,7 @@ 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 email
       #   @return [String]
@@ -32,7 +36,7 @@ module Recurly
 
       # @!attribute [r] id
       #   @return [String] Shipping Address ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute last_name
       #   @return [String]
@@ -64,7 +68,7 @@ module Recurly
 
       # @!attribute [r] updated_at
       #   @return [DateTime] Updated at
-      define_attribute :updated_at, DateTime, {:read_only => true}
+      define_attribute :updated_at, DateTime, { :read_only => true }
 
       # @!attribute vat_number
       #   @return [String]

data/lib/recurly/resources/site.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 Site < Resource
@@ -8,27 +12,31 @@ 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 [r] deleted_at
       #   @return [DateTime] Deleted at
-      define_attribute :deleted_at, DateTime, {:read_only => true}
+      define_attribute :deleted_at, DateTime, { :read_only => true }
 
       # @!attribute features
       #   @return [Array[String]] A list of features enabled for the site.
-      define_attribute :features, Array, {:item_type => String}
+      define_attribute :features, Array, { :item_type => String }
 
       # @!attribute [r] id
       #   @return [String] Site ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute [r] mode
       #   @return [String] Mode
-      define_attribute :mode, String, {:read_only => true, :enum => ["development", "production", "sandbox"]}
+      define_attribute :mode, String, { :read_only => true, :enum => ["development", "production", "sandbox"] }
 
       # @!attribute [r] object
       #   @return [String] Object type
-      define_attribute :object, String, {:read_only => true}
+      define_attribute :object, String, { :read_only => true }
+
+      # @!attribute [r] 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 }
 
       # @!attribute settings
       #   @return [Settings]
@@ -36,11 +44,11 @@ module Recurly
 
       # @!attribute [r] subdomain
       #   @return [String]
-      define_attribute :subdomain, String, {:read_only => true}
+      define_attribute :subdomain, String, { :read_only => true }
 
       # @!attribute [r] updated_at
       #   @return [DateTime] 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/subscription.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 Subscription < Resource
@@ -12,7 +16,7 @@ module Recurly
 
       # @!attribute add_ons
       #   @return [Array[SubscriptionAddOn]] Add-ons
-      define_attribute :add_ons, Array, {:item_type => :SubscriptionAddOn}
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
 
       # @!attribute add_ons_total
       #   @return [Float] Total price of add-ons
@@ -32,11 +36,11 @@ module Recurly
 
       # @!attribute collection_method
       #   @return [String] Collection method
-      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
 
       # @!attribute coupon_redemptions
       #   @return [Array[CouponRedemptionMini]] Coupon redemptions
-      define_attribute :coupon_redemptions, Array, {:item_type => :CouponRedemptionMini}
+      define_attribute :coupon_redemptions, Array, { :item_type => :CouponRedemptionMini }
 
       # @!attribute created_at
       #   @return [DateTime] Created at
@@ -64,7 +68,7 @@ module Recurly
 
       # @!attribute custom_fields
       #   @return [Array[CustomField]]
-      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute customer_notes
       #   @return [String] Customer notes
@@ -128,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, { :enum => ["active", "canceled", "expired", "failed", "future", "paused"] }
 
       # @!attribute subtotal
       #   @return [Float] Estimated total, before tax.

data/lib/recurly/resources/subscription_add_on.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 SubscriptionAddOn < Resource

data/lib/recurly/resources/subscription_change.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 SubscriptionChange < Resource
 
       # @!attribute [r] activate_at
       #   @return [DateTime] Activated at
-      define_attribute :activate_at, DateTime, {:read_only => true}
+      define_attribute :activate_at, DateTime, { :read_only => true }
 
       # @!attribute activated
       #   @return [Boolean] Returns `true` if the subscription change is activated.
@@ -12,15 +16,15 @@ module Recurly
 
       # @!attribute add_ons
       #   @return [Array[SubscriptionAddOn]] These add-ons will be used when the subscription renews.
-      define_attribute :add_ons, Array, {:item_type => :SubscriptionAddOn}
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOn }
 
       # @!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 [r] deleted_at
       #   @return [DateTime] Deleted at
-      define_attribute :deleted_at, DateTime, {:read_only => true}
+      define_attribute :deleted_at, DateTime, { :read_only => true }
 
       # @!attribute id
       #   @return [String] The ID of the Subscription Change.
@@ -48,7 +52,7 @@ module Recurly
 
       # @!attribute [r] updated_at
       #   @return [DateTime] 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/tax_info.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 TaxInfo < Resource

data/lib/recurly/resources/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 Transaction < Resource
@@ -12,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, { :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"] }
 
       # @!attribute billing_address
       #   @return [Address]
@@ -22,6 +26,10 @@ module Recurly
       #   @return [DateTime] Collected at, or if not collected yet, the time the transaction was created.
       define_attribute :collected_at, DateTime
 
+      # @!attribute collection_method
+      #   @return [String] The method by which the payment was collected.
+      define_attribute :collection_method, String, { :enum => ["automatic", "manual"] }
+
       # @!attribute created_at
       #   @return [DateTime] Created at
       define_attribute :created_at, DateTime
@@ -40,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, { :enum => ["D", "I", "M", "N", "P", "S", "U", "X"] }
 
       # @!attribute gateway_approval_code
       #   @return [String] Transaction approval code from the payment gateway.
@@ -88,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, { :enum => ["api", "hpp", "merchant", "recurly_admin", "recurlyjs", "recurring", "transparent", "force_collect", "refunded_externally", "chargeback"] }
 
       # @!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.
@@ -99,7 +107,7 @@ module Recurly
       define_attribute :payment_gateway, Hash
 
       # @!attribute payment_method
-      #   @return [Hash] Payment method (TODO: this overlaps with BillinInfo’s payment_method but only documents credit cards)
+      #   @return [Hash] Payment method (TODO: this overlaps with BillingInfo’s payment_method but only documents credit cards)
       define_attribute :payment_method, Hash
 
       # @!attribute refunded
@@ -108,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, { :enum => ["pending", "scheduled", "processing", "success", "void", "declined", "error", "chargeback"] }
 
       # @!attribute status_code
       #   @return [String] Status code
@@ -120,15 +128,15 @@ module Recurly
 
       # @!attribute subscription_ids
       #   @return [Array[String]] If the transaction 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 success
       #   @return [Boolean] Did this transaction complete successfully?
       define_attribute :success, :Boolean
 
       # @!attribute type
-      #   @return [String] Transaction type
-      define_attribute :type, String, {:enum => ["authorization", "capture", "purchase", "refund", "verify"]}
+      #   @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"] }
 
       # @!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_gateway.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 TransactionPaymentGateway < Resource
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String]
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute type
+      #   @return [String]
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/transaction_payment_method.rb

@@ -0,0 +1,34 @@
+# 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 TransactionPaymentMethod < Resource
+
+      # @!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"] }
+
+      # @!attribute exp_month
+      #   @return [Integer] Expiration month.
+      define_attribute :exp_month, Integer
+
+      # @!attribute exp_year
+      #   @return [Integer] Expiration year.
+      define_attribute :exp_year, Integer
+
+      # @!attribute first_six
+      #   @return [String] Credit card number's first six digits.
+      define_attribute :first_six, String
+
+      # @!attribute last_four
+      #   @return [String] Credit card number's last four digits.
+      define_attribute :last_four, String
+
+      # @!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"] }
+    end
+  end
+end

data/lib/recurly/resources/unique_coupon_code.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 UniqueCouponCode < Resource
@@ -8,7 +12,7 @@ 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 expired_at
       #   @return [DateTime] The date and time the coupon was expired early or reached its `max_redemptions`.
@@ -16,23 +20,23 @@ module Recurly
 
       # @!attribute [r] id
       #   @return [String] Unique Coupon Code ID
-      define_attribute :id, String, {:read_only => true}
+      define_attribute :id, String, { :read_only => true }
 
       # @!attribute [r] object
       #   @return [String] Object type
-      define_attribute :object, String, {:read_only => true}
+      define_attribute :object, String, { :read_only => true }
 
       # @!attribute [r] 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, { :read_only => true }
 
       # @!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, { :enum => ["redeemable", "maxed_out", "expired", "inactive"] }
 
       # @!attribute [r] updated_at
       #   @return [DateTime] Updated at
-      define_attribute :updated_at, DateTime, {:read_only => true}
+      define_attribute :updated_at, DateTime, { :read_only => true }
     end
   end
 end