maxio-advanced-billing-sdk 7.0.1 → 8.0.0

data/lib/advanced_billing/controllers/subscription_components_controller.rb

@@ -528,48 +528,46 @@ module AdvancedBilling
         .execute
     end
 
-    # ## Documentation
+    # Records an instance of metered or prepaid usage for a subscription.
+    # You can report metered or prepaid usage to Advanced Billing as often as
+    # you wish. You can report usage as it happens or periodically, such as each
+    # night or once per billing period.
     # Full documentation on how to create Components in the Advanced Billing UI
     # can be located
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Create-E
     # dit-and-Archive-Components). Additionally, for information on how to
-    # record component usage against a subscription, please see the following
+    # record component usage against a subscription, see the following
     # resources:
-    # + [Recording Metered Component
+    # It is not possible to record metered usage for more than one component at
+    # a time Usage should be reported as one API call per component on a single
+    # subscription. For example, to record that a subscriber has sent both an
+    # SMS Message and an Email, send an API call for each.
+    # See the following product documention articles for more information:
+    # - [Create and Manage
+    # Components](https://maxio.zendesk.com/hc/en-us/articles/24261149711501-Cre
+    # ate-Edit-and-Archive-Components). A
+    # - [Recording Metered Component
     # Usage](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reportin
     # g-Component-Allocations#reporting-metered-component-usage)
-    # + [Reporting Prepaid Component
+    # - [Reporting Prepaid Component
     # Status](https://maxio.zendesk.com/hc/en-us/articles/24251890500109-Reporti
     # ng-Component-Allocations#reporting-prepaid-component-status)
-    # You may choose to report metered or prepaid usage to Advanced Billing as
-    # often as you wish. You may report usage as it happens. You may also report
-    # usage periodically, such as each night or once per billing period. If
-    # usage events occur in your system very frequently (on the order of
-    # thousands of times an hour), it is best to accumulate usage into batches
-    # on your side, and then report those batches less frequently, such as
-    # daily. This will ensure you remain below any API throttling limits. If
-    # your use case requires higher rates of usage reporting, we recommend
-    # utilizing Events Based Components.
-    # ## Create Usage for Subscription
-    # This endpoint allows you to record an instance of metered or prepaid usage
-    # for a subscription. The `quantity` from usage for each component is
-    # accumulated to the `unit_balance` on the [Component Line
-    # Item](./b3A6MTQxMDgzNzQ-read-subscription-component) for the subscription.
+    # The `quantity` from usage for each component is accumulated to the
+    # `unit_balance` on the [Component Line
+    # Item]($e/Subscription%20Components/readSubscriptionComponent) for the
+    # subscription.
     # ## Price Point ID usage
-    # If you are using price points, for metered and prepaid usage components,
+    # If you are using price points, for metered and prepaid usage components
     # Advanced Billing gives you the option to specify a price point in your
     # request.
     # You do not need to specify a price point ID. If a price point is not
     # included, the default price point for the component will be used when the
     # usage is recorded.
-    # If an invalid `price_point_id` is submitted, the endpoint will return an
-    # error.
     # ## Deducting Usage
-    # In the event that you need to reverse a previous usage report or otherwise
-    # deduct from the current usage balance, you may provide a negative
-    # quantity.
+    # If you need to reverse a previous usage report or otherwise deduct from
+    # the current usage balance, you can provide a negative quantity.
     # Example:
-    # Previously recorded:
+    # Previously recorded quantity was 5000:
     # ```json
     # {
     #   "usage": {
@@ -578,8 +576,7 @@ module AdvancedBilling
     #   }
     # }
     # ```
-    # At this point, `unit_balance` would be `5000`. To reduce the balance to
-    # `0`, POST the following payload:
+    # To reduce the quantity to `0`, POST the following payload:
     # ```json
     # {
     #   "usage": {
@@ -591,12 +588,6 @@ module AdvancedBilling
     # The `unit_balance` has a floor of `0`; negative unit balances are never
     # allowed. For example, if the usage balance is 100 and you deduct 200
     # units, the unit balance would then be `0`, not `-100`.
-    # ## FAQ
-    # Q. Is it possible to record metered usage for more than one component at a
-    # time?
-    # A. No. Usage should be reported as one API call per component on a single
-    # subscription. For example, to record that a subscriber has sent both an
-    # SMS Message and an Email, send an API call for each.
     # @param [Integer | String] subscription_id_or_reference Required parameter:
     # Either the Advanced Billing subscription ID (integer) or the subscription
     # reference (string). Important: In cases where a numeric string value

data/lib/advanced_billing/controllers/subscription_group_status_controller.rb

@@ -6,14 +6,14 @@
 module AdvancedBilling
   # SubscriptionGroupStatusController
   class SubscriptionGroupStatusController < BaseController
-    # This endpoint will immediately cancel all subscriptions within the
-    # specified group. The group is identified by it's `uid` passed in the URL.
-    # To successfully cancel the group, the primary subscription must be on
-    # automatic billing. The group members as well must be on automatic billing
-    # or they must be prepaid.
-    # In order to cancel a subscription group while also charging for any
-    # unbilled usage on metered or prepaid components, the
-    # `charge_unbilled_usage=true` parameter must be included in the request.
+    # Cancels all subscriptions within the specified group immediately. The
+    # group is identified by the `uid` that is passed in the URL. To
+    # successfully cancel the group, the primary subscription must be on
+    # automatic billing. The group members must be on automatic billing or
+    # prepaid.
+    # To cancel a subscription group while also charging for any unbilled usage
+    # on metered or prepaid components, the `charge_unbilled_usage=true`
+    # parameter must be included in the request.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
     # @param [CancelGroupedSubscriptionsRequest] body Optional parameter: TODO:
