recurly 2.18.22 → 3.0.0.beta.1

data/lib/recurly/resources/account.rb

@@ -0,0 +1,86 @@
+module Recurly
+  module Resources
+    class Account < Resource
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute billing_info
+      #   @return [BillingInfo]
+      define_attribute :billing_info, :BillingInfo
+
+      # @!attribute cc_emails
+      #   @return [String] Additional email address that should receive account correspondence. These should be separated only by commas. These CC emails will receive all emails that the `email` field also receives.
+      define_attribute :cc_emails, String
+
+      # @!attribute [r] code
+      #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
+      define_attribute :code, String, {:read_only => true}
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] When the account was created.
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute [r] deleted_at
+      #   @return [DateTime] If present, when the account was last marked inactive.
+      define_attribute :deleted_at, DateTime, {:read_only => true}
+
+      # @!attribute email
+      #   @return [String] The email address used for communicating with this customer. The customer will also use this email address to log into your hosted account management pages. This value does not need to be unique.
+      define_attribute :email, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute [r] hosted_login_token
+      #   @return [String] The unique token for automatically logging the account in to the hosted management pages. You may automatically log the user into their hosted management pages by directing the user to: `https://{subdomain}.recurly.com/account/{hosted_login_token}`.
+      define_attribute :hosted_login_token, String, {:read_only => true}
+
+      # @!attribute [r] id
+      #   @return [String]
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute preferred_locale
+      #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer.
+      define_attribute :preferred_locale, String, {:enum => ["da-DK", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-NZ", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "ja-JP", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN"]}
+
+      # @!attribute shipping_addresses
+      #   @return [Array[ShippingAddress]] The shipping addresses on the account.
+      define_attribute :shipping_addresses, Array, {:item_type => :ShippingAddress}
+
+      # @!attribute [r] state
+      #   @return [String] Accounts can be either active or inactive.
+      define_attribute :state, String, {:read_only => true, :enum => ["active", "inactive"]}
+
+      # @!attribute tax_exempt
+      #   @return [Boolean] The tax status of the account. `true` exempts tax on the account, `false` applies tax on the account.
+      define_attribute :tax_exempt, :Boolean
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] When the account was last changed.
+      define_attribute :updated_at, DateTime, {:read_only => true}
+
+      # @!attribute username
+      #   @return [String] A secondary value for the account.
+      define_attribute :username, String
+
+      # @!attribute vat_number
+      #   @return [String] The VAT number of the account (to avoid having the VAT applied). This is only used for manually collected invoices.
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/resources/account_acquisition.rb

@@ -0,0 +1,42 @@
+module Recurly
+  module Resources
+    class AccountAcquisition < Resource
+
+      # @!attribute account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
+
+      # @!attribute campaign
+      #   @return [String] An arbitrary identifier for the marketing campaign that led to the acquisition of this account.
+      define_attribute :campaign, String
+
+      # @!attribute channel
+      #   @return [String] The channel through which the account was acquired.
+      define_attribute :channel, String, {:enum => ["referral", "social_media", "email", "paid_search", "organic_search", "direct_traffic", "marketing_content", "blog", "events", "outbound_sales", "advertising", "public_relations", "other"]}
+
+      # @!attribute cost
+      #   @return [Hash] Account balance
+      define_attribute :cost, Hash
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] When the account acquisition data was created.
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute [r] id
+      #   @return [String]
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute subchannel
+      #   @return [String] An arbitrary subchannel string representing a distinction/subcategory within a broader channel.
+      define_attribute :subchannel, String
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] When the account acquisition data was last changed.
+      define_attribute :updated_at, DateTime, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/account_balance.rb

@@ -0,0 +1,22 @@
+module Recurly
+  module Resources
+    class AccountBalance < Resource
+
+      # @!attribute account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
+
+      # @!attribute balances
+      #   @return [Hash] Account balance
+      define_attribute :balances, Hash
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute past_due
+      #   @return [Boolean]
+      define_attribute :past_due, :Boolean
+    end
+  end
+end

data/lib/recurly/resources/account_note.rb

