recurly 3.28.0 → 4.0.0

data/CONTRIBUTING.md

@@ -7,10 +7,6 @@ however, we may not get to these right away. Although we try to be quick, our pr
 writing code. If you want a timely response (especially if you have an emergency), we recommend
 you contact our [official support team](https://support.recurly.com/).
 
-## Code of Conduct
-
-Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
-
 #### Table Of Contents
 
 * [I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)

data/GETTING_STARTED.md

@@ -5,7 +5,7 @@ This repository houses the official ruby client for Recurly's V3 API.
 In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '~> 3.28'
+gem 'recurly', '~> 4.0'
 ```
 
 > *Note*: We try to follow [semantic versioning](https://semver.org/) and will only apply breaking changes to major versions.
@@ -106,17 +106,19 @@ plans.each_page.each_with_index do |data, page_num|
 end
 ```
 
-Pagination endpoints take a number of options to sort and filter the results. They can be passed in as keyword arguments.
+Pagination endpoints take a number of options to sort and filter the results. They can be passed in as a hash provided by the `:params` keyword argument.
 The names, types, and descriptions of these arguments are listed in the rubydocs for each method:
 
 ```ruby
 options = {
-  limit: 200, # number of items per page
-  state: :active, # only active plans
-  sort: :updated_at,
-  order: :asc,
-  begin_time: DateTime.new(2017,1,1), # January 1st 2017,
-  end_time: DateTime.now
+  params: {
+    limit: 200, # number of items per page
+    state: :active, # only active plans
+    sort: :updated_at,
+    order: :asc,
+    begin_time: DateTime.new(2017,1,1), # January 1st 2017,
+    end_time: DateTime.now
+  }
 }
 
 plans = client.list_plans(**options)
@@ -200,12 +202,11 @@ plan = client.create_plan(body: plan_data)
 
 # Error Handling
 
-This library currently throws 2 types of exceptions. {Recurly::Errors::APIError} and {Recurly::Errors::NetworkError}. See these 2 files for the types of exceptions you can catch:
+All errors thrown by this library are based off of the `Recurly::Errors::APIError`. There 
 
-1. [API Errors](./lib/recurly/errors/api_errors.rb)
-2. [Network Errors](./lib/recurly/errors/network_errors.rb)
+This library throws one main type of exception, `Recurly::Errors::APIError`. There exists an additional hierarchy of errors to facilitate the process of rescuing various classes of errors. More detail can be found in the [Api Errors Module](./lib/recurly/errors/api_errors.rb).
 
-You will normally be working with {Recurly::Errors::APIError}. You can catch specific or generic versions of these exceptions. Example:
+You can catch specific or generic versions of these exceptions. Example:
 
 ```ruby
 begin
@@ -233,15 +234,17 @@ rescue Recurly::Errors::ValidationError => ex
   #=> #<Recurly::Error:0x007fbbdf8a32c8 @attributes={:type=>"validation", :message=>"Code 'iexistalready' already exists", :params=>[{"param"=>"code", "message"=>"'iexistalready' already exists"}]}>
   puts ex.status_code
   #=> 422
+rescue Recurly::Errors::TimeoutError => ex
+  # catch a specific server error
+rescue Recurly::Errors::ServerError => ex
+  # catch a generic server error
 rescue Recurly::Errors::APIError => ex
   # catch a generic api error
-rescue Recurly::Errors::TimeoutError => ex
-  # catch a specific network error
-rescue Recurly::Errors::NetworkError => ex
-  # catch a generic network error
 end
 ```
 
+`Recurly::Errors::APIError` instances provide access to the response via the `#get_response` method.
+
 # HTTP Metadata
 
 Sometimes you might want to get some additional information about the underlying HTTP request and response. Instead of
@@ -266,7 +269,7 @@ response = @client.remove_line_item(
   line_item_id: "a959576b2b10b012"
 ).get_response
 ```
-And it can be captured on exceptions through the {Recurly::ApiError} object:
+And it can be captured on exceptions through the {Recurly::APIError} object:
 
 ```ruby
 begin

data/README.md

@@ -1,8 +1,5 @@
 # Recurly
 
-[![Rubygems](https://img.shields.io/static/v1?label=rubygems&message=recurly&color=purple)](https://rubygems.org/gems/recurly)
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
-
 This repository houses the official ruby client for Recurly's V3 API.
 
 > *Note*: