recurly 2.20.3 → 3.0.0.beta.1

data/lib/recurly/billing_info.rb

@@ -1,134 +0,0 @@
-module Recurly
-  # Represents an account's Billing Information. You normally want to use a token when creating billing information.
-  #
-  # Recurly Documentation: https://dev.recurly.com/docs/create-an-accounts-billing-info-token
-  class BillingInfo < Resource
-    BANK_ACCOUNT_ATTRIBUTES = %w(name_on_account account_type last_four routing_number).freeze
-    CREDIT_CARD_ATTRIBUTES = %w(number verification_value card_type year month first_six last_four).freeze
-    AMAZON_ATTRIBUTES = %w(amazon_billing_agreement_id amazon_region).freeze
-    PAYPAL_ATTRIBUTES = %w(paypal_billing_agreement_id).freeze
-    ROKU_ATTRIBUTES = %w(roku_billing_agreement_id last_four).freeze
-    SEPA_ATTRIBUTES = %w(iban last_two).freeze
-    BACS_ATTRIBUTES = %w(account_number sort_code type).freeze
-    BECS_ATTRIBUTES = %w(account_number bsb_code type).freeze
-    VENMO_ATTRIBUTES = %w(username).freeze
-
-    # @return [Account]
-    belongs_to :account
-
-    has_one :gateway_attribute, class_name: :GatewayAttribute, readonly: false
-
-    define_attribute_methods %w(
-      uuid
-      first_name
-      last_name
-      company
-      address1
-      address2
-      city
-      state
-      zip
-      country
-      phone
-      vat_number
-      ip_address
-      ip_address_country
-      token_id
-      currency
-      geo_code
-      updated_at
-      external_hpp_type
-      gateway_token
-      gateway_code
-      fraud_session_id
-      three_d_secure_action_result_token_id
-      transaction_type
-      mandate_reference
-      tax_identifier
-      tax_identifier_type
-      primary_payment_method
-      backup_payment_method
-      cc_bin_country
-      online_banking_payment_type
-      card_network_preference
-    ) | CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES | AMAZON_ATTRIBUTES | PAYPAL_ATTRIBUTES | ROKU_ATTRIBUTES | SEPA_ATTRIBUTES | BACS_ATTRIBUTES | BECS_ATTRIBUTES | VENMO_ATTRIBUTES
-
-    # Verify an account's stored billing info
-    #
-    # @param [Hash] gateway_code (optional) is the code for the gateway to use for verification. If unspecified, a gateway will be selected using the normal rules.
-    # @return [Transaction]
-    # @raise [Invalid] Raise if the account's billing info cannot be verified
-    def verify(attrs = {})
-      Transaction.from_response API.post("#{path}/verify", attrs.empty? ? nil : Verify.to_xml(attrs))
-    end
-
-    def self.to_xml(attrs)
-      billing_info = new attrs
-      billing_info.to_xml
-    end
-
-    # Verify a credit card CVV
-    #
-    # @param [Hash] verification_value is the credit card CVV
-    # @return [BillingInfo]
-    def verify_cvv(attrs = {})
-      BillingInfo.from_response API.post("#{path}/verify_cvv", attrs.empty? ? nil : self.class.to_xml(attrs))
-    end
-
-    # @return [String]
-    def inspect
-      attributes = self.class.attribute_names
-      case type
-      when 'credit_card'
-        attributes -= (AMAZON_ATTRIBUTES + PAYPAL_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES + ROKU_ATTRIBUTES + SEPA_ATTRIBUTES + BACS_ATTRIBUTES + BECS_ATTRIBUTES + VENMO_ATTRIBUTES)
-        attributes |= CREDIT_CARD_ATTRIBUTES
-      when 'paypal'
-        attributes -= (CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES + AMAZON_ATTRIBUTES + ROKU_ATTRIBUTES + SEPA_ATTRIBUTES + BACS_ATTRIBUTES + BECS_ATTRIBUTES + VENMO_ATTRIBUTES)
-      when 'amazon'
-        attributes -= (CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES + PAYPAL_ATTRIBUTES + ROKU_ATTRIBUTES + SEPA_ATTRIBUTES + BACS_ATTRIBUTES + BECS_ATTRIBUTES + VENMO_ATTRIBUTES)
-      when 'bank_account'
-        attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + ROKU_ATTRIBUTES + SEPA_ATTRIBUTES + BACS_ATTRIBUTES + BECS_ATTRIBUTES + VENMO_ATTRIBUTES)
-        attributes |= BANK_ACCOUNT_ATTRIBUTES
-      when 'roku'
-        attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES + SEPA_ATTRIBUTES + BACS_ATTRIBUTES + BECS_ATTRIBUTES + VENMO_ATTRIBUTES)
-        attributes |= ROKU_ATTRIBUTES
-      when 'sepa'
-        attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES + ROKU_ATTRIBUTES + BACS_ATTRIBUTES + BECS_ATTRIBUTES + VENMO_ATTRIBUTES)
-        attributes |= SEPA_ATTRIBUTES
-      when 'bacs'
-        attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES + ROKU_ATTRIBUTES + SEPA_ATTRIBUTES + BECS_ATTRIBUTES + VENMO_ATTRIBUTES)
-        attributes |= BACS_ATTRIBUTES
-      when 'becs'
-        attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES + ROKU_ATTRIBUTES + SEPA_ATTRIBUTES + BACS_ATTRIBUTES + VENMO_ATTRIBUTES)
-        attributes |= BECS_ATTRIBUTES
-      when 'venmo'
-        attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES + ROKU_ATTRIBUTES + SEPA_ATTRIBUTES + BACS_ATTRIBUTES + BECS_ATTRIBUTES)
-        attributes |= VENMO_ATTRIBUTES
-      end
-      super attributes
-    end
-
-    # @return ["credit_card", "paypal", "amazon", "bank_account", "roku", "sepa", "bacs", "becs", nil] The type of billing info.
-    def type
-      self[:type] || @type
-    end
-
-    class << self
-      # Overrides the inherited member_path method to allow for billing info's
-      # irregular URL structure.
-      #
-      # @return [String] The relative path to an account's billing info from the
-      #   API's base URI.
-      # @param uuid [String]
-      # @example
-      #   Recurly::BillingInfo.member_path "code"
-      #   # => "accounts/code/billing_info"
-      def member_path uuid
-        "accounts/#{uuid}/billing_info"
-      end
-    end
-
-    # Billing info is only writeable through an {Account} instance.
-    embedded!
-  end
-end

