maxio-advanced-billing-sdk 7.0.0 → 8.0.0

data/lib/advanced_billing/controllers/payment_profiles_controller.rb

@@ -6,40 +6,27 @@
 module AdvancedBilling
   # PaymentProfilesController
   class PaymentProfilesController < BaseController
-    # Use this endpoint to create a payment profile for a customer.
-    # Payment Profiles house the credit card, ACH (Authorize.Net or Stripe
-    # only,) or PayPal (Braintree only,) data for a customer. The payment
-    # information is attached to the customer within Advanced Billing, as
-    # opposed to the Subscription itself.
-    # You must include a customer_id so that Advanced Billing will attach it to
-    # the customer entry. If no customer_id is included the API will return a
-    # 404.
-    # ## Create a Payment Profile for ACH usage
-    # If you would like to create a payment method that is a Bank Account
-    # applicable for ACH payments use the following:
-    # ```json
-    # {
-    # "payment_profile": {
-    #   "customer_id": [Valid-Customer-ID],
-    #   "bank_name": "Best Bank",
-    #   "bank_routing_number": "021000089",
-    #   "bank_account_number": "111111111111",
-    #   "bank_account_type": "checking",
-    #   "bank_account_holder_type": "business",
-    #   "payment_type": "bank_account"
-    #   }
-    # }
-    # ```
-    # ## Taxable Subscriptions
-    # If your subscriber pays taxes on their purchased product, and you are
-    # attempting to create or update the `payment_profile`, complete address
-    # information is required. For information on required address formatting to
-    # allow your subscriber to be taxed, please see our documentation
-    # [here](https://developers.chargify.com/docs/developer-docs/d2e9e34db740e-s
-    # ignups#taxes)
-    # ## Payment Profile Documentation
-    # Full documentation on how Payment Profiles operate within Advanced Billing
-    # can be located under the following links:
+    # Creates a payment profile for a customer.
+    # When you create a new payment profile for a customer via the API, it does
+    # not automatically make the profile current for any of the customer’s
+    # subscriptions. To use the payment profile as the default, you must set it
+    # explicitly for the subscription or subscription group.
+    # Select an option from the **Request Examples** drop-down on the right side
+    # of the portal to see examples of common scenarios for creating payment
+    # profiles.
+    # Do not use real card information for testing. See the Sites articles that
+    # cover [testing your site
+    # setup](https://docs.maxio.com/hc/en-us/articles/24250712113165-Testing-Ove
+    # rview#testing-overview-0-0) for more details on testing in your sandbox.
+    # Note that collecting and sending raw card details in production requires
+    # [PCI
+    # compliance](https://docs.maxio.com/hc/en-us/articles/24183956938381-PCI-Co
+    # mpliance#pci-compliance-0-0) on your end. If your business is not PCI
+    # compliant, use
+    # [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Char
+    # gify-js-Overview#chargify-js-overview-0-0) to collect credit card or bank
+    # account information.
+    # See the following articles to learn more about subscriptions and payments:
     # + [Subscriber Payment
     # Details](https://maxio.zendesk.com/hc/en-us/articles/24251599929613-Subscr
     # iption-Summary-Payment-Details-Tab)
@@ -49,211 +36,50 @@ module AdvancedBilling
     # + [Public Signup Pages payment
     # settings](https://maxio.zendesk.com/hc/en-us/articles/24261368332557-Indiv
     # idual-Page-Settings)
