recurly 2.18.21 → 3.0.0.beta.1

data/lib/recurly/requests/account_create_only.rb

@@ -0,0 +1,18 @@
+module Recurly
+  module Requests
+    class AccountCreateOnly < Request
+
+      # @!attribute acquisition
+      #   @return [AccountAcquisitionUpdatable]
+      define_attribute :acquisition, :AccountAcquisitionUpdatable
+
+      # @!attribute code
+      #   @return [String] The unique identifier of the account. This cannot be changed once the account is created.
+      define_attribute :code, String
+
+      # @!attribute shipping_addresses
+      #   @return [Array[ShippingAddressCreate]]
+      define_attribute :shipping_addresses, Array, {:item_type => :ShippingAddressCreate}
+    end
+  end
+end

data/lib/recurly/requests/account_updatable.rb

@@ -0,0 +1,50 @@
+module Recurly
+  module Requests
+    class AccountUpdatable < Request
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute billing_info
+      #   @return [BillingInfoCreate]
+      define_attribute :billing_info, :BillingInfoCreate
+
+      # @!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 company
+      #   @return [String]
+      define_attribute :company, 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 first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute preferred_locale
+      #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+      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 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 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/requests/add_on_create.rb

@@ -0,0 +1,38 @@
+module Recurly
+  module Requests
+    class AddOnCreate < Request
+
+      # @!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 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 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 name
+      #   @return [String] Describes your add-on and will appear in subscribers' invoices.
+      define_attribute :name, String
+
+      # @!attribute [r] plan_id
+      #   @return [String] Plan ID
+      define_attribute :plan_id, String, {:read_only => true}
+
+      # @!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
+    end
+  end
+end

data/lib/recurly/requests/add_on_update.rb

@@ -0,0 +1,38 @@
+module Recurly
+  module Requests
+    class AddOnUpdate < Request
+
+      # @!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 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 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 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
+    end
+  end
+end

data/lib/recurly/requests/address.rb

@@ -0,0 +1,42 @@
+module Recurly
+  module Requests
+    class Address < Request
+
+      # @!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/requests/billing_info_create.rb

@@ -0,0 +1,58 @@
+module Recurly
+  module Requests
+    class BillingInfoCreate < Request
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute amazon_billing_agreement_id
+      #   @return [String] Amazon billing agreement ID
+      define_attribute :amazon_billing_agreement_id, String
+
+      # @!attribute company
+      #   @return [String] Company name
+      define_attribute :company, String
+
+      # @!attribute cvv
+      #   @return [String] *STRONGLY RECOMMENDED*
+      define_attribute :cvv, String
+
+      # @!attribute first_name
+      #   @return [String] First name
+      define_attribute :first_name, String
+
+      # @!attribute ip_address
+      #   @return [String] *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
+      define_attribute :ip_address, String
+
+      # @!attribute last_name
+      #   @return [String] Last name
+      define_attribute :last_name, String
+
+      # @!attribute month
+      #   @return [String] Expiration month
+      define_attribute :month, String
+
+      # @!attribute number
+      #   @return [String] Credit card number, spaces and dashes are accepted.
+      define_attribute :number, String
+
+      # @!attribute paypal_billing_agreement_id
+      #   @return [String] PayPal billing agreement ID
+      define_attribute :paypal_billing_agreement_id, String
+
+      # @!attribute token_id
+      #   @return [String] A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token).
+      define_attribute :token_id, String
+
+      # @!attribute vat_number
+      #   @return [String] VAT number
+      define_attribute :vat_number, String
+
+      # @!attribute year
+      #   @return [String] Expiration year
+      define_attribute :year, String
+    end
+  end
+end

data/lib/recurly/requests/coupon_create_only.rb

@@ -0,0 +1,66 @@
+module Recurly
+  module Requests
+    class CouponCreateOnly < Request
+
+      # @!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 currencies
+      #   @return [Array[String]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute discount_percent
+      #   @return [Integer] The percent of the price discounted by the coupon.  Required if `discount_type` is `percent`.
+      define_attribute :discount_percent, Integer
+
+      # @!attribute discount_type
+      #   @return [String] The type of discount provided by the coupon (how the amount discounted is calculated)
+      define_attribute :discount_type, String, {:enum => ["percent", "fixed", "free_trial"]}
+
+      # @!attribute duration
+      #   @return [String] This field does not apply when the discount_type is `free_trial`. - "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. - "forever" coupons will apply to invoices forever.
+      define_attribute :duration, String, {:enum => ["forever", "single_use", "temporal"]}
+
+      # @!attribute free_trial_amount
+      #   @return [Integer] Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
+      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.  Required if `discount_type` is `free_trial`.
+      define_attribute :free_trial_unit, String, {:enum => ["day", "week", "month"]}
+
+      # @!attribute plan_codes
+      #   @return [Array[String]] List of plan codes to which this coupon applies. See `applies_to_all_plans`
+      define_attribute :plan_codes, Array, {:item_type => String}
+
+      # @!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 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 unique_code_template
+      #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated. - You must start the template with your coupon_code wrapped in single quotes. - Outside of single quotes, use a 9 for a character that you want to be a random number. - Outside of single quotes, use an "x" for a character that you want to be a random letter. - Outside of single quotes, use an * for a character that you want to be a random number or letter. - Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +. For example: "'abc-'****'-def'"
+      define_attribute :unique_code_template, String
+    end
+  end
+end

data/lib/recurly/requests/coupon_updatable.rb

@@ -0,0 +1,30 @@
+module Recurly
+  module Requests
+    class CouponUpdatable < Request
+
+      # @!attribute hosted_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_description, String
+
+      # @!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 redeem_by_date
+      #   @return [String] 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_date, String
+    end
+  end
+end

data/lib/recurly/requests/create_account.rb

@@ -0,0 +1,62 @@
+module Recurly
+  module Requests
+    class CreateAccount < Request
+
+      # @!attribute acquisition
+      #   @return [AccountAcquisitionUpdatable]
+      define_attribute :acquisition, :AccountAcquisitionUpdatable
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute billing_info
+      #   @return [BillingInfoCreate]
+      define_attribute :billing_info, :BillingInfoCreate
+
+      # @!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 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 last_name
+      #   @return [String]
+      define_attribute :last_name, String
+
+      # @!attribute preferred_locale
+      #   @return [String] Used to determine the language and locale of emails sent on behalf of the merchant to the customer. The list of locales is restricted to those the merchant has enabled on the site.
+      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[ShippingAddressCreate]]
+      define_attribute :shipping_addresses, Array, {:item_type => :ShippingAddressCreate}
+
+      # @!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 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/requests/create_coupon.rb

@@ -0,0 +1,90 @@
+module Recurly
+  module Requests
+    class CreateCoupon < Request
+
+      # @!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 currencies
+      #   @return [Array[String]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
+      define_attribute :currencies, Array, {:item_type => String}
+
+      # @!attribute discount_percent
+      #   @return [Integer] The percent of the price discounted by the coupon.  Required if `discount_type` is `percent`.
+      define_attribute :discount_percent, Integer
+
+      # @!attribute discount_type
+      #   @return [String] The type of discount provided by the coupon (how the amount discounted is calculated)
+      define_attribute :discount_type, String, {:enum => ["percent", "fixed", "free_trial"]}
+
+      # @!attribute duration
+      #   @return [String] This field does not apply when the discount_type is `free_trial`. - "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. - "forever" coupons will apply to invoices forever.
+      define_attribute :duration, String, {:enum => ["forever", "single_use", "temporal"]}
+
+      # @!attribute free_trial_amount
+      #   @return [Integer] Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
+      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.  Required if `discount_type` is `free_trial`.
+      define_attribute :free_trial_unit, String, {:enum => ["day", "week", "month"]}
+
+      # @!attribute hosted_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_description, String
+
+      # @!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 plan_codes
+      #   @return [Array[String]] List of plan codes to which this coupon applies. See `applies_to_all_plans`
+      define_attribute :plan_codes, Array, {:item_type => String}
+
+      # @!attribute redeem_by_date
+      #   @return [String] 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_date, String
+
+      # @!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 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 unique_code_template
+      #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated. - You must start the template with your coupon_code wrapped in single quotes. - Outside of single quotes, use a 9 for a character that you want to be a random number. - Outside of single quotes, use an "x" for a character that you want to be a random letter. - Outside of single quotes, use an * for a character that you want to be a random number or letter. - Use single quotes ' ' for characters that you want to remain static. These strings can be alphanumeric and may contain a - _ or +. For example: "'abc-'****'-def'"
+      define_attribute :unique_code_template, String
+    end
+  end
+end