paypal-sdk-rest 1.7.5 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ceddc9047784a7073f8972215a244fd2d836ce6e01ff5a6607f47f121037ea5c
-  data.tar.gz: 161ba58a2ab0ed0d76f5d0c8eb454d9771e1f70dd1f843377abee0e16ed7dc82
+SHA1:
+  metadata.gz: 45787495ebb89e16774f4eec5eb3927a445e7f7a
+  data.tar.gz: 54d9b9db9a19ee483c1918894ca2d0ce34a3e0dc
 SHA512:
-  metadata.gz: 78c5333220b0e8f3706145337337f6012481c5ace6717f9b22e3103149ddabd712f0129aafec717e6aa2bc8673895278949ee4b764036aea839683239997e67c
-  data.tar.gz: 9bb769e8ddfe00d3313c2adf029094bd15be4a044e6e87125f146d3d552e9c962d73f0bb749a60088421ed536abfc5fcba5d4ffbe58fbd16bb3eedaa998908aa
+  metadata.gz: d82a1c5976df45733b87b2deb887db6f91d4fc390db57464c9c748b1874420051785e0c15e69083b9571e7bbf715472de8d9aeb93ed1d418df296afa80345262
+  data.tar.gz: 826180fe0c068f828a73d2cf5863631b1158c15cd5c0e9d5d875881781b6c12a54d5585aad1560a5176c8839a49b868c26b3cfefb1daa90026ccc9d32417fa96

data/Gemfile

@@ -1,15 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gemspec
-
-#gem 'paypal-sdk-core', :git => "https://github.com/paypal/sdk-core-ruby.git"
-
-gem 'rake', :require => false
-
-group :test do
-  gem 'simplecov', :require => false
-  gem 'rspec'
-  gem 'webmock'
-end
-
-gem 'releasinator', '~> 0.6'
+gem "rspec"
+gem "webmock"
+gem "braintreehttp", '0.4.4'

data/README.md

@@ -1,282 +1,72 @@
-# Deprecation Notice:
-This SDK is deprecated. You can continue to use it, but no new features or support requests will be accepted.
-For alternatives, please visit [the current SDK homepage on the PayPal Developer Portal](https://developer.paypal.com/docs/api/rest-sdks/)
+# PayPal SDK 2.0.0-beta [![Build Status](https://travis-ci.org/paypal/PayPal-ruby-SDK.svg?branch=2.0-beta)](https://travis-ci.org/paypal/PayPal-ruby-SDK)
 
-## PayPal REST API Ruby SDK [![Build Status](https://travis-ci.org/paypal/PayPal-Ruby-SDK.svg?branch=master)](https://travis-ci.org/paypal/PayPal-Ruby-SDK) [![Coverage Status](https://coveralls.io/repos/github/paypal/PayPal-Ruby-SDK/badge.svg?branch=master)](https://coveralls.io/github/paypal/PayPal-Ruby-SDK?branch=master)
+This is a preview of how PayPal SDKs will look in the next major version. We've simplified the interface to only provide HTTPRequest that can easily be called via our HttpClient.
 
-
-The PayPal REST SDK provides Ruby APIs to create, process and manage payment.
-
-## PayPal Checkout v2
-Please note that if you are integrating with PayPal Checkout, this SDK and corresponding API [v1/payments](https://developer.paypal.com/docs/api/payments/v1/) are in the process of being deprecated.
-
-We recommend that you integrate with API [v2/checkout/orders](https://developer.paypal.com/docs/api/orders/v2/) and [v2/payments](https://developer.paypal.com/docs/api/payments/v2/). Please refer to the [Checkout Ruby SDK](https://github.com/paypal/Checkout-Ruby-SDK) to continue with the integration.
-
-
-## 2.0 Release Candidate!
-We're releasing a [brand new version of our SDK!](https://github.com/paypal/PayPal-Ruby-SDK/tree/2.0-beta) 2.0 is currently at release candidate status, and represents a full refactor, with the goal of making all of our APIs extremely easy to use. 2.0 includes all of the existing APIs (except payouts), and includes the new Orders API (disputes and Marketplace coming soon). Check out the [FAQ and migration guide](https://github.com/paypal/PayPal-Ruby-SDK/tree/2.0-beta/docs), and let us know if you have any suggestions or issues!
-
-## Prerequisites
-- Ruby 2.0.0 or above
-- Bundler
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'paypal-sdk-rest'
-```
-
-And then execute:
-
-```sh
-$ bundle
-```
-
-Or install it yourself as:
-
-```sh
-$ gem install paypal-sdk-rest
-```
-
-## Configuration
-
-For Rails application:
-
-```sh
-rails g paypal:sdk:install
-```
-
-For other ruby application, create a configuration file(`config/paypal.yml`):
-
-```yaml
-development: &default
-  mode: sandbox
-  client_id: EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM
-  client_secret: EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM
-  # # with Proxy
-  # http_proxy: http://proxy-ipaddress:3129/
-  # # with CA File
-  # ssl_options:
-  #   ca_file: config/cacert.pem
-  # # Override Endpoint
-  # rest_endpoint: https://api.sandbox.paypal.com
-test:
-  <<: *default
-production:
-  mode: live
-  client_id: CLIENT_ID
-  client_secret: CLIENT_SECRET
-```
-
-
-Load Configurations from specified file:
-
-```ruby
-PayPal::SDK::Core::Config.load('spec/config/paypal.yml',  ENV['RACK_ENV'] || 'development')
-```
-
-Without configuration file:
-
-```ruby
-PayPal::SDK.configure(
-  :mode => "sandbox", # "sandbox" or "live"
-  :client_id => "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
-  :client_secret => "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM",
-  :ssl_options => { } )
-```
-
-Logger configuration:
-
-```ruby
-PayPal::SDK.logger = Logger.new(STDERR)
-
-# change log level to INFO
-PayPal::SDK.logger.level = Logger::INFO
-```
-**NOTE**: At `DEBUG` level, all requests/responses are logged except when `mode` is set to `live`. In order to disable request/response printing, set the log level to `INFO` or less verbose ones.
-
-
-### OpenIDConnect Samples
+### Creating a Payment
 
 ```ruby
 require 'paypal-sdk-rest'
 
-# Update client_id, client_secret and redirect_uri
-PayPal::SDK.configure({
-  :openid_client_id     => "client_id",
-  :openid_client_secret => "client_secret",
-  :openid_redirect_uri  => "http://google.com"
-})
-include PayPal::SDK::OpenIDConnect
-
-# Generate URL to Get Authorize code
-puts Tokeninfo.authorize_url( :scope => "openid profile" )
-
-# Create tokeninfo by using AuthorizeCode from redirect_uri
-tokeninfo = Tokeninfo.create("Replace with Authorize Code received on redirect_uri")
-puts tokeninfo.to_hash
-
-# Refresh tokeninfo object
-tokeninfo = tokeninfo.refresh
-puts tokeninfo.to_hash
-
-# Create tokeninfo by using refresh token
-tokeninfo = Tokeninfo.refresh("Replace with refresh_token")
-puts tokeninfo.to_hash
-
-# Get Userinfo
-userinfo = tokeninfo.userinfo
-puts userinfo.to_hash
-
-# Get logout url
-put tokeninfo.logout_url
-```
-
-## Create Payment
+include PayPal::V1::Payments
 
-```ruby
-require 'paypal-sdk-rest'
-include PayPal::SDK::REST
+environment = PayPal::SandboxEnvironment.new('AdV4d6nLHabWLyemrw4BKdO9LjcnioNIOgoz7vD611ObbDUL0kJQfzrdhXEBwnH8QmV-7XZjvjRWn0kg', 'EPKoPC_haZMTq5uM9WXuzoxUVdgzVqHyD5avCyVC1NCIUJeVaNNUZMnzduYIqrdw-carG9LBAizFGMyK')
+client = PayPal::PayPalHttpClient.new(environment)
 
-PayPal::SDK::REST.set_config(
-  :mode => "sandbox", # "sandbox" or "live"
-  :client_id => "EBWKjlELKMYqRNQ6sYvFo64FtaRLRR5BdHEESmha49TM",
-  :client_secret => "EO422dn3gQLgDbuwqTjzrFgFtaRLRR5BdHEESmha49TM")
-
-# Build Payment object
-@payment = Payment.new({
-  :intent =>  "sale",
-  :payer =>  {
-    :payment_method =>  "paypal" },
+payment = {
+  :intent => "sale",
+  :transactions => [
+    :amount => {
+      :currency => "USD",
+      :amount => "10"
+    }
+  ],
   :redirect_urls => {
-    :return_url => "http://localhost:3000/payment/execute",
-    :cancel_url => "http://localhost:3000/" },
-  :transactions =>  [{
-    :item_list => {
-      :items => [{
-        :name => "item",
-        :sku => "item",
-        :price => "5",
-        :currency => "USD",
-        :quantity => 1 }]},
-    :amount =>  {
-      :total =>  "5",
-      :currency =>  "USD" },
-    :description =>  "This is the payment transaction description." }]})
-
-if @payment.create
-  @payment.id     # Payment Id
-else
-  @payment.error  # Error Hash
-end
-```
-
-## Get Payment details
-
-```ruby
-# Fetch Payment
-payment = Payment.find("PAY-57363176S1057143SKE2HO3A")
+    :cancel_url => "http://example.com/cancel",
+    :return_url => "http://example.com/return"
+  },
+  :payer => {
+    :payment_method" => "paypal"
+  }
+}
 
-# Get List of Payments
-payment_history = Payment.all( :count => 10 )
-payment_history.payments
-```
 
-## Execute Payment
+request = PaymentCreateRequest.new
+request.request_body(payment);
 
-```ruby
-payment = Payment.find("PAY-57363176S1057143SKE2HO3A")
-
-if payment.execute( :payer_id => "DUFRQ8GWYMJXC" )
-  # Success Message
-  # Note that you'll need to `Payment.find` the payment again to access user info like shipping address
-else
-  payment.error # Error Hash
+begin
+  response = client.execute(request)
+  puts response.status_code
+  puts response.result
+rescue BraintreeHttp::HttpError => e
+  puts e.status_code
+  puts e.result
 end
 ```
 
-## Create Future Payment
-[Future Payments](https://developer.paypal.com/docs/integration/mobile/make-future-payment/) sample is available [here](https://github.com/paypal/rest-api-sdk-ruby/blob/master/samples/payment/create_future_payment.rb#L149)
-
-## Webhook event validation
-See [webhook event validation code sample](https://github.com/paypal/PayPal-Ruby-SDK/blob/master/samples/notifications/verify_webhook_event.rb) and [webhook event validation docs](https://developer.paypal.com/docs/integration/direct/rest-webhooks-overview/#event-signature)
-
-## OpenID Connect
-
-```ruby
-# Update client_id, client_secret and redirect_uri
-PayPal::SDK.configure({
-  :openid_client_id     => "client_id",
-  :openid_client_secret => "client_secret",
-  :openid_redirect_uri  => "http://google.com"
-})
-include PayPal::SDK::OpenIDConnect
-
-# Generate authorize URL to Get Authorize code
-puts Tokeninfo.authorize_url( :scope => "openid profile" )
+If you're migrating from v1, check out our [Migration Guide](./docs/Migrating.md) or our [Frequently Asked Questions](./docs/FAQ.md).
 
-# Create tokeninfo by using Authorize Code from redirect_uri
-tokeninfo = Tokeninfo.create("Replace with Authorize Code received on redirect_uri")
+## Building
 
-# Refresh tokeninfo object
-tokeninfo.refresh
+To try this out, update the version of `paypalrestsdk` in your `Gemfile` to `2.0.0.rc1`.
 
-# Create tokeninfo by using refresh token
-tokeninfo = Tokeninfo.refresh("Replace with refresh_token")
+Please feel free to create an issue in this repo with any feedback, questions, or concerns you have.
 
-# Get Userinfo
-userinfo = tokeninfo.userinfo
+## Running tests
 
-# Get Userinfo by using access token
-userinfo = Userinfo.get("Replace with access_token")
-
-# Get logout url
-logout_url = tokeninfo.logout_url
+To run integration tests using your client id and secret, clone this repository and run the following command:
+```sh
+$ bundle install
+$ rspec spec/integration
 ```
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/paypal/rest-api-sdk-ruby/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-
-
-## Payouts
-
-To make Payouts, you should enable this option in your account at http://developer.paypal.com.
 
-```ruby
-@payout = Payout.new(
-  {
-    :sender_batch_header => {
-      :sender_batch_id => SecureRandom.hex(8),
-      :email_subject => 'You have a Payout!',
-    },
-    :items => [
-      {
-        :recipient_type => 'EMAIL',
-        :amount => {
-          :value => '1.0',
-          :currency => 'USD'
-        },
-        :note => 'Thanks for your patronage!',
-        :receiver => 'shirt-supplier-one@mail.com',
-        :sender_item_id => "2014031400023",
-      }
-    ]
-  }
-)
+*NOTE*: This API is still in beta, is subject to change, and should not be used in production.
 
-begin
-  @payout_batch = @payout.create
-  logger.info "Created Payout with [#{@payout_batch.batch_header.payout_batch_id}]"
-rescue ResourceNotFound => err
-  logger.error @payout.error.inspect
-end
-```
+## Feedback
 
-## Direct Credit Card Support
-[Braintree Direct](https://www.braintreepayments.com/products/braintree-direct) is PayPal's preferred integration solution for accepting direct credit card payments in your mobile app or website. Braintree, a PayPal service, is the easiest way to accept credit cards, PayPal, and many other payment methods.
+If you have any suggestions/remarks/feedback related to SDK 2.0.0, feel free to create an issue.
 
 ## License
-Code released under [SDK LICENSE](LICENSE)  
+PayPal-Ruby-SDK is open source. See the [LICENSE](./LICENSE) file for more info.
 
-## Contributions 
- Pull requests and new issues are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. 
+## Contributions
+Pull requests and new issues are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

data/lib/lib.rb

@@ -0,0 +1,88 @@
+
+require_relative './paypal/core/access_token'
+require_relative './paypal/core/paypal_environment'
+require_relative './paypal/core/paypal_http_client'
+require_relative './paypal/core/token_requests'
+require_relative './paypal/core/version'
+require_relative './v1/billing_agreements/agreement_bill_balance_request'
+require_relative './v1/billing_agreements/agreement_cancel_request'
+require_relative './v1/billing_agreements/agreement_create_request'
+require_relative './v1/billing_agreements/agreement_execute_request'
+require_relative './v1/billing_agreements/agreement_get_request'
+require_relative './v1/billing_agreements/agreement_re_activate_request'
+require_relative './v1/billing_agreements/agreement_set_balance_request'
+require_relative './v1/billing_agreements/agreement_suspend_request'
+require_relative './v1/billing_agreements/agreement_transactions_request'
+require_relative './v1/billing_agreements/agreement_update_request'
+require_relative './v1/billing_plans/plan_create_request'
+require_relative './v1/billing_plans/plan_get_request'
+require_relative './v1/billing_plans/plan_list_request'
+require_relative './v1/billing_plans/plan_update_request'
+require_relative './v1/identity/userinfo_get_request'
+require_relative './v1/identity/user_consent'
+require_relative './v1/invoices/invoice_cancel_request'
+require_relative './v1/invoices/invoice_create_request'
+require_relative './v1/invoices/invoice_delete_external_payment_request'
+require_relative './v1/invoices/invoice_delete_external_refund_request'
+require_relative './v1/invoices/invoice_delete_request'
+require_relative './v1/invoices/invoice_get_request'
+require_relative './v1/invoices/invoice_list_request'
+require_relative './v1/invoices/invoice_next_invoice_number_request'
+require_relative './v1/invoices/invoice_qr_code_request'
+require_relative './v1/invoices/invoice_record_payment_request'
+require_relative './v1/invoices/invoice_record_refund_request'
+require_relative './v1/invoices/invoice_remind_request'
+require_relative './v1/invoices/invoice_search_request'
+require_relative './v1/invoices/invoice_send_request'
+require_relative './v1/invoices/invoice_update_request'
+require_relative './v1/invoices/template_create_request'
+require_relative './v1/invoices/template_delete_request'
+require_relative './v1/invoices/template_get_request'
+require_relative './v1/invoices/template_list_request'
+require_relative './v1/invoices/template_update_request'
+require_relative './v1/orders/orders_cancel_request'
+require_relative './v1/orders/orders_create_request'
+require_relative './v1/orders/orders_get_request'
+require_relative './v1/orders/orders_pay_request'
+require_relative './v1/payment_experience/web_profile_create_request'
+require_relative './v1/payment_experience/web_profile_delete_request'
+require_relative './v1/payment_experience/web_profile_get_request'
+require_relative './v1/payment_experience/web_profile_list_request'
+require_relative './v1/payment_experience/web_profile_partial_update_request'
+require_relative './v1/payment_experience/web_profile_update_request'
+require_relative './v1/payments/authorization_capture_request'
+require_relative './v1/payments/authorization_get_request'
+require_relative './v1/payments/authorization_reauthorize_request'
+require_relative './v1/payments/authorization_void_request'
+require_relative './v1/payments/capture_get_request'
+require_relative './v1/payments/capture_refund_request'
+require_relative './v1/payments/order_authorize_request'
+require_relative './v1/payments/order_capture_request'
+require_relative './v1/payments/order_get_request'
+require_relative './v1/payments/order_void_request'
+require_relative './v1/payments/payment_create_request'
+require_relative './v1/payments/payment_execute_request'
+require_relative './v1/payments/payment_get_request'
+require_relative './v1/payments/payment_list_request'
+require_relative './v1/payments/payment_update_request'
+require_relative './v1/payments/refund_get_request'
+require_relative './v1/payments/sale_get_request'
+require_relative './v1/payments/sale_refund_request'
+require_relative './v1/sync/search_get_request'
+require_relative './v1/vault/credit_card_create_request'
+require_relative './v1/vault/credit_card_delete_request'
+require_relative './v1/vault/credit_card_get_request'
+require_relative './v1/vault/credit_card_list_request'
+require_relative './v1/vault/credit_card_update_request'
+require_relative './v1/webhooks/available_event_type_list_request'
+require_relative './v1/webhooks/event_get_request'
+require_relative './v1/webhooks/event_list_request'
+require_relative './v1/webhooks/event_resend_request'
+require_relative './v1/webhooks/simulate_event_request'
+require_relative './v1/webhooks/webhook_create_request'
+require_relative './v1/webhooks/webhook_delete_request'
+require_relative './v1/webhooks/webhook_get_request'
+require_relative './v1/webhooks/webhook_list_event_subscriptions_request'
+require_relative './v1/webhooks/webhook_list_request'
+require_relative './v1/webhooks/webhook_update_request'
+require_relative './v1/webhooks/webhook_verify_signature_request'

data/lib/paypal/core/access_token.rb

@@ -0,0 +1,20 @@
+module PayPal
+  class AccessToken
+    attr_accessor :access_token, :token_type, :expires_in, :date_created
+
+    def initialize(options)
+      @access_token = options.access_token
+      @token_type = options.token_type
+      @expires_in = options.expires_in * 1000
+      @date_created = Time.now
+    end
+
+    def isExpired
+      return Time.now > @date_created + @expires_in
+    end
+
+    def authorizationString
+      return "#{@token_type} #{@access_token}"
+    end
+  end
+end

data/lib/paypal/core/paypal_environment.rb

@@ -0,0 +1,38 @@
+require "braintreehttp"
+require "base64"
+
+module PayPal
+
+  SANDBOXAPI = 'https://api.sandbox.paypal.com'
+  LIVEAPI = 'https://api.paypal.com'
+  SANDBOXWEB = 'https://sandbox.paypal.com'
+  LIVEWEB = 'https://paypal.com'
+
+  class PayPalEnvironment < BraintreeHttp::Environment
+    attr_accessor :client_id, :client_secret, :web_url
+
+    def initialize(client_id, client_secret, base_url, web_url)
+      super(base_url)
+      @client_id = client_id
+      @client_secret = client_secret
+      @web_url = web_url
+    end
+
+    def authorizationString
+      encoded = Base64.strict_encode64("#{@client_id}:#{@client_secret}")
+      return "Basic #{encoded}"
+    end
+  end
+
+  class SandboxEnvironment < PayPal::PayPalEnvironment
+    def initialize(client_id, client_secret)
+      super(client_id, client_secret, PayPal::SANDBOXAPI, PayPal::SANDBOXWEB)
+    end
+  end
+
+  class LiveEnvironment < PayPal::PayPalEnvironment
+    def initialize(client_id, client_secret)
+      super(client_id, client_secret, PayPal::LIVEAPI, PayPal::LIVEWEB)
+    end
+  end
+end

data/lib/paypal/core/paypal_http_client.rb

@@ -0,0 +1,51 @@
+require "braintreehttp"
+require_relative './version'
+
+module PayPal
+  class PayPalHttpClient < BraintreeHttp::HttpClient
+    attr_accessor :refresh_token
+
+    def initialize(environment, refresh_token = nil)
+      super(environment)
+      @refresh_token = refresh_token
+
+      add_injector(&method(:_sign_request))
+      add_injector(&method(:_add_headers))
+    end
+
+    def user_agent
+      library_details ||= "paypal-sdk-core #{VERSION}; ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}-#{RUBY_PLATFORM}"
+      begin
+        library_details << ";#{OpenSSL::OPENSSL_LIBRARY_VERSION}"
+      rescue NameError
+        library_details << ";OpenSSL #{OpenSSL::OPENSSL_VERSION}"
+      end
+
+      "PayPalSDK/rest-sdk-ruby #{VERSION} (#{library_details})"
+    end
+
+    def _sign_request(request)
+      if (!_has_auth_header(request) && !_is_auth_request(request))
+        if (!@access_token || @access_token.isExpired)
+          accessTokenRequest = PayPal::AccessTokenRequest.new(@environment, @refresh_token)
+          tokenResponse = execute(accessTokenRequest)
+          @access_token = PayPal::AccessToken.new(tokenResponse.result)
+        end
+        request.headers["Authorization"] = @access_token.authorizationString()
+      end
+    end
+
+    def _add_headers(request)
+      request.headers["Accept-Encoding"] = "gzip"
+    end
+
+    def _is_auth_request(request)
+      request.path == '/v1/oauth2/token' ||
+        request.path == '/v1/identity/openidconnect/tokenservice'
+    end
+
+    def _has_auth_header(request)
+      request.headers.key?("Authorization")
+    end
+  end
+end

data/lib/paypal/core/token_requests.rb

@@ -0,0 +1,40 @@
+module PayPal
+  class AccessTokenRequest
+    attr_accessor :path, :body, :headers, :verb
+
+    def initialize(environment, refreshToken = nil)
+      @path = "/v1/oauth2/token"
+      @body = {
+        :grant_type => "client_credentials",
+      }
+
+      if (refreshToken)
+        @body[:grant_type] = "refresh_token"
+        @body[:refresh_token] = refreshToken
+      end
+
+      @headers = {
+        "Content-Type" => "application/x-www-form-urlencoded",
+        "Authorization" => environment.authorizationString(),
+      }
+      @verb = "POST"
+    end
+  end
+
+  class RefreshTokenRequest
+    attr_accessor :path, :body, :headers, :verb
+
+    def initialize(environment, authorization_code)
+      @path = "/v1/identity/openidconnect/tokenservice"
+      @body = {
+        :grant_type => "authorization_code",
+        :code => authorization_code,
+      }
+      @headers = {
+        "Content-Type" => "application/x-www-form-urlencoded",
+        "Authorization" => environment.authorizationString(),
+      }
+      @verb = "POST"
+    end
+  end
+end

data/lib/paypal/core/version.rb

@@ -0,0 +1,3 @@
+module PayPal
+  VERSION = "2.0.0.rc1"
+end

data/lib/v1/billing_agreements/agreement_bill_balance_request.rb

@@ -0,0 +1,35 @@
+# This class was generated on Thu, 01 Feb 2018 12:44:43 PST by version 0.1.0-dev+3a517e of Braintree SDK Generator
+# agreement_bill_balance_request.rb
+# @version 0.1.0-dev+3a517e
+# @type request
+# @data H4sIAAAAAAAC/6RUTW/TQBC98ytGc97WBXHyLTSgBkQTSMQFVdXYO4kXbXbd3TFgRfnvaG03H45UhDhFeX4z896bsXd4T1vGHGkTmLfs5Low1l4VZMmVjAqnHMtgajHeYY7vjLURpGIYGLD2AcjBoV5B0cJseg0z1/E+Luf3EPip4ShQeN0qMK60jeZU5rvGZMF5YZCKBHQ3sOB+TGCK3nVTuqnGWuM2QGWqA3K6gw/Tgba+ST9OQ9mEwK5sr1Hhl4ZDu6BAWxYOEfPvDwrvmDSHMfrBh+0YW5BUZ9gOV22dcosSjNugwm8UDBWWx3k+Go0KP3E7PLiIdFUxzKbg1yMnyfKvypQViO98n8aePE1CoLaXcaPwK5OeO9tiviYbOQFPjQmsMZfQsMJF8DUHMRwxd421+4eew1H6JgdPk4OGpZAwPOv14SWfMXEf9Sn36PpF2nkeE9DH/8+x9LsU6KovsvqnNAbgNI6/rzOd55mhAbhc5ehgj/vspZcVuQ3/r+B+f/vEirV3kfs+CVZ4652wG5aKVNfWlJQUZj+id6jwTqT+zFJ5jTku5ssV9heOOWY/X2c1tUlwzIaX7ergIWa707veZ6NvxfvfNZfCOp1NE2+9Zszf3Lzdv/oDAAD//w==
+# DO NOT EDIT
+require 'cgi'
+
+module PayPal
+  module V1
+    module BillingAgreements
+
+      #
+      # Bills the balance for an agreement, by ID. In the JSON request body, include an optional note that describes the reason for the billing action and the agreement amount and currency.
+      #
+      class AgreementBillBalanceRequest
+        attr_accessor :path, :body, :headers, :verb
+
+        def initialize(agreement_id)
+          @headers = {}
+          @body = nil
+          @verb = "POST"
+          @path = "/v1/payments/billing-agreements/{agreement_id}/bill-balance?"
+
+          @path = @path.gsub("{agreement_id}", CGI::escape(agreement_id.to_s))
+          @headers["Content-Type"] = "application/json"
+        end
+
+        def request_body(agreementStateDescriptor)
+          @body = agreementStateDescriptor
+        end
+      end
+    end
+  end
+end