maxio-advanced-billing-sdk 2.0.0 → 3.0.0

data/lib/advanced_billing/controllers/product_families_controller.rb

@@ -24,6 +24,8 @@ module AdvancedBilling
     # @param [BasicDateField] date_field Optional parameter: The type of filter
     # you would like to apply to your search. Use in query:
     # `date_field=created_at`.
+    # @param [ListProductsFilter] filter Optional parameter: Filter to use for
+    # List Products operations
     # @param [String] start_date Optional parameter: The start date (format
     # YYYY-MM-DD) with which to filter the date_field. Returns products with a
     # timestamp at or after midnight (12:00:00 AM) in your site’s time zone on
@@ -47,17 +49,6 @@ module AdvancedBilling
     # @param [ListProductsInclude] include Optional parameter: Allows including
     # additional data in the response. Use in query
     # `include=prepaid_product_price_point`.
-    # @param [IncludeNotNull]
-    # filter_prepaid_product_price_point_product_price_point_id Optional
-    # parameter: Allows fetching products only if a prepaid product price point
-    # is present or not. To use this filter you also have to include the
-    # following param in the request `include=prepaid_product_price_point`. Use
-    # in query
-    # `filter[prepaid_product_price_point][product_price_point_id]=not_null`.
-    # @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
-    # parameter: Allows fetching products with matching use_site_exchange_rate
-    # based on provided value (refers to default price point). Use in query
-    # `filter[use_site_exchange_rate]=true`.
     # @return [Array[ProductResponse]] response from the API call
     def list_products_for_product_family(options = {})
       new_api_call_builder
@@ -70,16 +61,16 @@ module AdvancedBilling
                    .query_param(new_parameter(options['page'], key: 'page'))
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))
                    .query_param(new_parameter(options['date_field'], key: 'date_field'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .query_param(new_parameter(options['start_date'], key: 'start_date'))
                    .query_param(new_parameter(options['end_date'], key: 'end_date'))
                    .query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
                    .query_param(new_parameter(options['end_datetime'], key: 'end_datetime'))
                    .query_param(new_parameter(options['include_archived'], key: 'include_archived'))
                    .query_param(new_parameter(options['include'], key: 'include'))
-                   .query_param(new_parameter(options['filter_prepaid_product_price_point_product_price_point_id'], key: 'filter[prepaid_product_price_point][product_price_point_id]'))
-                   .query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
+                   .auth(Single.new('BasicAuth'))
+                   .array_serialization_format(ArraySerializationFormat::CSV))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
                    .deserialize_into(ProductResponse.method(:from_hash))

data/lib/advanced_billing/controllers/product_price_points_controller.rb

@@ -381,38 +381,8 @@ module AdvancedBilling
     # to a Site.
     # @param [SortingDirection] direction Optional parameter: Controls the order
     # in which results are returned. Use in query `direction=asc`.
-    # @param [IncludeNotNull] filter_archived_at Optional parameter: Allows
-    # fetching price points only if archived_at is present or not. Use in query:
-    # `filter[archived_at]=not_null`.
-    # @param [BasicDateField] filter_date_field Optional parameter: The type of
-    # filter you would like to apply to your search. Use in query:
-    # `filter[date_field]=created_at`.
-    # @param [Date] filter_end_date Optional parameter: The end date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns price points with
-    # a timestamp up to and including 11:59:59PM in your site’s time zone on the
-    # date specified.
-    # @param [DateTime] filter_end_datetime Optional parameter: The end date and
-    # time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
-    # Returns price points 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.
-    # @param [Array[Integer]] filter_ids Optional parameter: Allows fetching
-    # price points with matching id based on provided values. Use in query:
-    # `filter[ids]=1,2,3`.
-    # @param [Date] filter_start_date Optional parameter: The start date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns price points with
-    # a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on
-    # the date specified.
-    # @param [DateTime] filter_start_datetime Optional parameter: The start date
-    # and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
-    # Returns price points with a timestamp at or after 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
-    # start_date.
-    # @param [Array[PricePointType]] filter_type Optional parameter: Allows
-    # fetching price points with matching type. Use in query:
-    # `filter[type]=catalog,custom`.
+    # @param [ListPricePointsFilter] filter Optional parameter: Filter to use
+    # for List PricePoints operations
     # @param [ListProductsPricePointsInclude] include Optional parameter: Allows
     # including additional data in the response. Use in query:
     # `include=currency_prices`.
@@ -434,14 +404,7 @@ module AdvancedBilling
                                      '/products_price_points.json',
                                      Server::DEFAULT)
                    .query_param(new_parameter(options['direction'], key: 'direction'))
-                   .query_param(new_parameter(options['filter_archived_at'], key: 'filter[archived_at]'))
-                   .query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
-                   .query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
-                   .query_param(new_parameter(options['filter_end_datetime'], key: 'filter[end_datetime]'))
-                   .query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
-                   .query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
-                   .query_param(new_parameter(options['filter_start_datetime'], key: 'filter[start_datetime]'))
-                   .query_param(new_parameter(options['filter_type'], key: 'filter[type]'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .query_param(new_parameter(options['include'], key: 'include'))
                    .query_param(new_parameter(options['page'], key: 'page'))
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))

data/lib/advanced_billing/controllers/products_controller.rb

@@ -149,6 +149,8 @@ module AdvancedBilling
     # @param [BasicDateField] date_field Optional parameter: The type of filter
     # you would like to apply to your search. Use in query:
     # `date_field=created_at`.
+    # @param [ListProductsFilter] filter Optional parameter: Filter to use for
+    # List Products operations
     # @param [Date] end_date Optional parameter: The end date (format
     # YYYY-MM-DD) with which to filter the date_field. Returns products with a
     # timestamp up to and including 11:59:59PM in your site’s time zone on the
@@ -184,17 +186,6 @@ module AdvancedBilling
     # @param [ListProductsInclude] include Optional parameter: Allows including
     # additional data in the response. Use in query
     # `include=prepaid_product_price_point`.
-    # @param [IncludeNotNull]
-    # filter_prepaid_product_price_point_product_price_point_id Optional
-    # parameter: Allows fetching products only if a prepaid product price point
-    # is present or not. To use this filter you also have to include the
-    # following param in the request `include=prepaid_product_price_point`. Use
-    # in query
-    # `filter[prepaid_product_price_point][product_price_point_id]=not_null`.
-    # @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
-    # parameter: Allows fetching products with matching use_site_exchange_rate
-    # based on provided value (refers to default price point). Use in query
-    # `filter[use_site_exchange_rate]=true`.
     # @return [Array[ProductResponse]] response from the API call
     def list_products(options = {})
       new_api_call_builder
@@ -202,6 +193,7 @@ module AdvancedBilling
                                      '/products.json',
                                      Server::DEFAULT)
                    .query_param(new_parameter(options['date_field'], key: 'date_field'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .query_param(new_parameter(options['end_date'], key: 'end_date'))
                    .query_param(new_parameter(options['end_datetime'], key: 'end_datetime'))
                    .query_param(new_parameter(options['start_date'], key: 'start_date'))
@@ -210,10 +202,9 @@ module AdvancedBilling
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))
                    .query_param(new_parameter(options['include_archived'], key: 'include_archived'))
                    .query_param(new_parameter(options['include'], key: 'include'))
-                   .query_param(new_parameter(options['filter_prepaid_product_price_point_product_price_point_id'], key: 'filter[prepaid_product_price_point][product_price_point_id]'))
-                   .query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
+                   .auth(Single.new('BasicAuth'))
+                   .array_serialization_format(ArraySerializationFormat::CSV))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
                    .deserialize_into(ProductResponse.method(:from_hash))

data/lib/advanced_billing/controllers/subscription_components_controller.rb

@@ -48,6 +48,8 @@ module AdvancedBilling
     # `date_field=updated_at`.
     # @param [SortingDirection] direction Optional parameter: Controls the order
     # in which results are returned. Use in query `direction=asc`.