@@ -43,7 +43,7 @@ module AdvancedBilling
 
     # This endpoint will schedule all subscriptions within the specified group
     # to be canceled at the end of their billing period. The group is identified
-    # by it's uid passed in the URL.
+    # by its uid passed in the URL.
     # All subscriptions in the group must be on automatic billing in order to
     # successfully cancel them, and the group must not be in a "past_due" state.
     # @param [String] uid Required parameter: The uid of the subscription

data/lib/advanced_billing/controllers/subscription_groups_controller.rb

@@ -17,6 +17,11 @@ module AdvancedBilling
     # Only one of the `subscriptions` can have `"primary": true` attribute set.
     # When passing product to a subscription you can use either `product_id` or
     # `product_handle` or `offer_id`. You can also use `custom_price` instead.
+    # The subscription request examples below will be split into two sections.
+    # The first section, "Subscription Customization", will focus on passing
+    # different information with a subscription, such as components, calendar
+    # billing, and custom fields. These examples will presume you are using a
+    # secure chargify_token generated by Chargify.js.
     # @param [SubscriptionGroupSignupRequest] body Optional parameter: TODO:
     # type description here
     # @return [SubscriptionGroupSignupResponse] Response from the API call.
@@ -229,9 +234,9 @@ module AdvancedBilling
     # subscription group, a new group will be created and the subscription will
     # become part of the group with the specified target customer set as the
     # responsible payer for the group's subscriptions.
-    # **Please Note:** In order to add an existing subscription to a
-    # subscription group, it must belong to either the same customer record as
-    # the target, or be within the same customer hierarchy.
+    # **Note:** In order to add an existing subscription to a subscription
+    # group, it must belong to either the same customer record as the target, or
+    # be within the same customer hierarchy.
     # Rather than specifying a customer, the `target` parameter could instead
     # simply have a value of
     # * `"self"` which indicates the subscription will be paid for not by some
@@ -240,8 +245,8 @@ module AdvancedBilling
     # subscribing customer's parent within a customer hierarchy, or
     # * `"eldest"` which indicates the subscription will be paid for by the
     # root-level customer in the subscribing customer's hierarchy.
-    # To create a new subscription into a subscription group, please reference
-    # the following:
+    # To create a new subscription into a subscription group, reference the
+    # following:
     # [Create Subscription in a Subscription
     # Group](https://developers.chargify.com/docs/api-docs/d571659cf0f24-create-
     # subscription#subscription-in-a-subscription-group)

data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb

@@ -35,7 +35,7 @@ module AdvancedBilling
     # amount will be collected using the default credit card payment profile and
     # applied to the prepayment account balance.  This is especially useful for
     # manual replenishment of prepaid subscriptions.
-    # Please note that you **can't** pass `amount_in_cents`.
+    # Note that passing `amount_in_cents` is now allowed.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [CreatePrepaymentRequest] body Optional parameter: TODO: type

data/lib/advanced_billing/controllers/subscription_products_controller.rb

@@ -26,13 +26,12 @@ module AdvancedBilling
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24181589372429-Data-Mig
     # ration-to-Advanced-Billing).
     # ## Failed Migrations
-    # One of the most common ways that a migration can fail is when the attempt
-    # is made to migrate a subscription to it's current product. Please be aware
-    # of this issue!
+    # Importaint note: One of the most common ways that a migration can fail is
+    # when the attempt is made to migrate a subscription to its current product.
     # ## Migration 3D Secure - Stripe
-    # It may happen that a payment needs 3D Secure Authentication when the
-    # subscription is migrated to a new product; this is referred to in our help
-    # docs as a [post-authentication
+    # When a payment requires 3D Secure Authentication to adhear to Strong
+    # Customer Authentication (SCA) when the subscription is migrated to a new
+    # product, 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
@@ -82,7 +81,7 @@ module AdvancedBilling
     # urpage.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
+    # SCA was performed successfully. Here's an example flow to use as a
     # reference:
     # 1. Create a migration via API; it requires 3DS
     # 2. You receive a `gateway_payment_id` in the `action_link` along other

data/lib/advanced_billing/controllers/subscription_status_controller.rb

@@ -104,7 +104,7 @@ module AdvancedBilling
     # This will place the subscription in the on_hold state and it will not
     # renew.
     # ## Limitations
-    # You may not place a subscription on hold if the `next_billing` date is
+    # You may not place a subscription on hold if the `next_billing_at` date is
     # within 24 hours.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
@@ -176,10 +176,9 @@ module AdvancedBilling
     # reactivate subscriptions through the application, see
     # [reactivation](https://maxio.zendesk.com/hc/en-us/articles/24252109503629-
     # Reactivating-and-Resuming).
-    # **Please note: The term
-    # "resume" is used also during another process in Advanced Billing. This
-    # occurs when an on-hold subscription is "resumed". This returns the
-    # subscription to an active state.**
+    # **Note: The term "resume" is used also during another process in Advanced
+    # Billing. This occurs when an on-hold subscription is "resumed". This
+    # returns the subscription to an active state.**
     # + The response returns the subscription object in the `active` or
     # `trialing` state.
     # + The `canceled_at` and `cancellation_message` fields do not have values.
@@ -434,8 +433,8 @@ module AdvancedBilling
     # subscription’s next assessment. You can retrieve it to see a snapshot of
     # how much your customer will be charged on their next renewal.
     # The "Next Billing" amount and "Next Billing" date are already represented
-    # in the UI on each Subscriber's Summary. For more information, please see
-    # our documentation
+    # in the UI on each Subscriber's Summary. For more information, see our
+    # documentation
     # [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscrib
     # er-Interface-Overview).
     # ## Optional Component Fields