@@ -0,0 +1,30 @@
+module Recurly
+  module Resources
+    class AccountNote < Resource
+
+      # @!attribute account_id
+      #   @return [String]
+      define_attribute :account_id, String
+
+      # @!attribute [r] created_at
+      #   @return [DateTime]
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute [r] id
+      #   @return [String]
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute message
+      #   @return [String]
+      define_attribute :message, String
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute user
+      #   @return [User]
+      define_attribute :user, :User
+    end
+  end
+end

data/lib/recurly/resources/add_on.rb

@@ -0,0 +1,62 @@
+module Recurly
+  module Resources
+    class AddOn < Resource
+
+      # @!attribute accounting_code
+      #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code.
+      define_attribute :accounting_code, String
+
+      # @!attribute code
+      #   @return [String] The unique identifier for the add-on within its plan.
+      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]] Add-on pricing
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute default_quantity
+      #   @return [Integer] Default quantity for the hosted pages.
+      define_attribute :default_quantity, Integer
+
+      # @!attribute [r] deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime, {:read_only => true}
+
+      # @!attribute display_quantity
+      #   @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
+      define_attribute :display_quantity, :Boolean
+
+      # @!attribute [r] id
+      #   @return [String] Add-on ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute name
+      #   @return [String] Describes your add-on and will appear in subscribers' invoices.
+      define_attribute :name, String
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute [r] plan_id
+      #   @return [String] Plan ID
+      define_attribute :plan_id, String, {:read_only => true}
+
+      # @!attribute [r] state
+      #   @return [String] Add-ons can be either active or inactive.
+      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 [r] updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/address.rb

@@ -0,0 +1,42 @@
+module Recurly
+  module Resources
+    class Address < Resource
+
+      # @!attribute city
+      #   @return [String] City
+      define_attribute :city, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO code.
+      define_attribute :country, String
+
+      # @!attribute first_name
+      #   @return [String] First name
+      define_attribute :first_name, String
+
+      # @!attribute last_name
+      #   @return [String] Last name
+      define_attribute :last_name, String
+
+      # @!attribute phone
+      #   @return [String] Phone number
+      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] Street 1
+      define_attribute :street1, String
+
+      # @!attribute street2
+      #   @return [String] Street 2
+      define_attribute :street2, String
+    end
+  end
+end

data/lib/recurly/resources/billing_info.rb

@@ -0,0 +1,62 @@
+module Recurly
+  module Resources
+    class BillingInfo < Resource
+
+      # @!attribute [r] account_id
+      #   @return [String]
+      define_attribute :account_id, String, {:read_only => true}
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] When the billing information was created.
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute [r] fraud
+      #   @return [Hash] Most recent fraud result.
+      define_attribute :fraud, Hash, {:read_only => true}
+
+      # @!attribute [r] id
+      #   @return [String]
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute payment_method
+      #   @return [Hash]
+      define_attribute :payment_method, Hash
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] When the billing information was last changed.
+      define_attribute :updated_at, DateTime, {:read_only => true}
+
+      # @!attribute [r] updated_by
+      #   @return [Hash]
+      define_attribute :updated_by, Hash, {:read_only => true}
+
+      # @!attribute [r] valid
+      #   @return [Boolean]
+      define_attribute :valid, :Boolean, {:read_only => true}
+
+      # @!attribute vat_number
+      #   @return [String] Customer's VAT number (to avoid having the VAT applied). This is only used for automatically collected invoices.
+      define_attribute :vat_number, String
+    end
+  end
+end

data/lib/recurly/resources/coupon.rb