+    # @param [ListSubscriptionComponentsFilter] filter Optional parameter:
+    # Filter to use for List Subscription Components operation
     # @param [String] end_date Optional parameter: The end date (format
     # YYYY-MM-DD) with which to filter the date_field. Returns components with a
     # timestamp up to and including 11:59:59PM in your site’s time zone on the
@@ -74,16 +76,13 @@ module AdvancedBilling
     # components with a timestamp at or after 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 start_date.
-    # @param [ListSubscriptionComponentsInclude] include Optional parameter:
-    # Allows including additional data in the response. Use in query
-    # `include=subscription`.
-    # @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
-    # parameter: Allows fetching components allocation with matching
-    # use_site_exchange_rate based on provided value. Use in query
-    # `filter[use_site_exchange_rate]=true`.
-    # @param [Array[String]] filter_currencies Optional parameter: Allows
-    # fetching components allocation with matching currency based on provided
-    # values. Use in query `filter[currencies]=EUR,USD`.
+    # @param [Array[ListSubscriptionComponentsInclude]] include Optional
+    # parameter: Allows including additional data in the response. Use in query
+    # `include=subscription,historic_usages`.
+    # @param [TrueClass | FalseClass] in_use Optional parameter: If in_use is
+    # 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
     def list_subscription_components(options = {})
       new_api_call_builder
