maxio-advanced-billing-sdk 8.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4162d051ddc0cf07b64fd725db7e949703d79f1d4f6d2392f6eebc7bab3d4a93
-  data.tar.gz: 219842157f663b67e9abbc765cd0789d7493a74638c104352bcf599877ec4d40
+  metadata.gz: 55931a03c7a222eba4a541573e8a59b031224dc88744d3504e0dd2097075572e
+  data.tar.gz: d695f27b17a21691cb870dc43362491654d457799027c4603e625a3364488474
 SHA512:
-  metadata.gz: 9b036081cec516a5b4a0029890bf667539a4907509c3547b86a84456e3a119b95ab8d0ed1ec35cd3be15fb3a6dc32847918e2f745122d579b78d2c8477a31ccf
-  data.tar.gz: 6f10a8b2cae2905d8bb8a6b110de110f2408173f0d6a61713e3a54b5ac2252cabddbab1654fb4ec0821703e2a662aba37c31e0d4c0f239c879003acb3011349d
+  metadata.gz: 7c1123ccfa7205b6405f78a912abc2e8230192e204d26dd8a6bfa24c9e682ba22e612b7fbf6f05fa42b61385d86cfa7f0e7c0d8f97b2c619112240dcdd7f9a10
+  data.tar.gz: ddd4b84372a1946ef74331db82d3ba3173d55803d824f272bdc0719edf25575d959240ba35bbafa9f792dfd1b54238150bfba341096dd0a45c7181ce14d06470

data/LICENSE

@@ -3,7 +3,7 @@ License:
 The MIT License (MIT)
 http://opensource.org/licenses/MIT
 
-Copyright (c) 2014 - 2025 APIMATIC Limited
+Copyright (c) 2014 - 2026 APIMATIC Limited
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -29,16 +29,16 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json
 Install the gem from the command line:
 
 ```bash
-gem install maxio-advanced-billing-sdk -v 8.0.0
+gem install maxio-advanced-billing-sdk -v 9.1.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'maxio-advanced-billing-sdk', '8.0.0'
+gem 'maxio-advanced-billing-sdk', '9.1.0'
 ```
 
-For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/8.0.0).
+For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/9.1.0).
 
 ## IRB Console Usage
 
@@ -77,14 +77,14 @@ ruby bin/console
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
 | site | `String` | The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'` |