@@ -0,0 +1,110 @@
+module Recurly
+  module Resources
+    class Coupon < Resource
+
+      # @!attribute applies_to_all_plans
+      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` and `plans_names` will list the applicable plans.
+      define_attribute :applies_to_all_plans, :Boolean
+
+      # @!attribute applies_to_non_plan_charges
+      #   @return [Boolean] The coupon is valid for one-time, non-plan charges if true.
+      define_attribute :applies_to_non_plan_charges, :Boolean
+
+      # @!attribute code
+      #   @return [String] The code the customer enters to redeem the coupon.
+      define_attribute :code, String
+
+      # @!attribute coupon_type
+      #   @return [String] Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
+      define_attribute :coupon_type, String, {:enum => ["single_code", "bulk"]}
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute discount
+      #   @return [CouponDiscount]
+      define_attribute :discount, :CouponDiscount
+
+      # @!attribute duration
+      #   @return [String] - "single_use" coupons applies to the first invoice only. - "temporal" coupons will apply to invoices for the duration determined by the `temporal_unit` and `temporal_amount` attributes.
+      define_attribute :duration, String, {:enum => ["forever", "single_use", "temporal"]}
+
+      # @!attribute expired_at
+      #   @return [DateTime] The date and time the coupon was expired early or reached its `max_redemptions`.
+      define_attribute :expired_at, DateTime
+
+      # @!attribute free_trial_amount
+      #   @return [Integer] Sets the duration of time the `free_trial_unit` is for.
+      define_attribute :free_trial_amount, Integer
+
+      # @!attribute free_trial_unit
+      #   @return [String] Description of the unit of time the coupon is for. Used with `free_trial_amount` to determine the duration of time the coupon is for.
+      define_attribute :free_trial_unit, String, {:enum => ["day", "week", "month"]}
+
+      # @!attribute hosted_page_description
+      #   @return [String] This description will show up when a customer redeems a coupon on your Hosted Payment Pages, or if you choose to show the description on your own checkout page.
+      define_attribute :hosted_page_description, String
+
+      # @!attribute [r] id
+      #   @return [String] Coupon ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute invoice_description
+      #   @return [String] Description of the coupon on the invoice.
+      define_attribute :invoice_description, String
+
+      # @!attribute max_redemptions
+      #   @return [Integer] A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
+      define_attribute :max_redemptions, Integer
+
+      # @!attribute max_redemptions_per_account
+      #   @return [Integer] Redemptions per account is the number of times a specific account can redeem the coupon. Set redemptions per account to `1` if you want to keep customers from gaming the system and getting more than one discount from the coupon campaign.
+      define_attribute :max_redemptions_per_account, Integer
+
+      # @!attribute name
+      #   @return [String] The internal name for the coupon.
+      define_attribute :name, String
+
+      # @!attribute [r] object
+      #   @return [String] Object type
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute plans
+      #   @return [Array[String]] Plans
+      define_attribute :plans, Array, {:item_type => String}
+
+      # @!attribute plans_names
+      #   @return [Array[String]] TODO
+      define_attribute :plans_names, Array, {:item_type => String}
+
+      # @!attribute redeem_by
+      #   @return [DateTime] The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59, the end-of-day Pacific time.
+      define_attribute :redeem_by, DateTime
+
+      # @!attribute redemption_resource
+      #   @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
+      define_attribute :redemption_resource, String, {:enum => ["account", "subscription"]}
+
+      # @!attribute state
+      #   @return [String] Indicates if the coupon is redeemable, and if it is not, why.
+      define_attribute :state, String, {:enum => ["redeemable", "maxed_out", "expired"]}
+
+      # @!attribute temporal_amount
+      #   @return [Integer] If `duration` is "temporal" than `temporal_amount` is an integer which is multiplied by `temporal_unit` to define the duration that the coupon will be applied to invoices for.
+      define_attribute :temporal_amount, Integer
+
+      # @!attribute temporal_unit
+      #   @return [String] If `duration` is "temporal" than `temporal_unit` is multiplied by `temporal_amount` to define the duration that the coupon will be applied to invoices for.
+      define_attribute :temporal_unit, String, {:enum => ["day", "week", "month", "year"]}
+
+      # @!attribute [r] unique_coupon_codes_count
+      #   @return [Integer] When this number reaches `max_redemptions` the coupon will no longer be redeemable.
+      define_attribute :unique_coupon_codes_count, Integer, {:read_only => true}
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/coupon_discount.rb

@@ -0,0 +1,22 @@
+module Recurly
+  module Resources
+    class CouponDiscount < Resource
+
+      # @!attribute currencies
+      #   @return [Array[String]] This is only present when `type=fixed`.
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute percent
+      #   @return [Integer] This is only present when `type=percent`.
+      define_attribute :percent, Integer
+
+      # @!attribute trial
+      #   @return [Hash] This is only present when `type=free_trial`.
+      define_attribute :trial, Hash
+
+      # @!attribute type
+      #   @return [String]
+      define_attribute :type, String, {:enum => ["percent", "fixed", "free_trial"]}
+    end
+  end
+end

data/lib/recurly/resources/coupon_redemption.rb

@@ -0,0 +1,46 @@
+module Recurly
+  module Resources
+    class CouponRedemption < Resource
+
+      # @!attribute account_id
+      #   @return [String] The Account ID on which the coupon was applied.
+      define_attribute :account_id, String
+
+      # @!attribute coupon
+      #   @return [Coupon]
+      define_attribute :coupon, :Coupon
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute discounted
+      #   @return [String] The amount that was discounted upon the application of the coupon, formatted with the currency.
+      define_attribute :discounted, String
+
+      # @!attribute [r] id
+      #   @return [String] Coupon Redemption ID
+      define_attribute :id, String, {:read_only => true}
+
+      # @!attribute [r] object
+      #   @return [String] Will always be `coupon`.
+      define_attribute :object, String, {:read_only => true}
+
+      # @!attribute removed_at
+      #   @return [DateTime] The date and time the redemption was removed from the account (un-redeemed).
+      define_attribute :removed_at, DateTime
+
+      # @!attribute state
+      #   @return [String] Coupon Redemption state
+      define_attribute :state, String, {:enum => ["active", "inactive"]}
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/credit_payment.rb

@@ -0,0 +1,62 @@
+module Recurly
+  module Resources
+    class CreditPayment < Resource
+
+      # @!attribute account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
+
+      # @!attribute action
+      #   @return [String] The action for which the credit was created.
+      define_attribute :action, String, {:enum => ["payment", "refund", "reduction", "write_off"]}
+
+      # @!attribute amount
+      #   @return [Float] Total credit payment amount applied to the charge invoice.
+      define_attribute :amount, Float
+
+      # @!attribute applied_to_invoice
+      #   @return [InvoiceMini]
+      define_attribute :applied_to_invoice, :InvoiceMini
+
+      # @!attribute [r] created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime, {:read_only => true}
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute id
+      #   @return [String] Credit Payment ID
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute original_credit_payment_id
+      #   @return [String] For credit payments with action `refund`, this is the credit payment that was refunded.
+      define_attribute :original_credit_payment_id, String
+
+      # @!attribute original_invoice
+      #   @return [InvoiceMini]
+      define_attribute :original_invoice, :InvoiceMini
+
+      # @!attribute refund_transaction
+      #   @return [Transaction]
+      define_attribute :refund_transaction, :Transaction
+
+      # @!attribute [r] updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime, {:read_only => true}
+
+      # @!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
+
+      # @!attribute [r] voided_at
+      #   @return [DateTime] Voided at
+      define_attribute :voided_at, DateTime, {:read_only => true}
+    end
+  end
+end

data/lib/recurly/resources/error.rb

@@ -0,0 +1,18 @@
+module Recurly
+  module Resources
+    class Error < Resource
+
+      # @!attribute message
+      #   @return [String] Message
+      define_attribute :message, String
+
+      # @!attribute params
+      #   @return [Array[String]] Parameter specific errors
+      define_attribute :params, Array, {:item_type => String}
+
+      # @!attribute type
+      #   @return [String] Type
+      define_attribute :type, String, {:enum => ["bad_request", "internal_server_error", "immutable_subscription", "invalid_api_key", "invalid_api_version", "invalid_content_type", "invalid_permissions", "invalid_token", "not_found", "simultaneous_request", "transaction", "unauthorized", "unavailable_in_api_version", "unknown_api_version", "validation", "missing_feature"]}
+    end
+  end
+end

data/lib/recurly/resources/error_may_have_transaction.rb

@@ -0,0 +1,22 @@
+module Recurly
+  module Resources
+    class ErrorMayHaveTransaction < Resource
+
+      # @!attribute message
+      #   @return [String] Message
+      define_attribute :message, String
+
+      # @!attribute params
+      #   @return [Array[String]] Parameter specific errors
+      define_attribute :params, Array, {:item_type => String}
+
+      # @!attribute transaction_error
+      #   @return [Hash] This is only included on errors with `type=transaction`.
+      define_attribute :transaction_error, Hash
+
+      # @!attribute type
+      #   @return [String] Type
+      define_attribute :type, String, {:enum => ["bad_request", "internal_server_error", "immutable_subscription", "invalid_api_key", "invalid_api_version", "invalid_content_type", "invalid_permissions", "invalid_token", "not_found", "simultaneous_request", "transaction", "unauthorized", "unavailable_in_api_version", "unknown_api_version", "validation", "missing_feature"]}
+    end
+  end
+end