maxio-advanced-billing-sdk 4.0.0 → 5.0.0

data/lib/advanced_billing/controllers/reason_codes_controller.rb

@@ -9,15 +9,15 @@ module AdvancedBilling
     # # Reason Codes Intro
     # ReasonCodes are a way to gain a high level view of why your customers are
     # cancelling the subcription to your product or service.
-    # Add a set of churn reason codes to be displayed in-app and/or the Chargify
+    # Add a set of churn reason codes to be displayed in-app and/or the Maxio
     # Billing Portal. As your subscribers decide to cancel their subscription,
     # learn why they decided to cancel.
     # ## Reason Code Documentation
-    # Full documentation on how Reason Codes operate within Chargify can be
-    # located under the following links.
+    # Full documentation on how Reason Codes operate within Advanced Billing can
+    # be located under the following links.
     # [Churn Reason
-    # Codes](https://chargify.zendesk.com/hc/en-us/articles/4407896775579#churn-
-    # reason-codes)
+    # Codes](https://maxio.zendesk.com/hc/en-us/articles/24286647554701-Churn-Re
+    # ason-Codes)
     # ## Create Reason Code
     # This method gives a merchant the option to create a reason codes for a
     # given Site.
@@ -34,12 +34,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(ReasonCodeResponse.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(ReasonCodeResponse.method(:from_hash))
+                    .local_error_template('422',
+                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                           ' Response: \'{$response.body}\'.',
+                                          ErrorListResponseException))
         .execute
     end
 
@@ -67,16 +67,16 @@ 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(ReasonCodeResponse.method(:from_hash))
-                   .is_response_array(true))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReasonCodeResponse.method(:from_hash))
+                    .is_response_array(true))
         .execute
     end
 
     # This method gives a merchant the option to retrieve a list of a particular
     # code for a given Site by providing the unique numerical ID of the code.
-    # @param [Integer] reason_code_id Required parameter: The Chargify id of the
-    # reason code
+    # @param [Integer] reason_code_id Required parameter: The Advanced Billing
+    # id of the reason code
     # @return [ReasonCodeResponse] response from the API call
     def read_reason_code(reason_code_id)
       new_api_call_builder
@@ -89,18 +89,18 @@ 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(ReasonCodeResponse.method(:from_hash))
-                   .local_error_template('404',
-                                         'Not Found:\'{$response.body}\'',
-                                         APIException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReasonCodeResponse.method(:from_hash))
+                    .local_error_template('404',
+                                          'Not Found:\'{$response.body}\'',
+                                          APIException))
         .execute
     end
 
     # This method gives a merchant the option to update an existing reason code
     # for a given site.
-    # @param [Integer] reason_code_id Required parameter: The Chargify id of the
-    # reason code
+    # @param [Integer] reason_code_id Required parameter: The Advanced Billing
+    # id of the reason code
     # @param [UpdateReasonCodeRequest] body Optional parameter: Example:
     # @return [ReasonCodeResponse] response from the API call
     def update_reason_code(reason_code_id,
@@ -118,19 +118,19 @@ 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(ReasonCodeResponse.method(:from_hash))
-                   .local_error_template('404',
-                                         'Not Found:\'{$response.body}\'',
-                                         APIException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReasonCodeResponse.method(:from_hash))
+                    .local_error_template('404',
+                                          'Not Found:\'{$response.body}\'',
+                                          APIException))
         .execute
     end
 
     # This method gives a merchant the option to delete one reason code from the
     # Churn Reason Codes. This code will be immediately removed. This action is
     # not reversable.
-    # @param [Integer] reason_code_id Required parameter: The Chargify id of the
-    # reason code
+    # @param [Integer] reason_code_id Required parameter: The Advanced Billing
+    # id of the reason code
     # @return [ReasonCodesJsonResponse] response from the API call
     def delete_reason_code(reason_code_id)
       new_api_call_builder
@@ -143,11 +143,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(ReasonCodesJsonResponse.method(:from_hash))
-                   .local_error_template('404',
-                                         'Not Found:\'{$response.body}\'',
-                                         APIException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReasonCodesJsonResponse.method(:from_hash))
+                    .local_error_template('404',
+                                          'Not Found:\'{$response.body}\'',
+                                          APIException))
         .execute
     end
   end

data/lib/advanced_billing/controllers/referral_codes_controller.rb

@@ -10,9 +10,10 @@ module AdvancedBilling
     # within your Site. This method is useful for validating referral codes that
     # are entered by a customer.
     # ## Referrals Documentation
-    # Full documentation on how to use the referrals feature in the Chargify UI
-    # can be located
-    # [here](https://chargify.zendesk.com/hc/en-us/articles/4407802831643).
+    # Full documentation on how to use the referrals feature in the Advanced
+    # Billing UI can be located
+    # [here](https://maxio.zendesk.com/hc/en-us/sections/24286965611405-Referral
+    # s).
     # ## Server Response
     # If the referral code is valid the status code will be `200` and the
     # referral code will be returned. If the referral code is invalid, a `404`
@@ -30,11 +31,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(ReferralValidationResponse.method(:from_hash))
-                   .local_error_template('404',
-                                         'Invalid referral code.',
-                                         SingleStringErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReferralValidationResponse.method(:from_hash))
+                    .local_error_template('404',
+                                          'Invalid referral code.',
+                                          SingleStringErrorResponseException))
         .execute
     end
   end

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 Chargify support.
+    # please 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
@@ -57,9 +57,9 @@ 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(SaleRepSettings.method(:from_hash))
-                   .is_response_array(true))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SaleRepSettings.method(:from_hash))
+                    .is_response_array(true))
         .execute
     end
 
@@ -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 Chargify support.
+    # please 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
@@ -114,9 +114,9 @@ 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(ListSaleRepItem.method(:from_hash))
-                   .is_response_array(true))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListSaleRepItem.method(:from_hash))
+                    .is_response_array(true))
         .execute
     end
 
@@ -134,13 +134,13 @@ 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 Chargify support.
+    # please 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
     # seller account
-    # @param [String] sales_rep_id Required parameter: The Chargify id of sales
-    # rep.
+    # @param [String] sales_rep_id Required parameter: The Advanced Billing id
+    # of sales rep.
     # @param [String] authorization Optional parameter: For authorization use
     # user API key. See details
     # [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg
@@ -181,8 +181,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(SaleRep.method(:from_hash)))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SaleRep.method(:from_hash)))
         .execute
     end
   end

data/lib/advanced_billing/controllers/sites_controller.rb

@@ -7,11 +7,11 @@ module AdvancedBilling
   # SitesController
   class SitesController < BaseController
     # This endpoint allows you to fetch some site data.
-    # Full documentation on Sites in the Chargify UI can be located
-    # [here](https://chargify.zendesk.com/hc/en-us/articles/4407870738587).
+    # Full documentation on Sites in the Advanced Billing UI can be located
+    # [here](https://maxio.zendesk.com/hc/en-us/sections/24250550707085-Sites).
     # Specifically, the [Clearing Site
-    # Data](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405428327309)
-    # section is extremely relevant to this endpoint documentation.
+    # Data](https://maxio.zendesk.com/hc/en-us/articles/24250617028365-Clearing-
+    # Site-Data) section is extremely relevant to this endpoint documentation.
     # #### Relationship invoicing enabled
     # If site has RI enabled then you will see more settings like:
     #     "customer_hierarchy_enabled": true,
@@ -19,7 +19,8 @@ module AdvancedBilling
     #     "whopays_default_payer": "self"
     # You can read more about these settings here:
     #  [Who Pays & Customer
-    # Hierarchy](https://chargify.zendesk.com/hc/en-us/articles/4407746683291)
+    # Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Cust
+    # omer-Hierarchies-WhoPays)
     # @return [SiteResponse] response from the API call
     def read_site
       new_api_call_builder
@@ -29,8 +30,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(SiteResponse.method(:from_hash)))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SiteResponse.method(:from_hash)))
         .execute
     end
 
@@ -55,7 +56,7 @@ module AdvancedBilling
                    .query_param(new_parameter(cleanup_scope, key: 'cleanup_scope'))
                    .auth(Single.new('BasicAuth')))
         .response(new_response_handler
-                   .is_response_void(true))
+                    .is_response_void(true))
         .execute
     end
 
@@ -82,8 +83,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(ListPublicKeysResponse.method(:from_hash)))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListPublicKeysResponse.method(:from_hash)))
         .execute
     end
   end