-| environment | `Environment` | The API environment. <br> **Default: `Environment.US`** |
+| environment | [`Environment`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/README.md#environments) | The API environment. <br> **Default: `Environment.US`** |
 | connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
 | adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
 | timeout | `Float` | The value to use for connection timeout. <br> **Default: 120** |
@@ -94,8 +94,8 @@ The following parameters are configurable for the API Client:
 | retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
 | retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
 | http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| proxy_settings | [`ProxySettings`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+| proxy_settings | [`ProxySettings`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
 
 The API client can be initialized as follows:
 
@@ -125,7 +125,7 @@ include AdvancedBilling
 client = Client.from_env
 ```
 
-See the [`Environment-Based Client Initialization`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/environment-based-client-initialization.md) section for details.
+See the [`Environment-Based Client Initialization`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/environment-based-client-initialization.md) section for details.
 
 ## Environments
 
@@ -142,57 +142,58 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/auth/basic-authentication.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/auth/basic-authentication.md)
 
 ## List of APIs
 
-* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/billing-portal.md)
-* [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/component-price-points.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscription-products.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/controllers/webhooks.md)
+* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/billing-portal.md)
+* [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/component-price-points.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-products.md)
+* [Subscription Renewals](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-renewals.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/controllers/webhooks.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [ProxySettings](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/environment-based-client-initialization.md)
+* [ProxySettings](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/environment-based-client-initialization.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/http-request.md)
+* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/http-request.md)
 
 ### Utilities
 
-* [ApiHelper](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/date-time-helper.md)
+* [ApiHelper](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.1.0/doc/date-time-helper.md)
 

data/lib/advanced_billing/client.rb

@@ -193,6 +193,12 @@ module AdvancedBilling
       @subscription_products ||= SubscriptionProductsController.new @global_configuration
     end
 
+    # Access to subscription_renewals controller.
+    # @return [SubscriptionRenewalsController] Returns the controller instance.
+    def subscription_renewals
+      @subscription_renewals ||= SubscriptionRenewalsController.new @global_configuration
+    end
+
     # Access to subscription_status controller.
     # @return [SubscriptionStatusController] Returns the controller instance.
     def subscription_status

data/lib/advanced_billing/controllers/advance_invoice_controller.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     # [See our
     # docs](https://maxio.zendesk.com/hc/en-us/articles/24252026404749-Issue-Inv
     # oice-In-Advance) for more information on advance invoices, including
-    # eligibility on generating one; for the most part, they function like any
+    # eligibility for generating one; for the most part, they function like any
     # other invoice, except they are issued early and have special behavior upon
     # being voided.
     # A subscription may only have one advance invoice per billing period.
@@ -24,7 +24,7 @@ module AdvancedBilling
     # invoices to preview this advance invoice before using this endpoint to
     # generate it.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @param [IssueAdvanceInvoiceRequest] body Optional parameter: TODO: type
     # description here
     # @return [Invoice] Response from the API call.
@@ -55,11 +55,11 @@ module AdvancedBilling
         .execute
     end
 
-    # Once an advance invoice has been generated for a subscription's upcoming
-    # renewal, it can be viewed through this endpoint. There can only be one
-    # advance invoice per subscription per billing cycle.
+    # Returns the advance invoice generated for a subscription's upcoming
+    # renewal. There can only be one advance invoice per subscription per
+    # billing cycle.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @return [Invoice] Response from the API call.
     def read_advance_invoice(subscription_id)
       @api_call
@@ -87,7 +87,7 @@ module AdvancedBilling
     # to the invoice to be returned to the subscription. For a full overview of
     # the impact of voiding, [see our help docs]($m/Invoice).
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @param [VoidInvoiceRequest] body Optional parameter: TODO: type
     # description here
     # @return [Invoice] Response from the API call.

data/lib/advanced_billing/controllers/api_exports_controller.rb

@@ -6,9 +6,8 @@
 module AdvancedBilling
   # APIExportsController
   class APIExportsController < BaseController
-    # This API returns an array of exported proforma invoices for a provided
-    # `batch_id`. Pay close attention to pagination in order to control
-    # responses from the server.
+    # Lists exported proforma invoices for a provided `batch_id`. Use pagination
+    # to control responses returned from the server.
     # Example: `GET
     # https://{subdomain}.chargify.com/api_exports/proforma_invoices/123/rows?pe
     # r_page=10000&page=1`.
@@ -47,9 +46,8 @@ module AdvancedBilling
         .execute
     end
 
-    # This API returns an array of exported invoices for a provided `batch_id`.
-    # Pay close attention to pagination in order to control responses from the
-    # server.
+    # Lists exported invoices for a provided `batch_id`. Use pagination to
+    # control responses returned from the server.
     # Example: `GET
     # https://{subdomain}.chargify.com/api_exports/invoices/123/rows?per_page=10
     # 000&page=1`.
@@ -88,9 +86,8 @@ module AdvancedBilling
         .execute
     end
 
-    # This API returns an array of exported subscriptions for a provided
-    # `batch_id`. Pay close attention to pagination in order to control
-    # responses from the server.
+    # Lists exported subscriptions for a provided `batch_id`. Use pagination to
+    # control responses returned from the server.
     # Example: `GET
     # https://{subdomain}.chargify.com/api_exports/subscriptions/123/rows?per_pa
     # ge=200&page=1`.
@@ -129,7 +126,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This API creates a proforma invoices export and returns a batchjob object.
+    # Creates a proforma invoices export and returns a batch job object.
     # It is only available for Relationship Invoicing architecture.
     # @return [BatchJobResponse] Response from the API call.
     def export_proforma_invoices
@@ -152,7 +149,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This API creates an invoices export and returns a batchjob object.
+    # Creates an invoices export and returns a batch job object.
     # @return [BatchJobResponse] Response from the API call.
     def export_invoices
       @api_call
@@ -174,7 +171,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This API creates a subscriptions export and returns a batchjob object.
+    # Creates a subscriptions export and returns a batch job object.
     # @return [BatchJobResponse] Response from the API call.
     def export_subscriptions
       @api_call
@@ -193,7 +190,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This API returns a batchjob object for proforma invoices export.
+    # Returns a batch job object for a proforma invoices export.
     # @param [String] batch_id Required parameter: Id of a Batch Job.
     # @return [BatchJobResponse] Response from the API call.
     def read_proforma_invoices_export(batch_id)
@@ -215,7 +212,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This API returns a batchjob object for invoices export.
+    # Returns a batch job object for an invoices export.
     # @param [String] batch_id Required parameter: Id of a Batch Job.
     # @return [BatchJobResponse] Response from the API call.
     def read_invoices_export(batch_id)
@@ -237,7 +234,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This API returns a batchjob object for subscriptions export.
+    # Returns a batch job object for a subscriptions export.
     # @param [String] batch_id Required parameter: Id of a Batch Job.
     # @return [BatchJobResponse] Response from the API call.
     def read_subscriptions_export(batch_id)

data/lib/advanced_billing/controllers/base_controller.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'AB SDK Ruby:8.0.0 on OS {os-info}'
+      'AB SDK Ruby:9.1.0 on OS {os-info}'
     end
 
     def self.user_agent_parameters

data/lib/advanced_billing/controllers/billing_portal_controller.rb

@@ -6,12 +6,14 @@
 module AdvancedBilling
   # BillingPortalController
   class BillingPortalController < BaseController
+    # Enables Billing Portal access for a customer, with an option to send an
+    # invitation email at the same time.
     # ## Billing Portal Documentation
     # Full documentation on how the Billing Portal operates within the Advanced
     # Billing UI can be located
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24252412965133-Billing-
     # Portal-Overview).
-    # This documentation is focused on how the to configure the Billing Portal
+    # This documentation is focused on how to configure the Billing Portal
     # Settings, as well as Subscriber Interaction and Merchant Management of the
     # Billing Portal.
     # You can use this endpoint to enable Billing Portal access for a Customer,
@@ -60,8 +62,8 @@ module AdvancedBilling
         .execute
     end
 
-    # This method will provide to the API user the exact URL required for a
-    # subscriber to access the Billing Portal.
+    # Returns the exact URL required for a subscriber to access the Billing
+    # Portal.
     # ## Rules for Management Link API
     # + When retrieving a management URL, multiple requests for the same
     # customer in a short period will return the **same** URL
@@ -99,15 +101,13 @@ module AdvancedBilling
         .execute
     end
 
-    # You can resend a customer's Billing Portal invitation.
+    # Resends a customer's Billing Portal invitation.
     # If you attempt to resend an invitation 5 times within 30 minutes, you will
-    # receive a `422` response with `error` message in the body.
+    # receive a `422` response with an `error` message in the body.
     # If you attempt to resend an invitation when the Billing Portal is already
     # disabled for a Customer, you will receive a `422` error response.
-    # If you attempt to resend an invitation when the Billing Portal is already
-    # disabled for a Customer, you will receive a `422` error response.
-    # If you attempt to resend an invitation when the Customer does not exist a
-    # Customer, you will receive a `404` error response.
+    # If you attempt to resend an invitation when the Customer does not exist,
+    # you will receive a `404` error response.
     # ## Limitations
     # This endpoint will only return a JSON response.
     # @param [Integer] customer_id Required parameter: The Chargify id of the
@@ -136,7 +136,7 @@ module AdvancedBilling
         .execute
     end
 
-    # You can revoke a customer's Billing Portal invitation.
+    # Revokes a customer's Billing Portal invitation.
     # If you attempt to revoke an invitation when the Billing Portal is already
     # disabled for a Customer, you will receive a 422 error response.
     # ## Limitations

data/lib/advanced_billing/controllers/component_price_points_controller.rb

@@ -70,8 +70,7 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to read current price points that are associated with a
-    # component.
+    # Lists the price points associated with a component.
     # You may specify the component by using either the numeric id or the
     # `handle:gold` syntax.
     # When fetching a component's price points, if you have defined multiple
@@ -120,8 +119,7 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to create multiple component price points in one
-    # request.
+    # Creates multiple component price points in one request.
     # @param [String] component_id Required parameter: The Advanced Billing id
     # of the component for which you want to fetch price points.
     # @param [CreateComponentPricePointsRequest] body Optional parameter: TODO:
@@ -151,8 +149,67 @@ module AdvancedBilling
         .execute
     end
 
-    # When updating a price point, prices can be updated as well by creating new
-    # prices or editing / removing existing ones.
+    # Clones a component price point. Custom price points (tied to a specific
+    # subscription) cannot be cloned. The following attributes are copied from
+    # the source price point:
+    # - Pricing scheme
+    # - All price tiers (with starting/ending quantities and unit prices)
+    # - Tax included setting
+    # - Currency prices (if definitive pricing is set)
+    # - Overage pricing (for prepaid usage components)
+    # - Interval settings (if multi-frequency is enabled)
+    # - Event-based billing segments (if applicable)
+    # @param [Integer | String] component_id Required parameter: The id or
+    # handle of the component. When using the handle, it must be prefixed with
+    # `handle:`. Example: `123` for an integer ID, or
+    # `handle:example-product-handle` for a string handle.
+    # @param [Integer | String] price_point_id Required parameter: The id or
+    # handle of the price point. When using the handle, it must be prefixed with
+    # `handle:`. Example: `123` for an integer ID, or
+    # `handle:example-price_point-handle` for a string handle.
+    # @param [CloneComponentPricePointRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [ComponentPricePointCurrencyOverageResponse] Response from the API call.
+    def clone_component_price_point(component_id,
+                                    price_point_id,
+                                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/components/{component_id}/price_points/{price_point_id}/clone.json',
+                                     Server::PRODUCTION)
+                   .template_param(new_parameter(component_id, key: 'component_id')
+                                    .is_required(true)
+                                    .should_encode(true)
+                                    .validator(proc do |value|
+                                      UnionTypeLookUp.get(:CloneComponentPricePointComponentId)
+                                                     .validate(value)
+                                    end))
+                   .template_param(new_parameter(price_point_id, key: 'price_point_id')
+                                    .is_required(true)
+                                    .should_encode(true)
+                                    .validator(proc do |value|
+                                      UnionTypeLookUp.get(:CloneComponentPricePointPricePointId)
+                                                     .validate(value)
+                                    end))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ComponentPricePointCurrencyOverageResponse.method(:from_hash))
+                    .local_error_template('404',
+                                          'Not Found:\'{$response.body}\'',
+                                          APIException)
+                    .local_error_template('422',
+                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                           ' Response: \'{$response.body}\'.',
+                                          ErrorListResponseException))
+        .execute
+    end
+
+    # Updates a component price point and its associated prices.
     # Passing in a price bracket without an `id` will attempt to create a new
     # price.
     # Including an `id` will update the corresponding price, and including the
@@ -206,9 +263,8 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to retrieve details for a specific component price
-    # point. You can achieve this by using either the component price point ID
-    # or handle.
+    # Returns details for a specific component price point. You can achieve this
+    # by using either the component price point ID or handle.
     # @param [Integer | String] component_id Required parameter: The id or
     # handle of the component. When using the handle, it must be prefixed with
     # `handle:`. Example: `123` for an integer ID, or
@@ -219,7 +275,7 @@ module AdvancedBilling
     # `handle:example-price_point-handle` for a string handle.
     # @param [TrueClass | FalseClass] currency_prices Optional parameter:
     # Include an array of currency price data
-    # @return [ComponentPricePointResponse] Response from the API call.
+    # @return [ComponentPricePointCurrencyOverageResponse] Response from the API call.
     def read_component_price_point(component_id,
                                    price_point_id,
                                    currency_prices: nil)
@@ -246,13 +302,13 @@ module AdvancedBilling
                    .auth(Single.new('BasicAuth')))
         .response(new_response_handler
                     .deserializer(APIHelper.method(:custom_type_deserializer))
-                    .deserialize_into(ComponentPricePointResponse.method(:from_hash)))
+                    .deserialize_into(ComponentPricePointCurrencyOverageResponse.method(:from_hash)))
         .execute
     end
 