@@ -95,6 +94,7 @@ module AdvancedBilling
                                     .should_encode(true))
                    .query_param(new_parameter(options['date_field'], key: 'date_field'))
                    .query_param(new_parameter(options['direction'], key: 'direction'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .query_param(new_parameter(options['end_date'], key: 'end_date'))
                    .query_param(new_parameter(options['end_datetime'], key: 'end_datetime'))
                    .query_param(new_parameter(options['price_point_ids'], key: 'price_point_ids'))
@@ -103,8 +103,7 @@ module AdvancedBilling
                    .query_param(new_parameter(options['start_date'], key: 'start_date'))
                    .query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
                    .query_param(new_parameter(options['include'], key: 'include'))
-                   .query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
-                   .query_param(new_parameter(options['filter_currencies'], key: 'filter[currencies]'))
+                   .query_param(new_parameter(options['in_use'], key: 'in_use'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth'))
                    .array_serialization_format(ArraySerializationFormat::CSV))
@@ -869,6 +868,9 @@ module AdvancedBilling
     # attribute by which to sort. Use in query: `sort=updated_at`.
     # @param [SortingDirection] direction Optional parameter: Controls the order
     # in which results are returned. Use in query `direction=asc`.
+    # @param [ListSubscriptionComponentsForSiteFilter] filter Optional
+    # parameter: Filter to use for List Subscription Components For Site
+    # operation
     # @param [SubscriptionListDateField] date_field Optional parameter: The type
     # of filter you'd like to apply to your search. Use in query:
     # `date_field=updated_at`.
@@ -903,52 +905,7 @@ module AdvancedBilling
     # provided ids. Use in query `product_family_ids=1,2,3`.
     # @param [ListSubscriptionComponentsInclude] include Optional parameter:
     # Allows including additional data in the response. Use in query
-    # `include=subscription`.
-    # @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
-    # parameter: Allows fetching components allocation with matching
-    # use_site_exchange_rate based on provided value. Use in query
-    # `filter[use_site_exchange_rate]=true`.
-    # @param [Array[String]] filter_currencies Optional parameter: Allows
-    # fetching components allocation with matching currency based on provided
-    # values. Use in query `filter[currencies]=USD,EUR`.
-    # @param [Array[SubscriptionStateFilter]] filter_subscription_states
-    # Optional parameter: Allows fetching components allocations that belong to
-    # the subscription with matching states based on provided values. To use
-    # this filter you also have to include the following param in the request
-    # `include=subscription`. Use in query
-    # `filter[subscription][states]=active,canceled&include=subscription`.
-    # @param [SubscriptionListDateField] filter_subscription_date_field Optional
-    # parameter: The type of filter you'd like to apply to your search. To use
-    # this filter you also have to include the following param in the request
-    # `include=subscription`.
-    # @param [Date] filter_subscription_start_date Optional parameter: The start
-    # date (format YYYY-MM-DD) with which to filter the date_field. Returns
-    # components that belong to the subscription with a timestamp at or after
-    # midnight (12:00:00 AM) in your site’s time zone on the date specified. To
-    # use this filter you also have to include the following param in the
-    # request `include=subscription`.
-    # @param [DateTime] filter_subscription_start_datetime Optional parameter:
-    # The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter
-    # the date_field. Returns components that belong to the subscription with a
-    # timestamp at or after 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 start_date. To use this
-    # filter you also have to include the following param in the request
-    # `include=subscription`.
-    # @param [Date] filter_subscription_end_date Optional parameter: The end
-    # date (format YYYY-MM-DD) with which to filter the date_field. Returns
-    # components that belong to the subscription with a timestamp up to and
-    # including 11:59:59PM in your site’s time zone on the date specified. To
-    # use this filter you also have to include the following param in the
-    # request `include=subscription`.
-    # @param [DateTime] filter_subscription_end_datetime Optional parameter: The
-    # end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the
-    # date_field. Returns components that belong to the subscription 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. To use this
-    # filter you also have to include the following param in the request
-    # `include=subscription`.
+    # `include=subscription,historic_usages`.
     # @return [ListSubscriptionComponentsResponse] response from the API call
     def list_subscription_components_for_site(options = {})
       new_api_call_builder
@@ -959,6 +916,7 @@ module AdvancedBilling
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))
                    .query_param(new_parameter(options['sort'], key: 'sort'))
                    .query_param(new_parameter(options['direction'], key: 'direction'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .query_param(new_parameter(options['date_field'], key: 'date_field'))
                    .query_param(new_parameter(options['start_date'], key: 'start_date'))
                    .query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
@@ -968,14 +926,6 @@ module AdvancedBilling
                    .query_param(new_parameter(options['price_point_ids'], key: 'price_point_ids'))
                    .query_param(new_parameter(options['product_family_ids'], key: 'product_family_ids'))
                    .query_param(new_parameter(options['include'], key: 'include'))
-                   .query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
-                   .query_param(new_parameter(options['filter_currencies'], key: 'filter[currencies]'))
-                   .query_param(new_parameter(options['filter_subscription_states'], key: 'filter[subscription][states]'))
-                   .query_param(new_parameter(options['filter_subscription_date_field'], key: 'filter[subscription][date_field]'))
-                   .query_param(new_parameter(options['filter_subscription_start_date'], key: 'filter[subscription][start_date]'))
-                   .query_param(new_parameter(options['filter_subscription_start_datetime'], key: 'filter[subscription][start_datetime]'))
-                   .query_param(new_parameter(options['filter_subscription_end_date'], key: 'filter[subscription][end_date]'))
-                   .query_param(new_parameter(options['filter_subscription_end_datetime'], key: 'filter[subscription][end_datetime]'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth'))
                    .array_serialization_format(ArraySerializationFormat::CSV))

data/lib/advanced_billing/controllers/subscription_group_invoice_account_controller.rb

@@ -42,17 +42,6 @@ module AdvancedBilling
     # This request will list a subscription group's prepayments.
     # @param [String] uid Required parameter: The uid of the subscription
     # group
-    # @param [ListSubscriptionGroupPrepaymentDateField] filter_date_field
-    # Optional parameter: The type of filter you would like to apply to your
-    # search. Use in query: `filter[date_field]=created_at`.
-    # @param [Date] filter_end_date Optional parameter: The end date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns prepayments with
-    # a timestamp up to and including 11:59:59PM in your site's time zone on the
-    # date specified. Use in query: `filter[end_date]=2011-12-15`.
-    # @param [Date] filter_start_date Optional parameter: The start date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns prepayments with
-    # a timestamp at or after midnight (12:00:00 AM) in your site's time zone on
-    # the date specified. Use in query: `filter[start_date]=2011-12-15`.
     # @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
@@ -64,6 +53,8 @@ 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`.
+    # @param [ListPrepaymentsFilter] filter Optional parameter: Filter to use
+    # for List Prepayments operations
     # @return [ListSubscriptionGroupPrepaymentResponse] response from the API call
     def list_prepayments_for_subscription_group(options = {})
       new_api_call_builder
@@ -73,13 +64,12 @@ module AdvancedBilling
                    .template_param(new_parameter(options['uid'], key: 'uid')
                                     .is_required(true)
                                     .should_encode(true))
-                   .query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
-                   .query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
-                   .query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
                    .query_param(new_parameter(options['page'], key: 'page'))
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
+                   .auth(Single.new('BasicAuth'))
+                   .array_serialization_format(ArraySerializationFormat::CSV))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
                    .deserialize_into(ListSubscriptionGroupPrepaymentResponse.method(:from_hash))

data/lib/advanced_billing/controllers/subscription_groups_controller.rb

@@ -93,10 +93,10 @@ module AdvancedBilling
                                      Server::DEFAULT)
                    .query_param(new_parameter(options['page'], key: 'page'))
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .query_param(new_parameter(options['include'], key: 'include[]'))
+                   .query_param(new_parameter(options['include'], key: 'include'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth'))
-                   .array_serialization_format(ArraySerializationFormat::CSV))
+                   .array_serialization_format(ArraySerializationFormat::UN_INDEXED))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
                    .deserialize_into(ListSubscriptionGroupsResponse.method(:from_hash)))
@@ -124,10 +124,10 @@ module AdvancedBilling
                    .template_param(new_parameter(uid, key: 'uid')
                                     .is_required(true)
                                     .should_encode(true))
-                   .query_param(new_parameter(include, key: 'include[]'))
+                   .query_param(new_parameter(include, key: 'include'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth'))
-                   .array_serialization_format(ArraySerializationFormat::CSV))
+                   .array_serialization_format(ArraySerializationFormat::UN_INDEXED))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
                    .deserialize_into(FullSubscriptionGroupResponse.method(:from_hash)))
@@ -135,8 +135,8 @@ module AdvancedBilling
     end
 
     # Use this endpoint to update subscription group members.
-    # `"member_ids": []` should contain an array of both subscription IDs to set
-    # as group members and subscription IDs already present in the groups. Not
+    # `"member_ids"` should contain an array of both subscription IDs to set as
+    # group members and subscription IDs already present in the groups. Not
     # including them will result in removing them from subscription group. To
     # clean up members, just leave the array empty.
     # @param [String] uid Required parameter: The uid of the subscription

data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb

@@ -78,18 +78,8 @@ 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`.
-    # @param [BasicDateField] filter_date_field Optional parameter: The type of
-    # filter you would like to apply to your search. created_at - Time when
-    # prepayment was created. application_at - Time when prepayment was applied
-    # to invoice. Use in query `filter[date_field]=created_at`.
-    # @param [Date] filter_start_date Optional parameter: The start date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns prepayments with
-    # a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on
-    # the date specified. Use in query `filter[start_date]=2011-12-15`.
-    # @param [Date] filter_end_date Optional parameter: The end date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns prepayments with
-    # a timestamp up to and including 11:59:59PM in your site’s time zone on the
-    # date specified. Use in query `filter[end_date]=2011-12-15`.
+    # @param [ListPrepaymentsFilter] filter Optional parameter: Filter to use
+    # for List Prepayments operations
     # @return [PrepaymentsResponse] response from the API call
     def list_prepayments(options = {})
       new_api_call_builder
@@ -101,11 +91,10 @@ module AdvancedBilling
                                     .should_encode(true))
                    .query_param(new_parameter(options['page'], key: 'page'))
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
-                   .query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
-                   .query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
+                   .auth(Single.new('BasicAuth'))
+                   .array_serialization_format(ArraySerializationFormat::CSV))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
                    .deserialize_into(PrepaymentsResponse.method(:from_hash))
@@ -138,7 +127,11 @@ module AdvancedBilling
                    .auth(Single.new('BasicAuth')))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ServiceCredit.method(:from_hash)))
