recurly 3.0.0.beta.2 → 3.0.0.beta.3

data/lib/recurly/resources/custom_field.rb

@@ -0,0 +1,14 @@
+module Recurly
+  module Resources
+    class CustomField < Resource
+
+      # @!attribute name
+      #   @return [String] Fields must be created in the UI before values can be assigned to them.
+      define_attribute :name, String
+
+      # @!attribute value
+      #   @return [String] Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
+      define_attribute :value, String
+    end
+  end
+end

data/lib/recurly/resources/custom_field_definition.rb

@@ -0,0 +1,46 @@
+module Recurly
+  module Resources
+    class CustomFieldDefinition < Resource
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute [r] 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}
+
+      # @!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
+      #   @return [String] Custom field definition ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!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
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute related_type
+      #   @return [String] Related Recurly object type
+      define_attribute :related_type, String, {:enum => ["account", "subscription"]}
+
+      # @!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
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+
+      # @!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"]}
+    end
+  end
+end

data/lib/recurly/resources/error.rb

@@ -7,8 +7,8 @@ module Recurly
       define_attribute :message, String
 
       # @!attribute params
-      #   @return [Array[String]] Parameter specific errors
-      define_attribute :params, Array, {:item_type => String}
+      #   @return [Array[Hash]] Parameter specific errors
+      define_attribute :params, Array, {:item_type => Hash}
 
       # @!attribute type
       #   @return [String] Type

data/lib/recurly/resources/error_may_have_transaction.rb

@@ -7,8 +7,8 @@ module Recurly
       define_attribute :message, String
 
       # @!attribute params
-      #   @return [Array[String]] Parameter specific errors
-      define_attribute :params, Array, {:item_type => String}
+      #   @return [Array[Hash]] Parameter specific errors
+      define_attribute :params, Array, {:item_type => Hash}
 
       # @!attribute transaction_error
       #   @return [Hash] This is only included on errors with `type=transaction`.

data/lib/recurly/resources/invoice.rb

@@ -3,8 +3,8 @@ module Recurly
     class Invoice < Resource
 
       # @!attribute account
-      #   @return [Account]
-      define_attribute :account, :Account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
 
       # @!attribute address
       #   @return [Address]
@@ -51,8 +51,8 @@ module Recurly
       define_attribute :id, String, {:read_only => true}
 
       # @!attribute line_items
-      #   @return [Array[LineItem]] Line items
-      define_attribute :line_items, Array, {:item_type => :LineItem}
+      #   @return [LineItemList]
+      define_attribute :line_items, :LineItemList
 
       # @!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.

data/lib/recurly/resources/line_item.rb

@@ -3,8 +3,8 @@ module Recurly
     class LineItem < Resource
 
       # @!attribute account
-      #   @return [Account]
-      define_attribute :account, :Account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
 
       # @!attribute accounting_code
       #   @return [String] Internal accounting code to help you reconcile your revenue to the correct ledger. Line items created as part of a subscription invoice will use the plan or add-on's accounting code, otherwise the value will only be present if you define an accounting code when creating the line item.
@@ -63,7 +63,7 @@ module Recurly
       define_attribute :invoice_number, String
 
       # @!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_invoice_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.
+      #   @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"]}
 
       # @!attribute object

data/lib/recurly/resources/line_item_list.rb

@@ -0,0 +1,22 @@
+module Recurly
+  module Resources
+    class LineItemList < Resource
+
+      # @!attribute data
+      #   @return [Array[LineItem]]
+      define_attribute :data, Array, {:item_type => :LineItem}
+
+      # @!attribute has_more
+      #   @return [Boolean] Indicates there are more results on subsequent pages.
+      define_attribute :has_more, :Boolean
+
+      # @!attribute next
+      #   @return [String] Path to subsequent page of results.
+      define_attribute :next, String
+
+      # @!attribute object
+      #   @return [String] Will always be List.
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/plan.rb

@@ -6,6 +6,10 @@ module Recurly
       #   @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 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 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
@@ -15,8 +19,8 @@ module Recurly
       define_attribute :created_at, DateTime, {:read_only => true}
 
       # @!attribute currencies
-      #   @return [Array[String]] Pricing
-      define_attribute :currencies, Array, {:item_type => String}
+      #   @return [Array[Hash]] Pricing
+      define_attribute :currencies, Array, {:item_type => Hash}
 
       # @!attribute [r] deleted_at
       #   @return [DateTime] Deleted at

data/lib/recurly/resources/subscription.rb

@@ -3,8 +3,8 @@ module Recurly
     class Subscription < Resource
 
       # @!attribute account
-      #   @return [Account]
-      define_attribute :account, :Account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
 
       # @!attribute activated_at
       #   @return [DateTime] Activated at
@@ -18,6 +18,10 @@ module Recurly
       #   @return [Float] Total price of add-ons
       define_attribute :add_ons_total, Float
 
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
       # @!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
@@ -50,6 +54,18 @@ module Recurly
       #   @return [DateTime] Current billing period started at
       define_attribute :current_period_started_at, DateTime
 
