recurly 2.17.0 → 3.14.0

data/lib/recurly/resources/payment_method.rb

@@ -0,0 +1,66 @@
+# 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 PaymentMethod < Resource
+
+      # @!attribute account_type
+      #   @return [String] The bank account type. Only present for ACH payment methods.
+      define_attribute :account_type, String
+
+      # @!attribute billing_agreement_id
+      #   @return [String] Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
+      define_attribute :billing_agreement_id, String
+
+      # @!attribute card_type
+      #   @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
+      define_attribute :card_type, String
+
+      # @!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 gateway_code
+      #   @return [String] An identifier for a specific payment gateway.
+      define_attribute :gateway_code, String
+
+      # @!attribute gateway_token
+      #   @return [String] A token used in place of a credit card in order to perform transactions.
+      define_attribute :gateway_token, String
+
+      # @!attribute last_four
+      #   @return [String] Credit card number's last four digits. Will refer to bank account if payment method is ACH.
+      define_attribute :last_four, String
+
+      # @!attribute last_two
+      #   @return [String] The IBAN bank account's last two digits.
+      define_attribute :last_two, String
+
+      # @!attribute name_on_account
+      #   @return [String] The name associated with the bank account.
+      define_attribute :name_on_account, String
+
+      # @!attribute object
+      #   @return [String]
+      define_attribute :object, String
+
+      # @!attribute routing_number
+      #   @return [String] The bank account's routing number. Only present for ACH payment methods.
+      define_attribute :routing_number, String
+
+      # @!attribute routing_number_bank
+      #   @return [String] The bank name of this routing number.
+      define_attribute :routing_number_bank, String
+    end
+  end
+end

data/lib/recurly/resources/plan.rb

@@ -0,0 +1,118 @@
+# 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
+
+      # @!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 allow_any_item_on_subscriptions
+      #   @return [Boolean] Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.
+      define_attribute :allow_any_item_on_subscriptions, :Boolean
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_service_type, Integer
+
+      # @!attribute avalara_transaction_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the plan is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
+      define_attribute :avalara_transaction_type, Integer
+
+      # @!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 created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currencies
+      #   @return [Array[PlanPricing]] Pricing
+      define_attribute :currencies, Array, { :item_type => :PlanPricing }
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Optional description, not displayed.
+      define_attribute :description, String
+
+      # @!attribute hosted_pages
+      #   @return [PlanHostedPages] Hosted pages settings
+      define_attribute :hosted_pages, :PlanHostedPages
+
+      # @!attribute id
+      #   @return [String] Plan ID
+      define_attribute :id, String
+
+      # @!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
+
+      # @!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 object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, 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 setup_fee_revenue_schedule_type
+      #   @return [String] Setup fee revenue schedule type
+      define_attribute :setup_fee_revenue_schedule_type, String
+
+      # @!attribute state
+      #   @return [String] The current state of the plan.
+      define_attribute :state, String
+
+      # @!attribute tax_code
+      #   @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 you can use `unknown`, `physical`, or `digital`.
+      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_requires_billing_info
+      #   @return [Boolean] Allow free trial subscriptions to be created without billing info.
+      define_attribute :trial_requires_billing_info, :Boolean
+
+      # @!attribute trial_unit
+      #   @return [String] Units for the plan's trial period.
+      define_attribute :trial_unit, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    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

data/lib/recurly/resources/plan_mini.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 PlanMini < Resource
+
+      # @!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 id
+      #   @return [String] Plan ID
+      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 object
+      #   @return [String] Object type
+      define_attribute :object, String
+    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/pricing.rb

@@ -0,0 +1,18 @@
+# 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 Pricing < Resource
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute unit_amount
+      #   @return [Float] Unit price
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/resources/settings.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 Settings < Resource
+
+      # @!attribute accepted_currencies
+      #   @return [Array[String]]
+      define_attribute :accepted_currencies, Array, { :item_type => String }
+
+      # @!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
+
+      # @!attribute default_currency
+      #   @return [String] The default 3-letter ISO 4217 currency code.
+      define_attribute :default_currency, String
+    end
+  end
+end

data/lib/recurly/resources/shipping_address.rb

@@ -0,0 +1,82 @@
+# 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 account_id
+      #   @return [String] Account ID
+      define_attribute :account_id, String
+
+      # @!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 created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute email
+      #   @return [String]
+      define_attribute :email, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute id
+      #   @return [String] Shipping Address ID
+      define_attribute :id, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute nickname
+      #   @return [String]
+      define_attribute :nickname, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, 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 updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+
+      # @!attribute vat_number
+      #   @return [String]
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/resources/shipping_method.rb

@@ -0,0 +1,46 @@
+# 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 ShippingMethod < Resource
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for shipping method.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @return [String] The internal name used identify the shipping method.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute id
+      #   @return [String] Shipping Method ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are:  - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
+      define_attribute :tax_code, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/shipping_method_mini.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 ShippingMethodMini < Resource
+
+      # @!attribute code
+      #   @return [String] The internal name used identify the shipping method.
+      define_attribute :code, String
+
+      # @!attribute id
+      #   @return [String] Shipping Method ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/site.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 Site < Resource
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      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 id
+      #   @return [String] Site ID
+      define_attribute :id, String
+
+      # @!attribute mode
+      #   @return [String] Mode
+      define_attribute :mode, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute public_api_key
+      #   @return [String] This value is used to configure RecurlyJS to submit tokenized billing information.
+      define_attribute :public_api_key, String
+
+      # @!attribute settings
+      #   @return [Settings]
+      define_attribute :settings, :Settings
+
+      # @!attribute subdomain
+      #   @return [String]
+      define_attribute :subdomain, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end