maxio-advanced-billing-sdk 4.0.0 → 5.0.0

data/lib/advanced_billing/controllers/subscription_status_controller.rb

@@ -6,8 +6,8 @@
 module AdvancedBilling
   # SubscriptionStatusController
   class SubscriptionStatusController < BaseController
-    # Chargify offers the ability to retry collecting the balance due on a past
-    # due Subscription without waiting for the next scheduled attempt.
+    # Advanced Billing offers the ability to retry collecting the balance due on
+    # a past due Subscription without waiting for the next scheduled attempt.
     # ## Successful Reactivation
     # The response will be `200 OK` with the updated Subscription.
     # ## Failed Reactivation
@@ -26,12 +26,12 @@ module AdvancedBilling
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionResponse.method(:from_hash))
-                   .local_error_template('422',
-                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
-                                          ' Response: \'{$response.body}\'.',
-                                         ErrorListResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionResponse.method(:from_hash))
+                    .local_error_template('422',
+                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                           ' Response: \'{$response.body}\'.',
+                                          ErrorListResponseException))
         .execute
     end
 
@@ -56,15 +56,15 @@ module AdvancedBilling
                    .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(SubscriptionResponse.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}\'.',
-                                         APIException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionResponse.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}\'.',
+                                          APIException))
         .execute
     end
 
@@ -91,12 +91,12 @@ module AdvancedBilling
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionResponse.method(:from_hash))
-                   .local_error_template('422',
-                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
-                                          ' Response: \'{$response.body}\'.',
-                                         ErrorListResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionResponse.method(:from_hash))
+                    .local_error_template('422',
+                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                           ' Response: \'{$response.body}\'.',
+                                          ErrorListResponseException))
         .execute
     end
 
@@ -124,12 +124,12 @@ module AdvancedBilling
                    .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(SubscriptionResponse.method(:from_hash))
-                   .local_error_template('422',
-                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
-                                          ' Response: \'{$response.body}\'.',
-                                         ErrorListResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionResponse.method(:from_hash))
+                    .local_error_template('422',
+                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                           ' Response: \'{$response.body}\'.',
+                                          ErrorListResponseException))
         .execute
     end
 
@@ -159,24 +159,24 @@ module AdvancedBilling
                    .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(SubscriptionResponse.method(:from_hash))
-                   .local_error_template('422',
-                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
-                                          ' Response: \'{$response.body}\'.',
-                                         ErrorListResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionResponse.method(:from_hash))
+                    .local_error_template('422',
+                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                           ' Response: \'{$response.body}\'.',
+                                          ErrorListResponseException))
         .execute
     end
 
-    # Chargify offers the ability to reactivate a previously canceled
+    # Advanced Billing offers the ability to reactivate a previously canceled
     # subscription. For details on how the reactivation works, and how to
     # reactivate subscriptions through the application, see
-    # [reactivation](https://chargify.zendesk.com/hc/en-us/articles/440789873769
-    # 1).
+    # [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 Chargify. This occurs when
-    # an on-hold subscription is "resumed". This returns the subscription to an
-    # active state.**
+    # "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.
@@ -194,12 +194,12 @@ module AdvancedBilling
     # Consider a subscription which was created on June 1st, and would renew on
     # July 1st. The subscription is then canceled on June 15.
     # If a reactivation with `resume: true` were attempted _before_ what would
-    # have been the next billing date of July 1st, then Chargify would resume
-    # the subscription.
+    # have been the next billing date of July 1st, then Advanced Billing would
+    # resume the subscription.
     # If a reactivation with `resume: true` were attempted _after_ what would
-    # have been the next billing date of July 1st, then Chargify would not
-    # resume the subscription, and instead it would be reactivated with a new
-    # billing period.
+    # have been the next billing date of July 1st, then Advanced Billing would
+    # not resume the subscription, and instead it would be reactivated with a
+    # new billing period.
     # | Canceled | Reactivation | Resumable? |
     # |---|---|---|
     # | Jun 15 | June 28 | Yes |
@@ -325,17 +325,17 @@ module AdvancedBilling
                    .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(SubscriptionResponse.method(:from_hash))
-                   .local_error_template('422',
-                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
-                                          ' Response: \'{$response.body}\'.',
-                                         ErrorListResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionResponse.method(:from_hash))
+                    .local_error_template('422',
+                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                           ' Response: \'{$response.body}\'.',
+                                          ErrorListResponseException))
         .execute
     end
 
-    # Chargify offers the ability to cancel a subscription at the end of the
-    # current billing period. This period is set by its current product.
+    # Advanced Billing offers the ability to cancel a subscription at the end of
+    # the current billing period. This period is set by its current product.
     # Requesting to cancel the subscription at the end of the period sets the
     # `cancel_at_end_of_period` flag to true.
     # Note that you cannot set `cancel_at_end_of_period` at subscription
@@ -359,11 +359,11 @@ module AdvancedBilling
                    .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(DelayedCancellationResponse.method(:from_hash))
-                   .local_error_template('404',
-                                         'Not Found:\'{$response.body}\'',
-                                         APIException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DelayedCancellationResponse.method(:from_hash))
+                    .local_error_template('404',
+                                          'Not Found:\'{$response.body}\'',
+                                          APIException))
         .execute
     end
 
@@ -387,11 +387,11 @@ module AdvancedBilling
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(DelayedCancellationResponse.method(:from_hash))
-                   .local_error_template('404',
-                                         'Not Found:\'{$response.body}\'',
-                                         APIException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DelayedCancellationResponse.method(:from_hash))
+                    .local_error_template('404',
+                                          'Not Found:\'{$response.body}\'',
+                                          APIException))
         .execute
     end
 
@@ -411,8 +411,8 @@ module AdvancedBilling
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionResponse.method(:from_hash)))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionResponse.method(:from_hash)))
         .execute
     end
 
@@ -423,8 +423,8 @@ module AdvancedBilling
     # 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
-    # [here](https://chargify.zendesk.com/hc/en-us/articles/4407884887835#next-b
-    # illing).
+    # [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscrib
+    # er-Interface-Overview).
     # ## Optional Component Fields
     # This endpoint is particularly useful due to the fact that it will return
     # the computed billing amount for the base product and the components which
@@ -467,12 +467,12 @@ module AdvancedBilling
                    .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(RenewalPreviewResponse.method(:from_hash))
-                   .local_error_template('422',
-                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
-                                          ' Response: \'{$response.body}\'.',
-                                         ErrorListResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RenewalPreviewResponse.method(:from_hash))
+                    .local_error_template('422',
+                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                           ' Response: \'{$response.body}\'.',
+                                          ErrorListResponseException))
         .execute
     end
   end