data/lib/recurly/business_entity.rb

@@ -1,35 +0,0 @@
-module Recurly
-  class BusinessEntity < Resource
-    belongs_to :site
-    belongs_to :default_revenue_gl_account, class_name: 'GeneralLedgerAccount'
-    belongs_to :default_liability_gl_account, class_name: 'GeneralLedgerAccount'
-
-    has_many :invoices
-    has_many :accounts
-
-    define_attribute_methods %w(
-      id
-      code
-      name
-      invoice_display_address
-      tax_address
-      origin_tax_address_source
-      destination_tax_address_source
-      subscriber_location_countries
-      default_vat_number
-      default_registration_number
-      default_revenue_gl_account_id
-      default_liability_gl_account_id
-      created_at
-      updated_at
-    )
-
-    def self.collection_path
-      "business_entities"
-    end
-
-    # We do not expose PUT or POST in the v2 API.
-    protected(*%w(save save!))
-    private_class_method(*%w(create! create))
-  end
-end

data/lib/recurly/coupon.rb

@@ -1,136 +0,0 @@
-module Recurly
-
-  # Recurly Documentation: https://dev.recurly.com/docs/list-active-coupons
-  class Coupon < Resource
-    BULK = 'bulk'.freeze
-    SINGLE_CODE = 'single_code'.freeze
-
-    # @macro [attach] scope
-    #   @scope class
-    #   @return [Pager<Coupon>] A pager that yields +$1+ coupons.
-    scope :redeemable, :state => :redeemable
-    scope :expired,    :state => :expired
-    scope :maxed_out,  :state => :maxed_out
-
-    # @return [Pager<Redemption>, []] A pager that yields Redemptions
-    has_many :redemptions
-
-    # @return [Pager<Coupon>, []] A pager that yields coupon-code type Coupons
-    has_many :unique_coupon_codes, class_name: :Coupon
-
-    define_attribute_methods %w(
-      id
-      coupon_code
-      name
-      state
-      discount_type
-      discount_percent
-      discount_in_cents
-      redeem_by_date
-      single_use
-      applies_for_months
-      duration
-      temporal_unit
-      temporal_amount
-      max_redemptions
-      max_redemptions_per_account
-      applies_to_all_plans
-      created_at
-      updated_at
-      plan_codes
-      description
-      invoice_description
-      applies_to_non_plan_charges
-      redemption_resource
-      coupon_type
-      unique_template_code
-      free_trial_amount
-      free_trial_unit
-      applies_to_all_items
-      item_codes
-    )
-    alias to_param coupon_code
-
-    # Redeem a coupon with a given account or account code.
-    #
-    # @return [true]
-    # @param account_or_code [Account, String]
-    # @param currency [String] Three-letter currency code
-    # @param extra_opts [Hash] extra options that go into the {Redemption}
-    # @example
-    #   coupon = Coupon.find(coupon_code)
-    #   coupon.redeem(account_code, 'USD', subscription_uuid: 'ab3b1dbabc3195')
-    #
-    #   coupon = Coupon.find(coupon_code)
-    #   account = Account.find(account_code)
-    #   coupon.redeem(account)
-    def redeem account_or_code, currency = nil, extra_opts={}
-      return false unless link? :redeem
-
-      account_code = if account_or_code.is_a? Account
-        account_or_code.account_code
-      else
-        account_or_code
-      end
-
-      redemption_options = {
-        :account_code => account_code,
-        :currency     => currency || Recurly.default_currency
-      }.merge(extra_opts)
-
-      redemption = Redemption.new(redemption_options)
-
-      Redemption.from_response follow_link(:redeem,
-        :body => redemption.to_xml
-      )
-    rescue API::UnprocessableEntity => e
-      redemption.apply_errors e
-      redemption
-    end
-
-    # Generate unique coupon codes on the server. This is based on the unique_template_code.
-    #
-    # @param amount [Integer]
-    # @return [Pager<Coupon>] A pager that yields the coupon-code type Coupons
-    # @example
-    #   unique_codes = coupon.generate(10)
-    #   unique_codes.each do |c|
-    #     puts c.coupon_code
-    #   end
-    def generate(amount)
-      builder = XML.new("<coupon/>")
-      builder.add_element 'number_of_unique_codes', amount
-
-      resp = follow_link(:generate,
-        :body => builder.to_s
-      )
-
-      Pager.new(Recurly::Coupon, uri: resp['location'], parent: self, etag: resp['ETag'])
-    end
-
-    # Redeem a coupon on the given account code
-    #
-    # @param account_code [String] Acccount's account code
-    # @param currency [String] Three-letter currency code
-    # @raise [Invalid] If the coupon cannot be redeemed
-    # @return [Redemption] The Coupon Redemption
-    def redeem!(account_code, currency = nil)
-      redemption = redeem(account_code, currency)
-      raise Invalid.new(self) unless redemption && redemption.persisted?
-      redemption
-    end
-
-    # Restores the coupon
-    def restore!
-      return false unless link? :restore
-      reload follow_link(:restore, body: self.to_xml(delta: true))
-    end
-
-    # Will return true if there are no limits on number of redemptions for this Coupon.
-    #
-    # @return [true, false]
-    def unlimited_redemptions_per_account?
-      !max_redemptions_per_account
-    end
-  end
-end

data/lib/recurly/credit_payment.rb

@@ -1,32 +0,0 @@
-module Recurly
-  class CreditPayment < Resource
-    # @return [Account, nil]
-    belongs_to :account, class_name: :Account, readonly: true
-
-    # @return [Invoice, nil]
-    has_one :original_invoice, class_name: :Invoice, readonly: true
-
-    # @return [Invoice, nil]
-    has_one :applied_to_invoice, class_name: :Invoice, readonly: true
-
-    define_attribute_methods %w(
-      action
-      amount_in_cents
-      applied_to_invoice_number
-      currency
-      created_at
-      original_credit_payment
-      original_credit_payment_uuid
-      original_invoice_number
-      refund_transaction
-      refund_transaction_uuid
-      updated_at
-      uuid
-      voided_at
-    )
-    alias to_param uuid
-
-    # @return ["charge", "credit", nil] The type of credit payment.
-    attr_reader :type
-  end
-end

data/lib/recurly/currency_percentage_tier.rb

@@ -1,17 +0,0 @@
-module Recurly
-  class CurrencyPercentageTier < Resource
-
-    belongs_to :add_on
-    has_many :tiers, class_name: :PercentageTier, readonly: false
-
-    define_attribute_methods %w(
-      currency
-    )
-
-    def xml_keys
-      attributes.keys
-    end
-
-    embedded! true
-  end
-end