+      # @!attribute current_term_ends_at
+      #   @return [DateTime] When the term ends. This is calculated by a plan's interval and `total_billing_cycles` in a term. Subscription changes with a `timeframe=renewal` will be applied on this date.
+      define_attribute :current_term_ends_at, DateTime
+
+      # @!attribute current_term_started_at
+      #   @return [DateTime] The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing periods.
+      define_attribute :current_term_started_at, DateTime
+
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]]
+      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+
       # @!attribute customer_notes
       #   @return [String] Customer notes
       define_attribute :customer_notes, String
@@ -74,13 +90,17 @@ module Recurly
       #   @return [String] Object type
       define_attribute :object, String
 
+      # @!attribute paused_at
+      #   @return [DateTime] Null unless subscription is paused or will pause at the end of the current billing period.
+      define_attribute :paused_at, DateTime
+
       # @!attribute pending_change
       #   @return [SubscriptionChange]
       define_attribute :pending_change, :SubscriptionChange
 
       # @!attribute plan
-      #   @return [Plan]
-      define_attribute :plan, :Plan
+      #   @return [PlanMini]
+      define_attribute :plan, :PlanMini
 
       # @!attribute po_number
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
@@ -91,9 +111,17 @@ module Recurly
       define_attribute :quantity, Integer
 
       # @!attribute remaining_billing_cycles
-      #   @return [Integer] Remaining billing cycles
+      #   @return [Integer] The remaining billing cycles in the current term.
       define_attribute :remaining_billing_cycles, Integer
 
+      # @!attribute remaining_pause_cycles
+      #   @return [Integer] Null unless subscription is paused or will pause at the end of the current billing period.
+      define_attribute :remaining_pause_cycles, Integer
+
+      # @!attribute renewal_billing_cycles
+      #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+      define_attribute :renewal_billing_cycles, Integer
+
       # @!attribute shipping_address
       #   @return [ShippingAddress]
       define_attribute :shipping_address, :ShippingAddress
@@ -110,6 +138,10 @@ module Recurly
       #   @return [String] Terms and conditions
       define_attribute :terms_and_conditions, String
 
+      # @!attribute total_billing_cycles
+      #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+      define_attribute :total_billing_cycles, Integer
+
       # @!attribute trial_ends_at
       #   @return [DateTime] Trial period ends at
       define_attribute :trial_ends_at, DateTime

data/lib/recurly/resources/subscription_add_on.rb

@@ -3,8 +3,8 @@ module Recurly
     class SubscriptionAddOn < Resource
 
       # @!attribute add_on
-      #   @return [AddOn]
-      define_attribute :add_on, :AddOn
+      #   @return [AddOnMini]
+      define_attribute :add_on, :AddOnMini
 
       # @!attribute created_at
       #   @return [DateTime] Created at

data/lib/recurly/resources/subscription_change.rb

@@ -31,8 +31,8 @@ module Recurly
       define_attribute :object, String
 
       # @!attribute plan
-      #   @return [Plan]
-      define_attribute :plan, :Plan
+      #   @return [PlanMini]
+      define_attribute :plan, :PlanMini
 
       # @!attribute quantity
       #   @return [Integer] Subscription quantity

data/lib/recurly/resources/transaction.rb

@@ -3,8 +3,8 @@ module Recurly
     class Transaction < Resource
 
       # @!attribute account
-      #   @return [Account]
-      define_attribute :account, :Account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
 
       # @!attribute amount
       #   @return [Float] Total transaction amount sent to the payment gateway.
@@ -71,8 +71,8 @@ module Recurly
       define_attribute :id, String
 
       # @!attribute invoice
-      #   @return [Invoice]
-      define_attribute :invoice, :Invoice
+      #   @return [InvoiceMini]
+      define_attribute :invoice, :InvoiceMini
 
       # @!attribute ip_address_country
       #   @return [String] IP address's country
@@ -139,8 +139,8 @@ module Recurly
       define_attribute :voided_at, DateTime
 
       # @!attribute voided_by_invoice
-      #   @return [Invoice]
-      define_attribute :voided_by_invoice, :Invoice
+      #   @return [InvoiceMini]
+      define_attribute :voided_by_invoice, :InvoiceMini
     end
   end
 end

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.0.0.beta.2"
+  VERSION = "3.0.0.beta.3"
 end

data/recurly.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday", "~> 0.12"
 
+  spec.add_development_dependency "net-http-persistent", "~> 2.9.4"
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.2
+  version: 3.0.0.beta.3
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,21 +136,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/bundle
-- bin/coderay
-- bin/console
-- bin/htmldiff
-- bin/ldiff
-- bin/pry
-- bin/rake
-- bin/rspec
-- bin/setup
-- bin/yard
-- bin/yardoc
-- bin/yri
 - lib/data/ca-certificates.crt
 - lib/recurly.rb
 - lib/recurly/client.rb
+- lib/recurly/client/adapter.rb
 - lib/recurly/client/operations.rb
 - lib/recurly/errors.rb
 - lib/recurly/errors/api_errors.rb