+                   .deserialize_into(ServiceCredit.method(:from_hash))
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         APIException))
         .execute
     end
 
@@ -167,7 +160,7 @@ module AdvancedBilling
                    .local_error_template('422',
                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
                                           ' Response: \'{$response.body}\'.',
-                                         ErrorListResponseException))
+                                         APIException))
         .execute
     end
 
@@ -179,7 +172,7 @@ module AdvancedBilling
     # in cents, with `amount_in_cents`.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @param [String] prepayment_id Required parameter: id of prepayment
+    # @param [Integer] prepayment_id Required parameter: id of prepayment
     # @param [RefundPrepaymentRequest] body Optional parameter: Example:
     # @return [PrepaymentResponse] response from the API call
     def refund_prepayment(subscription_id,
@@ -213,7 +206,7 @@ module AdvancedBilling
                    .local_error_template('422',
                                          'HTTP Response Not OK. Status code: {$statusCode}.'\
                                           ' Response: \'{$response.body}\'.',
-                                         RefundPrepaymentAggregatedErrorsResponseException))
+                                         APIException))
         .execute
     end
   end

data/lib/advanced_billing/controllers/subscriptions_controller.rb

@@ -377,18 +377,16 @@ module AdvancedBilling
     # For more information on Stripe Direct Debit, please view the following two
     # resources:
     # + [Payment Profiles via API for Stripe BECS Direct
