recurly 2.18.21 → 3.0.0.beta.1

data/lib/recurly/resources/plan.rb

@@ -0,0 +1,86 @@
+module Recurly
+  module Resources
+    class Plan < Resource
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @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
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute currencies
+      #   @return [Array[String]] Pricing
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute [r] deleted_at
+      #   @return [DateTime] Deleted at
+      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
+
+      # @!attribute [r] id
+      #   @return [String] Plan ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute interval_length
+      #   @return [Integer] Length of the plan's billing interval in `interval_unit`.
+      define_attribute :interval_length, Integer
+
+      # @!attribute interval_unit
+      #   @return [String] Unit for the plan's billing interval.
+      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.
+      define_attribute :name, String
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      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.
+      define_attribute :setup_fee_accounting_code, String
+
+      # @!attribute [r] state
+      #   @return [String] The current state of the plan.
+      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.
+      define_attribute :tax_code, String
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] `true` exempts tax on the plan, `false` applies tax on the plan.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] Automatically terminate subscriptions after a defined number of billing cycles. Number of billing cycles before the plan automatically stops renewing, defaults to `null` for continuous, automatic renewal.
+      define_attribute :total_billing_cycles, Integer
+
+      # @!attribute trial_length
+      #   @return [Integer] Length of plan's trial period in `trial_units`. `0` means `no trial`.
+      define_attribute :trial_length, Integer
+
+      # @!attribute trial_unit
+      #   @return [String] Units for the plan's trial period.
+      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}
+    end
+  end
+end

data/lib/recurly/resources/settings.rb

@@ -0,0 +1,18 @@
+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}
+
+      # @!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"]}
+
+      # @!attribute [r] default_currency
+      #   @return [String] The default 3-letter ISO 4217 currency code.
+      define_attribute :default_currency, String, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/shipping_address.rb

@@ -0,0 +1,74 @@
+module Recurly
+  module Resources
+    class ShippingAddress < Resource
+
+      # @!attribute [r] account_id
+      #   @return [String] Account ID
+      define_attribute :account_id, String, {:read_only => true}
+
+      # @!attribute city
+      #   @return [String]
+      define_attribute :city, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO code.
+      define_attribute :country, String
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute email
+      #   @return [String]
+      define_attribute :email, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute [r] id
+      #   @return [String] Shipping Address ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute nickname
+      #   @return [String]
+      define_attribute :nickname, String
+
+      # @!attribute phone
+      #   @return [String]
+      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]
+      define_attribute :street1, String
+
+      # @!attribute street2
+      #   @return [String]
+      define_attribute :street2, String
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+
+      # @!attribute vat_number
+      #   @return [String]
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/resources/site.rb

@@ -0,0 +1,46 @@
+module Recurly
+  module Resources
+    class Site < Resource
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute [r] deleted_at
+      #   @return [DateTime] Deleted at
+      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}
+
+      # @!attribute [r] id
+      #   @return [String] Site ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute [r] mode
+      #   @return [String] Mode
+      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}
+
+      # @!attribute settings
+      #   @return [Settings]
+      define_attribute :settings, :Settings
+
+      # @!attribute [r] subdomain
+      #   @return [String]
+      define_attribute :subdomain, String, {:read_only => true}
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/subscription.rb