-    # ## Create a Payment Profile with a Chargify.js token
-    # ```json
-    # {
-    #   "payment_profile": {
-    #     "customer_id": 1036,
-    #     "chargify_token": "tok_w68qcpnftyv53jk33jv6wk3w"
-    #   }
-    # }
-    # ```
-    # ## Active Payment Methods
-    # Creating a new payment profile for a Customer via the API will not make
-    # that Payment Profile current for any of the Customer’s Subscriptions. In
-    # order to utilize the payment profile as the default, it must be set as the
-    # default payment profile for the subscription or subscription group.
-    # ## Requirements
-    # Either the full_number, expiration_month, and expiration_year or if you
-    # have an existing vault_token from your gateway, that vault_token and the
-    # current_vault are required.
-    # Passing in the vault_token and current_vault are only allowed when
-    # creating a new payment profile.
-    # ### Taxable Subscriptions
-    # If your subscriber pays taxes on their purchased product, and you are
-    # attempting to create or update the `payment_profile`, complete address
-    # information is required. For information on required address formatting to
-    # allow your subscriber to be taxed, please see our documentation
-    # [here](https://developers.chargify.com/docs/developer-docs/d2e9e34db740e-s
-    # ignups#taxes)
-    # ## BraintreeBlue
-    # Some merchants use Braintree JavaScript libraries directly and then pass
-    # `payment_method_nonce` and/or `paypal_email` to create a payment profile.
-    # This implementation is deprecated and does not handle 3D Secure.  Instead,
-    # we have provided
-    # [Chargify.js](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0
-    # NjAzNDI0-overview) which is continuously improved and supports Credit
-    # Cards (along with 3D Secure), PayPal and ApplePay payment types.
-    # ## GoCardless
-    # For more information on GoCardless, please view the following resources:
+    # +
+    # [Taxes](https://developers.chargify.com/docs/developer-docs/d2e9e34db740e-
+    # signups#taxes)
+    # +
+    # [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Char
+    # gify-js-Overview)
+    #     + [Chargify.js with GoCardless - minimal
+    # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
+    # h_01K0PJ15QQZKCER8CFK40MR6XJ)
+    #     + [Chargify.js with GoCardless - full
+    # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
+    # h_01K0PJ15QR09JVHWW0MCA7HVJV)
+    #     + [Chargify.js with Stripe Direct Debit - minimal
+    # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
+    # h_01K0PJ15QQFKKN8Z7B7DZ9AJS5)
+    #     + [Chargify.js with Stripe Direct Debit - full
+    # example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#
+    # h_01K0PJ15QRECQQ4ECS3ZA55GY7)
+    #     + [Chargify.js with Stripe BECS Direct Debit - minimal
+    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
+    # DIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway
+    # )
+    #     + [Chargify.js with Stripe BECS Direct Debit - full
+    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
+    # DIy-examples#full-example-with-sepa-direct-debit-stripe-gateway)
     # + [Full documentation on
     # GoCardless](https://maxio.zendesk.com/hc/en-us/articles/24176159136909-GoC
     # ardless)
-    # + [Using Chargify.js with GoCardless - minimal
-    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
-    # DIy-examples#minimal-example-with-direct-debit-gocardless-gateway)
-    # + [Using Chargify.js with GoCardless - full
-    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
-    # DIy-examples#full-example-with-direct-debit-gocardless-gateway)
-    # ### GoCardless with Local Bank Details
-    # Following examples create customer, bank account and mandate in
-    # GoCardless:
-    # ```json
-    # {
-    #   "payment_profile": {
-    #     "customer_id": "Valid-Customer-ID",
-    #     "bank_name": "Royal Bank of France",
-    #     "bank_account_number": "0000000",
-    #     "bank_routing_number": "0003",
-    #     "bank_branch_code": "00006",
-    #     "payment_type": "bank_account",
-    #     "billing_address": "20 Place de la Gare",
-    #     "billing_city": "Colombes",
-    #     "billing_state": "Île-de-France",
-    #     "billing_zip": "92700",
-    #     "billing_country": "FR"
-    #   }
-    # }
-    # ```
-    # ### GoCardless with IBAN
-    # ```json
-    # {
-    #   "payment_profile": {
-    #     "customer_id": "24907598",
-    #     "bank_name": "French Bank",
-    #     "bank_iban": "FR1420041010050500013M02606",
-    #     "payment_type": "bank_account",
-    #     "billing_address": "20 Place de la Gare",
-    #     "billing_city": "Colombes",
-    #     "billing_state": "Île-de-France",
-    #     "billing_zip": "92700",
-    #     "billing_country": "FR"
-    #   }
-    # }
-    # ```
-    # ### Importing GoCardless
-    # If the customer, bank account, and mandate already exist in GoCardless, a
-    # payment profile can be created by using the IDs. In order to create masked
-    # versions of `bank_account_number` and `bank_routing_number` that are used
-    # to display within Advanced Billing Admin UI, you can pass the last four
-    # digits for this fields which then will be saved in this form
-    # `XXXX[four-provided-digits]`.
-    # ```json
-    # {
-    #   "payment_profile": {
-    #     "customer_id": "24907598",
-    #     "customer_vault_token": [Existing GoCardless Customer ID]
-    #     "vault_token": [Existing GoCardless Mandate ID],
-    #     "current_vault": "gocardless",
-    #     "bank_name": "French Bank",
-    #     "bank_account_number": [Last Four Of The Existing Account Number or
-    # IBAN if applicable],
-    #     "bank_routing_number": [Last Four Of The Existing Routing Number],
-    #     "payment_type": "bank_account",
-    #     "billing_address": "20 Place de la Gare",
-    #     "billing_city": "Colombes",
-    #     "billing_state": "Île-de-France",
-    #     "billing_zip": "92700",
-    #     "billing_country": "FR"
-    #   }
-    # }
-    # ```
-    # ## SEPA Direct Debit
-    # For more information on Stripe SEPA Direct Debit, please view the
-    # following resources:
     # + [Full documentation on Stripe SEPA Direct
     # Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-S
     # EPA-and-BECS-Direct-Debit)
