maxio-advanced-billing-sdk 6.1.0 → 7.0.0

data/lib/advanced_billing/controllers/subscription_components_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
   # SubscriptionComponentsController
@@ -13,10 +13,10 @@ module AdvancedBilling
     # @param [Integer] component_id Required parameter: The Advanced Billing id
     # of the component. Alternatively, the component's handle prefixed by
     # `handle:`
-    # @return [SubscriptionComponentResponse] response from the API call.
+    # @return [SubscriptionComponentResponse] Response from the API call.
     def read_subscription_component(subscription_id,
                                     component_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/components/{component_id}.json',
                                      Server::PRODUCTION)
@@ -84,9 +84,9 @@ module AdvancedBilling
     # set to true, it returns only components that are currently in use.
     # However, if it's set to false or not provided, it returns all components
     # connected with the subscription.
-    # @return [Array[SubscriptionComponentResponse]] response from the API call.
+    # @return [Array[SubscriptionComponentResponse]] Response from the API call.
     def list_subscription_components(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/components.json',
                                      Server::PRODUCTION)
@@ -123,12 +123,12 @@ module AdvancedBilling
     # component's current default price point.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [BulkComponentsPricePointAssignment] body Optional parameter:
-    # Example:
-    # @return [BulkComponentsPricePointAssignment] response from the API call.
+    # @param [BulkComponentsPricePointAssignment] body Optional parameter: TODO:
+    # type description here
+    # @return [BulkComponentsPricePointAssignment] Response from the API call.
     def bulk_update_subscription_components_price_points(subscription_id,
                                                          body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/price_points.json',
                                      Server::PRODUCTION)
@@ -155,9 +155,9 @@ module AdvancedBilling
     # components, even ones that have not been allocated yet.
     # @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 bulk_reset_subscription_components_price_points(subscription_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/price_points/reset.json',
                                      Server::PRODUCTION)
@@ -243,12 +243,13 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] component_id Required parameter: The Advanced Billing id
     # of the component
-    # @param [CreateAllocationRequest] body Optional parameter: Example:
-    # @return [AllocationResponse] response from the API call.
+    # @param [CreateAllocationRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [AllocationResponse] Response from the API call.
     def allocate_component(subscription_id,
                            component_id,
                            body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/components/{component_id}/allocations.json',
                                      Server::PRODUCTION)
@@ -302,11 +303,11 @@ module AdvancedBilling
     # 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`.
-    # @return [Array[AllocationResponse]] response from the API call.
+    # @return [Array[AllocationResponse]] Response from the API call.
     def list_allocations(subscription_id,
                          component_id,
                          page: 1)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/components/{component_id}/allocations.json',
                                      Server::PRODUCTION)
@@ -342,11 +343,12 @@ module AdvancedBilling
     # This endpoint only responds to JSON. It is not available for XML.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [AllocateComponents] body Optional parameter: Example:
-    # @return [Array[AllocationResponse]] response from the API call.
+    # @param [AllocateComponents] body Optional parameter: TODO: type
+    # description here
+    # @return [Array[AllocationResponse]] Response from the API call.
     def allocate_components(subscription_id,
                             body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/allocations.json',
                                      Server::PRODUCTION)
@@ -386,11 +388,12 @@ module AdvancedBilling
     # See example below for Fine-Grained Component Control response.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [PreviewAllocationsRequest] body Optional parameter: Example:
-    # @return [AllocationPreviewResponse] response from the API call.
+    # @param [PreviewAllocationsRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [AllocationPreviewResponse] Response from the API call.
     def preview_allocations(subscription_id,
                             body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/allocations/preview.json',
                                      Server::PRODUCTION)
@@ -432,14 +435,14 @@ module AdvancedBilling
     # of the component
     # @param [Integer] allocation_id Required parameter: The Advanced Billing id
     # of the allocation
-    # @param [UpdateAllocationExpirationDate] body Optional parameter:
-    # Example:
-    # @return [void] response from the API call.
+    # @param [UpdateAllocationExpirationDate] body Optional parameter: TODO:
+    # type description here
+    # @return [void] Response from the API call.
     def update_prepaid_usage_allocation_expiration_date(subscription_id,
                                                         component_id,
                                                         allocation_id,
                                                         body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/subscriptions/{subscription_id}/components/{component_id}/allocations/{allocation_id}.json',
                                      Server::PRODUCTION)
@@ -489,13 +492,14 @@ module AdvancedBilling
     # of the component
     # @param [Integer] allocation_id Required parameter: The Advanced Billing id
     # of the allocation
-    # @param [CreditSchemeRequest] body Optional parameter: Example:
-    # @return [void] response from the API call.
+    # @param [CreditSchemeRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
     def delete_prepaid_usage_allocation(subscription_id,
                                         component_id,
                                         allocation_id,
                                         body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/subscriptions/{subscription_id}/components/{component_id}/allocations/{allocation_id}.json',
                                      Server::PRODUCTION)
@@ -598,12 +602,13 @@ module AdvancedBilling
     # @param [Integer | String] component_id Required parameter: Either the
     # Advanced Billing id for the component or the component's handle prefixed
     # by `handle:`
-    # @param [CreateUsageRequest] body Optional parameter: Example:
-    # @return [UsageResponse] response from the API call.
+    # @param [CreateUsageRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [UsageResponse] Response from the API call.
     def create_usage(subscription_id,
                      component_id,
                      body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/components/{component_id}/usages.json',
                                      Server::PRODUCTION)
@@ -674,9 +679,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[UsageResponse]] response from the API call.
+    # @return [Array[UsageResponse]] Response from the API call.
     def list_usages(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/components/{component_id}/usages.json',
                                      Server::PRODUCTION)
@@ -722,12 +727,13 @@ module AdvancedBilling
     # id of the subscription
     # @param [Integer] component_id Required parameter: The Advanced Billing id
     # of the component
-    # @param [ActivateEventBasedComponent] body Optional parameter: Example:
-    # @return [void] response from the API call.
+    # @param [ActivateEventBasedComponent] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
     def activate_event_based_component(subscription_id,
                                        component_id,
                                        body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/event_based_billing/subscriptions/{subscription_id}/components/{component_id}/activate.json',
                                      Server::PRODUCTION)
@@ -753,10 +759,10 @@ module AdvancedBilling
     # id of the subscription
     # @param [Integer] component_id Required parameter: The Advanced Billing id
     # of the component
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def deactivate_event_based_component(subscription_id,
                                          component_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/event_based_billing/subscriptions/{subscription_id}/components/{component_id}/deactivate.json',
                                      Server::PRODUCTION)
@@ -796,12 +802,12 @@ module AdvancedBilling
     # @param [String] store_uid Optional parameter: If you've attached your own
     # Keen project as an Advanced Billing event data-store, use this parameter
     # to indicate the data-store.
-    # @param [EBBEvent] body Optional parameter: Example:
-    # @return [void] response from the API call.
+    # @param [EBBEvent] body Optional parameter: TODO: type description here
+    # @return [void] Response from the API call.
     def record_event(api_handle,
                      store_uid: nil,
                      body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/events/{api_handle}.json',
                                      Server::EBB)
@@ -829,12 +835,13 @@ module AdvancedBilling
     # @param [String] store_uid Optional parameter: If you've attached your own
     # Keen project as an Advanced Billing event data-store, use this parameter
     # to indicate the data-store.
-    # @param [Array[EBBEvent]] body Optional parameter: Example:
-    # @return [void] response from the API call.
+    # @param [Array[EBBEvent]] body Optional parameter: TODO: type description
+    # here
+    # @return [void] Response from the API call.
     def bulk_record_events(api_handle,
                            store_uid: nil,
                            body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/events/{api_handle}/bulk.json',
                                      Server::EBB)
@@ -905,9 +912,9 @@ module AdvancedBilling
     # @param [ListSubscriptionComponentsInclude] include Optional parameter:
     # Allows including additional data in the response. Use in query
     # `include=subscription,historic_usages`.
-    # @return [ListSubscriptionComponentsResponse] response from the API call.
+    # @return [ListSubscriptionComponentsResponse] Response from the API call.
     def list_subscription_components_for_site(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions_components.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/subscription_group_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
   # SubscriptionGroupInvoiceAccountController
@@ -12,12 +12,12 @@ module AdvancedBilling
     # balance.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @param [SubscriptionGroupPrepaymentRequest] body Optional parameter:
-    # Example:
-    # @return [SubscriptionGroupPrepaymentResponse] response from the API call.
+    # @param [SubscriptionGroupPrepaymentRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [SubscriptionGroupPrepaymentResponse] Response from the API call.
     def create_subscription_group_prepayment(uid,
                                              body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscription_groups/{uid}/prepayments.json',
                                      Server::PRODUCTION)
@@ -55,9 +55,9 @@ module AdvancedBilling
     # Use in query `per_page=200`.
     # @param [ListPrepaymentsFilter] filter Optional parameter: Filter to use
     # for List Prepayments operations
-    # @return [ListSubscriptionGroupPrepaymentResponse] response from the API call.
+    # @return [ListSubscriptionGroupPrepaymentResponse] Response from the API call.
     def list_prepayments_for_subscription_group(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscription_groups/{uid}/prepayments.json',
                                      Server::PRODUCTION)
@@ -85,11 +85,12 @@ module AdvancedBilling
     # are generated.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @param [IssueServiceCreditRequest] body Optional parameter: Example:
-    # @return [ServiceCreditResponse] response from the API call.
+    # @param [IssueServiceCreditRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ServiceCreditResponse] Response from the API call.
     def issue_subscription_group_service_credit(uid,
                                                 body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscription_groups/{uid}/service_credits.json',
                                      Server::PRODUCTION)
@@ -116,11 +117,12 @@ module AdvancedBilling
     # the request body.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @param [DeductServiceCreditRequest] body Optional parameter: Example:
-    # @return [ServiceCredit] response from the API call.
+    # @param [DeductServiceCreditRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ServiceCredit] Response from the API call.
     def deduct_subscription_group_service_credit(uid,
                                                  body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscription_groups/{uid}/service_credit_deductions.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/subscription_group_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
   # SubscriptionGroupStatusController
@@ -16,12 +16,12 @@ module AdvancedBilling
     # `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:
-    # Example:
-    # @return [void] response from the API call.
+    # @param [CancelGroupedSubscriptionsRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [void] Response from the API call.
     def cancel_subscriptions_in_group(uid,
                                       body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscription_groups/{uid}/cancel.json',
                                      Server::PRODUCTION)
@@ -48,9 +48,9 @@ module AdvancedBilling
     # successfully cancel them, and the group must not be in a "past_due" state.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def initiate_delayed_cancellation_for_group(uid)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscription_groups/{uid}/delayed_cancel.json',
                                      Server::PRODUCTION)
@@ -73,9 +73,9 @@ module AdvancedBilling
     # member in the group.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def cancel_delayed_cancellation_for_group(uid)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/subscription_groups/{uid}/delayed_cancel.json',
                                      Server::PRODUCTION)
@@ -127,12 +127,12 @@ module AdvancedBilling
     # corresponding calendar renewal date.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @param [ReactivateSubscriptionGroupRequest] body Optional parameter:
-    # Example:
-    # @return [ReactivateSubscriptionGroupResponse] response from the API call.
+    # @param [ReactivateSubscriptionGroupRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [ReactivateSubscriptionGroupResponse] Response from the API call.
     def reactivate_subscription_group(uid,
                                       body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscription_groups/{uid}/reactivate.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/subscription_groups_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
   # SubscriptionGroupsController
@@ -17,11 +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.
-    # @param [SubscriptionGroupSignupRequest] body Optional parameter:
-    # Example:
-    # @return [SubscriptionGroupSignupResponse] response from the API call.
+    # @param [SubscriptionGroupSignupRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [SubscriptionGroupSignupResponse] Response from the API call.
     def signup_with_subscription_group(body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscription_groups/signup.json',
                                      Server::PRODUCTION)
@@ -41,11 +41,11 @@ module AdvancedBilling
     end
 
     # Creates a subscription group with given members.
-    # @param [CreateSubscriptionGroupRequest] body Optional parameter:
-    # Example:
-    # @return [SubscriptionGroupResponse] response from the API call.
+    # @param [CreateSubscriptionGroupRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [SubscriptionGroupResponse] Response from the API call.
     def create_subscription_group(body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscription_groups.json',
                                      Server::PRODUCTION)
@@ -85,9 +85,9 @@ module AdvancedBilling
     # A list of additional information to include in the response. The following
     # values are supported:  - `account_balances`: Account balance information
     # for the subscription groups. Use in query: `include[]=account_balances`
-    # @return [ListSubscriptionGroupsResponse] response from the API call.
+    # @return [ListSubscriptionGroupsResponse] Response from the API call.
     def list_subscription_groups(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscription_groups.json',
                                      Server::PRODUCTION)
@@ -114,10 +114,10 @@ module AdvancedBilling
     # @param [Array[SubscriptionGroupInclude]] include Optional parameter:
     # Allows including additional data in the response. Use in query:
     # `include[]=current_billing_amount_in_cents`.
-    # @return [FullSubscriptionGroupResponse] response from the API call.
+    # @return [FullSubscriptionGroupResponse] Response from the API call.
     def read_subscription_group(uid,
                                 include: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscription_groups/{uid}.json',
                                      Server::PRODUCTION)
@@ -141,12 +141,12 @@ module AdvancedBilling
     # clean up members, just leave the array empty.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @param [UpdateSubscriptionGroupRequest] body Optional parameter:
-    # Example:
-    # @return [SubscriptionGroupResponse] response from the API call.
+    # @param [UpdateSubscriptionGroupRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [SubscriptionGroupResponse] Response from the API call.
     def update_subscription_group_members(uid,
                                           body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/subscription_groups/{uid}.json',
                                      Server::PRODUCTION)
@@ -172,9 +172,9 @@ module AdvancedBilling
     # Only groups without members can be deleted
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @return [DeleteSubscriptionGroupResponse] response from the API call.
+    # @return [DeleteSubscriptionGroupResponse] Response from the API call.
     def delete_subscription_group(uid)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/subscription_groups/{uid}.json',
                                      Server::PRODUCTION)
@@ -196,9 +196,9 @@ module AdvancedBilling
     # If the subscription is not in a group endpoint will return 404 code.
     # @param [String] subscription_id Required parameter: The Advanced Billing
     # id of the subscription associated with the subscription group
-    # @return [FullSubscriptionGroupResponse] response from the API call.
+    # @return [FullSubscriptionGroupResponse] Response from the API call.
     def find_subscription_group(subscription_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscription_groups/lookup.json',
                                      Server::PRODUCTION)
@@ -247,11 +247,12 @@ module AdvancedBilling
     # subscription#subscription-in-a-subscription-group)
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [AddSubscriptionToAGroup] body Optional parameter: Example:
-    # @return [SubscriptionGroupResponse] response from the API call.
+    # @param [AddSubscriptionToAGroup] body Optional parameter: TODO: type
+    # description here
+    # @return [SubscriptionGroupResponse] Response from the API call.
     def add_subscription_to_group(subscription_id,
                                   body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/subscriptions/{subscription_id}/group.json',
                                      Server::PRODUCTION)
@@ -277,9 +278,9 @@ module AdvancedBilling
     # remove existing subscription from subscription group.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def remove_subscription_from_group(subscription_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/subscriptions/{subscription_id}/group.json',
                                      Server::PRODUCTION)