maxio-advanced-billing-sdk 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56ad6bf7a546dec06d225320086160fc7268eabaa8494758580cb136cd957526
-  data.tar.gz: 5c251518ad00a555d27146b7c2f317ac169474ecf303e4de1216b44e84189f4d
+  metadata.gz: 32c5dafe5bea02b9f4b9e58fe9b135ae484bfe4e621cddafc46492ef9cb46a84
+  data.tar.gz: 7b375ac0ccb8c59f1573f84bbf40886793981ad28f87727fda0342cda3c35e3d
 SHA512:
-  metadata.gz: 348d9a2c09c3f1557ce3340cd3623765e50da283354f322fa0cfd55d4f898f53cc54983a3b15d64e44bf54b39b5bcc3d78b457b07846c8ce68f6d501f8f56f22
-  data.tar.gz: 412763f3a4e11e72088bbca0fcd1fb6377fee9b5b1b35eb8cddaeb0a7126be72b656efa206211648d785a8a471f2d7bd46d6b4121e0fce9c0edb87d5e0710f36
+  metadata.gz: f69877c24f4051ea86da5af356846d3ef5a36bbd7ee147453434488f72eaf0453a9b068013b8f4137d238e7ef168b3e5f1092a8c09a417e6954be648b9c8b273
+  data.tar.gz: c0d84c7e8e61fd733a10a470eff219c6c1eb5f7165df687abc49a895c66db85dbaeb3be563f0dbc7ec3e6e843a2f6a2d248d79411e776eeaa472d08f9ddb5619

data/README.md

@@ -30,20 +30,20 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json
 Install the gem from the command line:
 
 ```ruby
-gem install maxio-advanced-billing-sdk -v 2.0.0
+gem install maxio-advanced-billing-sdk -v 3.0.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'maxio-advanced-billing-sdk', '2.0.0'
+gem 'maxio-advanced-billing-sdk', '3.0.0'
 ```
 
-For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/2.0.0).
+For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/3.0.0).
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -61,7 +61,7 @@ The following parameters are configurable for the API Client:
 | `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
 | `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
 | `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/basic-authentication.md) | The credential object for Basic Authentication |
+| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/basic-authentication.md) | The credential object for Basic Authentication |
 
 The API client can be initialized as follows:
 
@@ -92,45 +92,45 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/basic-authentication.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/basic-authentication.md)
 
 ## List of APIs
 
-* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/billing-portal.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscription-products.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/controllers/webhooks.md)
+* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/billing-portal.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-products.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/webhooks.md)
 
 ## Classes Documentation
 
-* [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/2.0.0/doc/http-request.md)
+* [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/http-request.md)
 

data/lib/advanced_billing/controllers/advance_invoice_controller.rb

@@ -7,10 +7,12 @@ module AdvancedBilling
   # AdvanceInvoiceController
   class AdvanceInvoiceController < BaseController
     # Generate an invoice in advance for a subscription's next renewal date.
-    # [Please see our docs]($m/Invoice) for more information on advance
-    # invoices, including eligibility on generating one; for the most part, they
-    # function like any other invoice, except they are issued early and have
-    # special behavior upon being voided.
+    # [Please see our
+    # docs](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404811062541-I
+    # ssue-Invoice-In-Advance) for more information on advance invoices,
+    # including eligibility on generating one; for the most part, they function
+    # like any other invoice, except they are issued early and have special
+    # behavior upon being voided.
     # A subscription may only have one advance invoice per billing period.
     # Attempting to issue an advance invoice when one already exists will return
     # an error.

data/lib/advanced_billing/controllers/base_controller.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'AB SDK Ruby:2.0.0 on OS {os-info}'
+      'AB SDK Ruby:3.0.0 on OS {os-info}'
     end
 
     def self.user_agent_parameters

data/lib/advanced_billing/controllers/components_controller.rb

@@ -382,13 +382,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 [Array[String]] filter_ids Optional parameter: Allows fetching
-    # components with matching id based on provided value. Use in query
-    # `filter[ids]=1,2,3`.
-    # @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
-    # parameter: Allows fetching components with matching use_site_exchange_rate
-    # based on provided value (refers to default price point). Use in query
-    # `filter[use_site_exchange_rate]=true`.
+    # @param [ListComponentsFilter] filter Optional parameter: Filter to use for
+    # List Components operations
     # @return [Array[ComponentResponse]] response from the API call
     def list_components(options = {})
       new_api_call_builder
@@ -403,8 +398,7 @@ module AdvancedBilling
                    .query_param(new_parameter(options['include_archived'], key: 'include_archived'))
                    .query_param(new_parameter(options['page'], key: 'page'))
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
-                   .query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth'))
                    .array_serialization_format(ArraySerializationFormat::CSV))
@@ -486,9 +480,6 @@ module AdvancedBilling
     # the product family
     # @param [TrueClass | FalseClass] include_archived Optional parameter:
     # Include archived items.
-    # @param [Array[Integer]] filter_ids Optional parameter: Allows fetching
-    # components with matching id based on provided value. Use in query
-    # `filter[ids]=1,2`.
     # @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
@@ -500,6 +491,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 [ListComponentsFilter] filter Optional parameter: Filter to use for
+    # List Components operations
     # @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`.
@@ -522,10 +515,6 @@ 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 [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
-    # parameter: Allows fetching components 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[ComponentResponse]] response from the API call
     def list_components_for_product_family(options = {})
       new_api_call_builder
@@ -536,15 +525,14 @@ module AdvancedBilling
                                     .is_required(true)
                                     .should_encode(true))
                    .query_param(new_parameter(options['include_archived'], key: 'include_archived'))
-                   .query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
                    .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'))
                    .query_param(new_parameter(options['date_field'], key: 'date_field'))
                    .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'))
                    .query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
-                   .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'))
                    .array_serialization_format(ArraySerializationFormat::CSV))
@@ -826,19 +814,6 @@ module AdvancedBilling
 
     # This method allows to retrieve a list of Components Price Points belonging
     # to a Site.
-    # @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 [ListComponentsPricePointsInclude] include Optional parameter:
     # Allows including additional data in the response. Use in query:
     # `include=currency_prices`.
@@ -853,45 +828,21 @@ 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 [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]=custom,catalog`.
     # @param [SortingDirection] direction Optional parameter: Controls the order
     # in which results are returned. Use in query `direction=asc`.
-    # @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 [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 [ListPricePointsFilter] filter Optional parameter: Filter to use
+    # for List PricePoints operations
     # @return [ListComponentsPricePointsResponse] response from the API call
     def list_all_component_price_points(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/components_price_points.json',
                                      Server::DEFAULT)
-                   .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['include'], key: 'include'))
                    .query_param(new_parameter(options['page'], key: 'page'))
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .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['direction'], key: 'direction'))
-                   .query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
-                   .query_param(new_parameter(options['filter_archived_at'], key: 'filter[archived_at]'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('BasicAuth'))
                    .array_serialization_format(ArraySerializationFormat::CSV))

data/lib/advanced_billing/controllers/coupons_controller.rb

@@ -70,44 +70,13 @@ module AdvancedBilling
     # many records to fetch in each request. Default value is 30. 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. 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 coupons with a
-    # timestamp up to and including 11:59:59PM in your site’s time zone on the
-    # date specified. Use in query `filter[date_field]=2011-12-15`.
-    # @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 coupons 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. Use in query `?filter[end_datetime]=2011-12-1T10:15:30+01:00`.
-    # @param [Date] filter_start_date Optional parameter: The start date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns coupons 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-17`.
-    # @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 coupons 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.
-    # Use in query `filter[start_datetime]=2011-12-19T10:15:30+01:00`.
-    # @param [Array[Integer]] filter_ids Optional parameter: Allows fetching
-    # coupons with matching id based on provided values. Use in query
-    # `filter[ids]=1,2,3`.
-    # @param [Array[String]] filter_codes Optional parameter: Allows fetching
-    # coupons with matching codes based on provided values. Use in query
-    # `filter[codes]=free,free_trial`.
+    # @param [ListCouponsFilter] filter Optional parameter: Filter to use for
+    # List Coupons operations
     # @param [TrueClass | FalseClass] currency_prices Optional parameter: When
     # fetching coupons, if you have defined multiple currencies at the site
     # level, you can optionally pass the `?currency_prices=true` query param to
     # include an array of currency price data in the response. Use in query
     # `currency_prices=true`.