-    # + [Using Chargify.js with Stripe Direct Debit - minimal
-    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
-    # DIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway
-    # )
-    # + [Using Chargify.js with Stripe Direct Debit - full
-    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
-    # DIy-examples#full-example-with-sepa-direct-debit-stripe-gateway)
-    # ### Stripe SEPA Direct Debit Payment Profiles
-    # The following example creates a customer, bank account and mandate in
-    # Stripe:
-    # ```json
-    # {
-    #   "payment_profile": {
-    #     "customer_id": "24907598",
-    #     "bank_name": "Deutsche bank",
-    #     "bank_iban": "DE89370400440532013000",
-    #     "payment_type": "bank_account",
-    #     "billing_address": "Test",
-    #     "billing_city": "Berlin",
-    #     "billing_state": "Brandenburg",
-    #     "billing_zip": "12345",
-    #     "billing_country": "DE"
-    #   }
-    # }
-    # ```
-    # ## Stripe BECS Direct Debit
-    # For more information on Stripe BECS Direct Debit, please view the
-    # following resources:
     # + [Full documentation on Stripe BECS Direct
     # Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-S
     # EPA-and-BECS-Direct-Debit)
-    # + [Using Chargify.js with Stripe BECS Direct Debit - minimal
-    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
-    # DIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway
-    # )
-    # + [Using Chargify.js with Stripe BECS Direct Debit - full
-    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
-    # DIy-examples#full-example-with-sepa-direct-debit-stripe-gateway)
-    # ### Stripe BECS Direct Debit Payment Profiles
-    # The following example creates a customer, bank account and mandate in
-    # Stripe:
-    # ```json
-    # {
-    #   "payment_profile": {
-    #     "customer_id": "24907598",
-    #     "bank_name": "Australian bank",
-    #     "bank_branch_code": "000000",
-    #     "bank_account_number": "000123456"
-    #     "payment_type": "bank_account",
-    #     "billing_address": "Test",
-    #     "billing_city": "Stony Rise",
-    #     "billing_state": "Tasmania",
-    #     "billing_zip": "12345",
-    #     "billing_country": "AU"
-    #   }
-    # }
-    # ```
-    # ## Stripe BACS Direct Debit
-    # Contact the support team to enable this payment method.
-    # For more information on Stripe BACS Direct Debit, please view the
-    # following resources:
     # + [Full documentation on Stripe BACS Direct
     # Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-S
     # EPA-and-BECS-Direct-Debit)
-    # ### Stripe BACS Direct Debit Payment Profiles
-    # The following example creates a customer, bank account and mandate in
-    # Stripe:
-    # ```json
-    # {
-    #   "payment_profile": {
-    #     "customer_id": "24907598",
-    #     "bank_name": "British bank",
-    #     "bank_branch_code": "108800",
-    #     "bank_account_number": "00012345"
-    #     "payment_type": "bank_account",
-    #     "billing_address": "Test",
-    #     "billing_city": "London",
-    #     "billing_state": "LND",
-    #     "billing_zip": "12345",
-    #     "billing_country": "GB"
-    #   }
-    # }
-    # ```
-    # ## 3D Secure - Checkout
-    # It may happen that a payment needs 3D Secure Authentication when the
-    # payment profile is created; this is referred to in our help docs as a
-    # [post-authentication
+    # ## 3D Secure Authentication during payment profile creation.
+    # When a payment requires 3D Secure Authentication to adhear to Strong
+    # Customer Authentication (SCA) during payment profile creation, the request
+    # enters a [post-authentication
     # flow](https://maxio.zendesk.com/hc/en-us/articles/24176278996493-Testing-I
     # mplementing-3D-Secure#psd2-flows-pre-authentication-and-post-authenticatio
-    # n). The server returns `422 Unprocessable Entity` in this case with the
+    # n). In this case, a 422 Unprocessable Entity status is returned with the
     # following response:
     # ```json
     # {
