recurly 2.17.11 → 4.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.bumpversion.cfg +15 -0
- data/.changelog_config.yaml +11 -0
- data/.github/ISSUE_TEMPLATE/bug-report.md +30 -0
- data/.github/ISSUE_TEMPLATE/question-or-other.md +10 -0
- data/.github/workflows/ci.yml +29 -0
- data/.github/workflows/docs.yml +28 -0
- data/.gitignore +15 -0
- data/.rspec +2 -0
- data/.yardopts +2 -0
- data/CHANGELOG.md +295 -0
- data/CODE_OF_CONDUCT.md +130 -0
- data/CONTRIBUTING.md +106 -0
- data/GETTING_STARTED.md +330 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +9 -148
- data/Rakefile +6 -0
- data/benchmark.rb +16 -0
- data/lib/data/ca-certificates.crt +3466 -0
- data/lib/recurly/client/operations.rb +4079 -0
- data/lib/recurly/client.rb +400 -0
- data/lib/recurly/connection_pool.rb +42 -0
- data/lib/recurly/errors/api_errors.rb +90 -0
- data/lib/recurly/errors/network_errors.rb +7 -0
- data/lib/recurly/errors.rb +51 -0
- data/lib/recurly/http.rb +50 -0
- data/lib/recurly/pager.rb +136 -0
- data/lib/recurly/request.rb +31 -0
- data/lib/recurly/requests/account_acquisition_cost.rb +18 -0
- data/lib/recurly/requests/account_acquisition_update.rb +26 -0
- data/lib/recurly/requests/account_create.rb +98 -0
- data/lib/recurly/requests/account_purchase.rb +98 -0
- data/lib/recurly/requests/account_update.rb +86 -0
- data/lib/recurly/requests/add_on_create.rb +102 -0
- data/lib/recurly/requests/add_on_pricing.rb +26 -0
- data/lib/recurly/requests/add_on_update.rb +78 -0
- data/lib/recurly/requests/address.rb +38 -0
- data/lib/recurly/requests/billing_info_create.rb +134 -0
- data/lib/recurly/requests/billing_info_verify.rb +14 -0
- data/lib/recurly/requests/coupon_bulk_create.rb +14 -0
- data/lib/recurly/requests/coupon_create.rb +102 -0
- data/lib/recurly/requests/coupon_pricing.rb +18 -0
- data/lib/recurly/requests/coupon_redemption_create.rb +22 -0
- data/lib/recurly/requests/coupon_update.rb +34 -0
- data/lib/recurly/requests/custom_field.rb +18 -0
- data/lib/recurly/requests/dunning_campaigns_bulk_update.rb +18 -0
- data/lib/recurly/requests/external_refund.rb +22 -0
- data/lib/recurly/requests/external_transaction.rb +26 -0
- data/lib/recurly/requests/invoice_address.rb +54 -0
- data/lib/recurly/requests/invoice_collect.rb +22 -0
- data/lib/recurly/requests/invoice_create.rb +42 -0
- data/lib/recurly/requests/invoice_refund.rb +34 -0
- data/lib/recurly/requests/invoice_update.rb +34 -0
- data/lib/recurly/requests/item_create.rb +58 -0
- data/lib/recurly/requests/item_update.rb +58 -0
- data/lib/recurly/requests/line_item_create.rb +86 -0
- data/lib/recurly/requests/line_item_refund.rb +22 -0
- data/lib/recurly/requests/measured_unit_create.rb +22 -0
- data/lib/recurly/requests/measured_unit_update.rb +22 -0
- data/lib/recurly/requests/percentage_tier.rb +18 -0
- data/lib/recurly/requests/percentage_tiers_by_currency.rb +18 -0
- data/lib/recurly/requests/plan_create.rb +102 -0
- data/lib/recurly/requests/plan_hosted_pages.rb +26 -0
- data/lib/recurly/requests/plan_pricing.rb +26 -0
- data/lib/recurly/requests/plan_update.rb +94 -0
- data/lib/recurly/requests/pricing.rb +22 -0
- data/lib/recurly/requests/purchase_create.rb +78 -0
- data/lib/recurly/requests/shipping_address_create.rb +62 -0
- data/lib/recurly/requests/shipping_address_update.rb +66 -0
- data/lib/recurly/requests/shipping_fee_create.rb +22 -0
- data/lib/recurly/requests/shipping_method_create.rb +26 -0
- data/lib/recurly/requests/shipping_method_update.rb +26 -0
- data/lib/recurly/requests/shipping_purchase.rb +22 -0
- data/lib/recurly/requests/subscription_add_on_create.rb +46 -0
- data/lib/recurly/requests/subscription_add_on_percentage_tier.rb +18 -0
- data/lib/recurly/requests/subscription_add_on_tier.rb +26 -0
- data/lib/recurly/requests/subscription_add_on_update.rb +50 -0
- data/lib/recurly/requests/subscription_cancel.rb +14 -0
- data/lib/recurly/requests/subscription_change_billing_info_create.rb +14 -0
- data/lib/recurly/requests/subscription_change_create.rb +74 -0
- data/lib/recurly/requests/subscription_change_shipping_create.rb +30 -0
- data/lib/recurly/requests/subscription_create.rb +114 -0
- data/lib/recurly/requests/subscription_pause.rb +14 -0
- data/lib/recurly/requests/subscription_purchase.rb +70 -0
- data/lib/recurly/requests/subscription_shipping_create.rb +30 -0
- data/lib/recurly/requests/subscription_shipping_purchase.rb +22 -0
- data/lib/recurly/requests/subscription_shipping_update.rb +22 -0
- data/lib/recurly/requests/subscription_update.rb +70 -0
- data/lib/recurly/requests/tier.rb +22 -0
- data/lib/recurly/requests/tier_pricing.rb +22 -0
- data/lib/recurly/requests/usage_create.rb +26 -0
- data/lib/recurly/requests.rb +8 -0
- data/lib/recurly/resource.rb +23 -1092
- data/lib/recurly/resources/account.rb +138 -0
- data/lib/recurly/resources/account_acquisition.rb +46 -0
- data/lib/recurly/resources/account_acquisition_cost.rb +18 -0
- data/lib/recurly/resources/account_balance.rb +26 -0
- data/lib/recurly/resources/account_balance_amount.rb +22 -0
- data/lib/recurly/resources/account_mini.rb +50 -0
- data/lib/recurly/resources/account_note.rb +34 -0
- data/lib/recurly/resources/add_on.rb +122 -0
- data/lib/recurly/resources/add_on_mini.rb +54 -0
- data/lib/recurly/resources/add_on_pricing.rb +26 -0
- data/lib/recurly/resources/address.rb +38 -0
- data/lib/recurly/resources/address_with_name.rb +46 -0
- data/lib/recurly/resources/billing_info.rb +74 -0
- data/lib/recurly/resources/billing_info_updated_by.rb +18 -0
- data/lib/recurly/resources/binary_file.rb +14 -0
- data/lib/recurly/resources/coupon.rb +126 -0
- data/lib/recurly/resources/coupon_discount.rb +26 -0
- data/lib/recurly/resources/coupon_discount_pricing.rb +18 -0
- data/lib/recurly/resources/coupon_discount_trial.rb +18 -0
- data/lib/recurly/resources/coupon_mini.rb +42 -0
- data/lib/recurly/resources/coupon_redemption.rb +54 -0
- data/lib/recurly/resources/coupon_redemption_mini.rb +34 -0
- data/lib/recurly/resources/credit_payment.rb +66 -0
- data/lib/recurly/resources/custom_field.rb +18 -0
- data/lib/recurly/resources/custom_field_definition.rb +50 -0
- data/lib/recurly/resources/dunning_campaign.rb +50 -0
- data/lib/recurly/resources/dunning_campaigns_bulk_update_response.rb +18 -0
- data/lib/recurly/resources/dunning_cycle.rb +58 -0
- data/lib/recurly/resources/dunning_interval.rb +18 -0
- data/lib/recurly/resources/error.rb +22 -0
- data/lib/recurly/resources/error_may_have_transaction.rb +26 -0
- data/lib/recurly/resources/export_dates.rb +18 -0
- data/lib/recurly/resources/export_file.rb +22 -0
- data/lib/recurly/resources/export_files.rb +18 -0
- data/lib/recurly/resources/fraud_info.rb +22 -0
- data/lib/recurly/resources/invoice.rb +162 -0
- data/lib/recurly/resources/invoice_address.rb +54 -0
- data/lib/recurly/resources/invoice_collection.rb +22 -0
- data/lib/recurly/resources/invoice_mini.rb +30 -0
- data/lib/recurly/resources/invoice_template.rb +34 -0
- data/lib/recurly/resources/item.rb +82 -0
- data/lib/recurly/resources/item_mini.rb +34 -0
- data/lib/recurly/resources/line_item.rb +206 -0
- data/lib/recurly/resources/measured_unit.rb +46 -0
- data/lib/recurly/resources/payment_method.rb +70 -0
- data/lib/recurly/resources/percentage_tier.rb +18 -0
- data/lib/recurly/resources/percentage_tiers_by_currency.rb +18 -0
- data/lib/recurly/resources/plan.rb +122 -0
- data/lib/recurly/resources/plan_hosted_pages.rb +26 -0
- data/lib/recurly/resources/plan_mini.rb +26 -0
- data/lib/recurly/resources/plan_pricing.rb +26 -0
- data/lib/recurly/resources/pricing.rb +22 -0
- data/lib/recurly/resources/settings.rb +22 -0
- data/lib/recurly/resources/shipping_address.rb +82 -0
- data/lib/recurly/resources/shipping_method.rb +46 -0
- data/lib/recurly/resources/shipping_method_mini.rb +26 -0
- data/lib/recurly/resources/site.rb +54 -0
- data/lib/recurly/resources/subscription.rb +198 -0
- data/lib/recurly/resources/subscription_add_on.rb +78 -0
- data/lib/recurly/resources/subscription_add_on_percentage_tier.rb +18 -0
- data/lib/recurly/resources/subscription_add_on_tier.rb +26 -0
- data/lib/recurly/resources/subscription_change.rb +82 -0
- data/lib/recurly/resources/subscription_change_billing_info.rb +14 -0
- data/lib/recurly/resources/subscription_shipping.rb +26 -0
- data/lib/recurly/resources/tax_detail.rb +26 -0
- data/lib/recurly/resources/tax_info.rb +26 -0
- data/lib/recurly/resources/tier.rb +22 -0
- data/lib/recurly/resources/tier_pricing.rb +22 -0
- data/lib/recurly/resources/transaction.rb +162 -0
- data/lib/recurly/resources/transaction_error.rb +38 -0
- data/lib/recurly/resources/transaction_payment_gateway.rb +26 -0
- data/lib/recurly/resources/unique_coupon_code.rb +50 -0
- data/lib/recurly/resources/unique_coupon_code_params.rb +26 -0
- data/lib/recurly/resources/usage.rb +78 -0
- data/lib/recurly/resources/user.rb +42 -0
- data/lib/recurly/resources.rb +18 -0
- data/lib/recurly/schema/file_parser.rb +13 -0
- data/lib/recurly/schema/json_parser.rb +72 -0
- data/lib/recurly/schema/request_caster.rb +60 -0
- data/lib/recurly/schema/resource_caster.rb +46 -0
- data/lib/recurly/schema/schema_factory.rb +48 -0
- data/lib/recurly/schema/schema_validator.rb +144 -0
- data/lib/recurly/schema.rb +156 -0
- data/lib/recurly/version.rb +1 -15
- data/lib/recurly.rb +15 -141
- data/openapi/api.yaml +22879 -0
- data/recurly.gemspec +39 -0
- data/scripts/build +5 -0
- data/scripts/clean +6 -0
- data/scripts/format +12 -0
- data/scripts/prepare-release +50 -0
- data/scripts/release +17 -0
- data/scripts/test +15 -0
- metadata +217 -220
- data/lib/recurly/account.rb +0 -189
- data/lib/recurly/account_acquisition.rb +0 -19
- data/lib/recurly/account_balance.rb +0 -21
- data/lib/recurly/add_on.rb +0 -30
- data/lib/recurly/address.rb +0 -25
- data/lib/recurly/adjustment.rb +0 -76
- data/lib/recurly/api/errors.rb +0 -208
- data/lib/recurly/api/net_http_adapter.rb +0 -111
- data/lib/recurly/api.rb +0 -101
- data/lib/recurly/billing_info.rb +0 -82
- data/lib/recurly/coupon.rb +0 -134
- data/lib/recurly/credit_payment.rb +0 -32
- data/lib/recurly/custom_field.rb +0 -15
- data/lib/recurly/delivery.rb +0 -19
- data/lib/recurly/error.rb +0 -13
- data/lib/recurly/gift_card.rb +0 -82
- data/lib/recurly/helper.rb +0 -51
- data/lib/recurly/invoice.rb +0 -273
- data/lib/recurly/invoice_collection.rb +0 -14
- data/lib/recurly/js.rb +0 -14
- data/lib/recurly/juris_detail.rb +0 -14
- data/lib/recurly/measured_unit.rb +0 -16
- data/lib/recurly/money.rb +0 -120
- data/lib/recurly/note.rb +0 -14
- data/lib/recurly/plan.rb +0 -40
- data/lib/recurly/purchase.rb +0 -234
- data/lib/recurly/redemption.rb +0 -46
- data/lib/recurly/resource/association.rb +0 -16
- data/lib/recurly/resource/errors.rb +0 -20
- data/lib/recurly/resource/pager.rb +0 -313
- data/lib/recurly/shipping_address.rb +0 -26
- data/lib/recurly/shipping_fee.rb +0 -17
- data/lib/recurly/shipping_method.rb +0 -13
- data/lib/recurly/subscription/add_ons.rb +0 -77
- data/lib/recurly/subscription.rb +0 -330
- data/lib/recurly/subscription_add_on.rb +0 -50
- data/lib/recurly/tax_detail.rb +0 -14
- data/lib/recurly/tax_type.rb +0 -12
- data/lib/recurly/transaction/errors.rb +0 -115
- data/lib/recurly/transaction.rb +0 -129
- data/lib/recurly/usage.rb +0 -28
- data/lib/recurly/webhook/account_notification.rb +0 -10
- data/lib/recurly/webhook/billing_info_updated_notification.rb +0 -6
- data/lib/recurly/webhook/canceled_account_notification.rb +0 -6
- data/lib/recurly/webhook/canceled_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/closed_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/closed_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/credit_payment_notification.rb +0 -12
- data/lib/recurly/webhook/dunning_notification.rb +0 -14
- data/lib/recurly/webhook/expired_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/failed_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/failed_payment_notification.rb +0 -6
- data/lib/recurly/webhook/gift_card_notification.rb +0 -8
- data/lib/recurly/webhook/invoice_notification.rb +0 -12
- data/lib/recurly/webhook/low_balance_gift_card_notification.rb +0 -6
- data/lib/recurly/webhook/new_account_notification.rb +0 -6
- data/lib/recurly/webhook/new_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/new_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/new_credit_payment_notification.rb +0 -6
- data/lib/recurly/webhook/new_dunning_event_notification.rb +0 -6
- data/lib/recurly/webhook/new_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/new_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/new_usage_notification.rb +0 -8
- data/lib/recurly/webhook/notification.rb +0 -18
- data/lib/recurly/webhook/paid_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/past_due_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/past_due_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/processing_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/processing_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/processing_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/processing_payment_notification.rb +0 -6
- data/lib/recurly/webhook/purchased_gift_card_notification.rb +0 -7
- data/lib/recurly/webhook/reactivated_account_notification.rb +0 -6
- data/lib/recurly/webhook/redeemed_gift_card_notification.rb +0 -7
- data/lib/recurly/webhook/renewed_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/reopened_charge_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/reopened_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/scheduled_payment_notification.rb +0 -6
- data/lib/recurly/webhook/subscription_notification.rb +0 -12
- data/lib/recurly/webhook/successful_payment_notification.rb +0 -6
- data/lib/recurly/webhook/successful_refund_notification.rb +0 -6
- data/lib/recurly/webhook/transaction_authorized_notification.rb +0 -6
- data/lib/recurly/webhook/transaction_notification.rb +0 -12
- data/lib/recurly/webhook/transaction_status_updated_notification.rb +0 -6
- data/lib/recurly/webhook/updated_account_notification.rb +0 -6
- data/lib/recurly/webhook/updated_balance_gift_card_notification.rb +0 -7
- data/lib/recurly/webhook/updated_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/updated_subscription_notification.rb +0 -6
- data/lib/recurly/webhook/void_payment_notification.rb +0 -6
- data/lib/recurly/webhook/voided_credit_invoice_notification.rb +0 -6
- data/lib/recurly/webhook/voided_credit_payment_notification.rb +0 -6
- data/lib/recurly/webhook.rb +0 -91
- data/lib/recurly/xml/nokogiri.rb +0 -60
- data/lib/recurly/xml/rexml.rb +0 -52
- data/lib/recurly/xml.rb +0 -122
@@ -0,0 +1,78 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class AddOnUpdate < Request
|
8
|
+
|
9
|
+
# @!attribute accounting_code
|
10
|
+
# @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If an `Item` is associated to the `AddOn` then `accounting code` must be absent.
|
11
|
+
define_attribute :accounting_code, String
|
12
|
+
|
13
|
+
# @!attribute avalara_service_type
|
14
|
+
# @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. If an `Item` is associated to the `AddOn`, then the `avalara_service_type` must be absent.
|
15
|
+
define_attribute :avalara_service_type, Integer
|
16
|
+
|
17
|
+
# @!attribute avalara_transaction_type
|
18
|
+
# @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. If an `Item` is associated to the `AddOn`, then the `avalara_transaction_type` must be absent.
|
19
|
+
define_attribute :avalara_transaction_type, Integer
|
20
|
+
|
21
|
+
# @!attribute code
|
22
|
+
# @return [String] The unique identifier for the add-on within its plan. If an `Item` is associated to the `AddOn` then `code` must be absent.
|
23
|
+
define_attribute :code, String
|
24
|
+
|
25
|
+
# @!attribute currencies
|
26
|
+
# @return [Array[AddOnPricing]] If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then currencies must be absent. Must also be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.
|
27
|
+
define_attribute :currencies, Array, { :item_type => :AddOnPricing }
|
28
|
+
|
29
|
+
# @!attribute default_quantity
|
30
|
+
# @return [Integer] Default quantity for the hosted pages.
|
31
|
+
define_attribute :default_quantity, Integer
|
32
|
+
|
33
|
+
# @!attribute display_quantity
|
34
|
+
# @return [Boolean] Determines if the quantity field is displayed on the hosted pages for the add-on.
|
35
|
+
define_attribute :display_quantity, :Boolean
|
36
|
+
|
37
|
+
# @!attribute id
|
38
|
+
# @return [String] Add-on ID
|
39
|
+
define_attribute :id, String
|
40
|
+
|
41
|
+
# @!attribute measured_unit_id
|
42
|
+
# @return [String] System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
|
43
|
+
define_attribute :measured_unit_id, String
|
44
|
+
|
45
|
+
# @!attribute measured_unit_name
|
46
|
+
# @return [String] Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.
|
47
|
+
define_attribute :measured_unit_name, String
|
48
|
+
|
49
|
+
# @!attribute name
|
50
|
+
# @return [String] Describes your add-on and will appear in subscribers' invoices. If an `Item` is associated to the `AddOn` then `name` must be absent.
|
51
|
+
define_attribute :name, String
|
52
|
+
|
53
|
+
# @!attribute optional
|
54
|
+
# @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.
|
55
|
+
define_attribute :optional, :Boolean
|
56
|
+
|
57
|
+
# @!attribute percentage_tiers
|
58
|
+
# @return [Array[PercentageTiersByCurrency]] `percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier.
|
59
|
+
define_attribute :percentage_tiers, Array, { :item_type => :PercentageTiersByCurrency }
|
60
|
+
|
61
|
+
# @!attribute revenue_schedule_type
|
62
|
+
# @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.
|
63
|
+
define_attribute :revenue_schedule_type, String
|
64
|
+
|
65
|
+
# @!attribute tax_code
|
66
|
+
# @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If an `Item` is associated to the `AddOn` then `tax code` must be absent.
|
67
|
+
define_attribute :tax_code, String
|
68
|
+
|
69
|
+
# @!attribute tiers
|
70
|
+
# @return [Array[Tier]] If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier without an `ending_quantity` value which represents the final tier.
|
71
|
+
define_attribute :tiers, Array, { :item_type => :Tier }
|
72
|
+
|
73
|
+
# @!attribute usage_percentage
|
74
|
+
# @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. Required if `add_on_type` is usage, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.
|
75
|
+
define_attribute :usage_percentage, Float
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class Address < Request
|
8
|
+
|
9
|
+
# @!attribute city
|
10
|
+
# @return [String] City
|
11
|
+
define_attribute :city, String
|
12
|
+
|
13
|
+
# @!attribute country
|
14
|
+
# @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
|
15
|
+
define_attribute :country, String
|
16
|
+
|
17
|
+
# @!attribute phone
|
18
|
+
# @return [String] Phone number
|
19
|
+
define_attribute :phone, String
|
20
|
+
|
21
|
+
# @!attribute postal_code
|
22
|
+
# @return [String] Zip or postal code.
|
23
|
+
define_attribute :postal_code, String
|
24
|
+
|
25
|
+
# @!attribute region
|
26
|
+
# @return [String] State or province.
|
27
|
+
define_attribute :region, String
|
28
|
+
|
29
|
+
# @!attribute street1
|
30
|
+
# @return [String] Street 1
|
31
|
+
define_attribute :street1, String
|
32
|
+
|
33
|
+
# @!attribute street2
|
34
|
+
# @return [String] Street 2
|
35
|
+
define_attribute :street2, String
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,134 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class BillingInfoCreate < Request
|
8
|
+
|
9
|
+
# @!attribute account_number
|
10
|
+
# @return [String] The bank account number. (ACH, Bacs only)
|
11
|
+
define_attribute :account_number, String
|
12
|
+
|
13
|
+
# @!attribute account_type
|
14
|
+
# @return [String] The bank account type. (ACH only)
|
15
|
+
define_attribute :account_type, String
|
16
|
+
|
17
|
+
# @!attribute address
|
18
|
+
# @return [Address]
|
19
|
+
define_attribute :address, :Address
|
20
|
+
|
21
|
+
# @!attribute amazon_billing_agreement_id
|
22
|
+
# @return [String] Amazon billing agreement ID
|
23
|
+
define_attribute :amazon_billing_agreement_id, String
|
24
|
+
|
25
|
+
# @!attribute backup_payment_method
|
26
|
+
# @return [Boolean] The `backup_payment_method` field is used to designate a billing info as a backup on the account that will be tried if the initial billing info used for an invoice is declined. All payment methods, including the billing info marked `primary_payment_method` can be set as a backup. An account can have a maximum of 1 backup, if a user sets a different payment method as a backup, the existing backup will no longer be marked as such.
|
27
|
+
define_attribute :backup_payment_method, :Boolean
|
28
|
+
|
29
|
+
# @!attribute company
|
30
|
+
# @return [String] Company name
|
31
|
+
define_attribute :company, String
|
32
|
+
|
33
|
+
# @!attribute cvv
|
34
|
+
# @return [String] *STRONGLY RECOMMENDED*
|
35
|
+
define_attribute :cvv, String
|
36
|
+
|
37
|
+
# @!attribute external_hpp_type
|
38
|
+
# @return [String] Use for Adyen HPP billing info.
|
39
|
+
define_attribute :external_hpp_type, String
|
40
|
+
|
41
|
+
# @!attribute first_name
|
42
|
+
# @return [String] First name
|
43
|
+
define_attribute :first_name, String
|
44
|
+
|
45
|
+
# @!attribute fraud_session_id
|
46
|
+
# @return [String] Fraud Session ID
|
47
|
+
define_attribute :fraud_session_id, String
|
48
|
+
|
49
|
+
# @!attribute gateway_code
|
50
|
+
# @return [String] An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.
|
51
|
+
define_attribute :gateway_code, String
|
52
|
+
|
53
|
+
# @!attribute gateway_token
|
54
|
+
# @return [String] A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.
|
55
|
+
define_attribute :gateway_token, String
|
56
|
+
|
57
|
+
# @!attribute iban
|
58
|
+
# @return [String] The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information
|
59
|
+
define_attribute :iban, String
|
60
|
+
|
61
|
+
# @!attribute ip_address
|
62
|
+
# @return [String] *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
|
63
|
+
define_attribute :ip_address, String
|
64
|
+
|
65
|
+
# @!attribute last_name
|
66
|
+
# @return [String] Last name
|
67
|
+
define_attribute :last_name, String
|
68
|
+
|
69
|
+
# @!attribute month
|
70
|
+
# @return [String] Expiration month
|
71
|
+
define_attribute :month, String
|
72
|
+
|
73
|
+
# @!attribute name_on_account
|
74
|
+
# @return [String] The name associated with the bank account (ACH, SEPA, Bacs only)
|
75
|
+
define_attribute :name_on_account, String
|
76
|
+
|
77
|
+
# @!attribute number
|
78
|
+
# @return [String] Credit card number, spaces and dashes are accepted.
|
79
|
+
define_attribute :number, String
|
80
|
+
|
81
|
+
# @!attribute online_banking_payment_type
|
82
|
+
# @return [String] Use for Online Banking billing info.
|
83
|
+
define_attribute :online_banking_payment_type, String
|
84
|
+
|
85
|
+
# @!attribute paypal_billing_agreement_id
|
86
|
+
# @return [String] PayPal billing agreement ID
|
87
|
+
define_attribute :paypal_billing_agreement_id, String
|
88
|
+
|
89
|
+
# @!attribute primary_payment_method
|
90
|
+
# @return [Boolean] The `primary_payment_method` field is used to designate the primary billing info on the account. The first billing info created on an account will always become primary. Adding additional billing infos provides the flexibility to mark another billing info as primary, or adding additional non-primary billing infos. This can be accomplished by passing the `primary_payment_method` with a value of `true`. When adding billing infos via the billing_info and /accounts endpoints, this value is not permitted, and will return an error if provided.
|
91
|
+
define_attribute :primary_payment_method, :Boolean
|
92
|
+
|
93
|
+
# @!attribute routing_number
|
94
|
+
# @return [String] The bank's rounting number. (ACH only)
|
95
|
+
define_attribute :routing_number, String
|
96
|
+
|
97
|
+
# @!attribute sort_code
|
98
|
+
# @return [String] Bank identifier code for UK based banks. Required for Bacs based billing infos. (Bacs only)
|
99
|
+
define_attribute :sort_code, String
|
100
|
+
|
101
|
+
# @!attribute tax_identifier
|
102
|
+
# @return [String] Tax identifier is required if adding a billing info that is a consumer card in Brazil or in Argentina. This would be the customer's CPF/CNPJ (Brazil) and CUIT (Argentina). CPF, CNPJ and CUIT are tax identifiers for all residents who pay taxes in Brazil and Argentina respectively.
|
103
|
+
define_attribute :tax_identifier, String
|
104
|
+
|
105
|
+
# @!attribute tax_identifier_type
|
106
|
+
# @return [String] This field and a value of `cpf`, `cnpj` or `cuit` are required if adding a billing info that is an elo or hipercard type in Brazil or in Argentina.
|
107
|
+
define_attribute :tax_identifier_type, String
|
108
|
+
|
109
|
+
# @!attribute three_d_secure_action_result_token_id
|
110
|
+
# @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
|
111
|
+
define_attribute :three_d_secure_action_result_token_id, String
|
112
|
+
|
113
|
+
# @!attribute token_id
|
114
|
+
# @return [String] A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
|
115
|
+
define_attribute :token_id, String
|
116
|
+
|
117
|
+
# @!attribute transaction_type
|
118
|
+
# @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.
|
119
|
+
define_attribute :transaction_type, String
|
120
|
+
|
121
|
+
# @!attribute type
|
122
|
+
# @return [String] The payment method type for a non-credit card based billing info. `bacs` and `becs` are the only accepted values.
|
123
|
+
define_attribute :type, String
|
124
|
+
|
125
|
+
# @!attribute vat_number
|
126
|
+
# @return [String] VAT number
|
127
|
+
define_attribute :vat_number, String
|
128
|
+
|
129
|
+
# @!attribute year
|
130
|
+
# @return [String] Expiration year
|
131
|
+
define_attribute :year, String
|
132
|
+
end
|
133
|
+
end
|
134
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class BillingInfoVerify < Request
|
8
|
+
|
9
|
+
# @!attribute gateway_code
|
10
|
+
# @return [String] An identifier for a specific payment gateway.
|
11
|
+
define_attribute :gateway_code, String
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class CouponBulkCreate < Request
|
8
|
+
|
9
|
+
# @!attribute number_of_unique_codes
|
10
|
+
# @return [Integer] The quantity of unique coupon codes to generate
|
11
|
+
define_attribute :number_of_unique_codes, Integer
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,102 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class CouponCreate < Request
|
8
|
+
|
9
|
+
# @!attribute applies_to_all_items
|
10
|
+
# @return [Boolean] To apply coupon to Items in your Catalog, include a list of `item_codes` in the request that the coupon will apply to. Or set value to true to apply to all Items in your Catalog. The following values are not permitted when `applies_to_all_items` is included: `free_trial_amount` and `free_trial_unit`.
|
11
|
+
define_attribute :applies_to_all_items, :Boolean
|
12
|
+
|
13
|
+
# @!attribute applies_to_all_plans
|
14
|
+
# @return [Boolean] The coupon is valid for all plans if true. If false then `plans` will list the applicable plans.
|
15
|
+
define_attribute :applies_to_all_plans, :Boolean
|
16
|
+
|
17
|
+
# @!attribute applies_to_non_plan_charges
|
18
|
+
# @return [Boolean] The coupon is valid for one-time, non-plan charges if true.
|
19
|
+
define_attribute :applies_to_non_plan_charges, :Boolean
|
20
|
+
|
21
|
+
# @!attribute code
|
22
|
+
# @return [String] The code the customer enters to redeem the coupon.
|
23
|
+
define_attribute :code, String
|
24
|
+
|
25
|
+
# @!attribute coupon_type
|
26
|
+
# @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.
|
27
|
+
define_attribute :coupon_type, String
|
28
|
+
|
29
|
+
# @!attribute currencies
|
30
|
+
# @return [Array[CouponPricing]] Fixed discount currencies by currency. Required if the coupon type is `fixed`. This parameter should contain the coupon discount values
|
31
|
+
define_attribute :currencies, Array, { :item_type => :CouponPricing }
|
32
|
+
|
33
|
+
# @!attribute discount_percent
|
34
|
+
# @return [Integer] The percent of the price discounted by the coupon. Required if `discount_type` is `percent`.
|
35
|
+
define_attribute :discount_percent, Integer
|
36
|
+
|
37
|
+
# @!attribute discount_type
|
38
|
+
# @return [String] The type of discount provided by the coupon (how the amount discounted is calculated)
|
39
|
+
define_attribute :discount_type, String
|
40
|
+
|
41
|
+
# @!attribute duration
|
42
|
+
# @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.
|
43
|
+
define_attribute :duration, String
|
44
|
+
|
45
|
+
# @!attribute free_trial_amount
|
46
|
+
# @return [Integer] Sets the duration of time the `free_trial_unit` is for. Required if `discount_type` is `free_trial`.
|
47
|
+
define_attribute :free_trial_amount, Integer
|
48
|
+
|
49
|
+
# @!attribute free_trial_unit
|
50
|
+
# @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`.
|
51
|
+
define_attribute :free_trial_unit, String
|
52
|
+
|
53
|
+
# @!attribute hosted_description
|
54
|
+
# @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.
|
55
|
+
define_attribute :hosted_description, String
|
56
|
+
|
57
|
+
# @!attribute invoice_description
|
58
|
+
# @return [String] Description of the coupon on the invoice.
|
59
|
+
define_attribute :invoice_description, String
|
60
|
+
|
61
|
+
# @!attribute item_codes
|
62
|
+
# @return [Array[String]] List of item codes to which this coupon applies. Sending `item_codes` is only permitted when `applies_to_all_items` is set to false. The following values are not permitted when `item_codes` is included: `free_trial_amount` and `free_trial_unit`.
|
63
|
+
define_attribute :item_codes, Array, { :item_type => String }
|
64
|
+
|
65
|
+
# @!attribute max_redemptions
|
66
|
+
# @return [Integer] A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
|
67
|
+
define_attribute :max_redemptions, Integer
|
68
|
+
|
69
|
+
# @!attribute max_redemptions_per_account
|
70
|
+
# @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.
|
71
|
+
define_attribute :max_redemptions_per_account, Integer
|
72
|
+
|
73
|
+
# @!attribute name
|
74
|
+
# @return [String] The internal name for the coupon.
|
75
|
+
define_attribute :name, String
|
76
|
+
|
77
|
+
# @!attribute plan_codes
|
78
|
+
# @return [Array[String]] List of plan codes to which this coupon applies. Required if `applies_to_all_plans` is false. Overrides `applies_to_all_plans` when `applies_to_all_plans` is true.
|
79
|
+
define_attribute :plan_codes, Array, { :item_type => String }
|
80
|
+
|
81
|
+
# @!attribute redeem_by_date
|
82
|
+
# @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.
|
83
|
+
define_attribute :redeem_by_date, String
|
84
|
+
|
85
|
+
# @!attribute redemption_resource
|
86
|
+
# @return [String] Whether the discount is for all eligible charges on the account, or only a specific subscription.
|
87
|
+
define_attribute :redemption_resource, String
|
88
|
+
|
89
|
+
# @!attribute temporal_amount
|
90
|
+
# @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.
|
91
|
+
define_attribute :temporal_amount, Integer
|
92
|
+
|
93
|
+
# @!attribute temporal_unit
|
94
|
+
# @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.
|
95
|
+
define_attribute :temporal_unit, String
|
96
|
+
|
97
|
+
# @!attribute unique_code_template
|
98
|
+
# @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'"
|
99
|
+
define_attribute :unique_code_template, String
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class CouponPricing < Request
|
8
|
+
|
9
|
+
# @!attribute currency
|
10
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
11
|
+
define_attribute :currency, String
|
12
|
+
|
13
|
+
# @!attribute discount
|
14
|
+
# @return [Float] The fixed discount (in dollars) for the corresponding currency.
|
15
|
+
define_attribute :discount, Float
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class CouponRedemptionCreate < Request
|
8
|
+
|
9
|
+
# @!attribute coupon_id
|
10
|
+
# @return [String] Coupon ID
|
11
|
+
define_attribute :coupon_id, String
|
12
|
+
|
13
|
+
# @!attribute currency
|
14
|
+
# @return [String] 3-letter ISO 4217 currency code.
|
15
|
+
define_attribute :currency, String
|
16
|
+
|
17
|
+
# @!attribute subscription_id
|
18
|
+
# @return [String] Subscription ID
|
19
|
+
define_attribute :subscription_id, String
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class CouponUpdate < Request
|
8
|
+
|
9
|
+
# @!attribute hosted_description
|
10
|
+
# @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.
|
11
|
+
define_attribute :hosted_description, String
|
12
|
+
|
13
|
+
# @!attribute invoice_description
|
14
|
+
# @return [String] Description of the coupon on the invoice.
|
15
|
+
define_attribute :invoice_description, String
|
16
|
+
|
17
|
+
# @!attribute max_redemptions
|
18
|
+
# @return [Integer] A maximum number of redemptions for the coupon. The coupon will expire when it hits its maximum redemptions.
|
19
|
+
define_attribute :max_redemptions, Integer
|
20
|
+
|
21
|
+
# @!attribute max_redemptions_per_account
|
22
|
+
# @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.
|
23
|
+
define_attribute :max_redemptions_per_account, Integer
|
24
|
+
|
25
|
+
# @!attribute name
|
26
|
+
# @return [String] The internal name for the coupon.
|
27
|
+
define_attribute :name, String
|
28
|
+
|
29
|
+
# @!attribute redeem_by_date
|
30
|
+
# @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.
|
31
|
+
define_attribute :redeem_by_date, String
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class CustomField < Request
|
8
|
+
|
9
|
+
# @!attribute name
|
10
|
+
# @return [String] Fields must be created in the UI before values can be assigned to them.
|
11
|
+
define_attribute :name, String
|
12
|
+
|
13
|
+
# @!attribute value
|
14
|
+
# @return [String] Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
|
15
|
+
define_attribute :value, String
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class DunningCampaignsBulkUpdate < Request
|
8
|
+
|
9
|
+
# @!attribute plan_codes
|
10
|
+
# @return [Array[String]] List of `plan_codes` associated with the Plans for which the dunning campaign should be updated. Required unless `plan_ids` is present.
|
11
|
+
define_attribute :plan_codes, Array, { :item_type => String }
|
12
|
+
|
13
|
+
# @!attribute plan_ids
|
14
|
+
# @return [Array[String]] List of `plan_ids` associated with the Plans for which the dunning campaign should be updated. Required unless `plan_codes` is present.
|
15
|
+
define_attribute :plan_ids, Array, { :item_type => String }
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class ExternalRefund < Request
|
8
|
+
|
9
|
+
# @!attribute description
|
10
|
+
# @return [String] Used as the refund transactions' description.
|
11
|
+
define_attribute :description, String
|
12
|
+
|
13
|
+
# @!attribute payment_method
|
14
|
+
# @return [String] Payment method used for external refund transaction.
|
15
|
+
define_attribute :payment_method, String
|
16
|
+
|
17
|
+
# @!attribute refunded_at
|
18
|
+
# @return [DateTime] Date the external refund payment was made. Defaults to the current date-time.
|
19
|
+
define_attribute :refunded_at, DateTime
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class ExternalTransaction < Request
|
8
|
+
|
9
|
+
# @!attribute amount
|
10
|
+
# @return [Float] The total amount of the transcaction. Cannot excceed the invoice total.
|
11
|
+
define_attribute :amount, Float
|
12
|
+
|
13
|
+
# @!attribute collected_at
|
14
|
+
# @return [DateTime] Datetime that the external payment was collected. Defaults to current datetime.
|
15
|
+
define_attribute :collected_at, DateTime
|
16
|
+
|
17
|
+
# @!attribute description
|
18
|
+
# @return [String] Used as the transaction's description.
|
19
|
+
define_attribute :description, String
|
20
|
+
|
21
|
+
# @!attribute payment_method
|
22
|
+
# @return [String] Payment method used for external transaction.
|
23
|
+
define_attribute :payment_method, String
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,54 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class InvoiceAddress < Request
|
8
|
+
|
9
|
+
# @!attribute city
|
10
|
+
# @return [String] City
|
11
|
+
define_attribute :city, String
|
12
|
+
|
13
|
+
# @!attribute company
|
14
|
+
# @return [String] Company
|
15
|
+
define_attribute :company, String
|
16
|
+
|
17
|
+
# @!attribute country
|
18
|
+
# @return [String] Country, 2-letter ISO 3166-1 alpha-2 code.
|
19
|
+
define_attribute :country, String
|
20
|
+
|
21
|
+
# @!attribute first_name
|
22
|
+
# @return [String] First name
|
23
|
+
define_attribute :first_name, String
|
24
|
+
|
25
|
+
# @!attribute last_name
|
26
|
+
# @return [String] Last name
|
27
|
+
define_attribute :last_name, String
|
28
|
+
|
29
|
+
# @!attribute name_on_account
|
30
|
+
# @return [String] Name on account
|
31
|
+
define_attribute :name_on_account, String
|
32
|
+
|
33
|
+
# @!attribute phone
|
34
|
+
# @return [String] Phone number
|
35
|
+
define_attribute :phone, String
|
36
|
+
|
37
|
+
# @!attribute postal_code
|
38
|
+
# @return [String] Zip or postal code.
|
39
|
+
define_attribute :postal_code, String
|
40
|
+
|
41
|
+
# @!attribute region
|
42
|
+
# @return [String] State or province.
|
43
|
+
define_attribute :region, String
|
44
|
+
|
45
|
+
# @!attribute street1
|
46
|
+
# @return [String] Street 1
|
47
|
+
define_attribute :street1, String
|
48
|
+
|
49
|
+
# @!attribute street2
|
50
|
+
# @return [String] Street 2
|
51
|
+
define_attribute :street2, String
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# This file is automatically created by Recurly's OpenAPI generation process
|
2
|
+
# and thus any edits you make by hand will be lost. If you wish to make a
|
3
|
+
# change to this file, please create a Github issue explaining the changes you
|
4
|
+
# need and we will usher them to the appropriate places.
|
5
|
+
module Recurly
|
6
|
+
module Requests
|
7
|
+
class InvoiceCollect < Request
|
8
|
+
|
9
|
+
# @!attribute billing_info_id
|
10
|
+
# @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.
|
11
|
+
define_attribute :billing_info_id, String
|
12
|
+
|
13
|
+
# @!attribute three_d_secure_action_result_token_id
|
14
|
+
# @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
|
15
|
+
define_attribute :three_d_secure_action_result_token_id, String
|
16
|
+
|
17
|
+
# @!attribute transaction_type
|
18
|
+
# @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.
|
19
|
+
define_attribute :transaction_type, String
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|