-    # Debit](https://developers.chargify.com/docs/api-docs/1f10a4f170405-create-
-    # payment-profile#stripe-becs-direct-debit)
+    # Debit]($e/Payment%20Profiles/createPaymentProfile)
     # + [Full documentation on Stripe Direct
     # Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-
     # Stripe-SEPA-and-BECS-Direct-Debit)
-    # + [Using Chargify.js with Stripe SEPA or BECS Direct Debit - minimal
-    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
-    # DIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway
-    # )
+    # + [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal
+    # example](page:development-tools/chargify-js/examples#minimal-example-with-
+    # sepa-becs-or-bacs-direct-debit-stripe-gateway)
     # + [Using Chargify.js with Stripe BECS Direct Debit - full
-    # example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzN
-    # DIy-examples#full-example-with-becs-direct-debit-stripe-gateway)
+    # example](page:development-tools/chargify-js/examples#full-example-with-bec
+    # s-direct-debit-stripe-gateway)
     # ```json
     # {
     #   "subscription": {
@@ -407,6 +405,43 @@ module AdvancedBilling
     #   }
     # }
     # ```
+    # ## Subscription using Stripe BACS Direct Debit
+    # For more information on Stripe Direct Debit, please view the following two
+    # resources:
+    # + [Payment Profiles via API for Stripe BACS Direct
+    # Debit]($e/Payment%20Profiles/createPaymentProfile)
+    # + [Full documentation on Stripe Direct
+    # Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-
+    # Stripe-SEPA-and-BECS-Direct-Debit)
+    # + [Using Chargify.js with Stripe SEPA, BECS or BACS Direct Debit - minimal
+    # example](page:development-tools/chargify-js/examples#minimal-example-with-
+    # sepa-becs-or-bacs-direct-debit-stripe-gateway)
+    # + [Using Chargify.js with Stripe BACS Direct Debit - full
+    # example](page:development-tools/chargify-js/examples#full-example-with-bac
+    # s-direct-debit-stripe-gateway)
+    # ```json
+    # {
+    #   "subscription": {
+    #     "product_handle": "gold-product",
+    #     "customer_attributes": {
+    #       "first_name": "Jane",
+    #       "last_name": "Doe",
+    #       "email": "jd@chargify.test"
+    #     },
+    #     "bank_account_attributes": {
+    #       "bank_name": "Test Bank",
+    #       "bank_branch_code": "108800",
+    #       "bank_account_number": "00012345",
+    #       "payment_type": "bank_account",
+    #       "billing_address": "123 Main St.",
+    #       "billing_city": "London",
+    #       "billing_state": "LND",
+    #       "billing_zip": "W1A 1AA",
+    #       "billing_country": "GB"
+    #     }
+    #   }
+    # }
+    # ```
     # ## 3D Secure - Stripe
     # It may happen that a payment needs 3D Secure Authentication when the
     # subscription is created; this is referred to in our help docs as a
@@ -863,10 +898,10 @@ module AdvancedBilling
                    .query_param(new_parameter(options['metadata'], key: 'metadata'))
                    .query_param(new_parameter(options['direction'], key: 'direction'))
                    .query_param(new_parameter(options['sort'], key: 'sort'))
-                   .query_param(new_parameter(options['include'], key: 'include[]'))
+                   .query_param(new_parameter(options['include'], key: 'include'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth'))
-                   .array_serialization_format(ArraySerializationFormat::CSV))
+                   .array_serialization_format(ArraySerializationFormat::UN_INDEXED))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
                    .deserialize_into(SubscriptionResponse.method(:from_hash))
@@ -984,10 +1019,10 @@ module AdvancedBilling
                    .template_param(new_parameter(subscription_id, key: 'subscription_id')
                                     .is_required(true)
                                     .should_encode(true))
-                   .query_param(new_parameter(include, key: 'include[]'))
+                   .query_param(new_parameter(include, key: 'include'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth'))
-                   .array_serialization_format(ArraySerializationFormat::PLAIN))
+                   .array_serialization_format(ArraySerializationFormat::UN_INDEXED))
         .response(new_response_handler
                    .deserializer(APIHelper.method(:custom_type_deserializer))
                    .deserialize_into(SubscriptionResponse.method(:from_hash)))
@@ -1100,9 +1135,9 @@ module AdvancedBilling
                                     .should_encode(true))
                    .query_param(new_parameter(ack, key: 'ack')
                                  .is_required(true))
-                   .query_param(new_parameter(cascade, key: 'cascade[]'))
+                   .query_param(new_parameter(cascade, key: 'cascade'))
                    .auth(Single.new('BasicAuth'))
-                   .array_serialization_format(ArraySerializationFormat::PLAIN))
+                   .array_serialization_format(ArraySerializationFormat::CSV))
         .response(new_response_handler
                    .is_response_void(true))
         .execute

data/lib/advanced_billing/models/ach_agreement.rb

@@ -94,5 +94,15 @@ module AdvancedBilling
                        ip_address,
                        hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [ACHAgreement | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/address_change.rb

@@ -63,27 +63,5 @@ module AdvancedBilling
                         after,
                         hash)
     end
-
-    # Validates an instance of the object from a given value.
-    # @param [AddressChange | Hash] The value against the validation is performed.
-    def self.validate(value)
-      if value.instance_of? self
-        return (
-          APIHelper.valid_type?(value.before,
-                                ->(val) { InvoiceAddress.validate(val) }) and
-            APIHelper.valid_type?(value.after,
-                                  ->(val) { InvoiceAddress.validate(val) })
-        )
-      end
-
-      return false unless value.instance_of? Hash
-
-      (
-        APIHelper.valid_type?(value['before'],
-                              ->(val) { InvoiceAddress.validate(val) }) and
-          APIHelper.valid_type?(value['after'],
-                                ->(val) { InvoiceAddress.validate(val) })
-      )
-    end
   end
 end

data/lib/advanced_billing/models/agreement_acceptance.rb

@@ -123,5 +123,15 @@ module AdvancedBilling
                               secure_checkout_policy_url,
                               hash)
     end
+
+    # Validates an instance of the object from a given value.
+    # @param [AgreementAcceptance | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
   end
 end

data/lib/advanced_billing/models/allocation.rb

@@ -326,9 +326,7 @@ module AdvancedBilling
         hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
       downgrade_credit =
         hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
-      payment = hash.key?('payment') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:AllocationPayment), hash['payment']
-      ) : SKIP
+      payment = PaymentForAllocation.from_hash(hash['payment']) if hash['payment']
       expires_at = if hash.key?('expires_at')
                      (DateTimeHelper.from_rfc3339(hash['expires_at']) if hash['expires_at'])
                    else