-    # @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
-    # parameter: Allows fetching coupons with matching use_site_exchange_rate
-    # based on provided value. Use in query
-    # `filter[use_site_exchange_rate]=true`.
     # @return [Array[CouponResponse]] response from the API call
     def list_coupons_for_product_family(options = {})
       new_api_call_builder
@@ -119,15 +88,8 @@ 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_end_date'], key: 'filter[end_date]'))
-                   .query_param(new_parameter(options['filter_end_datetime'], key: 'filter[end_datetime]'))
-                   .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_ids'], key: 'filter[ids]'))
-                   .query_param(new_parameter(options['filter_codes'], key: 'filter[codes]'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .query_param(new_parameter(options['currency_prices'], key: 'currency_prices'))
-                   .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'))
                    .array_serialization_format(ArraySerializationFormat::CSV))
@@ -283,72 +245,13 @@ module AdvancedBilling
     # many records to fetch in each request. Default value is 30. 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] date_field Optional parameter: The field was
-    # deprecated: on January 20, 2022. We recommend using filter[date_field]
-    # instead to achieve the same result. The type of filter you would like to
-    # apply to your search.
-    # @param [Date] start_date Optional parameter: The field was deprecated: on
-    # January 20, 2022. We recommend using filter[start_date] instead to achieve
-    # the same result. The start date (format YYYY-MM-DD) with which to filter
-    # the date_field. Returns coupons with a timestamp at or after midnight
-    # (12:00:00 AM) in your site’s time zone on the date specified.
-    # @param [Date] end_date Optional parameter: The field was deprecated: on
-    # January 20, 2022. We recommend using filter[end_date] instead to achieve
-    # the same result. The end date (format YYYY-MM-DD) with which to filter the
-    # date_field. Returns coupons with a timestamp up to and including
-    # 11:59:59PM in your site’s time zone on the date specified.
-    # @param [DateTime] start_datetime Optional parameter: The field was
-    # deprecated: on January 20, 2022. We recommend using filter[start_datetime]
-    # instead to achieve the same result. The start date and time (format
-    # YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons
-    # 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 [DateTime] end_datetime Optional parameter: The field was
-    # deprecated: on January 20, 2022. We recommend using filter[end_datetime]
-    # instead to achieve the same result. The end date and time (format
-    # YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons
-    # 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
-    # coupons with matching id based on provided values. Use in query
-    # `filter[ids]=1,2,3`.
-    # @param [Array[String]] filter_codes Optional parameter: Allows fetching
-    # coupons with matching code based on provided values. Use in query
-    # `filter[ids]=1,2,3`.
+    # @param [ListCouponsFilter] filter Optional parameter: Filter to use for
+    # List Coupons operations
     # @param [TrueClass | FalseClass] currency_prices Optional parameter: When
     # fetching coupons, if you have defined multiple currencies at the site
     # level, you can optionally pass the `?currency_prices=true` query param to
     # include an array of currency price data in the response. Use in query
     # `currency_prices=true`.
-    # @param [Date] filter_end_date Optional parameter: The end date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns coupons 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-17`.
-    # @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 coupons 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. Use in query `filter[end_datetime]=2011-12-19T10:15:30+01:00`.
-    # @param [Date] filter_start_date Optional parameter: The start date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns coupons 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-19`.
-    # @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 coupons 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.
-    # Use in query `filter[start_datetime]=2011-12-19T10:15:30+01:00`.
-    # @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]=updated_at`.
-    # @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
-    # parameter: Allows fetching coupons with matching use_site_exchange_rate
-    # based on provided value. Use in query
-    # `filter[use_site_exchange_rate]=true`.
     # @return [Array[CouponResponse]] response from the API call
     def list_coupons(options = {})
       new_api_call_builder
@@ -357,20 +260,8 @@ 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['date_field'], key: 'date_field'))
-                   .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['filter_ids'], key: 'filter[ids]'))
-                   .query_param(new_parameter(options['filter_codes'], key: 'filter[codes]'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .query_param(new_parameter(options['currency_prices'], key: 'currency_prices'))
-                   .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_start_date'], key: 'filter[start_date]'))
-                   .query_param(new_parameter(options['filter_start_datetime'], key: 'filter[start_datetime]'))
-                   .query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
-                   .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'))
                    .array_serialization_format(ArraySerializationFormat::CSV))

data/lib/advanced_billing/controllers/custom_fields_controller.rb

@@ -354,9 +354,9 @@ module AdvancedBilling
                                     .is_required(true)
                                     .should_encode(true))
                    .query_param(new_parameter(name, key: 'name'))
