# 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 Account < Resource

      # @!attribute address
      #   @return [Address]
      define_attribute :address, :Address

      # @!attribute bill_to
      #   @return [String] An enumerable describing the billing behavior of the account, specifically whether the account is self-paying or will rely on the parent account to pay.
      define_attribute :bill_to, String

      # @!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 code
      #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
      define_attribute :code, String

      # @!attribute company
      #   @return [String]
      define_attribute :company, String

      # @!attribute created_at
      #   @return [DateTime] When the account was created.
      define_attribute :created_at, DateTime

      # @!attribute custom_fields
      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
      define_attribute :custom_fields, Array, { :item_type => :CustomField }

      # @!attribute deleted_at
      #   @return [DateTime] If present, when the account was last marked inactive.
      define_attribute :deleted_at, DateTime

      # @!attribute dunning_campaign_id
      #   @return [String] Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.
      define_attribute :dunning_campaign_id, String

      # @!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 exemption_certificate
      #   @return [String] The tax exemption certificate number for the account. If the merchant has an integration for the Vertex tax provider, this optional value will be sent in any tax calculation requests for the account.
      define_attribute :exemption_certificate, String

      # @!attribute external_accounts
      #   @return [Array[ExternalAccount]] The external accounts belonging to this account
      define_attribute :external_accounts, Array, { :item_type => :ExternalAccount }

      # @!attribute first_name
      #   @return [String]
      define_attribute :first_name, String

      # @!attribute has_active_subscription
      #   @return [Boolean] Indicates if the account has an active subscription.
      define_attribute :has_active_subscription, :Boolean

      # @!attribute has_canceled_subscription
      #   @return [Boolean] Indicates if the account has a canceled subscription.
      define_attribute :has_canceled_subscription, :Boolean

      # @!attribute has_future_subscription
      #   @return [Boolean] Indicates if the account has a future subscription.
      define_attribute :has_future_subscription, :Boolean

      # @!attribute has_live_subscription
      #   @return [Boolean] Indicates if the account has a subscription that is either active, canceled, future, or paused.
      define_attribute :has_live_subscription, :Boolean

      # @!attribute has_past_due_invoice
      #   @return [Boolean] Indicates if the account has a past due invoice.
      define_attribute :has_past_due_invoice, :Boolean

      # @!attribute has_paused_subscription
      #   @return [Boolean] Indicates if the account has a paused subscription.
      define_attribute :has_paused_subscription, :Boolean

      # @!attribute 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

      # @!attribute id
      #   @return [String]
      define_attribute :id, String

      # @!attribute invoice_template_id
      #   @return [String] Unique ID to identify an invoice template. Available when the site is on a Pro or Enterprise plan. Used to specify if a non-default invoice template will be used to generate invoices for the account. For sites without multiple invoice templates enabled, the default template will always be used.
      define_attribute :invoice_template_id, String

      # @!attribute last_name
      #   @return [String]
      define_attribute :last_name, String

      # @!attribute object
      #   @return [String] Object type
      define_attribute :object, String

      # @!attribute override_business_entity_id
      #   @return [String] Unique ID to identify the business entity assigned to the account. Available when the `Multiple Business Entities` feature is enabled.
      define_attribute :override_business_entity_id, String

      # @!attribute parent_account_id
      #   @return [String] The UUID of the parent account associated with this account.
      define_attribute :parent_account_id, String

      # @!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

      # @!attribute preferred_time_zone
      #   @return [String] The [IANA time zone name](https://docs.recurly.com/docs/email-time-zones-and-time-stamps#supported-api-iana-time-zone-names) used to determine the time zone of emails sent on behalf of the merchant to the customer.
      define_attribute :preferred_time_zone, String

      # @!attribute shipping_addresses
      #   @return [Array[ShippingAddress]] The shipping addresses on the account.
      define_attribute :shipping_addresses, Array, { :item_type => :ShippingAddress }

      # @!attribute state
      #   @return [String] Accounts can be either active or inactive.
      define_attribute :state, String

      # @!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 updated_at
      #   @return [DateTime] When the account was last changed.
      define_attribute :updated_at, DateTime

      # @!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