@@ -144,19 +147,20 @@ files:
 - lib/recurly/pager.rb
 - lib/recurly/request.rb
 - lib/recurly/requests/account_acquisition_updatable.rb
-- lib/recurly/requests/account_create_only.rb
-- lib/recurly/requests/account_updatable.rb
+- lib/recurly/requests/account_create.rb
+- lib/recurly/requests/account_update.rb
 - lib/recurly/requests/add_on_create.rb
 - lib/recurly/requests/add_on_update.rb
 - lib/recurly/requests/address.rb
 - lib/recurly/requests/billing_info_create.rb
-- lib/recurly/requests/coupon_create_only.rb
-- lib/recurly/requests/coupon_updatable.rb
-- lib/recurly/requests/create_account.rb
-- lib/recurly/requests/create_coupon.rb
+- lib/recurly/requests/coupon_bulk_create.rb
+- lib/recurly/requests/coupon_create.rb
+- lib/recurly/requests/coupon_redemption_create.rb
+- lib/recurly/requests/coupon_update.rb
 - lib/recurly/requests/invoice_create.rb
 - lib/recurly/requests/invoice_refund.rb
 - lib/recurly/requests/line_item_create.rb
+- lib/recurly/requests/line_item_refund.rb
 - lib/recurly/requests/plan_create.rb
 - lib/recurly/requests/plan_update.rb
 - lib/recurly/requests/shipping_address_create.rb
@@ -164,8 +168,8 @@ files:
 - lib/recurly/requests/subscription_add_on_create.rb
 - lib/recurly/requests/subscription_change_create.rb
 - lib/recurly/requests/subscription_create.rb
+- lib/recurly/requests/subscription_pause.rb
 - lib/recurly/requests/subscription_update.rb
-- lib/recurly/requests/update_coupon.rb
 - lib/recurly/resource.rb
 - lib/recurly/resources/account.rb
 - lib/recurly/resources/account_acquisition.rb
@@ -182,12 +186,15 @@ files:
 - lib/recurly/resources/coupon_redemption.rb
 - lib/recurly/resources/coupon_redemption_mini.rb
 - lib/recurly/resources/credit_payment.rb
+- lib/recurly/resources/custom_field.rb
+- lib/recurly/resources/custom_field_definition.rb
 - lib/recurly/resources/error.rb
 - lib/recurly/resources/error_may_have_transaction.rb
 - lib/recurly/resources/invoice.rb
 - lib/recurly/resources/invoice_collection.rb
 - lib/recurly/resources/invoice_mini.rb
 - lib/recurly/resources/line_item.rb
+- lib/recurly/resources/line_item_list.rb
 - lib/recurly/resources/plan.rb
 - lib/recurly/resources/plan_mini.rb
 - lib/recurly/resources/settings.rb

data/bin/bundle

@@ -1,105 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'bundle' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "rubygems"
-
-m = Module.new do
-    module_function
-
-  def invoked_as_script?
-    File.expand_path($0) == File.expand_path(__FILE__)
-  end
-
-  def env_var_version
-    ENV["BUNDLER_VERSION"]
-  end
-
-  def cli_arg_version
-    return unless invoked_as_script? # don't want to hijack other binstubs
-    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
-    bundler_version = nil
-    update_index = nil
-    ARGV.each_with_index do |a, i|
-      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
-        bundler_version = a
-      end
-      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
-      bundler_version = $1 || ">= 0.a"
-      update_index = i
-    end
-    bundler_version
-  end
-
-  def gemfile
-    gemfile = ENV["BUNDLE_GEMFILE"]
-    return gemfile if gemfile && !gemfile.empty?
-
-    File.expand_path("../../Gemfile", __FILE__)
-  end
-
-  def lockfile
-    lockfile =
-      case File.basename(gemfile)
-      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
-      else "#{gemfile}.lock"
-      end
-    File.expand_path(lockfile)
-  end
-
-  def lockfile_version
-    return unless File.file?(lockfile)
-    lockfile_contents = File.read(lockfile)
-    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
-    Regexp.last_match(1)
-  end
-
-  def bundler_version
-    @bundler_version ||= begin
-      env_var_version || cli_arg_version ||
-        lockfile_version || "#{Gem::Requirement.default}.a"
-    end
-  end
-
-  def load_bundler!
-    ENV["BUNDLE_GEMFILE"] ||= gemfile
-
-    # must dup string for RG < 1.8 compatibility
-    activate_bundler(bundler_version.dup)
-  end
-
-  def activate_bundler(bundler_version)
-    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
-      bundler_version = "< 2"
-    end
-    gem_error = activation_error_handling do
-      gem "bundler", bundler_version
-    end
-    return if gem_error.nil?
-    require_error = activation_error_handling do
-      require "bundler/version"
-    end
-    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
-    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
-    exit 42
-  end
-
-  def activation_error_handling
-    yield
-    nil
-  rescue StandardError, LoadError => e
-    e
-  end
-end
-
-m.load_bundler!
-
-if m.invoked_as_script?
-  load Gem.bin_path("bundler", "bundle")
-end