maxio-advanced-billing-sdk 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e794dec4e6e0ed8d205c57b25cd86308e63832c61276d5199c30e771380f982
-  data.tar.gz: 51cdb3baf82c47a6517215e6d13b4fcc4f9e5b3c0796e2abebb83904de14202b
+  metadata.gz: 4162d051ddc0cf07b64fd725db7e949703d79f1d4f6d2392f6eebc7bab3d4a93
+  data.tar.gz: 219842157f663b67e9abbc765cd0789d7493a74638c104352bcf599877ec4d40
 SHA512:
-  metadata.gz: e425f11949f8727347d53e007398adb921c065f4b95f273b45e1111e784726c6f00d6c3db2369c68a14055c6753678ba0b36bf335cdf1c240ede45f3e895773e
-  data.tar.gz: 1b10ad59202050b50634794e3e6d2244146093a1fabb3a3231d70ce172c5ed014071ed5679f3c18e7f8542b6ee000e1e4643f20524a58817974406af15d06ad2
+  metadata.gz: 9b036081cec516a5b4a0029890bf667539a4907509c3547b86a84456e3a119b95ab8d0ed1ec35cd3be15fb3a6dc32847918e2f745122d579b78d2c8477a31ccf
+  data.tar.gz: 6f10a8b2cae2905d8bb8a6b110de110f2408173f0d6a61713e3a54b5ac2252cabddbab1654fb4ec0821703e2a662aba37c31e0d4c0f239c879003acb3011349d

data/README.md

@@ -29,20 +29,55 @@ 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 7.0.0
+gem install maxio-advanced-billing-sdk -v 8.0.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'maxio-advanced-billing-sdk', '7.0.0'
+gem 'maxio-advanced-billing-sdk', '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/7.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).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'advanced_billing'
+include AdvancedBilling
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/advanced_billing
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/client.md)
+**_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)
 
 The following parameters are configurable for the API Client:
 
@@ -59,12 +94,18 @@ 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. |
-| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.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/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 |
 
 The API client can be initialized as follows:
 
+### Code-Based Client Initialization
+
 ```ruby
-client = AdvancedBilling::Client.new(
+require 'advanced_billing'
+include AdvancedBilling
+
+client = Client.new(
   basic_auth_credentials: BasicAuthCredentials.new(
     username: 'BasicAuthUserName',
     password: 'BasicAuthPassword'
@@ -74,6 +115,18 @@ client = AdvancedBilling::Client.new(
 )
 ```
 
+### Environment-Based Client Initialization
+
+```ruby
+require 'advanced_billing'
+include AdvancedBilling
+
+# Create client from environment
+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.
+
 ## Environments
 
 The SDK can be configured to use a different environment for making API calls. Available environments are:
@@ -89,52 +142,57 @@ 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/7.0.0/doc/auth/basic-authentication.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/8.0.0/doc/auth/basic-authentication.md)
 
 ## List of APIs
 
-* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/billing-portal.md)
-* [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/component-price-points.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscription-products.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/controllers/webhooks.md)
+* [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)
 
 ## 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)
+
 ### HTTP
 
-* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/http-request.md)
+* [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)
 
 ### Utilities
 
-* [ApiHelper](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/maxio-com/ab-ruby-sdk/tree/7.0.0/doc/date-time-helper.md)
+* [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)
 

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'advanced_billing'
+
+puts 'AdvancedBilling SDK loaded!'
+puts 'You can now create a client with: client = AdvancedBilling::Client.new'
+puts 'Or use from_env: client = AdvancedBilling::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/advanced_billing/client.rb

@@ -9,6 +9,10 @@ module AdvancedBilling
     include CoreLibrary
     attr_reader :config, :auth_managers
 
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
     # Access to api_exports controller.
     # @return [APIExportsController] Returns the controller instance.
     def api_exports
@@ -205,7 +209,7 @@ module AdvancedBilling
       connection: nil, adapter: :net_http_persistent, timeout: 120,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put], http_callback: nil,
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
       environment: Environment::US, site: 'subdomain',
       basic_auth_credentials: nil, config: nil
     )
@@ -216,8 +220,8 @@ module AdvancedBilling
                     backoff_factor: backoff_factor,
                     retry_statuses: retry_statuses,
                     retry_methods: retry_methods, http_callback: http_callback,
-                    environment: environment, site: site,
-                    basic_auth_credentials: basic_auth_credentials
+                    proxy_settings: proxy_settings, environment: environment,
+                    site: site, basic_auth_credentials: basic_auth_credentials
                   )
                 else
                   config
@@ -242,5 +246,12 @@ module AdvancedBilling
       %w[BasicAuth].each { |auth| @auth_managers[auth] = nil }
       @auth_managers['BasicAuth'] = BasicAuth.new(http_client_config.basic_auth_credentials)
     end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
   end
 end

data/lib/advanced_billing/configuration.rb

@@ -12,6 +12,21 @@ module AdvancedBilling
       US = 'US'.freeze,
       EU = 'EU'.freeze
     ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = US)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'us' then US
+      when 'eu' then EU
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
   end
 
   # An enum for API servers.
@@ -20,6 +35,21 @@ module AdvancedBilling
       PRODUCTION = 'production'.freeze,
       EBB = 'ebb'.freeze
     ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'production' then PRODUCTION
+      when 'ebb' then EBB
+
+      else
+        warn "[Server] Unknown server '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
   end
 
   # All configuration including auth info and base URI for the API access
@@ -36,14 +66,15 @@ module AdvancedBilling
       connection: nil, adapter: :net_http_persistent, timeout: 120,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put], http_callback: nil,
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
       environment: Environment::US, site: 'subdomain',
       basic_auth_credentials: nil
     )
       super connection: connection, adapter: adapter, timeout: timeout,
             max_retries: max_retries, retry_interval: retry_interval,
             backoff_factor: backoff_factor, retry_statuses: retry_statuses,
-            retry_methods: retry_methods, http_callback: http_callback
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings
 
       # Current API environment
       @environment = String(environment)
@@ -64,7 +95,8 @@ module AdvancedBilling
     def clone_with(connection: nil, adapter: nil, timeout: nil,
                    max_retries: nil, retry_interval: nil, backoff_factor: nil,
                    retry_statuses: nil, retry_methods: nil, http_callback: nil,
-                   environment: nil, site: nil, basic_auth_credentials: nil)
+                   proxy_settings: nil, environment: nil, site: nil,
+                   basic_auth_credentials: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -74,6 +106,7 @@ module AdvancedBilling
       retry_statuses ||= self.retry_statuses
       retry_methods ||= self.retry_methods
       http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
       environment ||= self.environment
       site ||= self.site
       basic_auth_credentials ||= self.basic_auth_credentials
@@ -84,8 +117,9 @@ module AdvancedBilling
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
                         retry_methods: retry_methods,
-                        http_callback: http_callback, environment: environment,
-                        site: site,
+                        http_callback: http_callback,
+                        proxy_settings: proxy_settings,
+                        environment: environment, site: site,
                         basic_auth_credentials: basic_auth_credentials)
     end
 
@@ -114,5 +148,48 @@ module AdvancedBilling
         ENVIRONMENTS[environment][server], parameters
       )
     end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'us'))
+      site = ENV.fetch('SITE', 'subdomain')
+      timeout = (ENV['TIMEOUT'] || 120).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      basic_auth_credentials = BasicAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+
+      Configuration.new(
+        environment: environment,
+        site: site,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        basic_auth_credentials: basic_auth_credentials,
+        proxy_settings: proxy_settings
+      )
+    end
   end
 end

data/lib/advanced_billing/controllers/advance_invoice_controller.rb

@@ -7,7 +7,7 @@ module AdvancedBilling
   # AdvanceInvoiceController
   class AdvanceInvoiceController < BaseController
     # Generate an invoice in advance for a subscription's next renewal date.
-    # [Please see our
+    # [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
@@ -85,7 +85,7 @@ module AdvancedBilling
     # A `reason` is required in order to void, and the invoice must have an open
     # status. Voiding will cause any prepayments and credits that were applied
     # to the invoice to be returned to the subscription. For a full overview of
-    # the impact of voiding, please [see our help docs]($m/Invoice).
+    # the impact of voiding, [see our help docs]($m/Invoice).
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [VoidInvoiceRequest] body Optional parameter: TODO: type

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:7.0.0 on OS {os-info}'
+      'AB SDK Ruby:8.0.0 on OS {os-info}'
     end
 
     def self.user_agent_parameters

data/lib/advanced_billing/controllers/billing_portal_controller.rb

@@ -30,8 +30,8 @@ module AdvancedBilling
     # In order to prevent abuse & overuse, we ask that you request a new URL
     # only when absolutely necessary. Management URLs are good for 65 days, so
     # you should re-use a previously generated one as much as possible. If you
-    # use the URL frequently (such as to display on your website), please **do
-    # not** make an API request to Advanced Billing every time.
+    # use the URL frequently (such as to display on your website), **do not**
+    # make an API request to Advanced Billing every time.
     # @param [Integer] customer_id Required parameter: The Chargify id of the
     # customer
     # @param [AutoInvite] auto_invite Optional parameter: When set to 1, an

data/lib/advanced_billing/controllers/component_price_points_controller.rb

@@ -40,8 +40,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This endpoint can be used to create a new price point for an existing
-    # component.
+    # Creates a price point for an existing component.
     # @param [Integer] component_id Required parameter: The Advanced Billing id
     # of the component
     # @param [CreateComponentPricePointRequest] body Optional parameter: TODO:
@@ -152,8 +151,8 @@ module AdvancedBilling
         .execute
     end
 
-    # When updating a price point, it's prices can be updated as well by
-    # creating new prices or editing / removing existing ones.
+    # 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
     # price.
     # Including an `id` will update the corresponding price, and including the

data/lib/advanced_billing/controllers/components_controller.rb

@@ -17,7 +17,7 @@ module AdvancedBilling
     # which DO NOT reset to zero at the start of every billing period. If you
     # want to bill for a quantity of something that does not change unless you
     # change it, then you want quantity components, instead.
-    # For more information on components, please see our documentation
+    # For more information on components, see our documentation
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Componen
     # ts-Overview).
     # @param [String] product_family_id Required parameter: Either the product
@@ -67,7 +67,7 @@ module AdvancedBilling
     # charge your customer a one-time fee for onboarding or other services.
     # The allocated quantity for one-time quantity-based components immediately
     # gets reset back to zero after the allocation is made.
-    # For more information on components, please see our documentation
+    # For more information on components, see our documentation
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Componen
     # ts-Overview).
     # @param [String] product_family_id Required parameter: Either the product
@@ -107,7 +107,7 @@ module AdvancedBilling
     # can then be added and “allocated” for a subscription.
     # On/off components are used for any flat fee, recurring add on (think
     # $99/month for tech support or a flat add on shipping fee).
-    # For more information on components, please see our documentation
+    # For more information on components, see our documentation
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Componen
     # ts-Overview).
     # @param [String] product_family_id Required parameter: Either the product
@@ -151,7 +151,7 @@ module AdvancedBilling
     # period for the amount of units used, prepaid components are charged for at
     # the time of purchase, and we subsequently keep track of the usage against
     # the amount purchased.
-    # For more information on components, please see our documentation
+    # For more information on components, see our documentation
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Componen
     # ts-Overview).
     # @param [String] product_family_id Required parameter: Either the product
@@ -198,7 +198,7 @@ module AdvancedBilling
     # So, instead of reporting usage directly for each component (as you would
     # with metered components), the usage is derived from analysis of your
     # events.
-    # For more information on components, please see our documentation
+    # For more information on components, see our documentation
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261141522189-Componen
     # ts-Overview).
     # @param [String] product_family_id Required parameter: Either the product
@@ -254,9 +254,8 @@ module AdvancedBilling
         .execute
     end
 
-    # This request will return information regarding a component from a specific
-    # product family.
-    # You may read the component by either the component's id or handle. When
+    # Returns information regarding a component from a specific product family.
+    # You can read the component by either the component's id or handle. When
     # using the handle, it must be prefixed with `handle:`.
     # @param [Integer] product_family_id Required parameter: The Advanced
     # Billing id of the product family to which the component belongs

data/lib/advanced_billing/controllers/coupons_controller.rb

@@ -8,11 +8,11 @@ module AdvancedBilling
   class CouponsController < BaseController
     # ## Coupons Documentation
     # Coupons can be administered in the Advanced Billing application or created
-    # via API. Please view our section on [creating
+    # via API. View our section on [creating
     # coupons](https://maxio.zendesk.com/hc/en-us/articles/24261212433165-Creati
     # ng-Editing-Deleting-Coupons) for more information.
     # Additionally, for documentation on how to apply a coupon to a subscription
-    # within the Advanced Billing UI, please see our documentation
+    # within the Advanced Billing UI, see our documentation
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-
     # and-Subscriptions).
     # ## Create Coupon
@@ -53,9 +53,6 @@ module AdvancedBilling
     end
 
     # List coupons for a specific Product Family in a Site.
-    # If the coupon is set to `use_site_exchange_rate: true`, it will return
-    # pricing based on the current exchange rate. If the flag is set to false,
-    # it will return all of the defined prices for each currency.
     # @param [Integer] product_family_id Required parameter: The Advanced
     # Billing id of the product family to which the coupon belongs
     # @param [Integer] page Optional parameter: Result records are organized in
@@ -247,9 +244,6 @@ module AdvancedBilling
     end
 
     # You can retrieve a list of coupons.
-    # If the coupon is set to `use_site_exchange_rate: true`, it will return
-    # pricing based on the current exchange rate. If the flag is set to false,
-    # it will return all of the defined prices for each currency.
     # @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
@@ -291,9 +285,9 @@ module AdvancedBilling
     # This request will provide details about the coupon usage as an array of
     # data hashes, one per product.
     # @param [Integer] product_family_id Required parameter: The Advanced
-    # Billing id of the product family to which the coupon belongs
+    # Billing id of the product family to which the coupon belongs.
     # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
-    # the coupon
+    # the coupon.
     # @return [Array[CouponUsage]] Response from the API call.
     def read_coupon_usage(product_family_id,
                           coupon_id)
@@ -423,7 +417,7 @@ module AdvancedBilling
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261208729229-Coupon-C
     # odes).
     # Additionally, for documentation on how to apply a coupon to a Subscription
-    # within the Advanced Billing UI, please see our documentation
+    # within the Advanced Billing UI, see our documentation
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261259337101-Coupons-
     # and-Subscriptions).
     # ## Create Coupon Subcode