maxio-advanced-billing-sdk 6.1.0 → 7.0.0

data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb

@@ -1,7 +1,7 @@
 # advanced_billing
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated for Maxio by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module AdvancedBilling
   # SubscriptionInvoiceAccountController
@@ -11,9 +11,9 @@ module AdvancedBilling
     # Subscription's open, payable invoices.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [AccountBalances] response from the API call.
+    # @return [AccountBalances] Response from the API call.
     def read_account_balances(subscription_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/account_balances.json',
                                      Server::PRODUCTION)
@@ -38,11 +38,12 @@ module AdvancedBilling
     # Please note that you **can't** pass `amount_in_cents`.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [CreatePrepaymentRequest] body Optional parameter: Example:
-    # @return [CreatePrepaymentResponse] response from the API call.
+    # @param [CreatePrepaymentRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [CreatePrepaymentResponse] Response from the API call.
     def create_prepayment(subscription_id,
                           body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/prepayments.json',
                                      Server::PRODUCTION)
@@ -80,9 +81,9 @@ module AdvancedBilling
     # Use in query `per_page=200`.
     # @param [ListPrepaymentsFilter] filter Optional parameter: Filter to use
     # for List Prepayments operations
-    # @return [PrepaymentsResponse] response from the API call.
+    # @return [PrepaymentsResponse] Response from the API call.
     def list_prepayments(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/prepayments.json',
                                      Server::PRODUCTION)
@@ -109,11 +110,12 @@ module AdvancedBilling
     # invoice.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [IssueServiceCreditRequest] body Optional parameter: Example:
-    # @return [ServiceCredit] response from the API call.
+    # @param [IssueServiceCreditRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ServiceCredit] Response from the API call.
     def issue_service_credit(subscription_id,
                              body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/service_credits.json',
                                      Server::PRODUCTION)
@@ -140,11 +142,12 @@ module AdvancedBilling
     # less than the current credit balance.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [DeductServiceCreditRequest] body Optional parameter: Example:
-    # @return [void] response from the API call.
+    # @param [DeductServiceCreditRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
     def deduct_service_credit(subscription_id,
                               body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/service_credit_deductions.json',
                                      Server::PRODUCTION)
@@ -164,6 +167,52 @@ module AdvancedBilling
         .execute
     end
 
+    # This request will list a subscription's service credits.
+    # @param [Integer] subscription_id Required parameter: The Chargify id of
+    # the subscription
+    # @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
+    # navigating through the pages to consume the results. You do this by
+    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
+    # the query string. If there are no results to return, then an empty result
+    # set will be returned. Use in query `page=1`.
+    # @param [Integer] per_page Optional parameter: This parameter indicates how
+    # many records to fetch in each request. Default value is 20. The maximum
+    # allowed values is 200; any per_page value over 200 will be changed to 200.
+    # Use in query `per_page=200`.
+    # @param [SortingDirection] direction Optional parameter: Controls the order
+    # in which results are returned. Use in query `direction=asc`.
+    # @return [ListServiceCreditsResponse] Response from the API call.
+    def list_service_credits(subscription_id,
+                             page: 1,
+                             per_page: 20,
+                             direction: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/subscriptions/{subscription_id}/service_credits/list.json',
+                                     Server::PRODUCTION)
+                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .query_param(new_parameter(direction, key: 'direction'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListServiceCreditsResponse.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}\'.',
+                                          ErrorListResponseException))
+        .execute
+    end
+
     # This endpoint will refund, completely or partially, a particular
     # prepayment applied to a subscription. The `prepayment_id` will be the
     # account transaction ID of the original payment. The prepayment must have
@@ -173,12 +222,13 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [Integer] prepayment_id Required parameter: id of prepayment
-    # @param [RefundPrepaymentRequest] body Optional parameter: Example:
-    # @return [PrepaymentResponse] response from the API call.
+    # @param [RefundPrepaymentRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [PrepaymentResponse] Response from the API call.
     def refund_prepayment(subscription_id,
                           prepayment_id,
                           body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/prepayments/{prepayment_id}/refunds.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/subscription_notes_controller.rb

@@ -1,7 +1,7 @@
 # advanced_billing
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated for Maxio by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module AdvancedBilling
   # SubscriptionNotesController
@@ -18,11 +18,12 @@ module AdvancedBilling
     # tion-Summary-Overview).
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [UpdateSubscriptionNoteRequest] body Optional parameter: Example:
-    # @return [SubscriptionNoteResponse] response from the API call.
+    # @param [UpdateSubscriptionNoteRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [SubscriptionNoteResponse] Response from the API call.
     def create_subscription_note(subscription_id,
                                  body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/notes.json',
                                      Server::PRODUCTION)
@@ -59,9 +60,9 @@ module AdvancedBilling
     # many records to fetch in each request. Default value is 20. The maximum
     # allowed values is 200; any per_page value over 200 will be changed to 200.
     # Use in query `per_page=200`.
-    # @return [Array[SubscriptionNoteResponse]] response from the API call.
+    # @return [Array[SubscriptionNoteResponse]] Response from the API call.
     def list_subscription_notes(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/notes.json',
                                      Server::PRODUCTION)
@@ -89,10 +90,10 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
-    # @return [SubscriptionNoteResponse] response from the API call.
+    # @return [SubscriptionNoteResponse] Response from the API call.
     def read_subscription_note(subscription_id,
                                note_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/notes/{note_id}.json',
                                      Server::PRODUCTION)
@@ -115,12 +116,13 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
-    # @param [UpdateSubscriptionNoteRequest] body Optional parameter: Example:
-    # @return [SubscriptionNoteResponse] response from the API call.
+    # @param [UpdateSubscriptionNoteRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [SubscriptionNoteResponse] Response from the API call.
     def update_subscription_note(subscription_id,
                                  note_id,
                                  body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/subscriptions/{subscription_id}/notes/{note_id}.json',
                                      Server::PRODUCTION)
@@ -150,10 +152,10 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def delete_subscription_note(subscription_id,
                                  note_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/subscriptions/{subscription_id}/notes/{note_id}.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/subscription_products_controller.rb

@@ -1,7 +1,7 @@
 # advanced_billing
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated for Maxio by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module AdvancedBilling
   # SubscriptionProductsController
@@ -102,11 +102,11 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [SubscriptionProductMigrationRequest] body Optional parameter:
-    # Example:
-    # @return [SubscriptionResponse] response from the API call.
+    # TODO: type description here
+    # @return [SubscriptionResponse] Response from the API call.
     def migrate_subscription_product(subscription_id,
                                      body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/migrations.json',
                                      Server::PRODUCTION)
@@ -139,11 +139,11 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [SubscriptionMigrationPreviewRequest] body Optional parameter:
-    # Example:
-    # @return [SubscriptionMigrationPreviewResponse] response from the API call.
+    # TODO: type description here
+    # @return [SubscriptionMigrationPreviewResponse] Response from the API call.
     def preview_subscription_product_migration(subscription_id,
                                                body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/migrations/preview.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/subscription_status_controller.rb

@@ -1,7 +1,7 @@
 # advanced_billing
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated for Maxio by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
 module AdvancedBilling
   # SubscriptionStatusController
@@ -14,9 +14,9 @@ module AdvancedBilling
     # The response will be `422 "Unprocessable Entity`.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [SubscriptionResponse] response from the API call.
+    # @return [SubscriptionResponse] Response from the API call.
     def retry_subscription(subscription_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/subscriptions/{subscription_id}/retry.json',
                                      Server::PRODUCTION)
@@ -39,11 +39,12 @@ module AdvancedBilling
     # the method sets the Subscription state to "canceled".
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [CancellationRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call.
+    # @param [CancellationRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [SubscriptionResponse] Response from the API call.
     def cancel_subscription(subscription_id,
                             body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/subscriptions/{subscription_id}.json',
                                      Server::PRODUCTION)
@@ -77,10 +78,10 @@ module AdvancedBilling
     # @param [ResumptionCharge] calendar_billing_resumption_charge Optional
     # parameter: (For calendar billing subscriptions only) The way that the
     # resumed subscription's charge should be handled
-    # @return [SubscriptionResponse] response from the API call.
+    # @return [SubscriptionResponse] Response from the API call.
     def resume_subscription(subscription_id,
                             calendar_billing_resumption_charge: ResumptionCharge::PRORATED)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/resume.json',
                                      Server::PRODUCTION)
@@ -107,11 +108,12 @@ module AdvancedBilling
     # within 24 hours.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [PauseRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call.
+    # @param [PauseRequest] body Optional parameter: TODO: type description
+    # here
+    # @return [SubscriptionResponse] Response from the API call.
     def pause_subscription(subscription_id,
                            body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/hold.json',
                                      Server::PRODUCTION)
@@ -142,11 +144,12 @@ module AdvancedBilling
     # would like the subscription to not have a resume date.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [PauseRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call.
+    # @param [PauseRequest] body Optional parameter: TODO: type description
+    # here
+    # @return [SubscriptionResponse] Response from the API call.
     def update_automatic_subscription_resumption(subscription_id,
                                                  body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/subscriptions/{subscription_id}/hold.json',
                                      Server::PRODUCTION)
@@ -308,11 +311,12 @@ module AdvancedBilling
     # + Any product-related charges should have been collected
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [ReactivateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call.
+    # @param [ReactivateSubscriptionRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [SubscriptionResponse] Response from the API call.
     def reactivate_subscription(subscription_id,
                                 body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/subscriptions/{subscription_id}/reactivate.json',
                                      Server::PRODUCTION)
@@ -342,11 +346,12 @@ module AdvancedBilling
     # creation, or if the subscription is past due.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [CancellationRequest] body Optional parameter: Example:
-    # @return [DelayedCancellationResponse] response from the API call.
+    # @param [CancellationRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [DelayedCancellationResponse] Response from the API call.
     def initiate_delayed_cancellation(subscription_id,
                                       body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/delayed_cancel.json',
                                      Server::PRODUCTION)
@@ -379,9 +384,9 @@ module AdvancedBilling
     # will be successful.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [DelayedCancellationResponse] response from the API call.
+    # @return [DelayedCancellationResponse] Response from the API call.
     def cancel_delayed_cancellation(subscription_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/subscriptions/{subscription_id}/delayed_cancel.json',
                                      Server::PRODUCTION)
@@ -403,9 +408,9 @@ module AdvancedBilling
     # active and the active Dunner will be resolved.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [SubscriptionResponse] response from the API call.
+    # @return [SubscriptionResponse] Response from the API call.
     def cancel_dunning(subscription_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/cancel_dunning.json',
                                      Server::PRODUCTION)
@@ -458,11 +463,12 @@ module AdvancedBilling
     # changes against a subscription.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [RenewalPreviewRequest] body Optional parameter: Example:
-    # @return [RenewalPreviewResponse] response from the API call.
+    # @param [RenewalPreviewRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [RenewalPreviewResponse] Response from the API call.
     def preview_renewal(subscription_id,
                         body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/renewals/preview.json',
                                      Server::PRODUCTION)