Release 4.0.0

Changelog

4.0.0 (2021-03-01)

Full Changelog

Major Version Release

The 4.x major version of the client pairs with the v2021-02-25 API version. This version of the client and the API contain breaking changes that should be considered before upgrading your integration.

Breaking Changes in the API

All changes to the core API are documented in the Developer Portal changelog

Breaking Changes in Client

• Remove site_id and subdomain from client initializer. [#624]

• Remove set_site_id method from client. [#627]

• Classify unexpected error responses from Recurly API via an HTTP status code mapping provided in Recurly::Errors::ERROR_MAP. [#616]

• Remove NetworkError class. All error classes now extend the APIError. This means that the order of multiple rescue blocks will need to be re-considered. [#616]

  3.x

  rescue Recurly::Errors::ValidationError => ex
    # catch a validation error
  rescue Recurly::Errors::APIError => ex
    # catch a generic api error
  rescue Recurly::Errors::TimeoutError => ex
    # catch a specific network error

  4.x

  rescue Recurly::Errors::ValidationError => ex
    # catch a validation error
  rescue Recurly::Errors::TimeoutError => ex
    # catch a specific network error
  rescue Recurly::Errors::APIError => ex
    # catch a generic api error

• Rename InvalidResponseError to InvalidContentTypeError. [#616]

• Rename UnavailableError to ServiceUnavailableError. [#616]

• Reorganize top-level keys of the optional parameters hash to improve clarity and create space for additional options. [#619]

  3.x

  options = {
    limit: 200,
    headers: {
      'Accept-Language' => 'fr'
    }
  }
  accounts = @client.list_accounts(options)

  4.x

  options = {
    params: {
        limit: 200
    }
    headers: {
      'Accept-Language' => 'fr'
    }
  }
  accounts = @client.list_accounts(options)

Implemented enhancements:

• Remove site_id and subdomain from client initializer #624 (joannasese)

Fixed bugs:

• Every method is returning wrong number of arguments #664

Merged pull requests:

• Release 4.0.0 #669 (douglasmiller)
• Updating changelog script and changelog generator config for 4.x release #663 (douglasmiller)
• Removing unused method 'set_site_id' #627 (douglasmiller)
• Updating 4.x client to expect query string params as ['params'] #619 (douglasmiller)
• Updating error mapping based on status code #616 (douglasmiller)