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)

Changelog

Unreleased

Full Changelog

Fixed bugs:

• Fixing issues with ruby 3.0 #665 (douglasmiller)

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Latest Changes for 2019-10-10 #660 (douglasmiller)

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Latest Changes for 2019-10-10 #657 (douglasmiller)

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Latest Changes for 2019-10-10 (tax_identifier / tax_identifier_type) #654 (douglasmiller)
• Latest Changes for 2019-10-10 #651 (douglasmiller)

• Expose item_state and external_sku in AddOn class https://github.com/recurly/recurly-client-ruby/pull/650
• Handle UnprocessableEntity error for Invoice#refund https://github.com/recurly/recurly-client-ruby/pull/653

• Expose last_two on BillingInfo class for IBAN accounts and repair tests https://github.com/recurly/recurly-client-ruby/pull/648

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Latest Changes for 2019-10-10 (Wallet, Item Coupons) #645 (douglasmiller)

• Support item-specific coupons https://github.com/recurly/recurly-client-ruby/pull/644

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Mon Oct 19 20:38:03 UTC 2020 Upgrade API version v2019-10-10 #642 (douglasmiller)

Merged pull requests:

• Fixes uninitialized constant Recurly::Errors::ServiceNotAvailableError #641 (ruyrocha)

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Latest Changes for 2019-10-10 (Automated Exports, additional resource data attributes) #638 (douglasmiller)

• New endpoint to verify an account's billing information https://github.com/recurly/recurly-client-ruby/pull/636

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Mon Aug 31 19:44:58 UTC 2020 Upgrade API version v2019-10-10 #632 (douglasmiller)

Merged pull requests:

• Code of Conduct #631 (bhelx)

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Fri Aug 21 16:17:28 UTC 2020 Upgrade API version v2019-10-10 #629 (douglasmiller)

This bumps us up to API version 2.29. There are no breaking changes.

• Add tax identifier fields to billing info https://github.com/recurly/recurly-client-ruby/pull/625

• Remove surcharge as Avalara recommends https://github.com/recurly/recurly-client-ruby/pull/618
• Establish association between Tier and SubscriptionAddOn https://github.com/recurly/recurly-client-ruby/pull/620

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Latest Changes for 2019-10-10 (usage, measured units, etc) #621 (bhelx)
• Adding hierarchical errors #610 (douglasmiller)

This bumps us to API version 2.28. There are no breaking changes.

• Fix sub-add-on init bug https://github.com/recurly/recurly-client-ruby/pull/615
• BECS support https://github.com/recurly/recurly-client-ruby/pull/612

• Add support for Avalara for Communications https://github.com/recurly/recurly-client-ruby/pull/613

Changelog

Unreleased

Full Changelog

Implemented enhancements:

• Mon Jul 6 14:48:05 UTC 2020 Upgrade API version v2019-10-10 #608 (douglasmiller)