recurly 2.17.5 → 4.18.0

data/lib/recurly/resources/account.rb

@@ -0,0 +1,138 @@
+# 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 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 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 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

data/lib/recurly/resources/account_acquisition.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 AccountAcquisition < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      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
+
+      # @!attribute cost
+      #   @return [AccountAcquisitionCost] Account balance
+      define_attribute :cost, :AccountAcquisitionCost
+
+      # @!attribute created_at
+      #   @return [DateTime] When the account acquisition data was created.
+      define_attribute :created_at, DateTime
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute subchannel
+      #   @return [String] An arbitrary subchannel string representing a distinction/subcategory within a broader channel.
+      define_attribute :subchannel, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the account acquisition data was last changed.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/account_acquisition_cost.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 AccountAcquisitionCost < Resource
+
+      # @!attribute amount
+      #   @return [Float] The amount of the corresponding currency used to acquire the account.
+      define_attribute :amount, Float
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+    end
+  end
+end

data/lib/recurly/resources/account_balance.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 AccountBalance < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      define_attribute :account, :AccountMini
+
+      # @!attribute balances
+      #   @return [Array[AccountBalanceAmount]]
+      define_attribute :balances, Array, { :item_type => :AccountBalanceAmount }
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute past_due
+      #   @return [Boolean]
+      define_attribute :past_due, :Boolean
+    end
+  end
+end

data/lib/recurly/resources/account_balance_amount.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 AccountBalanceAmount < Resource
+
+      # @!attribute amount
+      #   @return [Float] Total amount the account is past due.
+      define_attribute :amount, Float
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute processing_prepayment_amount
+      #   @return [Float] Total amount for the prepayment credit invoices in a `processing` state on the account.
+      define_attribute :processing_prepayment_amount, Float
+    end
+  end
+end

data/lib/recurly/resources/account_mini.rb

@@ -0,0 +1,50 @@
+# 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 AccountMini < Resource
+
+      # @!attribute bill_to
+      #   @return [String]
+      define_attribute :bill_to, String
+
+      # @!attribute code
+      #   @return [String] The unique identifier of the account.
+      define_attribute :code, String
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!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.
+      define_attribute :email, String
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute parent_account_id
+      #   @return [String]
+      define_attribute :parent_account_id, String
+    end
+  end
+end

data/lib/recurly/resources/account_note.rb

@@ -0,0 +1,34 @@
+# 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 AccountNote < Resource
+
+      # @!attribute account_id
+      #   @return [String]
+      define_attribute :account_id, String
+
+      # @!attribute created_at
+      #   @return [DateTime]
+      define_attribute :created_at, DateTime
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute message
+      #   @return [String]
+      define_attribute :message, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute user
+      #   @return [User]
+      define_attribute :user, :User
+    end
+  end
+end

data/lib/recurly/resources/add_on.rb

@@ -0,0 +1,122 @@
+# 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 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 add_on_type
+      #   @return [String] Whether the add-on type is fixed, or usage-based.
+      define_attribute :add_on_type, String
+
+      # @!attribute avalara_service_type
+      #   @return [Integer] Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on 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 add-on 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] The unique identifier for the add-on within its plan.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currencies
+      #   @return [Array[AddOnPricing]] Add-on pricing
+      define_attribute :currencies, Array, { :item_type => :AddOnPricing }
+
+      # @!attribute default_quantity
+      #   @return [Integer] Default quantity for the hosted pages.
+      define_attribute :default_quantity, Integer
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!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 external_sku
+      #   @return [String] Optional, stock keeping unit to link the item to other inventory systems.
+      define_attribute :external_sku, String
+
+      # @!attribute id
+      #   @return [String] Add-on ID
+      define_attribute :id, String
+
+      # @!attribute item
+      #   @return [ItemMini] Just the important parts.
+      define_attribute :item, :ItemMini
+
+      # @!attribute measured_unit_id
+      #   @return [String] System-generated unique identifier for an measured unit associated with the add-on.
+      define_attribute :measured_unit_id, String
+
+      # @!attribute name
+      #   @return [String] Describes your add-on and will appear in subscribers' invoices.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute optional
+      #   @return [Boolean] Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+      define_attribute :optional, :Boolean
+
+      # @!attribute percentage_tiers
+      #   @return [Array[PercentageTiersByCurrency]] Percentage Tiers
+      define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
+
+      # @!attribute plan_id
+      #   @return [String] Plan ID
+      define_attribute :plan_id, String
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute state
+      #   @return [String] Add-ons can be either active or inactive.
+      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 tier_type
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      define_attribute :tier_type, String
+
+      # @!attribute tiers
+      #   @return [Array[Tier]] Tiers
+      define_attribute :tiers, Array, { :item_type => :Tier }
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+
+      # @!attribute usage_percentage
+      #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.
+      define_attribute :usage_percentage, Float
+
+      # @!attribute usage_timeframe
+      #   @return [String] The time at which usage totals are reset for billing purposes.
+      define_attribute :usage_timeframe, String
+
+      # @!attribute usage_type
+      #   @return [String] Type of usage, returns usage type if `add_on_type` is `usage`.
+      define_attribute :usage_type, String
+    end
+  end
+end

data/lib/recurly/resources/add_on_mini.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 AddOnMini < 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 add_on_type
+      #   @return [String] Whether the add-on type is fixed, or usage-based.
+      define_attribute :add_on_type, String
+
+      # @!attribute code
+      #   @return [String] The unique identifier for the add-on within its plan.
+      define_attribute :code, String
+
+      # @!attribute external_sku
+      #   @return [String] Optional, stock keeping unit to link the item to other inventory systems.
+      define_attribute :external_sku, String
+
+      # @!attribute id
+      #   @return [String] Add-on ID
+      define_attribute :id, String
+
+      # @!attribute item_id
+      #   @return [String] Item ID
+      define_attribute :item_id, String
+
+      # @!attribute measured_unit_id
+      #   @return [String] System-generated unique identifier for an measured unit associated with the add-on.
+      define_attribute :measured_unit_id, String
+
+      # @!attribute name
+      #   @return [String] Describes your add-on and will appear in subscribers' invoices.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute usage_percentage
+      #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0.
+      define_attribute :usage_percentage, Float
+
+      # @!attribute usage_type
+      #   @return [String] Type of usage, returns usage type if `add_on_type` is `usage`.
+      define_attribute :usage_type, String
+    end
+  end
+end

data/lib/recurly/resources/add_on_pricing.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 AddOnPricing < Resource
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute tax_inclusive
+      #   @return [Boolean] This field is deprecated. Please do not use it.
+      define_attribute :tax_inclusive, :Boolean
+
+      # @!attribute unit_amount
+      #   @return [Float] Allows up to 2 decimal places. Required unless `unit_amount_decimal` is provided.
+      define_attribute :unit_amount, Float
+
+      # @!attribute unit_amount_decimal
+      #   @return [String] Allows up to 9 decimal places. Only supported when `add_on_type` = `usage`. If `unit_amount_decimal` is provided, `unit_amount` cannot be provided.
+      define_attribute :unit_amount_decimal, String
+    end
+  end
+end

data/lib/recurly/resources/address.rb

@@ -0,0 +1,38 @@
+# 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 Address < Resource
+
+      # @!attribute city
+      #   @return [String] City
+      define_attribute :city, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
+      define_attribute :country, 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/address_with_name.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 AddressWithName < Resource
+
+      # @!attribute city
+      #   @return [String] City
+      define_attribute :city, String
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 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