maxio-advanced-billing-sdk 6.1.0 → 7.0.0

data/lib/advanced_billing/controllers/custom_fields_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
   # CustomFieldsController
@@ -34,7 +34,7 @@ module AdvancedBilling
     # another 100 for Customer.
     # ### Metafields "On-the-Fly"
     # It is possible to create Metafields “on the fly” when you create your
-    # Metadata – if a non-existant name is passed when creating Metadata, a
+    # Metadata – if a non-existent name is passed when creating Metadata, a
     # Metafield for that key will be automatically created. The Metafield API,
     # however, gives you more control over your “keys”.
     # ### Metafield Scope Warning
@@ -43,11 +43,12 @@ module AdvancedBilling
     # update is sent it will overwrite the current configuration**.
     # @param [ResourceType] resource_type Required parameter: the resource type
     # to which the metafields belong
-    # @param [CreateMetafieldsRequest] body Optional parameter: Example:
-    # @return [Array[Metafield]] response from the API call.
+    # @param [CreateMetafieldsRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [Array[Metafield]] Response from the API call.
     def create_metafields(resource_type,
                           body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/{resource_type}/metafields.json',
                                      Server::PRODUCTION)
@@ -89,9 +90,9 @@ module AdvancedBilling
     # 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 [ListMetafieldsResponse] response from the API call.
+    # @return [ListMetafieldsResponse] Response from the API call.
     def list_metafields(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/{resource_type}/metafields.json',
                                      Server::PRODUCTION)
@@ -114,11 +115,12 @@ module AdvancedBilling
     # can be populated with metadata after the fact.
     # @param [ResourceType] resource_type Required parameter: the resource type
     # to which the metafields belong
-    # @param [UpdateMetafieldsRequest] body Optional parameter: Example:
-    # @return [Array[Metafield]] response from the API call.
+    # @param [UpdateMetafieldsRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [Array[Metafield]] Response from the API call.
     def update_metafield(resource_type,
                          body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/{resource_type}/metafields.json',
                                      Server::PRODUCTION)
@@ -149,10 +151,10 @@ module AdvancedBilling
     # to which the metafields belong
     # @param [String] name Optional parameter: The name of the metafield to be
     # deleted
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def delete_metafield(resource_type,
                          name: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/{resource_type}/metafields.json',
                                      Server::PRODUCTION)
@@ -201,12 +203,13 @@ module AdvancedBilling
     # to which the metafields belong
     # @param [Integer] resource_id Required parameter: The Advanced Billing id
     # of the customer or the subscription for which the metadata applies
-    # @param [CreateMetadataRequest] body Optional parameter: Example:
-    # @return [Array[Metadata]] response from the API call.
+    # @param [CreateMetadataRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [Array[Metadata]] Response from the API call.
     def create_metadata(resource_type,
                         resource_id,
                         body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/{resource_type}/{resource_id}/metadata.json',
                                      Server::PRODUCTION)
@@ -252,9 +255,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 [PaginatedMetadata] response from the API call.
+    # @return [PaginatedMetadata] Response from the API call.
     def list_metadata(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/{resource_type}/{resource_id}/metadata.json',
                                      Server::PRODUCTION)
@@ -280,12 +283,13 @@ module AdvancedBilling
     # to which the metafields belong
     # @param [Integer] resource_id Required parameter: The Advanced Billing id
     # of the customer or the subscription for which the metadata applies
-    # @param [UpdateMetadataRequest] body Optional parameter: Example:
-    # @return [Array[Metadata]] response from the API call.
+    # @param [UpdateMetadataRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [Array[Metadata]] Response from the API call.
     def update_metadata(resource_type,
                         resource_id,
                         body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/{resource_type}/{resource_id}/metadata.json',
                                      Server::PRODUCTION)
@@ -338,12 +342,12 @@ module AdvancedBilling
     # @param [Array[String]] names Optional parameter: Names of fields to be
     # removed. Use in query:
     # `names[]=field1&names[]=my-field&names[]=another-field`.
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def delete_metadata(resource_type,
                         resource_id,
                         name: nil,
                         names: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/{resource_type}/{resource_id}/metadata.json',
                                      Server::PRODUCTION)
@@ -417,9 +421,9 @@ module AdvancedBilling
     # `resource_ids[]=122&resource_ids[]=123&resource_ids[]=124`.
     # @param [SortingDirection] direction Optional parameter: Controls the order
     # in which results are returned. Use in query `direction=asc`.