-                   .query_param(new_parameter(names, key: 'names[]'))
+                   .query_param(new_parameter(names, key: 'names'))
                    .auth(Single.new('BasicAuth'))
-                   .array_serialization_format(ArraySerializationFormat::PLAIN))
+                   .array_serialization_format(ArraySerializationFormat::UN_INDEXED))
         .response(new_response_handler
                    .is_response_void(true)
                    .local_error_template('404',
@@ -434,11 +434,11 @@ module AdvancedBilling
                    .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['with_deleted'], key: 'with_deleted'))
-                   .query_param(new_parameter(options['resource_ids'], key: 'resource_ids[]'))
+                   .query_param(new_parameter(options['resource_ids'], key: 'resource_ids'))
                    .query_param(new_parameter(options['direction'], key: 'direction'))
                    .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(PaginatedMetadata.method(:from_hash)))

data/lib/advanced_billing/controllers/events_based_billing_segments_controller.rb

@@ -71,23 +71,8 @@ module AdvancedBilling
     # many records to fetch in each request. Default value is 30. The maximum
     # allowed values is 200; any per_page value over 200 will be changed to 200.
     # Use in query `per_page=200`.
-    # @param [String] filter_segment_property_1_value Optional parameter: The
-    # value passed here would be used to filter segments. Pass a value related
-    # to `segment_property_1` on attached Metric. If empty string is passed,
-    # this filter would be rejected. Use in query
-    # `filter[segment_property_1_value]=EU`.
-    # @param [String] filter_segment_property_2_value Optional parameter: The
-    # value passed here would be used to filter segments. Pass a value related
-    # to `segment_property_2` on attached Metric. If empty string is passed,
-    # this filter would be rejected.
-    # @param [String] filter_segment_property_3_value Optional parameter: The
-    # value passed here would be used to filter segments. Pass a value related
-    # to `segment_property_3` on attached Metric. If empty string is passed,
-    # this filter would be rejected.
-    # @param [String] filter_segment_property_4_value Optional parameter: The
-    # value passed here would be used to filter segments. Pass a value related
-    # to `segment_property_4` on attached Metric. If empty string is passed,
-    # this filter would be rejected.
+    # @param [ListSegmentsFilter] filter Optional parameter: Filter to use for
+    # List Segments for a Price Point operation
     # @return [ListSegmentsResponse] response from the API call
     def list_segments_for_price_point(options = {})
       new_api_call_builder
@@ -102,12 +87,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_segment_property_1_value'], key: 'filter[segment_property_1_value]'))
-                   .query_param(new_parameter(options['filter_segment_property_2_value'], key: 'filter[segment_property_2_value]'))
-                   .query_param(new_parameter(options['filter_segment_property_3_value'], key: 'filter[segment_property_3_value]'))
-                   .query_param(new_parameter(options['filter_segment_property_4_value'], key: 'filter[segment_property_4_value]'))
+                   .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(ListSegmentsResponse.method(:from_hash))

data/lib/advanced_billing/controllers/insights_controller.rb

@@ -112,9 +112,8 @@ module AdvancedBilling
 
     # This endpoint returns your site's current MRR, including plan and usage
     # breakouts split per subscription.
-    # @param [Array[Integer]] filter_subscription_ids Optional parameter: Submit
-    # ids in order to limit results. Use in query:
-    # `filter[subscription_ids]=1,2,3`.
+    # @param [ListMrrFilter] filter Optional parameter: Filter to use for List
+    # MRR per subscription operation
     # @param [String] at_time Optional parameter: Submit a timestamp in ISO8601
     # format to request MRR for a historic time. Use in query:
     # `at_time=2022-01-10T10:00:00-05:00`.
@@ -140,7 +139,7 @@ module AdvancedBilling
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/subscriptions_mrr.json',
                                      Server::DEFAULT)
-                   .query_param(new_parameter(options['filter_subscription_ids'], key: 'filter[subscription_ids]'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
                    .query_param(new_parameter(options['at_time'], key: 'at_time'))
                    .query_param(new_parameter(options['page'], key: 'page'))
                    .query_param(new_parameter(options['per_page'], key: 'per_page'))

data/lib/advanced_billing/controllers/invoices_controller.rb

@@ -154,6 +154,17 @@ module AdvancedBilling
     end
 
     # Use this endpoint to retrieve the details for an invoice.
+    # ## PDF Invoice retrieval
+    # Individual PDF Invoices can be retrieved by using the "Accept" header
+    # application/pdf or appending .pdf as the format portion of the URL:
+    # ```curl -u <api_key>:x -H
+    # Accept:application/pdf -H
+    # https://acme.chargify.com/invoices/inv_8gd8tdhtd3hgr.pdf > output_file.pdf
+    # URL: `https://<subdomain>.chargify.com/invoices/<uid>.<format>`
+    # Method: GET
+    # Required parameters: `uid`
+    # Response: A single Invoice.
+    # ```
     # @param [String] uid Required parameter: The unique identifier for the
     # invoice, this does not refer to the public facing invoice number.
     # @return [Invoice] response from the API call

data/lib/advanced_billing/controllers/payment_profiles_controller.rb

@@ -220,6 +220,32 @@ module AdvancedBilling
     #   }
     # }
     # ```
+    # ## Stripe BACS Direct Debit
+    # Contact the support team to enable this payment method.
+    # For more information on Stripe BACS Direct Debit, please view the
+    # following resources:
+    # + [Full documentation on Stripe BACS Direct
+    # Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-
+    # Stripe-SEPA-and-BECS-Direct-Debit)
+    # ### Stripe BACS Direct Debit Payment Profiles
+    # The following example creates a customer, bank account and mandate in
+    # Stripe:
+    # ```json
+    # {
+    #   "payment_profile": {
+    #     "customer_id": "24907598",
+    #     "bank_name": "British bank",
+    #     "bank_branch_code": "108800",
+    #     "bank_account_number": "00012345"
+    #     "payment_type": "bank_account",
+    #     "billing_address": "Test",
+    #     "billing_city": "London",
+    #     "billing_state": "LND",
+    #     "billing_zip": "12345",
+    #     "billing_country": "GB"
+    #   }
+    # }
+    # ```
     # ## 3D Secure - Checkout
     # It may happen that a payment needs 3D Secure Authentication when the
     # payment profile is created; this is referred to in our help docs as a