@@ -0,0 +1,134 @@
+module Recurly
+  module Resources
+    class Subscription < Resource
+
+      # @!attribute account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
+
+      # @!attribute activated_at
+      #   @return [DateTime] Activated at
+      define_attribute :activated_at, DateTime
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOn]] Add-ons
+      define_attribute :add_ons, Array, {:item_type => :SubscriptionAddOn}
+
+      # @!attribute add_ons_total
+      #   @return [Float] Total price of add-ons
+      define_attribute :add_ons_total, Float
+
+      # @!attribute bank_account_authorized_at
+      #   @return [DateTime] Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared.
+      define_attribute :bank_account_authorized_at, DateTime
+
+      # @!attribute canceled_at
+      #   @return [DateTime] Canceled at
+      define_attribute :canceled_at, DateTime
+
+      # @!attribute collection_method
+      #   @return [String] Collection method
+      define_attribute :collection_method, String, {:enum => ["automatic", "manual"]}
+
+      # @!attribute coupon_redemptions
+      #   @return [Array[CouponRedemptionMini]] Coupon redemptions
+      define_attribute :coupon_redemptions, Array, {:item_type => :CouponRedemptionMini}
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute current_period_ends_at
+      #   @return [DateTime] Current billing period ends at
+      define_attribute :current_period_ends_at, DateTime
+
+      # @!attribute current_period_started_at
+      #   @return [DateTime] Current billing period started at
+      define_attribute :current_period_started_at, DateTime
+
+      # @!attribute customer_notes
+      #   @return [String] Customer notes
+      define_attribute :customer_notes, String
+
+      # @!attribute expiration_reason
+      #   @return [String] Expiration reason
+      define_attribute :expiration_reason, String
+
+      # @!attribute expires_at
+      #   @return [DateTime] Expires at
+      define_attribute :expires_at, DateTime
+
+      # @!attribute id
+      #   @return [String] Subscription ID
+      define_attribute :id, String
+
+      # @!attribute net_terms
+      #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+      define_attribute :net_terms, Integer
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute pending_change
+      #   @return [SubscriptionChange]
+      define_attribute :pending_change, :SubscriptionChange
+
+      # @!attribute plan
+      #   @return [PlanMini]
+      define_attribute :plan, :PlanMini
+
+      # @!attribute po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!attribute quantity
+      #   @return [Integer] Subscription quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute remaining_billing_cycles
+      #   @return [Integer] Remaining billing cycles
+      define_attribute :remaining_billing_cycles, Integer
+
+      # @!attribute shipping_address
+      #   @return [ShippingAddress]
+      define_attribute :shipping_address, :ShippingAddress
+
+      # @!attribute state
+      #   @return [String] State
+      define_attribute :state, String, {:enum => ["active", "canceled", "expired", "failed", "future", "paused"]}
+
+      # @!attribute subtotal
+      #   @return [Float] Estimated total, before tax.
+      define_attribute :subtotal, Float
+
+      # @!attribute terms_and_conditions
+      #   @return [String] Terms and conditions
+      define_attribute :terms_and_conditions, String
+
+      # @!attribute trial_ends_at
+      #   @return [DateTime] Trial period ends at
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute trial_started_at
+      #   @return [DateTime] Trial period started at
+      define_attribute :trial_started_at, DateTime
+
+      # @!attribute unit_amount
+      #   @return [Float] Subscription unit price
+      define_attribute :unit_amount, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      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
+    end
+  end
+end

data/lib/recurly/resources/subscription_add_on.rb

@@ -0,0 +1,42 @@
+module Recurly
+  module Resources
+    class SubscriptionAddOn < Resource
+
+      # @!attribute add_on
+      #   @return [AddOnMini]
+      define_attribute :add_on, :AddOnMini
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute expired_at
+      #   @return [DateTime] Expired at
+      define_attribute :expired_at, DateTime
+
+      # @!attribute id
+      #   @return [String] Subscription Add-on ID
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute quantity
+      #   @return [Integer] Add-on quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute subscription_id
+      #   @return [String] Subscription ID
+      define_attribute :subscription_id, String
+
+      # @!attribute unit_amount
+      #   @return [Float] This is priced in the subscription's currency.
+      define_attribute :unit_amount, Float
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/subscription_change.rb

@@ -0,0 +1,54 @@
+module Recurly
+  module Resources
+    class SubscriptionChange < Resource
+
+      # @!attribute [r] activate_at
+      #   @return [DateTime] Activated at
+      define_attribute :activate_at, DateTime, {:read_only => true}
+
+      # @!attribute activated
+      #   @return [Boolean] Returns `true` if the subscription change is activated.
+      define_attribute :activated, :Boolean
+
+      # @!attribute add_ons
+      #   @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
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute [r] deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime, {:read_only => true}
+
+      # @!attribute id
+      #   @return [String] The ID of the Subscription Change.
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute plan
+      #   @return [PlanMini]
+      define_attribute :plan, :PlanMini
+
+      # @!attribute quantity
+      #   @return [Integer] Subscription quantity
+      define_attribute :quantity, Integer
+
+      # @!attribute subscription_id
+      #   @return [String] The ID of the subscription that is going to be changed.
+      define_attribute :subscription_id, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit amount
+      define_attribute :unit_amount, Float
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+    end
+  end
+end