From 8ae85fafa4f145f338dab4a5256b1ed65441ecfa Mon Sep 17 00:00:00 2001
From: DX Codefresh <dx@recurly.com>
Date: Fri, 4 Nov 2022 16:25:04 +0000
Subject: [PATCH] Generated Latest Changes for v2021-02-25

---
 lib/recurly/client/operations.rb              | 18 ++++----
 lib/recurly/requests/add_on_create.rb         |  4 +-
 lib/recurly/requests/billing_info_create.rb   |  2 +-
 lib/recurly/requests/plan_create.rb           |  4 ++
 lib/recurly/requests/plan_update.rb           |  4 ++
 .../requests/subscription_add_on_create.rb    |  4 +-
 lib/recurly/resources/add_on.rb               |  2 +-
 lib/recurly/resources/plan.rb                 |  4 ++
 lib/recurly/resources/subscription_add_on.rb  |  2 +-
 lib/recurly/resources/usage.rb                |  2 +-
 openapi/api.yaml                              | 41 +++++++++++--------
 11 files changed, 53 insertions(+), 34 deletions(-)

diff --git a/lib/recurly/client/operations.rb b/lib/recurly/client/operations.rb
index b6571e4bf..e58d53621 100644
--- a/lib/recurly/client/operations.rb
+++ b/lib/recurly/client/operations.rb
@@ -588,7 +588,7 @@ def remove_a_billing_info(account_id:, billing_info_id:, **options)
       delete(path, **options)
     end
 
-    # Show the coupon redemptions for an account
+    # List the coupon redemptions for an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_coupon_redemptions list_account_coupon_redemptions api documentation}
     #
@@ -636,7 +636,7 @@ def list_account_coupon_redemptions(account_id:, **options)
       pager(path, **options)
     end
 
-    # Show the coupon redemptions that are active on an account
+    # List the coupon redemptions that are active on an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_active_coupon_redemptions list_active_coupon_redemptions api documentation}
     #
@@ -950,7 +950,7 @@ def create_line_item(account_id:, body:, **options)
       post(path, body, Requests::LineItemCreate, **options)
     end
 
-    # Fetch a list of an account's notes
+    # List an account's notes
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_account_notes list_account_notes api documentation}
     #
@@ -2357,7 +2357,7 @@ def list_invoice_line_items(invoice_id:, **options)
       pager(path, **options)
     end
 
-    # Show the coupon redemptions applied to an invoice
+    # List the coupon redemptions applied to an invoice
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_invoice_coupon_redemptions list_invoice_coupon_redemptions api documentation}
     #
@@ -3586,7 +3586,7 @@ def list_subscription_line_items(subscription_id:, **options)
       pager(path, **options)
     end
 
-    # Show the coupon redemptions for a subscription
+    # List the coupon redemptions for a subscription
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_subscription_coupon_redemptions list_subscription_coupon_redemptions api documentation}
     #
@@ -4015,7 +4015,7 @@ def get_export_files(export_date:, **options)
       get(path, **options)
     end
 
-    # Show the dunning campaigns for a site
+    # List the dunning campaigns for a site
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_dunning_campaigns list_dunning_campaigns api documentation}
     #
@@ -4032,7 +4032,7 @@ def list_dunning_campaigns(**options)
       pager(path, **options)
     end
 
-    # Show the settings for a dunning campaign
+    # Fetch a dunning campaign
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_dunning_campaign get_dunning_campaign api documentation}
     #
@@ -4078,7 +4078,7 @@ def list_invoice_templates(**options)
       pager(path, **options)
     end
 
-    # Show the settings for an invoice template
+    # Fetch an invoice template
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/get_invoice_template get_invoice_template api documentation}
     #
@@ -4092,7 +4092,7 @@ def get_invoice_template(invoice_template_id:, **options)
       get(path, **options)
     end
 
-    # Show all entitlements granted to an account
+    # List entitlements granted to an account
     #
     # {https://developers.recurly.com/api/v2021-02-25#operation/list_entitlements list_entitlements api documentation}
     #
diff --git a/lib/recurly/requests/add_on_create.rb b/lib/recurly/requests/add_on_create.rb
index a5644a274..0fd5788f3 100644
--- a/lib/recurly/requests/add_on_create.rb
+++ b/lib/recurly/requests/add_on_create.rb
@@ -79,7 +79,7 @@ class AddOnCreate < Request
       define_attribute :tax_code, String
 
       # @!attribute tier_type
-      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!attribute tiers
@@ -95,7 +95,7 @@ class AddOnCreate < Request
       define_attribute :usage_timeframe, String
 
       # @!attribute usage_type
-      #   @return [String] Type of usage, required if `add_on_type` is `usage`. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
+      #   @return [String] Type of usage, required if `add_on_type` is `usage`. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
       define_attribute :usage_type, String
     end
   end
diff --git a/lib/recurly/requests/billing_info_create.rb b/lib/recurly/requests/billing_info_create.rb
index eac4191b6..6287f71ab 100644
--- a/lib/recurly/requests/billing_info_create.rb
+++ b/lib/recurly/requests/billing_info_create.rb
@@ -115,7 +115,7 @@ class BillingInfoCreate < Request
       define_attribute :three_d_secure_action_result_token_id, String
 
       # @!attribute token_id
-      #   @return [String] A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
+      #   @return [String] A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
       define_attribute :token_id, String
 
       # @!attribute transaction_type
diff --git a/lib/recurly/requests/plan_create.rb b/lib/recurly/requests/plan_create.rb
index c2369d296..b0bcaf8cc 100644
--- a/lib/recurly/requests/plan_create.rb
+++ b/lib/recurly/requests/plan_create.rb
@@ -38,6 +38,10 @@ class PlanCreate < Request
       #   @return [Array[PlanPricing]] Pricing
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
+      # @!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 description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
diff --git a/lib/recurly/requests/plan_update.rb b/lib/recurly/requests/plan_update.rb
index e37d62462..3459cdc8b 100644
--- a/lib/recurly/requests/plan_update.rb
+++ b/lib/recurly/requests/plan_update.rb
@@ -34,6 +34,10 @@ class PlanUpdate < Request
       #   @return [Array[PlanPricing]] Optional when the pricing model is 'ramp'.
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
+      # @!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 description
       #   @return [String] Optional description, not displayed.
       define_attribute :description, String
diff --git a/lib/recurly/requests/subscription_add_on_create.rb b/lib/recurly/requests/subscription_add_on_create.rb
index 6f759c94a..a64d5c634 100644
--- a/lib/recurly/requests/subscription_add_on_create.rb
+++ b/lib/recurly/requests/subscription_add_on_create.rb
@@ -27,7 +27,7 @@ class SubscriptionAddOnCreate < Request
       define_attribute :revenue_schedule_type, String
 
       # @!attribute tiers