-    # @return [PaginatedMetadata] response from the API call.
+    # @return [PaginatedMetadata] Response from the API call.
     def list_metadata_for_resource_type(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/{resource_type}/metadata.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/customers_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
   # CustomersController
@@ -41,10 +41,11 @@ module AdvancedBilling
     # For more: [Customer
     # Locale](https://maxio.zendesk.com/hc/en-us/articles/24286672013709-Custome
     # r-Locale)
-    # @param [CreateCustomerRequest] body Optional parameter: Example:
-    # @return [CustomerResponse] response from the API call.
+    # @param [CreateCustomerRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [CustomerResponse] Response from the API call.
     def create_customer(body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/customers.json',
                                      Server::PRODUCTION)
@@ -112,9 +113,9 @@ module AdvancedBilling
     # be used. If provided, this parameter will be used instead of end_date.
     # @param [String] q Optional parameter: A search query by which to filter
     # customers (can be an email, an ID, a reference, organization)
-    # @return [Array[CustomerResponse]] response from the API call.
+    # @return [Array[CustomerResponse]] Response from the API call.
     def list_customers(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/customers.json',
                                      Server::PRODUCTION)
@@ -140,9 +141,9 @@ module AdvancedBilling
     # Billing-generated Customer ID.
     # @param [Integer] id Required parameter: The Advanced Billing id of the
     # customer
-    # @return [CustomerResponse] response from the API call.
+    # @return [CustomerResponse] Response from the API call.
     def read_customer(id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/customers/{id}.json',
                                      Server::PRODUCTION)
@@ -160,11 +161,12 @@ module AdvancedBilling
     # This method allows to update the Customer.
     # @param [Integer] id Required parameter: The Advanced Billing id of the
     # customer
-    # @param [UpdateCustomerRequest] body Optional parameter: Example:
-    # @return [CustomerResponse] response from the API call.
+    # @param [UpdateCustomerRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [CustomerResponse] Response from the API call.
     def update_customer(id,
                         body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/customers/{id}.json',
                                      Server::PRODUCTION)
@@ -192,9 +194,9 @@ module AdvancedBilling
     # This method allows you to delete the Customer.
     # @param [Integer] id Required parameter: The Advanced Billing id of the
     # customer
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def delete_customer(id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/customers/{id}.json',
                                      Server::PRODUCTION)
@@ -210,9 +212,9 @@ module AdvancedBilling
     # Use this method to return the customer object if you have the unique
     # **Reference ID (Your App)** value handy. It will return a single match.
     # @param [String] reference Required parameter: Customer reference
-    # @return [CustomerResponse] response from the API call.
+    # @return [CustomerResponse] Response from the API call.
     def read_customer_by_reference(reference)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/customers/lookup.json',
                                      Server::PRODUCTION)
@@ -229,9 +231,9 @@ module AdvancedBilling
     # This method lists all subscriptions that belong to a customer.
     # @param [Integer] customer_id Required parameter: The Chargify id of the
     # customer
-    # @return [Array[SubscriptionResponse]] response from the API call.
+    # @return [Array[SubscriptionResponse]] Response from the API call.
     def list_customer_subscriptions(customer_id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/customers/{customer_id}/subscriptions.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/events_based_billing_segments_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
   # EventsBasedBillingSegmentsController
@@ -16,12 +16,13 @@ module AdvancedBilling
     # Component
     # @param [String] price_point_id Required parameter: ID or Handle for the
     # Price Point belonging to the Component
-    # @param [CreateSegmentRequest] body Optional parameter: Example:
-    # @return [SegmentResponse] response from the API call.
+    # @param [CreateSegmentRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [SegmentResponse] Response from the API call.
     def create_segment(component_id,
                        price_point_id,
                        body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/components/{component_id}/price_points/{price_point_id}/segments.json',
                                      Server::PRODUCTION)
@@ -73,9 +74,9 @@ module AdvancedBilling
     # Use in query `per_page=200`.
     # @param [ListSegmentsFilter] filter Optional parameter: Filter to use for
     # List Segments for a Price Point operation
-    # @return [ListSegmentsResponse] response from the API call.
+    # @return [ListSegmentsResponse] Response from the API call.
     def list_segments_for_price_point(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/components/{component_id}/price_points/{price_point_id}/segments.json',
                                      Server::PRODUCTION)
@@ -113,13 +114,14 @@ module AdvancedBilling
     # @param [String] price_point_id Required parameter: ID or Handle of the
     # Price Point belonging to the Component
     # @param [Float] id Required parameter: The ID of the Segment
-    # @param [UpdateSegmentRequest] body Optional parameter: Example:
-    # @return [SegmentResponse] response from the API call.
+    # @param [UpdateSegmentRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [SegmentResponse] Response from the API call.
     def update_segment(component_id,
                        price_point_id,
                        id,
                        body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/components/{component_id}/price_points/{price_point_id}/segments/{id}.json',
                                      Server::PRODUCTION)
@@ -158,11 +160,11 @@ module AdvancedBilling
     # @param [String] price_point_id Required parameter: ID or Handle of the
     # Price Point belonging to the Component
     # @param [Float] id Required parameter: The ID of the Segment
-    # @return [void] response from the API call.
+    # @return [void] Response from the API call.
     def delete_segment(component_id,
                        price_point_id,
                        id)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::DELETE,
                                      '/components/{component_id}/price_points/{price_point_id}/segments/{id}.json',
                                      Server::PRODUCTION)
@@ -200,12 +202,13 @@ module AdvancedBilling
     # Component
     # @param [String] price_point_id Required parameter: ID or Handle for the
     # Price Point belonging to the Component
-    # @param [BulkCreateSegments] body Optional parameter: Example:
-    # @return [ListSegmentsResponse] response from the API call.
+    # @param [BulkCreateSegments] body Optional parameter: TODO: type
+    # description here
+    # @return [ListSegmentsResponse] Response from the API call.
     def bulk_create_segments(component_id,
                              price_point_id,
                              body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/components/{component_id}/price_points/{price_point_id}/segments/bulk.json',
                                      Server::PRODUCTION)
@@ -245,12 +248,13 @@ module AdvancedBilling
     # Component
     # @param [String] price_point_id Required parameter: ID or Handle for the
     # Price Point belonging to the Component
-    # @param [BulkUpdateSegments] body Optional parameter: Example:
-    # @return [ListSegmentsResponse] response from the API call.
+    # @param [BulkUpdateSegments] body Optional parameter: TODO: type
+    # description here
+    # @return [ListSegmentsResponse] Response from the API call.
     def bulk_update_segments(component_id,
                              price_point_id,
                              body: nil)
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::PUT,
                                      '/components/{component_id}/price_points/{price_point_id}/segments/bulk.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/events_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
   # EventsController
@@ -114,9 +114,9 @@ module AdvancedBilling
     # components with a timestamp at or before exact time provided in query. You
     # can specify timezone in query - otherwise your site's time zone will be
     # used. If provided, this parameter will be used instead of end_date.
-    # @return [Array[EventResponse]] response from the API call.
+    # @return [Array[EventResponse]] Response from the API call.
     def list_events(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/events.json',
                                      Server::PRODUCTION)
@@ -174,9 +174,9 @@ module AdvancedBilling
     # @param [Array[EventKey]] filter Optional parameter: You can pass multiple
     # event keys after comma. Use in query
     # `filter=signup_success,payment_success`.
-    # @return [Array[EventResponse]] response from the API call.
+    # @return [Array[EventResponse]] Response from the API call.
     def list_subscription_events(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions/{subscription_id}/events.json',
                                      Server::PRODUCTION)
@@ -220,9 +220,9 @@ module AdvancedBilling
     # @param [Array[EventKey]] filter Optional parameter: You can pass multiple
     # event keys after comma. Use in query
     # `filter=signup_success,payment_success`.
-    # @return [CountResponse] response from the API call.
+    # @return [CountResponse] Response from the API call.
     def read_events_count(options = {})
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/events/count.json',
                                      Server::PRODUCTION)

data/lib/advanced_billing/controllers/insights_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
   # InsightsController
@@ -11,13 +11,13 @@ module AdvancedBilling
     # ## Stats Documentation
     # There currently is not a complimentary matching set of documentation that
     # compliments this endpoint. However, each Site's dashboard will reflect the
-    # summary of information provided in the Stats reposnse.
+    # summary of information provided in the Stats response.
     # ```
     # https://subdomain.chargify.com/dashboard
     # ```
-    # @return [SiteSummary] response from the API call.
+    # @return [SiteSummary] Response from the API call.
     def read_site_stats
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/stats.json',
                                      Server::PRODUCTION)
@@ -35,11 +35,11 @@ module AdvancedBilling
     # ISO8601 format to request MRR for a historic time
     # @param [Integer] subscription_id Optional parameter: submit the id of a
     # subscription in order to limit results
-    # @return [MRRResponse] response from the API call.
+    # @return [MRRResponse] Response from the API call.
     def read_mrr(at_time: nil,
                  subscription_id: nil)
       warn 'Endpoint read_mrr in InsightsController is deprecated'
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/mrr.json',
                                      Server::PRODUCTION)
@@ -91,10 +91,10 @@ module AdvancedBilling
     # Use in query `per_page=20`.
     # @param [SortingDirection] direction Optional parameter: Controls the order
     # in which results are returned. Use in query `direction=asc`.
-    # @return [ListMRRResponse] response from the API call.
+    # @return [ListMRRResponse] Response from the API call.
     def list_mrr_movements(options = {})
       warn 'Endpoint list_mrr_movements in InsightsController is deprecated'
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/mrr_movements.json',
                                      Server::PRODUCTION)
@@ -131,11 +131,11 @@ module AdvancedBilling
     # @param [Direction] direction Optional parameter: Controls the order in
     # which results are returned. Records are ordered by subscription_id in
     # ascending order by default. Use in query `direction=desc`.
-    # @return [SubscriptionMRRResponse] response from the API call.
+    # @return [SubscriptionMRRResponse] Response from the API call.
     def list_mrr_per_subscription(options = {})
       warn 'Endpoint list_mrr_per_subscription in InsightsController is deprec'\
            'ated'
-      new_api_call_builder
+      @api_call
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions_mrr.json',
                                      Server::PRODUCTION)