recurly 2.17.5 → 4.18.0

data/lib/recurly/resources/billing_info.rb

@@ -0,0 +1,74 @@
+# 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 BillingInfo < Resource
+
+      # @!attribute account_id
+      #   @return [String]
+      define_attribute :account_id, String
+
+      # @!attribute address
+      #   @return [Address]
+      define_attribute :address, :Address
+
+      # @!attribute backup_payment_method
+      #   @return [Boolean] The `backup_payment_method` field is used to indicate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined.
+      define_attribute :backup_payment_method, :Boolean
+
+      # @!attribute company
+      #   @return [String]
+      define_attribute :company, String
+
+      # @!attribute created_at
+      #   @return [DateTime] When the billing information was created.
+      define_attribute :created_at, DateTime
+
+      # @!attribute first_name
+      #   @return [String]
+      define_attribute :first_name, String
+
+      # @!attribute fraud
+      #   @return [FraudInfo] Most recent fraud result.
+      define_attribute :fraud, :FraudInfo
+
+      # @!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 payment_method
+      #   @return [PaymentMethod]
+      define_attribute :payment_method, :PaymentMethod
+
+      # @!attribute primary_payment_method
+      #   @return [Boolean] The `primary_payment_method` field is used to indicate the primary billing info on the account. The first billing info created on an account will always become primary. This payment method will be used
+      define_attribute :primary_payment_method, :Boolean
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the billing information was last changed.
+      define_attribute :updated_at, DateTime
+
+      # @!attribute updated_by
+      #   @return [BillingInfoUpdatedBy]
+      define_attribute :updated_by, :BillingInfoUpdatedBy
+
+      # @!attribute valid
+      #   @return [Boolean]
+      define_attribute :valid, :Boolean
+
+      # @!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/billing_info_updated_by.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 BillingInfoUpdatedBy < Resource
+
+      # @!attribute country
+      #   @return [String] Country, 2-letter ISO 3166-1 alpha-2 code matching the origin IP address, if known by Recurly.
+      define_attribute :country, String
+
+      # @!attribute ip
+      #   @return [String] Customer's IP address when updating their billing information.
+      define_attribute :ip, String
+    end
+  end
+end

data/lib/recurly/resources/binary_file.rb

@@ -0,0 +1,14 @@
+# 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 BinaryFile < Resource
+
+      # @!attribute data
+      #   @return [String]
+      define_attribute :data, String
+    end
+  end
+end

data/lib/recurly/resources/coupon.rb

@@ -0,0 +1,126 @@
+# 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 Coupon < Resource
+
+      # @!attribute applies_to_all_items
+      #   @return [Boolean] The coupon is valid for all items if true. If false then `items` will list the applicable items.
+      define_attribute :applies_to_all_items, :Boolean
+
+      # @!attribute applies_to_all_plans
+      #   @return [Boolean] The coupon is valid for all plans if true. If false then `plans` 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
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute discount
+      #   @return [CouponDiscount] Details of the discount a coupon applies. Will contain a `type` property and one of the following properties: `percent`, `fixed`, `trial`.
+      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
+
+      # @!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
+
+      # @!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 id
+      #   @return [String] Coupon ID
+      define_attribute :id, String
+
+      # @!attribute invoice_description
+      #   @return [String] Description of the coupon on the invoice.
+      define_attribute :invoice_description, String
+
+      # @!attribute items
+      #   @return [Array[ItemMini]] A list of items for which this coupon applies. This will be `null` if `applies_to_all_items=true`.
+      define_attribute :items, Array, { :item_type => :ItemMini }
+
+      # @!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 object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute plans
+      #   @return [Array[PlanMini]] A list of plans for which this coupon applies. This will be `null` if `applies_to_all_plans=true`.
+      define_attribute :plans, Array, { :item_type => :PlanMini }
+
+      # @!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
+
+      # @!attribute state
+      #   @return [String] Indicates if the coupon is redeemable, and if it is not, why.
+      define_attribute :state, String
+
+      # @!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
+
+      # @!attribute unique_code_template
+      #   @return [String] On a bulk coupon, the template from which unique coupon codes are generated.
+      define_attribute :unique_code_template, String
+
+      # @!attribute unique_coupon_code
+      #   @return [Hash] Will be populated when the Coupon being returned is a `UniqueCouponCode`.
+      define_attribute :unique_coupon_code, Hash
+
+      # @!attribute 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
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/coupon_discount.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 CouponDiscount < Resource
+
+      # @!attribute currencies
+      #   @return [Array[CouponDiscountPricing]] This is only present when `type=fixed`.
+      define_attribute :currencies, Array, { :item_type => :CouponDiscountPricing }
+
+      # @!attribute percent
+      #   @return [Integer] This is only present when `type=percent`.
+      define_attribute :percent, Integer
+
+      # @!attribute trial
+      #   @return [CouponDiscountTrial] This is only present when `type=free_trial`.
+      define_attribute :trial, :CouponDiscountTrial
+
+      # @!attribute type
+      #   @return [String]
+      define_attribute :type, String
+    end
+  end
+end

data/lib/recurly/resources/coupon_discount_pricing.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 CouponDiscountPricing < Resource
+
+      # @!attribute amount
+      #   @return [Float] Value of the fixed discount that this coupon applies.
+      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/coupon_discount_trial.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 CouponDiscountTrial < Resource
+
+      # @!attribute length
+      #   @return [Integer] Trial length measured in the units specified by the sibling `unit` property
+      define_attribute :length, Integer
+
+      # @!attribute unit
+      #   @return [String] Temporal unit of the free trial
+      define_attribute :unit, String
+    end
+  end
+end

