recurly 2.17.0 → 3.23.0

data/lib/recurly/requests/subscription_change_shipping_create.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 Requests
+    class SubscriptionChangeShippingCreate < Request
+
+      # @!attribute amount
+      #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [String] The code of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [String] The id of the shipping method used to deliver the subscription. To remove shipping set this to `null` and the `amount=0`. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_create.rb

@@ -0,0 +1,118 @@
+# 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 Requests
+    class SubscriptionCreate < Request
+
+      # @!attribute account
+      #   @return [AccountCreate]
+      define_attribute :account, :AccountCreate
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOnCreate]] Add-ons
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnCreate }
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute billing_info_id
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+      define_attribute :billing_info_id, String
+
+      # @!attribute collection_method
+      #   @return [String] Collection method
+      define_attribute :collection_method, String
+
+      # @!attribute coupon_code
+      #   @return [String] Optional coupon code to redeem on the account and discount the subscription. Please note, the subscription request will fail if the coupon is invalid.
+      define_attribute :coupon_code, String
+
+      # @!attribute credit_customer_notes
+      #   @return [String] If there are pending credits on the account that will be invoiced during the subscription creation, these will be used as the Customer Notes on the credit invoice.
+      define_attribute :credit_customer_notes, String
+
+      # @!attribute currency
+      #   @return [String] 3-letter ISO 4217 currency code.
+      define_attribute :currency, String
+
+      # @!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 customer_notes
+      #   @return [String] This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
+      define_attribute :customer_notes, String
+
+      # @!attribute net_terms
+      #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+      define_attribute :net_terms, Integer
+
+      # @!attribute next_bill_date
+      #   @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+      define_attribute :next_bill_date, DateTime
+
+      # @!attribute plan_code
+      #   @return [String] You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
+      define_attribute :plan_code, String
+
+      # @!attribute plan_id
+      #   @return [String] You must provide either a `plan_code` or `plan_id`. If both are provided the `plan_id` will be used.
+      define_attribute :plan_id, String
+
+      # @!attribute po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!attribute quantity
+      #   @return [Integer] Optionally override the default quantity of 1.
+      define_attribute :quantity, Integer
+
+      # @!attribute ramp_intervals
+      #   @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
+      define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
+
+      # @!attribute renewal_billing_cycles
+      #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+      define_attribute :renewal_billing_cycles, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute shipping
+      #   @return [SubscriptionShippingCreate] Create a shipping address on the account and assign it to the subscription.
+      define_attribute :shipping, :SubscriptionShippingCreate
+
+      # @!attribute starts_at
+      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      define_attribute :starts_at, DateTime
+
+      # @!attribute tax_inclusive
+      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      define_attribute :tax_inclusive, :Boolean
+
+      # @!attribute terms_and_conditions
+      #   @return [String] This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
+      define_attribute :terms_and_conditions, String
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+      define_attribute :total_billing_cycles, Integer
+
+      # @!attribute transaction_type
+      #   @return [String] An optional type designation for the payment gateway transaction created by this request. Supports 'moto' value, which is the acronym for mail order and telephone transactions.
+      define_attribute :transaction_type, String
+
+      # @!attribute trial_ends_at
+      #   @return [DateTime] IIf set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute unit_amount
+      #   @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_pause.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 Requests
+    class SubscriptionPause < Request
+
+      # @!attribute remaining_pause_cycles
+      #   @return [Integer] Number of billing cycles to pause the subscriptions. A value of 0 will cancel any pending pauses on the subscription.
+      define_attribute :remaining_pause_cycles, Integer
+    end
+  end
+end

data/lib/recurly/requests/subscription_purchase.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 Requests
+    class SubscriptionPurchase < Request
+
+      # @!attribute add_ons
+      #   @return [Array[SubscriptionAddOnCreate]] Add-ons
+      define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnCreate }
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
+      # @!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 next_bill_date
+      #   @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. The initial invoice will be prorated for the period between the subscription's activation date and the billing period end date. Subsequent periods will be based off the plan interval. For a subscription with a trial period, this will change when the trial expires.
+      define_attribute :next_bill_date, DateTime
+
+      # @!attribute plan_code
+      #   @return [String] Plan code
+      define_attribute :plan_code, String
+
+      # @!attribute plan_id
+      #   @return [String] Plan ID
+      define_attribute :plan_id, String
+
+      # @!attribute quantity
+      #   @return [Integer] Optionally override the default quantity of 1.
+      define_attribute :quantity, Integer
+
+      # @!attribute ramp_intervals
+      #   @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
+      define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
+
+      # @!attribute renewal_billing_cycles
+      #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+      define_attribute :renewal_billing_cycles, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute shipping
+      #   @return [SubscriptionShippingPurchase] Create a shipping address on the account and assign it to the subscription.
+      define_attribute :shipping, :SubscriptionShippingPurchase
+
+      # @!attribute starts_at
+      #   @return [DateTime] If set, the subscription will begin in the future on this date. The subscription will apply the setup fee and trial period, unless the plan has no trial.
+      define_attribute :starts_at, DateTime
+
+      # @!attribute tax_inclusive
+      #   @return [Boolean] Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.
+      define_attribute :tax_inclusive, :Boolean
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+      define_attribute :total_billing_cycles, Integer
+
+      # @!attribute trial_ends_at
+      #   @return [DateTime] If set, overrides the default trial behavior for the subscription. When the current date time or a past date time is provided the subscription will begin with no trial phase (overriding any plan default trial). When a future date time is provided the subscription will begin with a trial phase ending at the specified date time.
+      define_attribute :trial_ends_at, DateTime
+
+      # @!attribute unit_amount
+      #   @return [Float] Override the unit amount of the subscription plan by setting this value. If not provided, the subscription will inherit the price from the subscription plan for the provided currency.
+      define_attribute :unit_amount, Float
+    end
+  end
+end