@@ -285,41 +111,41 @@ module AdvancedBilling
     # ```
     # To let the customer go through 3D Secure Authentication, they need to be
     # redirected to the URL specified in `action_link`.
-    # Optionally, you can specify `callback_url` parameter in the `action_link`
-    # URL if you’d like to be notified about the result of 3D Secure
-    # Authentication. The `callback_url` will return the following information:
+    # Optionally, you can specify the `callback_url` parameter in the
+    # `action_link` URL to receive notification about the result of 3D Secure
+    # Authentication.
+    # The `callback_url` will return the following information:
     # - whether the authentication was successful (`success`)
     # - the payment profile ID (`payment_profile_id`)
-    # Lastly, you can also specify a `redirect_url` parameter within the
-    # `action_link` URL if you’d like to redirect a customer back to your site.
-    # It is not possible to use `action_link` in an iframe inside a custom
-    # application. You have to redirect the customer directly to the
-    # `action_link`, then, to be notified about the result, use `redirect_url`
-    # or `callback_url`.
+    # You can also specify a `redirect_url` parameter in the `action_link` URL
+    # to redirect the customer back to your site.
+    # You cannot use action_link in an iframe inside a custom application. You
+    # must redirect the customer directly to the `action_link` and use the
+    # `redirect_url` or `callback_url` to be notified of the result.
     # The final URL that you send a customer to complete 3D Secure may resemble
     # the following, where the first half is the `action_link` and the second
     # half contains a `redirect_url` and `callback_url`:
+    #
     # `https://checkout-test.chargifypay.test/3d-secure/checkout/pay_uerzhsxd5uh
     # kbodx5jhvkg6yeu?one_time_token_id=93&callback_url=http://localhost:4000&re
     # direct_url=https://yourpage.com`
     # ### Example Redirect Flow
-    # You may wish to redirect customers to different pages depending on whether
-    # their SCA was performed successfully. Here's an example flow to use as a
-    # reference:
-    # 1. Create a payment profile via API; it requires 3DS
-    # 2. You receive a `action_link` in the response.
+    # Here's an example flow to redirect customers to different pages depending
+    # on whether SCA was performed successfully:
+    # 1. Create a payment profile via the API; it requires 3DS.
+    # 2. You receive an `action_link` in the response.
     # 3. Use this `action_link` to, for example, connect with your internal
-    # resources or generate a session_id
-    # 4. Include 1 of those attributes inside the `callback_url` and
-    # `redirect_url` to be aware which “session” this applies to
+    # resources or generate a `session_id`.
+    # 4. Include one of those attributes inside the `callback_url` and
+    # `redirect_url` to be aware which “session” this applies to.
     # 5. Redirect the customer to the `action_link` with `callback_url` and
     # `redirect_url` applied
-    # 6. After the customer finishes 3DS authentication, we let you know the
-    # result by making a request to applied `callback_url`.
+    # 6. After the customer completes 3DS authentication, we notify you of the
+    # result via the applied `callback_url`.
     # 7. After that, we redirect the customer to the `redirect_url`; at this
-    # point the result of authentication is known
+    # point the result of authentication is known.
     # 8. Optionally, you can use the applied "msg" param in the `redirect_url`
-    # to determine whether it was successful or not
+    # to determine if the redirect was successful.
     # @param [CreatePaymentProfileRequest] body Optional parameter: When
     # following the IBAN or the Local Bank details examples, a customer, bank
     # account and mandate will be created in your current vault. If the
@@ -385,8 +211,8 @@ module AdvancedBilling
 
     # Using the GET method you can retrieve a Payment Profile identified by its
     # unique ID.
-    # Please note that a different JSON object will be returned if the card
-    # method on file is a bank account.
+    # Note that a different JSON object will be returned if the card method on
+    # file is a bank account.
     # ### Response for Bank Account
     # Example response for Bank Account:
     # ```
@@ -711,8 +537,8 @@ module AdvancedBilling
     # profile instead of passing all bank account or credit card data directly
     # to a given API endpoint.
     # To obtain a One Time Token you have to use
-    # [Chargify.js](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0
-    # NjAzNDI0-overview).
+    # [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Char
+    # gify-js-Overview#chargify-js-overview-0-0).
     # @param [String] chargify_token Required parameter: Advanced Billing
     # Token
     # @return [GetOneTimeTokenRequest] Response from the API call.

data/lib/advanced_billing/controllers/product_families_controller.rb

@@ -6,8 +6,7 @@
 module AdvancedBilling
   # ProductFamiliesController
   class ProductFamiliesController < BaseController
-    # This method allows to retrieve a list of Products belonging to a Product
-    # Family.
+    # Retrieves a list of Products belonging to a Product Family.
     # @param [String] product_family_id Required parameter: Either the product
     # family's id or its handle prefixed with `handle:`
     # @param [Integer] page Optional parameter: Result records are organized in
@@ -82,9 +81,9 @@ module AdvancedBilling
         .execute
     end
 
-    # This method will create a Product Family within your Advanced Billing
-    # site. Create a Product Family to act as a container for your products,
-    # components and coupons.
+    # Creates a Product Family within your Advanced Billing site. Create a
+    # Product Family to act as a container for your products, components and
+    # coupons.
     # Full documentation on how Product Families operate within the Advanced
     # Billing UI can be located
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261098936205-Product-
@@ -112,7 +111,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This method allows to retrieve a list of Product Families for a site.
+    # Retrieve a list of Product Families for a site.
     # @param [BasicDateField] date_field Optional parameter: The type of filter
     # you would like to apply to your search. Use in query:
     # `date_field=created_at`.
@@ -155,8 +154,8 @@ module AdvancedBilling
         .execute
     end
 
-    # This method allows to retrieve a Product Family via the
-    # `product_family_id`. The response will contain a Product Family object.
+    # Retrieves a Product Family via the `product_family_id`. The response will
+    # contain a Product Family object.
     # The product family can be specified either with the id number, or with the
     # `handle:my-family` format.
     # @param [Integer] id Required parameter: The Advanced Billing id of the

data/lib/advanced_billing/controllers/product_price_points_controller.rb

@@ -6,9 +6,9 @@
 module AdvancedBilling
   # ProductPricePointsController
   class ProductPricePointsController < BaseController
-    # [Product Price Point
-    # Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261111947789-
-    # Product-Price-Points)
+    # Creates a Product Price Point. See the [Product Price
+    # Point](https://maxio.zendesk.com/hc/en-us/articles/24261111947789-Product-
+    # Price-Points) documentation for details.
     # @param [Integer | String] product_id Required parameter: The id or handle
     # of the product. When using the handle, it must be prefixed with
     # `handle:`
@@ -43,7 +43,7 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to retrieve a list of product price points.
+    # Retrieves a list of product price points.
     # @param [Integer | String] product_id Required parameter: The id or handle
     # of the product. When using the handle, it must be prefixed with
     # `handle:`
@@ -96,8 +96,8 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to update a product price point.
-    # Note: Custom product price points are not able to be updated.
+    # Updates a product price point.
+    # Note: Custom product price points cannot be updated.
     # @param [Integer | String] product_id Required parameter: The id or handle
     # of the product. When using the handle, it must be prefixed with `handle:`.
     # Example: `123` for an integer ID, or `handle:example-product-handle` for a
@@ -189,7 +189,7 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to archive a product price point.
+    # Archives a product price point.
     # @param [Integer | String] product_id Required parameter: The id or handle
     # of the product. When using the handle, it must be prefixed with `handle:`.
     # Example: `123` for an integer ID, or `handle:example-product-handle` for a
@@ -257,10 +257,9 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to make a product price point the default for the
+    # Sets a product price point as the default for the product.
+    # Note: Custom product price points cannot be set as the default for a
     # product.
-    # Note: Custom product price points are not able to be set as the default
-    # for a product.
     # @param [Integer] product_id Required parameter: The Advanced Billing id of
     # the product to which the price point belongs
     # @param [Integer] price_point_id Required parameter: The Advanced Billing
@@ -286,7 +285,7 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this endpoint to create multiple product price points in one request.
+    # Creates multiple product price points in one request.
     # @param [Integer] product_id Required parameter: The Advanced Billing id of
     # the product to which the price points belong
     # @param [BulkCreateProductPricePointsRequest] body Optional parameter:
@@ -316,8 +315,8 @@ 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 that has been defined on the
+    # site level in your settings.
     # When creating currency prices, they need to mirror the structure of your
     # primary pricing. If the product price point defines a trial and/or setup
     # fee, each currency must also define a trial and/or setup fee.
@@ -352,13 +351,12 @@ module AdvancedBilling
         .execute
     end
 
-    # This endpoint allows you to update the `price`s of currency prices for a
-    # given currency that exists on the product price point.
+    # Updates the `price`s of currency prices for a given currency that exists
+    # on the product price point.
     # When updating the pricing, it needs to mirror the structure of your
     # primary pricing. If the product price point defines a trial and/or setup
     # fee, each currency must also define a trial and/or setup fee.