-    # A price point can be archived at any time. Subscriptions using a price
-    # point that has been archived will continue using it until they're moved to
-    # another price point.
+    # Archives a component price point. Subscriptions using a price point that
+    # has been archived will continue using it until they're moved to another
+    # price point.
     # @param [Integer | String] component_id Required parameter: The id or
     # handle of the component. When using the handle, it must be prefixed with
     # `handle:`. Example: `123` for an integer ID, or
@@ -294,7 +350,7 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to unarchive a component price point.
+    # Unarchives a component price point.
     # @param [Integer] component_id Required parameter: The Advanced Billing id
     # of the component to which the price point belongs
     # @param [Integer] price_point_id Required parameter: The Advanced Billing
@@ -320,8 +376,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This endpoint allows you to create currency prices for a given currency
-    # that has been defined on the site level in your settings.
+    # Creates currency prices for a given currency defined at the site level.
     # When creating currency prices, they need to mirror the structure of your
     # primary pricing. For each price level defined on the component price
     # point, there should be a matching price level created in the given
@@ -356,8 +411,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This endpoint allows you to update currency prices for a given currency
-    # that has been defined on the site level in your settings.
+    # Updates currency prices for a given currency defined at the site level.
     # Note: Currency Prices are not able to be updated for custom price points.
     # @param [Integer] price_point_id Required parameter: The Advanced Billing
     # id of the price point
@@ -388,8 +442,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This method allows to retrieve a list of Components Price Points belonging
-    # to a Site.
+    # Lists all component price points belonging to a site.
     # @param [ListComponentsPricePointsInclude] include Optional parameter:
     # Allows including additional data in the response. Use in query:
     # `include=currency_prices`.