data/lib/recurly/resources/coupon_mini.rb

@@ -0,0 +1,42 @@
+# 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 CouponMini < Resource
+
+      # @!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
+
+      # @!attribute discount
+      #   @return [CouponDiscount] Details of the discount a coupon applies. Will contain a `type` property and one of the following properties: `percent`, `fixed`, `trial`.
+      define_attribute :discount, :CouponDiscount
+
+      # @!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 id
+      #   @return [String] Coupon ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] The internal name for the coupon.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute state
+      #   @return [String] Indicates if the coupon is redeemable, and if it is not, why.
+      define_attribute :state, String
+    end
+  end
+end

data/lib/recurly/resources/coupon_redemption.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 CouponRedemption < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] The Account on which the coupon was applied.
+      define_attribute :account, :AccountMini
+
+      # @!attribute coupon
+      #   @return [Coupon]
+      define_attribute :coupon, :Coupon
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!attribute discounted
+      #   @return [Float] The amount that was discounted upon the application of the coupon, formatted with the currency.
+      define_attribute :discounted, Float
+
+      # @!attribute id
+      #   @return [String] Coupon Redemption ID
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Will always be `coupon`.
+      define_attribute :object, String
+
+      # @!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
+
+      # @!attribute subscription_id
+      #   @return [String] Subscription ID
+      define_attribute :subscription_id, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/coupon_redemption_mini.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 CouponRedemptionMini < Resource
+
+      # @!attribute coupon
+      #   @return [CouponMini]
+      define_attribute :coupon, :CouponMini
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute discounted
+      #   @return [Float] The amount that was discounted upon the application of the coupon, formatted with the currency.
+      define_attribute :discounted, Float
+
+      # @!attribute id
+      #   @return [String] Coupon Redemption ID
+      define_attribute :id, String
+
+      # @!attribute object
+      #   @return [String] Will always be `coupon`.
+      define_attribute :object, String
+
+      # @!attribute state
+      #   @return [String] Invoice state
+      define_attribute :state, String
+    end
+  end
+end

data/lib/recurly/resources/credit_payment.rb

@@ -0,0 +1,66 @@
+# 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 CreditPayment < Resource
+
+      # @!attribute account
+      #   @return [AccountMini] Account mini details
+      define_attribute :account, :AccountMini
+
+      # @!attribute action
+      #   @return [String] The action for which the credit was created.
+      define_attribute :action, String
+
+      # @!attribute amount
+      #   @return [Float] Total credit payment amount applied to the charge invoice.
+      define_attribute :amount, Float
+
+      # @!attribute applied_to_invoice
+      #   @return [InvoiceMini] Invoice mini details
+      define_attribute :applied_to_invoice, :InvoiceMini
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!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] Invoice mini details
+      define_attribute :original_invoice, :InvoiceMini
+
+      # @!attribute refund_transaction
+      #   @return [Transaction]
+      define_attribute :refund_transaction, :Transaction
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+
+      # @!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 voided_at
+      #   @return [DateTime] Voided at
+      define_attribute :voided_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/custom_field.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 CustomField < Resource
+
+      # @!attribute name
+      #   @return [String] Fields must be created in the UI before values can be assigned to them.
+      define_attribute :name, String
+
+      # @!attribute value
+      #   @return [String] Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
+      define_attribute :value, String
+    end
+  end
+end

data/lib/recurly/resources/custom_field_definition.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 CustomFieldDefinition < Resource
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute display_name
+      #   @return [String] Used to label the field when viewing and editing the field in Recurly's admin UI.
+      define_attribute :display_name, String
+
+      # @!attribute id
+      #   @return [String] Custom field definition ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute related_type
+      #   @return [String] Related Recurly object type
+      define_attribute :related_type, String
+
+      # @!attribute tooltip
+      #   @return [String] Displayed as a tooltip when editing the field in the Recurly admin UI.
+      define_attribute :tooltip, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+
+      # @!attribute user_access
+      #   @return [String] The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but   editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI.
+      define_attribute :user_access, String
+    end
+  end
+end

data/lib/recurly/resources/dunning_campaign.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 DunningCampaign < Resource
+
+      # @!attribute code
+      #   @return [String] Campaign code.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] When the current campaign was created in Recurly.
+      define_attribute :created_at, DateTime
+
+      # @!attribute default_campaign
+      #   @return [Boolean] Whether or not this is the default campaign for accounts or plans without an assigned dunning campaign.
+      define_attribute :default_campaign, :Boolean
+
+      # @!attribute deleted_at
+      #   @return [DateTime] When the current campaign was deleted in Recurly.
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Campaign description.
+      define_attribute :description, String
+
+      # @!attribute dunning_cycles
+      #   @return [Array[DunningCycle]] Dunning Cycle settings.
+      define_attribute :dunning_cycles, Array, { :item_type => :DunningCycle }
+
+      # @!attribute id
+      #   @return [String]
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] Campaign name.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] When the current campaign was updated in Recurly.
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/dunning_campaigns_bulk_update_response.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 DunningCampaignsBulkUpdateResponse < Resource
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute plans
+      #   @return [Array[Plan]] An array containing all of the `Plan` resources that have been updated.
+      define_attribute :plans, Array, { :item_type => :Plan }
+    end
+  end
+end