data/lib/recurly/custom_field.rb

@@ -1,15 +0,0 @@
-module Recurly
-  # Recurly Documentation: https://dev.recurly.com/docs/custom-fields
-  class CustomField < Resource
-
-    define_attribute_methods %w(
-      name
-      value
-    )
-
-    # include the name with the serialized field, even though it can't change
-    def xml_keys
-      attributes.keys
-    end
-  end
-end

data/lib/recurly/custom_field_definition.rb

@@ -1,14 +0,0 @@
-module Recurly
-  class CustomFieldDefinition < Resource
-    define_attribute_methods %w(
-      id
-      related_type
-      name
-      user_access
-      display_name
-      tooltip
-      created_at
-      updated_at
-    )
-  end
-end

data/lib/recurly/customer_permission.rb

@@ -1,10 +0,0 @@
-module Recurly
-  class CustomerPermission < Resource
-    define_attribute_methods %w(
-      id
-      code
-      name
-      description
-    )
-  end
-end

data/lib/recurly/delivery.rb

@@ -1,19 +0,0 @@
-module Recurly
-  # Delivery objects are only used with GiftCards.
-  #
-  # Recurly Documentation: https://dev.recurly.com/docs/gift-card-object
-  class Delivery < Resource
-    # @return [Address, nil]
-    has_one :address
-
-    define_attribute_methods %w(
-      deliver_at
-      email_address
-      first_name
-      gifter_name
-      last_name
-      method
-      personal_message
-    )
-  end
-end

data/lib/recurly/dunning_campaign.rb

@@ -1,30 +0,0 @@
-module Recurly
-  # Recurly Documentation: https://developers.recurly.com/api-v2/latest/index.html#tag/dunning-campaigns
-  class DunningCampaign < Resource
-    # @return [[DunningCycle], []]
-    has_many :dunning_cycles
-
-    define_attribute_methods %w(
-      id
-      name
-      code
-      description
-      default_campaign
-      dunning_cycles
-      created_at
-      updated_at
-      deleted_at
-    )
-
-    def bulk_update(plan_codes)
-      return false unless link? :bulk_update
-
-      builder = XML.new("<dunning_campaign/>")
-      node = builder.add_element("plan_codes")
-      plan_codes.each { |plan_code| node.add_element "plan_code", plan_code }
-
-      reload follow_link(:bulk_update, :body => builder.to_s)
-      true
-    end
-  end
-end

data/lib/recurly/dunning_cycle.rb

@@ -1,18 +0,0 @@
-module Recurly
-  class DunningCycle < Resource
-    define_attribute_methods %w(
-      type
-      applies_to_manual_trial
-      first_communication_interval
-      send_immediately_on_hard_decline
-      intervals
-      expire_subscription
-      fail_invoice
-      total_dunning_days
-      total_recycling_days
-      version
-      created_at
-      updated_at
-    )
-  end
-end

data/lib/recurly/entitlement.rb

@@ -1,19 +0,0 @@
-module Recurly
-  class Entitlement < Resource
-    # @return [Account]
-    belongs_to :account
-
-    define_attribute_methods %w(
-      account
-      customer_permission
-      granted_by
-      created_at
-      updated_at
-    )
-
-    # This object does not represent a model on the server side
-    # so we do not need to expose these methods.
-    protected(*%w(save save!))
-    private_class_method(*%w(all find_each first paginate scoped where create! create))
-  end
-end

data/lib/recurly/error.rb