-    # Note: Currency Prices are not able to be updated for custom product price
-    # points.
+    # Note: Currency Prices cannot be updated for custom product price points.
     # @param [Integer] product_price_point_id Required parameter: The Advanced
     # Billing id of the product price point
     # @param [UpdateCurrencyPricesRequest] body Optional parameter: TODO: type

data/lib/advanced_billing/controllers/products_controller.rb

@@ -6,7 +6,8 @@
 module AdvancedBilling
   # ProductsController
   class ProductsController < BaseController
-    # Use this method to create a product within your Advanced Billing site.
+    # Creates a product in your Advanced Billing site.
+    # See the following product docuemation for more information:
     # + [Products
     # Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261090117645-
     # Products-Overview)
@@ -42,8 +43,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This endpoint allows you to read the current details of a product that
-    # you've created in Advanced Billing.
+    # Reads the current details of a product.
     # @param [Integer] product_id Required parameter: The Advanced Billing id of
     # the product
     # @return [ProductResponse] Response from the API call.
@@ -63,7 +63,7 @@ module AdvancedBilling
         .execute
     end
 
-    # Use this method to change aspects of an existing product.
+    # Updates aspects of an existing product.
     # ### Input Attributes Update Notes
     # + `update_return_params` The parameters we will append to your
     # `update_return_url`. See Return URLs and Parameters
@@ -100,9 +100,8 @@ module AdvancedBilling
         .execute
     end
 
-    # Sending a DELETE request to this endpoint will archive the product. All
-    # current subscribers will be unffected; their subscription/purchase will
-    # continue to be charged monthly.
+    # Archives the product. All current subscribers will be unffected; their
+    # subscription/purchase will continue to be charged monthly.
     # This will restrict the option to chose the product for purchase via the
     # Billing Portal, as well as disable Public Signup Pages for the product.
     # @param [Integer] product_id Required parameter: The Advanced Billing id of
@@ -128,7 +127,7 @@ module AdvancedBilling
         .execute
     end
 
-    # This method allows to retrieve a Product object by its `api_handle`.
+    # Retrieves a Product object by its `api_handle`.
     # @param [String] api_handle Required parameter: The handle of the product
     # @return [ProductResponse] Response from the API call.
     def read_product_by_handle(api_handle)

data/lib/advanced_billing/controllers/proforma_invoices_controller.rb

@@ -113,7 +113,7 @@ module AdvancedBilling
     # If the information becomes outdated, simply void the old proforma invoice
     # and generate a new one.
     # If you would like to preview the next billing amounts without generating a
-    # full proforma invoice, please use the renewal preview endpoint.
+    # full proforma invoice, use the renewal preview endpoint.
     # ## Restrictions
     # Proforma invoices are only available on Relationship Invoicing sites. To
     # create a proforma invoice, the subscription must not be in a group, must

data/lib/advanced_billing/controllers/sales_commissions_controller.rb

@@ -20,7 +20,7 @@ module AdvancedBilling
     # Access to the Sales Commission API endpoints is available to users with
     # financial access, where the seller has the Advanced Analytics component
     # enabled. For further information on getting access to Advanced Analytics
-    # please contact Maxio support.
+    # contact Maxio support.
     # > Note: The request is at seller level, it means `<<subdomain>>` variable
     # will be replaced by `app`
     # @param [String] seller_id Required parameter: The Chargify id of your
@@ -77,7 +77,7 @@ module AdvancedBilling
     # Access to the Sales Commission API endpoints is available to users with
     # financial access, where the seller has the Advanced Analytics component
     # enabled. For further information on getting access to Advanced Analytics
-    # please contact Maxio support.
+    # contact Maxio support.
     # > Note: The request is at seller level, it means `<<subdomain>>` variable
     # will be replaced by `app`
     # @param [String] seller_id Required parameter: The Chargify id of your
@@ -134,7 +134,7 @@ module AdvancedBilling
     # Access to the Sales Commission API endpoints is available to users with
     # financial access, where the seller has the Advanced Analytics component
     # enabled. For further information on getting access to Advanced Analytics
-    # please contact Maxio support.
+    # contact Maxio support.
     # > Note: The request is at seller level, it means `<<subdomain>>` variable
     # will be replaced by `app`
     # @param [String] seller_id Required parameter: The Chargify id of your