-      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier. See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount`. There must be one tier without an `ending_quantity` value which represents the final tier. See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
 
       # @!attribute unit_amount
@@ -39,7 +39,7 @@ class SubscriptionAddOnCreate < Request
       define_attribute :unit_amount_decimal, String
 
       # @!attribute usage_percentage
-      #   @return [Float] The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
+      #   @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 and `usage_type` is percentage. Must be omitted otherwise. `usage_percentage` does not support tiers. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an overview of how to configure usage add-ons.
       define_attribute :usage_percentage, Float
     end
   end
diff --git a/lib/recurly/resources/add_on.rb b/lib/recurly/resources/add_on.rb
index 8115876b0..e57490073 100644
--- a/lib/recurly/resources/add_on.rb
+++ b/lib/recurly/resources/add_on.rb
@@ -95,7 +95,7 @@ class AddOn < Resource
       define_attribute :tax_code, String
 
       # @!attribute tier_type
-      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!attribute tiers
diff --git a/lib/recurly/resources/plan.rb b/lib/recurly/resources/plan.rb
index a7ed58fe2..d5492477f 100644
--- a/lib/recurly/resources/plan.rb
+++ b/lib/recurly/resources/plan.rb
@@ -38,6 +38,10 @@ class Plan < Resource
       #   @return [Array[PlanPricing]] Pricing
       define_attribute :currencies, Array, { :item_type => :PlanPricing }
 
+      # @!attribute custom_fields
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
+      define_attribute :custom_fields, Array, { :item_type => :CustomField }
+
       # @!attribute deleted_at
       #   @return [DateTime] Deleted at
       define_attribute :deleted_at, DateTime
diff --git a/lib/recurly/resources/subscription_add_on.rb b/lib/recurly/resources/subscription_add_on.rb
index e2e01436d..4efe3a9c7 100644
--- a/lib/recurly/resources/subscription_add_on.rb
+++ b/lib/recurly/resources/subscription_add_on.rb
@@ -47,7 +47,7 @@ class SubscriptionAddOn < Resource
       define_attribute :subscription_id, String
 
       # @!attribute tier_type
-      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!attribute tiers
diff --git a/lib/recurly/resources/usage.rb b/lib/recurly/resources/usage.rb
index f333485ae..cebeb1c33 100644
--- a/lib/recurly/resources/usage.rb
+++ b/lib/recurly/resources/usage.rb
@@ -43,7 +43,7 @@ class Usage < Resource
       define_attribute :recording_timestamp, DateTime
 
       # @!attribute tier_type
-      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
+      #   @return [String] The pricing model for the add-on.  For more information, [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how to configure quantity-based pricing models.
       define_attribute :tier_type, String
 
       # @!attribute tiers
diff --git a/openapi/api.yaml b/openapi/api.yaml
index f75d8c9e2..4e9e8636b 100644
--- a/openapi/api.yaml
+++ b/openapi/api.yaml
@@ -57,7 +57,7 @@ info:
 
     We encourage you to update to the latest version of the API and corresponding client library,
     as most recent versions are more performant than their predecessors. See the
-    [changelog](https://developers.recurly.com/api/changelog.html) for a comprehensive list of changes
+    [changelog](https://recurly.com/developers/api/changelog.html) for a comprehensive list of changes
     introduced in the latest API version.
 
     ### Default Versions
@@ -114,7 +114,7 @@ info:
     Please consider changing these messages in the target system to be better
     suited to the audience of the system.
 
-    Please see [transaction error codes](https://developers.recurly.com/pages/api-transaction-errors.html) for more details.
+    Please see [transaction error codes](https://recurly.com/developers/pages/api-transaction-errors.html) for more details.
 
     ## Pagination
     ### Response Schema
@@ -181,7 +181,7 @@ info:
 
     ## Change Log
 
-    A list of changes for this version can be found [in the changelog](https://developers.recurly.com/api/changelog.html#v2021-02-25---current-ga-version).
+    A list of changes for this version can be found [in the changelog](https://recurly.com/developers/api/changelog.html#v2021-02-25---current-ga-version).
   version: v2021-02-25
 security:
 - api_key: []
@@ -2694,7 +2694,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_account_coupon_redemptions
-      summary: Show the coupon redemptions for an account
+      summary: List the coupon redemptions for an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -2791,7 +2791,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_active_coupon_redemptions
-      summary: Show the coupon redemptions that are active on an account
+      summary: List the coupon redemptions that are active on an account
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -3944,7 +3944,7 @@ paths:
       tags:
       - note
       operationId: list_account_notes
-      summary: Fetch a list of an account's notes
+      summary: List an account's notes
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -8742,7 +8742,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_invoice_coupon_redemptions
-      summary: Show the coupon redemptions applied to an invoice
+      summary: List the coupon redemptions applied to an invoice
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -13327,7 +13327,7 @@ paths:
       tags:
       - coupon_redemption
       operationId: list_subscription_coupon_redemptions
-      summary: Show the coupon redemptions for a subscription
+      summary: List the coupon redemptions for a subscription
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -14907,7 +14907,7 @@ paths:
       tags:
       - dunning_campaigns
       operationId: list_dunning_campaigns
-      summary: Show the dunning campaigns for a site
+      summary: List the dunning campaigns for a site
       description: See the [Pagination Guide](/guides/pagination.html) to learn how
         to use pagination in the API and Client Libraries.
       parameters:
@@ -14939,7 +14939,7 @@ paths:
       tags:
       - dunning_campaigns
       operationId: get_dunning_campaign
-      summary: Show the settings for a dunning campaign
+      summary: Fetch a dunning campaign
       responses:
         '200':
           description: Settings for a dunning campaign.
@@ -15042,7 +15042,7 @@ paths:
       tags:
       - invoice_templates
       operationId: get_invoice_template
-      summary: Show the settings for an invoice template
+      summary: Fetch an invoice template
       responses:
         '200':
           description: Settings for an invoice template.
@@ -15077,7 +15077,7 @@ paths:
       tags:
       - account
       operationId: list_entitlements
-      summary: Show all entitlements granted to an account
+      summary: List entitlements granted to an account
       responses:
         '200':
           description: A list of the entitlements granted to an account.
@@ -16882,7 +16882,7 @@ components:
         token_id:
           type: string
           title: Token ID
-          description: A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
+          description: A token [generated by Recurly.js](https://recurly.com/developers/reference/recurly-js/#getting-a-token).
           maxLength: 22
         first_name:
           type: string
@@ -19090,6 +19090,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -19260,6 +19262,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -19474,6 +19478,8 @@ components:
           title: Ramp Intervals
           items:
             "$ref": "#/components/schemas/PlanRampInterval"
+        custom_fields:
+          "$ref": "#/components/schemas/CustomFields"
         revenue_schedule_type:
           title: Revenue schedule type
           "$ref": "#/components/schemas/RevenueScheduleTypeEnum"
@@ -20491,7 +20497,7 @@ components:
             If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent. The `tiers` object
             must include one to many tiers with `ending_quantity` and `unit_amount`.
             There must be one tier without an `ending_quantity` value which represents the final tier.
-            See our [Guide](https://developers.recurly.com/guides/item-addon-guide.html)
+            See our [Guide](https://recurly.com/developers/guides/item-addon-guide.html)
             for an overview of how to configure quantity-based pricing models.
         percentage_tiers:
           type: array
@@ -20512,7 +20518,7 @@ components:
           description: 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 and `usage_type` is percentage. Must be omitted
-            otherwise. `usage_percentage` does not support tiers. See our [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html)
+            otherwise. `usage_percentage` does not support tiers. See our [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html)
             for an overview of how to configure usage add-ons.
         revenue_schedule_type:
           title: Revenue schedule type
@@ -22367,6 +22373,7 @@ components:
       enum:
       - account
       - item
+      - plan
       - subscription
     RefundTypeEnum:
       type: string
@@ -22596,7 +22603,7 @@ components:
       title: Usage Type
       description: |
         Type of usage, required if `add_on_type` is `usage`. See our
-        [Guide](https://developers.recurly.com/guides/usage-based-billing-guide.html) for an
+        [Guide](https://recurly.com/developers/guides/usage-based-billing-guide.html) for an
         overview of how to configure usage add-ons.
     TierTypeEnum:
       type: string
@@ -22604,7 +22611,7 @@ components:
       description: |
         The pricing model for the add-on.  For more information,
         [click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
-        [Guide](https://developers.recurly.com/guides/item-addon-guide.html) for an overview of how
+        [Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
         to configure quantity-based pricing models.
       default: flat
       enum: