recurly 3.0.0.beta.4 → 3.0.0.beta.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa84948d98ac3695fb2639905b05c1ae0ff8ee70
-  data.tar.gz: 36229c9d3cd0e548e1b8845d98453e07b4fc07a8
+  metadata.gz: 3a83d4657995fd0ff223c206cec0f070cd2444d6
+  data.tar.gz: 30cd8091362db149ca7c6b58eda4bc0e28909362
 SHA512:
-  metadata.gz: 6794cb420246f6407362fa23c1e0c5621df35703fa210f97b4090e0226e56b2e68f8040a654a943909f802c89c7b37246de363bc297bbd8b0af6266de7cf7fe3
-  data.tar.gz: cc7fb401cd2ef58e1444137bb0e881e71afac83135ca18c1012aa8aef0c3f2c2016760382873f3384f1e8f268b61aa3e73313280e7e5248e132b9157ed2936ab
+  metadata.gz: f4e1d7f40eddeec2548d7725b00a23753ce9c89101395a15bb33039ff8e4fc76366c6fab7d77739ba78a3d8ae5106bc42e0a86cd55b6f6b58d9ef8a0cbbcac3e
+  data.tar.gz: 7a009fc1f8447ae303d17cf4040fbb3b7e0ccbf391814479a9003342a06e059febbe4d8fe243c082a74a7c63da7afb57a5ad73b6d03cb067174b63dff2f2319e

data/.ruby-version

@@ -1 +1 @@
-2.4.4
+2.4.5

data/.travis.yml

@@ -1,10 +1,12 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
+bundler_args: --binstubs
 before_install:
   - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
   - gem install bundler -v '< 2'
+script:
+  - ./scripts/test

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in recurly.gemspec
 gemspec

data/README.md

@@ -15,7 +15,7 @@ This contains everything in the README as well as code-level documentation. We s
 This gem is a pre-release. In your Gemfile, add `recurly` as a dependency.
 
 ```ruby
-gem 'recurly', '3.0.0.beta.4'
+gem 'recurly', '3.0.0.beta.5'
 ```
 
 It's important that you lock on a specific version as there may be breaking changes between releases.

data/lib/recurly.rb

@@ -4,13 +4,17 @@ require "recurly/request"
 require "recurly/resource"
 require "recurly/pager"
 # Include all request files
-resources = File.join(File.dirname(__FILE__), 'recurly', 'requests', '*.rb')
+resources = File.join(File.dirname(__FILE__), "recurly", "requests", "*.rb")
 Dir.glob(resources, &method(:require))
 # Include all resource files
-resources = File.join(File.dirname(__FILE__), 'recurly', 'resources', '*.rb')
+resources = File.join(File.dirname(__FILE__), "recurly", "resources", "*.rb")
 Dir.glob(resources, &method(:require))
 require "recurly/errors"
 require "recurly/client"
 
 module Recurly
+  STRICT_MODE = !ENV["RECURLY_STRICT_MODE"].nil?
+  if STRICT_MODE
+    puts "[Recurly] [WARNING] STRICT_MODE enabled. This should only be used for testing purposes."
+  end
 end

data/lib/recurly/client.rb

@@ -1,11 +1,12 @@
-require 'faraday'
-require 'logger'
-require_relative './schema/json_parser'
-require_relative './client/adapter'
+require "faraday"
+require "logger"
+require "erb"
+require_relative "./schema/json_parser"
+require_relative "./client/adapter"
 
 module Recurly
   class Client
-    require_relative './client/operations'
+    require_relative "./client/operations"
 
     BASE_URL = "https://partner-api.recurly.com/"
 
@@ -94,15 +95,15 @@ module Recurly
       raise_network_error!(ex)
     end
 
-    def put(path, request_data=nil, request_class=nil, **options)
+    def put(path, request_data = nil, request_class = nil, **options)
       response = if request_data
-        request = request_class.new(request_data)
-        request.validate!
-        logger.info("PUT BODY #{JSON.dump(request_data)}")
-        run_request(:put, path, JSON.dump(request_data), headers)
-      else
-        run_request(:put, path, nil, headers)
-      end
+                   request = request_class.new(request_data)
+                   request.validate!
+                   logger.info("PUT BODY #{JSON.dump(request_data)}")
+                   run_request(:put, path, JSON.dump(request_data), headers)
+                 else
+                   run_request(:put, path, nil, headers)
+                 end
       raise_api_error!(response) unless (200...300).include?(response.status)
       JSONParser.parse(self, response.body)
     rescue Faraday::ClientError => ex
@@ -138,7 +139,7 @@ module Recurly
                     when Faraday::TimeoutError
                       Errors::TimeoutError
                     when Faraday::ConnectionFailed
-                      Errors::ConnectionFailed
+                      Errors::ConnectionFailedError
                     when Faraday::SSLError
                       Errors::SSLError
                     else
@@ -155,25 +156,27 @@ module Recurly
     end
 
     def read_headers(response)
-      @rate_limit = response.headers['x-ratelimit-limit'].to_i
-      @rate_limit_remaining = response.headers['x-ratelimit-remaining'].to_i
-      @rate_limit_reset = Time.at(response.headers['x-ratelimit-reset'].to_i).to_datetime
-      if !@_ignore_deprecation_warning && response.headers['Recurly-Deprecated']&.upcase == 'TRUE'
-        puts "[recurly-client-ruby] WARNING: Your current API version \"#{api_version}\" is deprecated and will be sunset on #{response.headers['Recurly-Sunset-Date']}"
+      @rate_limit = response.headers["x-ratelimit-limit"].to_i
+      @rate_limit_remaining = response.headers["x-ratelimit-remaining"].to_i
+      @rate_limit_reset = Time.at(response.headers["x-ratelimit-reset"].to_i).to_datetime
+      if !@_ignore_deprecation_warning && response.headers["Recurly-Deprecated"]&.upcase == "TRUE"
+        puts "[recurly-client-ruby] WARNING: Your current API version \"#{api_version}\" is deprecated and will be sunset on #{response.headers["Recurly-Sunset-Date"]}"
       end
       response
     end
 
     def headers
       {
-        'Accept' => "application/vnd.recurly.#{api_version}", # got this method from operations.rb
-        'Content-Type' => 'application/json',
-        'User-Agent' => "Recurly/#{VERSION}; #{RUBY_DESCRIPTION}"
+        "Accept" => "application/vnd.recurly.#{api_version}", # got this method from operations.rb
+        "Content-Type" => "application/json",
+        "User-Agent" => "Recurly/#{VERSION}; #{RUBY_DESCRIPTION}",
       }.merge(@extra_headers)
     end
 
     def interpolate_path(path, **options)
       options.each do |k, v|
+        # Check to see that we are passing the correct data types
+        # This prevents a confusing error if the user passes in a non-primitive by mistake
         unless [String, Symbol, Integer, Float].include?(v.class)
           message = "We cannot build the url with the given argument #{k}=#{v.inspect}."
           if k =~ /_id$/
@@ -181,6 +184,8 @@ module Recurly
           end
           raise ArgumentError, message
         end
+        # We need to encode the values for the url
+        options[k] = ERB::Util.url_encode(v.to_s)
       end
       path = path.gsub("{", "%{")
       path % options
@@ -200,19 +205,19 @@ module Recurly
       options = {
         url: BASE_URL,
         request: { timeout: 60, open_timeout: 50 },
-        ssl: { verify: true }
+        ssl: { verify: true },
       }
       # Let's not use the bundled cert in production yet
       # but we will use these certs for any other staging or dev environment
-      unless BASE_URL.end_with?('.recurly.com')
-        options[:ssl][:ca_file] = File.join(File.dirname(__FILE__), '../data/ca-certificates.crt')
+      unless BASE_URL.end_with?(".recurly.com")
+        options[:ssl][:ca_file] = File.join(File.dirname(__FILE__), "../data/ca-certificates.crt")
       end
 
       @conn = Faraday.new(options) do |faraday|
         if [Logger::DEBUG, Logger::INFO].include?(@log_level)
           faraday.response :logger
         end
-        faraday.basic_auth(api_key, '')
+        faraday.basic_auth(api_key, "")
         configure_net_adapter(faraday)
       end
     end

data/lib/recurly/client/adapter.rb

@@ -1,9 +1,10 @@
-require 'openssl'
+require "openssl"
 
 module Recurly
   class Client
     module NetHttpPersistentAdapter
       protected
+
       def configure_net_adapter(faraday)
         faraday.adapter :net_http_persistent do |http|
           # yields Net::HTTP::Persistent
@@ -19,6 +20,7 @@ module Recurly
 
     module NetHttpAdapter
       protected
+
       def configure_net_adapter(faraday)
         faraday.adapter :net_http do |http|
           # yields Net::HTTP
@@ -29,7 +31,7 @@ module Recurly
     include NetHttpAdapter
 
     begin
-      require 'net/http/persistent'
+      require "net/http/persistent"
       include NetHttpPersistentAdapter
     rescue LoadError
     end

data/lib/recurly/client/operations.rb

@@ -16,6 +16,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -59,6 +60,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -386,6 +388,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -530,6 +533,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -637,6 +641,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -713,6 +718,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -766,6 +772,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -902,6 +909,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -922,6 +930,7 @@ module Recurly
     #   *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
     #
     # @param state [String] Filter by state.
+    #
     #   - When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
     #   - When +state=in_trial+, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
     #   - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
@@ -950,6 +959,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -995,6 +1005,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1020,13 +1031,13 @@ module Recurly
     # @param past_due [String] Filter for accounts with an invoice in the +past_due+ state.
     # @return [Pager<Resources::Account>] A list of an account's child accounts.
     # @example
-    #   # child_accounts = @client.list_child_accounts(
-    #   #   account_id: account_id,
-    #   #   limit: 200
-    #   # )
-    #   # child_accounts.each do |child|
-    #   #   puts "Account: #{child.code}"
-    #   # end
+    #   child_accounts = @client.list_child_accounts(
+    #     account_id: account_id,
+    #     limit: 200
+    #   )
+    #   child_accounts.each do |child|
+    #     puts "Account: #{child.code}"
+    #   end
     #
     def list_child_accounts(account_id:, **options)
       path = interpolate_path("/sites/{site_id}/accounts/{account_id}/accounts", site_id: site_id, account_id: account_id)
@@ -1041,6 +1052,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1080,6 +1092,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1187,6 +1200,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1259,6 +1273,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1279,6 +1294,12 @@ module Recurly
     #   *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
     #
     # @return [Pager<Resources::CustomFieldDefinition>] A list of the site's custom field definitions.
+    # @example
+    #   custom_fields = @client.list_custom_field_definitions(limit: 200)
+    #   custom_fields.each do |field|
+    #     puts "CustomFieldDefinition: #{field.name}"
+    #   end
+    #
     def list_custom_field_definitions(**options)
       path = interpolate_path("/sites/{site_id}/custom_field_definitions", site_id: site_id)
       pager(path, **options)
@@ -1303,6 +1324,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1457,7 +1479,7 @@ module Recurly
       put(path)
     end
 
-    # List a invoice's line items
+    # List an invoice's line items
     #
     # {https://partner-docs.recurly.com/v2018-08-09#operation/list_invoice_line_items list_invoice_line_items api documenation}
     #
@@ -1466,6 +1488,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1503,6 +1526,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1583,6 +1607,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1662,6 +1687,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1785,6 +1811,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1889,6 +1916,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1934,6 +1962,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -1954,6 +1983,7 @@ module Recurly
     #   *Note:* this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
     #
     # @param state [String] Filter by state.
+    #
     #   - When +state=active+, +state=canceled+, +state=expired+, or +state=future+, subscriptions with states that match the query and only those subscriptions will be returned.
     #   - When +state=in_trial+, only subscriptions that have a trial_started_at date earlier than now and a trial_ends_at date later than now will be returned.
     #   - When +state=live+, only subscriptions that are in an active, canceled, or future state or are in trial will be returned.
@@ -2267,6 +2297,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -2316,6 +2347,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -2362,6 +2394,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -2402,6 +2435,7 @@ module Recurly
     #   commas as separators, e.g. +ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6+.
     #
     #   *Important notes:*
+    #
     #   * The +ids+ parameter cannot be used with any other ordering or filtering
     #     parameters (+limit+, +order+, +sort+, +begin_time+, +end_time+, etc)
     #   * Invalid or unknown IDs will be ignored, so you should check that the
@@ -2488,5 +2522,81 @@ module Recurly
       path = interpolate_path("/sites/{site_id}/unique_coupon_codes/{unique_coupon_code_id}/restore", site_id: site_id, unique_coupon_code_id: unique_coupon_code_id)
       put(path)
     end
+
+    # Create a new purchase
+    #
+    # {https://partner-docs.recurly.com/v2018-08-09#operation/create_purchase create_purchase api documenation}
+    #
+    # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
+    # @return [Resources::InvoiceCollection] Returns the new invoices
+    # @example
+    #   begin
+    #     purchase = {
+    #       currency: "USD",
+    #       account: {
+    #         code: account_code,
+    #         first_name: "Benjamin",
+    #         last_name: "Du Monde",
+    #         billing_info: {
+    #           token_id: rjs_token_id
+    #         },
+    #       },
+    #       subscriptions: [
+    #         { plan_code: plan_code }
+    #       ]
+    #     }
+    #     invoice_collection = @client.create_purchase(
+    #       body: purchase
+    #     )
+    #     puts "Created Charge Invoice #{invoice_collection.charge_invoice}"
+    #     puts "Created Credit Invoices #{invoice_collection.credit_invoices}"
+    #   rescue Recurly::Errors::ValidationError => e
+    #     # If the request was invalid, you may want to tell your user
+    #     # why. You can find the invalid params and reasons in e.recurly_error.params
+    #     puts "ValidationError: #{e.recurly_error.params}"
+    #   end
+    #
+    def create_purchase(body:)
+      path = interpolate_path("/sites/{site_id}/purchases", site_id: site_id)
+      post(path, body, Requests::PurchaseCreate)
+    end
+
+    # Preview a new purchase
+    #
+    # {https://partner-docs.recurly.com/v2018-08-09#operation/preview_purchase preview_purchase api documenation}
+    #
+    # @param body [Requests::PurchaseCreate] The Hash representing the JSON request to send to the server. It should conform to the schema of {Requests::PurchaseCreate}
+    # @return [Resources::InvoiceCollection] Returns preview of the new invoices
+    # @example
+    #   begin
+    #     purchase = {
+    #       currency: "USD",
+    #       account: {
+    #         code: account_code,
+    #         first_name: "Benjamin",
+    #         last_name: "Du Monde",
+    #         billing_info: {
+    #           token_id: rjs_token_id
+    #         },
+    #       },
+    #       subscriptions: [
+    #         { plan_code: plan_code }
+    #       ]
+    #     }
+    #     invoice_collection = @client.preview_purchase(
+    #       body: purchase
+    #     )
+    #     puts "Preview Charge Invoice #{invoice_collection.charge_invoice}"
+    #     puts "Preview Credit Invoices #{invoice_collection.credit_invoices}"
+    #   rescue Recurly::Errors::ValidationError => e
+    #     # If the request was invalid, you may want to tell your user
+    #     # why. You can find the invalid params and reasons in e.recurly_error.params
+    #     puts "ValidationError: #{e.recurly_error.params}"
+    #   end
+    #
+    def preview_purchase(body:)
+      path = interpolate_path("/sites/{site_id}/purchases/preview", site_id: site_id)
+      post(path, body, Requests::PurchaseCreate)
+    end
   end
 end