@@ -1,13 +0,0 @@
-module Recurly
-  # The exception class from which all Recurly exceptions inherit.
-  class Error < StandardError
-    def set_message message
-      @message = message
-    end
-
-    # @return [String]
-    def to_s
-      defined? @message and @message or super
-    end
-  end
-end

data/lib/recurly/external_account.rb

@@ -1,17 +0,0 @@
-module Recurly
-  class ExternalAccount < Resource
-    belongs_to :account
-
-    define_attribute_methods %w(
-      id
-      external_account_code
-      external_connection_type
-      created_at
-      updated_at
-    )
-
-    # External Accounts are only writeable and readable through {Account} instances.
-    embedded!
-    private_class_method :find
-  end
-end

data/lib/recurly/external_charge.rb

@@ -1,20 +0,0 @@
-module Recurly
-  class ExternalCharge < Resource
-    belongs_to :account
-    belongs_to :external_invoice
-    belongs_to :external_product_reference, optional: true
-
-    define_attribute_methods %w(
-      description
-      unit_amount
-      currency
-      quantity
-      created_at
-      updated_at
-    )
-
-    # We do not expose POST or PUT via the v2 API
-    protected(*%w(save save!))
-    private_class_method(*%w(create! create))
-  end
-end

data/lib/recurly/external_invoice.rb

@@ -1,27 +0,0 @@
-module Recurly
-  class ExternalInvoice < Resource
-
-    # @return [Plan]
-    belongs_to :site
-    belongs_to :account
-    belongs_to :external_subscription
-    belongs_to :external_payment_phase
-
-    # @return [[ExternalCharge], nil]
-    has_many :line_items, class_name: :ExternalCharge
-
-    define_attribute_methods %w(
-      external_id
-      state
-      currency
-      total
-      purchased_at
-      created_at
-      updated_at
-    )
-
-    # We do not expose POST or PUT via the v2 API
-    protected(*%w(save save!))
-    private_class_method(*%w(create! create))
-  end
-end

data/lib/recurly/external_payment_phase.rb

@@ -1,27 +0,0 @@
-module Recurly
-  class ExternalPaymentPhase < Resource
-
-    # @return [ExternalSubscription]
-    belongs_to :external_subscription
-
-    define_attribute_methods %w(
-      id
-      started_at
-      ends_at
-      starting_billing_period_index
-      ending_billing_period_index
-      offer_type
-      offer_name
-      period_count
-      period_length
-      amount
-      currency
-      created_at
-      updated_at
-    )
-
-    # We do not expose POST or PUT via the v2 API
-    protected(*%w(save save!))
-    private_class_method(*%w(create! create))
-  end
-end

data/lib/recurly/external_product.rb

@@ -1,34 +0,0 @@
-module Recurly
-  class ExternalProduct < Resource
-
-    # @return [Plan]
-    belongs_to :plan
-
-    # @return array [ExternalProductReference]
-    has_many :external_product_references
-
-    define_attribute_methods %w(
-      name
-      created_at
-      updated_at
-    )
-
-    def create_external_product_reference(external_product_reference)
-      external_product_reference.uri = "#{path}/external_product_references"
-      external_product_reference.save!
-      external_product_reference
-    end
-
-    def get_external_product_references
-      Pager.new(Recurly::ExternalProductReference, uri: "#{path}/external_product_references", parent: self)
-    rescue Recurly::API::UnprocessableEntity => e
-      raise Invalid, e.message
-    end
-
-    def get_external_product_reference(external_product_reference_uuid)
-      ExternalProductReference.from_response API.get("#{path}/external_product_references/#{external_product_reference_uuid}")
-    rescue Recurly::API::UnprocessableEntity => e
-      raise Invalid, e.message
-    end
-  end
-end

data/lib/recurly/external_product_reference.rb

@@ -1,18 +0,0 @@
-module Recurly
-  class ExternalProductReference < Resource
-
-    # @return [ExternalProduct]
-    belongs_to :external_product
-
-    define_attribute_methods %w(
-      id
-      reference_code
-      external_connection_type
-      created_at
-      updated_at
-    )
-
-    # ExternalProductReferences are only writeable and readable through {ExternalProduct} instances.
-    embedded! true
-  end
-end