data/lib/recurly/requests/subscription_ramp_interval.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 Requests
+    class SubscriptionRampInterval < Request
+
+      # @!attribute starting_billing_cycle
+      #   @return [Integer] Represents the billing cycle where a ramp interval starts.
+      define_attribute :starting_billing_cycle, Integer
+
+      # @!attribute unit_amount
+      #   @return [Integer] Represents the price for the ramp interval.
+      define_attribute :unit_amount, Integer
+    end
+  end
+end

data/lib/recurly/requests/subscription_shipping_create.rb

@@ -0,0 +1,30 @@
+# 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 Requests
+    class SubscriptionShippingCreate < Request
+
+      # @!attribute address
+      #   @return [ShippingAddressCreate]
+      define_attribute :address, :ShippingAddressCreate
+
+      # @!attribute address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses. If `address_id` and `address` are both present, `address` will be used.
+      define_attribute :address_id, String
+
+      # @!attribute amount
+      #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [String] The code of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [String] The id of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_shipping_purchase.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 Requests
+    class SubscriptionShippingPurchase < Request
+
+      # @!attribute amount
+      #   @return [Float] Assigns the subscription's shipping cost. If this is greater than zero then a `method_id` or `method_code` is required.
+      define_attribute :amount, Float
+
+      # @!attribute method_code
+      #   @return [String] The code of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_code, String
+
+      # @!attribute method_id
+      #   @return [String] The id of the shipping method used to deliver the subscription. If `method_id` and `method_code` are both present, `method_id` will be used.
+      define_attribute :method_id, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_shipping_update.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 Requests
+    class SubscriptionShippingUpdate < Request
+
+      # @!attribute address
+      #   @return [ShippingAddressCreate]
+      define_attribute :address, :ShippingAddressCreate
+
+      # @!attribute address_id
+      #   @return [String] Assign a shipping address from the account's existing shipping addresses.
+      define_attribute :address_id, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/requests/subscription_update.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 Requests
+    class SubscriptionUpdate < Request
+
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
+      # @!attribute billing_info_id
+      #   @return [String] The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.
+      define_attribute :billing_info_id, String
+
+      # @!attribute collection_method
+      #   @return [String] Change collection method
+      define_attribute :collection_method, String
+
+      # @!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 customer_notes
+      #   @return [String] Specify custom notes to add or override Customer Notes. Custom notes will stay with a subscription on all renewals.
+      define_attribute :customer_notes, String
+
+      # @!attribute net_terms
+      #   @return [Integer] Integer representing the number of days after an invoice's creation that the invoice will become past due. If an invoice's net terms are set to '0', it is due 'On Receipt' and will become past due 24 hours after it’s created. If an invoice is due net 30, it will become past due at 31 days exactly.
+      define_attribute :net_terms, Integer
+
+      # @!attribute next_bill_date
+      #   @return [DateTime] If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). This can be used to align the subscription’s billing to a specific day of the month. For a subscription in a trial period, this will change when the trial expires. This parameter is useful for postponement of a subscription to change its billing date without proration.
+      define_attribute :next_bill_date, DateTime
+
+      # @!attribute po_number
+      #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
+      define_attribute :po_number, String
+
+      # @!attribute remaining_billing_cycles
+      #   @return [Integer] The remaining billing cycles in the current term.
+      define_attribute :remaining_billing_cycles, Integer
+
+      # @!attribute renewal_billing_cycles
+      #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
+      define_attribute :renewal_billing_cycles, Integer
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute shipping
+      #   @return [SubscriptionShippingUpdate] Subscription shipping details
+      define_attribute :shipping, :SubscriptionShippingUpdate
+
+      # @!attribute tax_inclusive
+      #   @return [Boolean] This field is deprecated. Please do not use it.
+      define_attribute :tax_inclusive, :Boolean
+
+      # @!attribute terms_and_conditions
+      #   @return [String] Specify custom notes to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals.
+      define_attribute :terms_and_conditions, String
+    end
+  end
+end

data/lib/recurly/requests/tier.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 Requests
+    class Tier < Request
+
+      # @!attribute currencies
+      #   @return [Array[Pricing]] Tier pricing
+      define_attribute :currencies, Array, { :item_type => :Pricing }
+
+      # @!attribute ending_quantity
+      #   @return [Integer] Ending quantity
+      define_attribute :ending_quantity, Integer
+    end
+  end
+end

data/lib/recurly/requests/usage_create.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 Requests
+    class UsageCreate < Request
+
+      # @!attribute amount
+      #   @return [Float] The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places.  Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is "500").
+      define_attribute :amount, Float
+
+      # @!attribute merchant_tag
+      #   @return [String] Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint.
+      define_attribute :merchant_tag, String
+
+      # @!attribute recording_timestamp
+      #   @return [DateTime] When the usage was recorded in your system.
+      define_attribute :recording_timestamp, DateTime
+
+      # @!attribute usage_timestamp
+      #   @return [DateTime] When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition.
+      define_attribute :usage_timestamp, DateTime
+    end
+  end
+end

data/lib/recurly/requests.rb

@@ -0,0 +1,8 @@
+# Include all request files
+resources = File.join(File.dirname(__FILE__), "requests", "*.rb")
+Dir.glob(resources, &method(:require))
+
+module Recurly
+  module Requests
+  end
+end