maxio-advanced-billing-sdk 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4162d051ddc0cf07b64fd725db7e949703d79f1d4f6d2392f6eebc7bab3d4a93
-  data.tar.gz: 219842157f663b67e9abbc765cd0789d7493a74638c104352bcf599877ec4d40
+  metadata.gz: d99bb2bf002ee0a7bc5ec80e0447000b6bdb579147527758be00403d356ba35f
+  data.tar.gz: c2fa38ed99bbef97a4d41d6e2ce54c877f949cedce09c83917b467c3ea64cbe2
 SHA512:
-  metadata.gz: 9b036081cec516a5b4a0029890bf667539a4907509c3547b86a84456e3a119b95ab8d0ed1ec35cd3be15fb3a6dc32847918e2f745122d579b78d2c8477a31ccf
-  data.tar.gz: 6f10a8b2cae2905d8bb8a6b110de110f2408173f0d6a61713e3a54b5ac2252cabddbab1654fb4ec0821703e2a662aba37c31e0d4c0f239c879003acb3011349d
+  metadata.gz: 34fac41ec4ea83b4168125fca951d183da08cd24ab797eac457aadbd83bd492f33c82a01a5be42c1c105240dda4f7c385456e72f43fff4ba5390a3d235e0d273
+  data.tar.gz: 5cca7b6d69365c2327cb231ec10f5467ef0a594eff89a3e281372a6ba4a86cb37a8848a4e45e22055e2b23c5219cb04db9643414fa5af78a66b06a80e28edb69

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.0.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.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/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.0.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.0.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.0.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.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/9.0.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.0.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.0.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.0.0/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/billing-portal.md)
+* [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/component-price-points.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-products.md)
+* [Subscription Renewals](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-renewals.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.0/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.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.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.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.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.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.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/maxio-com/ab-ruby-sdk/tree/9.0.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

@@ -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.
@@ -59,7 +59,7 @@ module AdvancedBilling
     # renewal, it can be viewed through this endpoint. 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/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.0.0 on OS {os-info}'
     end
 
     def self.user_agent_parameters

data/lib/advanced_billing/controllers/component_price_points_controller.rb

@@ -151,6 +151,66 @@ module AdvancedBilling
         .execute
     end
 
+    # 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
+
     # When updating a price point, prices can be updated as well by creating new
     # prices or editing / removing existing ones.
     # Passing in a price bracket without an `id` will attempt to create a new
@@ -219,7 +279,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,7 +306,7 @@ 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
 

data/lib/advanced_billing/controllers/events_controller.rb

@@ -153,7 +153,7 @@ module AdvancedBilling
     # For precise mappings from key to event_specific_data, refer to
     # [Event]($m/Event).
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @param [Integer] page Optional parameter: Result records are organized in
     # pages. By default, the first page of results is displayed. The page
     # parameter specifies a page number of results to fetch. You can start

data/lib/advanced_billing/controllers/invoices_controller.rb

@@ -424,7 +424,7 @@ module AdvancedBilling
     # Only ungrouped or primary subscriptions may be paid using the "bulk"
     # payment request.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @param [RecordPaymentRequest] body Optional parameter: TODO: type
     # description here
     # @return [RecordPaymentResponse] Response from the API call.
@@ -771,7 +771,7 @@ module AdvancedBilling
     # By default, invoices will be created with open status. Possible
     # alternative is `draft`.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @param [CreateInvoiceRequest] body Optional parameter: TODO: type
     # description here
     # @return [InvoiceResponse] Response from the API call.
@@ -804,6 +804,10 @@ module AdvancedBilling
     # automatically generated invoices. Additionally, this endpoint supports
     # email delivery to direct recipients, carbon-copy (cc) recipients, and
     # blind carbon-copy (bcc) recipients.
+    # **File Attachments**: You can attach files to invoice emails using
+    # `attachment_urls[]` parameter by providing URLs to the files you want to
+    # attach. When using attachments, the request must use `multipart/form-data`
+    # content type. Max 10 files, 10MB per file.
     # If no recipient email addresses are specified in the request, then the
     # subscription's default email configuration will be used. For example, if
     # `recipient_emails` is left blank, then the invoice will be delivered to
@@ -904,9 +908,10 @@ module AdvancedBilling
         .execute
     end
 
-    # This endpoint allows you to issue an invoice that is in "pending" status.
-    # For example, you can issue an invoice that was created when allocating new
-    # quantity on a component and using "accrue charges" option.
+    # This endpoint allows you to issue an invoice that is in "pending" or
+    # "draft" status. For example, you can issue an invoice that was created
+    # when allocating new quantity on a component and using "accrue charges"
+    # option.
     # You cannot issue a pending child invoice that was created for a member
     # subscription in a group.
     # For Remittance subscriptions, the invoice will go into "open" status and

data/lib/advanced_billing/controllers/payment_profiles_controller.rb

@@ -367,8 +367,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This will delete a payment profile belonging to the customer on the
-    # subscription.
+    # Deletes a payment profile belonging to the customer on the subscription.
     # + If the customer has multiple subscriptions, the payment profile will be
     # removed from all of them.
     # + If you delete the default payment profile for a subscription, you will
@@ -378,7 +377,7 @@ module AdvancedBilling
     # the Admin UI and use the “Add New Credit Card” or “Make Active Payment
     # Method” link, (depending on whether there are other cards present).
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @param [Integer] payment_profile_id Required parameter: The Chargify id of
     # the payment profile
     # @return [void] Response from the API call.
@@ -434,7 +433,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This will delete a Payment Profile belonging to a Subscription Group.
+    # Deletes a Payment Profile belonging to a Subscription Group.
     # **Note**: If the Payment Profile belongs to multiple Subscription Groups
     # and/or Subscriptions, it will be removed from all of them.
     # @param [String] uid Required parameter: The uid of the subscription
@@ -465,7 +464,7 @@ module AdvancedBilling
     # You must elect to change the existing payment profile to a new payment
     # profile ID in order to receive a satisfactory response from this endpoint.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @param [Integer] payment_profile_id Required parameter: The Chargify id of
     # the payment profile
     # @return [PaymentProfileResponse] Response from the API call.
@@ -577,7 +576,7 @@ module AdvancedBilling
     # requests, and to provide clear and helpful information to users who
     # encounter errors during the request process.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @return [void] Response from the API call.
     def send_request_update_payment_email(subscription_id)
       @api_call

data/lib/advanced_billing/controllers/proforma_invoices_controller.rb

@@ -119,7 +119,7 @@ module AdvancedBilling
     # create a proforma invoice, the subscription must not be in a group, must
     # not be prepaid, and must be in a live state.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @return [ProformaInvoice] Response from the API call.
     def create_proforma_invoice(subscription_id)
       @api_call
@@ -146,7 +146,7 @@ module AdvancedBilling
     # `credits`, `payments`, or `custom_fields`. To include breakdowns, pass the
     # specific field as a key in the query with a value set to `true`.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @param [String] start_date Optional parameter: The beginning date range
     # for the invoice's Due Date, in the YYYY-MM-DD format.
     # @param [String] end_date Optional parameter: The ending date range for the
@@ -208,6 +208,47 @@ module AdvancedBilling
         .execute
     end
 
+    # Allows for proforma invoices to be programmatically delivered via email.
+    # Supports email
+    # delivery to direct recipients, carbon-copy (cc) recipients, and blind
+    # carbon-copy (bcc) recipients.
+    # If `recipient_emails` is omitted, the system will fall back to the primary
+    # recipient derived from the invoice or
+    # subscription. At least one recipient must be present, either via the
+    # request body or via this default behavior, so an
+    # empty body may still succeed when defaults are available.
+    # @param [String] proforma_invoice_uid Required parameter: The uid of the
+    # proforma invoice
+    # @param [DeliverProformaInvoiceRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ProformaInvoice] Response from the API call.
+    def deliver_proforma_invoice(proforma_invoice_uid,
+                                 body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/proforma_invoices/{proforma_invoice_uid}/deliveries.json',
+                                     Server::PRODUCTION)
+                   .template_param(new_parameter(proforma_invoice_uid, key: 'proforma_invoice_uid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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(ProformaInvoice.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
+
     # This endpoint will void a proforma invoice that has the status "draft".
     # ## Restrictions
     # Proforma invoices are only available on Relationship Invoicing sites.
@@ -267,7 +308,7 @@ module AdvancedBilling
     # preview call to determine whether any billing information for the
     # subscription's upcoming renewal has changed.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
-    # the subscription
+    # the subscription.
     # @return [ProformaInvoice] Response from the API call.
     def preview_proforma_invoice(subscription_id)
       @api_call