paypal-rest-api 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 704b8e8aec9d843c2d8e3402eda341513a73dad5359011f58d804f9a845a61e9
-  data.tar.gz: 7a5f307034b4aa8fdeb3a7ec200e6f1fd4dffb60c2f1300997bf1902c229d0b1
+  metadata.gz: 154aa3a4e9e77bf6a4d3a88a1f6061d995f7a4f0c6e97eda2c58df3892c64f60
+  data.tar.gz: bd4788d47f3173f2349888205873bb7e796296ee961b8edb17b59f3f07ecfa8d
 SHA512:
-  metadata.gz: a3cbb7002e0a5c97d9e8ded458831b4c3b3da5f9f81e9096a6739542c643c35ca7a5258afd5d8c3d44d1c781e6d0ec08b64626d477db99083dd10b4654a10de9
-  data.tar.gz: 856e8d23c124ec61e353f51f64cd09974976f2dbfa4b17023719285ccb7c83fa99ea40992b820611a029a46bf3ecaa063fdb67c199909f2d638bec174bd902c3
+  metadata.gz: 87b51280566237af1cbb7c569acc723b0f64051adccc3bbf68a18792dbbcd8442abbe6e6e984bdaea8d549d4fdc38d9525d5ea58db4c30fb7867e3726a888f4f
+  data.tar.gz: e6518c22a79a1a8afb31339c607b24732f9f4ef1fe9bdd3421c37ec22c1723cc81b49d1e9f6fbca661acdd4db2476c5f3228b278e1e68e6bddabdd725f0626b8

data/README.md

@@ -25,65 +25,82 @@ bundle add paypal-rest-api
 
 ## Usage
 
-There are two options:
-
-- Setting global client
-- Setting local client (for possibility to use multiple PayPal environments)
-
-### Setting global client
-
 ```ruby
 # in config/initializers/paypal_rest_api.rb
 PaypalAPI.client = PaypalAPI::Client.new(
   client_id: ENV['PAYPAL_CLIENT_ID'],
   client_secret: ENV['PAYPAL_CLIENT_SECRET'],
-  live: false
+  live: ENV['PAYPAL_LIVE'] == 'true'
 )
 
-# in your business logic
-PaypalAPI.live? # => false
-PaypalAPI.api_url # => "https://api-m.sandbox.paypal.com"
-PaypalAPI.web_url # => "https://sandbox.paypal.com"
+# Use this API to create order
+PaypalAPI::Orders.create(body: body, headers: {prefer: 'return=representation'})
+
+# After customer approves order, we can tell PayPal to authorize it
+PaypalAPI::Orders.authorize(order_id)
+
+# After PayPal authorizes order, we can capture it
+PaypalAPI::AuthorizedPayments.capture(authorization_id)
 
-response = PaypalAPI::Orders.show(order_id)
-response = PaypalAPI::Orders.create(body: body)
+# After payment was captured, we can refund it
+PaypalAPI::CapturedPayments.refund(capture_id, body: payload, headers: headers)
+
+# Use this APIs to register/actualize PayPal Webhooks
+PaypalAPI::Webhooks.list
+PaypalAPI::Webhooks.create(body: body)
+PaypalAPI::Webhooks.update(webhook_id, body: body)
+PaypalAPI::Webhooks.delete(webhook_id)
 ```
 
-### Setting local client
+### Per-request Configuration
 
 ```ruby
-# in your business logic
+# Anywhere in your business logic
 client = PaypalAPI::Client.new(
   client_id: ENV['PAYPAL_CLIENT_ID'],
   client_secret: ENV['PAYPAL_CLIENT_SECRET'],
-  live: false
+  live: ENV['PAYPAL_LIVE'] == 'true'
 )
 
-client.live? # => false
-client.api_url # => "https://api-m.sandbox.paypal.com"
-client.web_url # => "https://sandbox.paypal.com"
+# Show order
+client.orders.show(order_id)
 
-response = client.orders.show(order_id)
-response = client.orders.create(body: body)
+# Create order
+client.orders.create(body: body)
 ```
 
-### Client REST methods
+### Custom requests
 
-Client can call HTTP methods directly:
+If you want to request some undocumented APIs (or some forgotten API):
 
 ```ruby
+response = PaypalAPI.post(path, query: query, body: body, headers: headers)
+response = PaypalAPI.get(path, query: query, body: body, headers: headers)
+response = PaypalAPI.patch(path, query: query, body: body, headers: headers)
+response = PaypalAPI.put(path, query: query, body: body, headers: headers)
+response = PaypalAPI.delete(path, query: query, body: body, headers: headers)
+
+# Or, using per-request client:
 response = client.post(path, query: query, body: body, headers: headers)
 response = client.get(path, query: query, body: body, headers: headers)
 response = client.patch(path, query: query, body: body, headers: headers)
 response = client.put(path, query: query, body: body, headers: headers)
 response = client.delete(path, query: query, body: body, headers: headers)
+```
 
-# Or, after setting global client:
-response = PaypalAPI.post(path, query: query, body: body, headers: headers)
-response = PaypalAPI.get(path, query: query, body: body, headers: headers)
-response = PaypalAPI.patch(path, query: query, body: body, headers: headers)
-response = PaypalAPI.put(path, query: query, body: body, headers: headers)
-response = PaypalAPI.delete(path, query: query, body: body, headers: headers)
+### Environment helpers
+
+```ruby
+PaypalAPI.client = PaypalAPI::Client.new(
+  live: ENV['PAYPAL_LIVE'] == 'true',
+  client_id: ENV['PAYPAL_CLIENT_ID'],
+  client_secret: ENV['PAYPAL_CLIENT_SECRET']
+)
+
+PaypalAPI.live? # => false
+PaypalAPI.sandbox? # => true
+PaypalAPI.api_url # => "https://api-m.sandbox.paypal.com"
+PaypalAPI.web_url # => "https://sandbox.paypal.com"
 ```
 
 ### Response
@@ -128,7 +145,7 @@ response = PaypalAPI.delete(path, query: query, body: body, headers: headers)
 PaypalAPI client accepts this additional options:
 
 - `:live`
-- `:retries`,
+- `:retries`
 - `:http_opts`
 - `:cache`
 
@@ -139,7 +156,7 @@ When `live` is `false` all requests will be send to the sandbox endpoints.
 
 ```ruby
 client = PaypalAPI::Client.new(
-  live: true
+  live: ENV['PAYPAL_LIVE'] == 'true'
   # ...
 )
 ```
@@ -180,9 +197,9 @@ client = PaypalAPI::Client.new(
 
 ### Option `:cache`
 
-This option can be added to save certificates to between redeploys to validate
-webhooks offline. By default this gem has only in-memory caching.
-Cache object must response to standard caching `#fetch(key, &block)` method.
+This option can be added to save webhook-validating certificates between
+redeploys to validate webhooks offline. By default this gem has only in-memory
+caching. The `cache` object must respond to standard for caching `#fetch` method.
 
 By default it is `nil`, so downloaded certificates will be downloaded again after
 redeploys.
@@ -228,7 +245,7 @@ valid webhook.
 When some required header is missing the
 `PaypalAPI::WebhooksVerifier::MissingHeader` error will be raised.
 
-Example of Rails controller with webhook verification:
+Example of a Rails controller with a webhook verification:
 
 ```ruby
 class Webhooks::PaypalController < ApplicationController
@@ -257,15 +274,13 @@ end
 
 ## Callbacks
 
-Callbacks list:
+Paypal::API client allows to subscribe to this callbacks:
 
 - `:before` - Runs before request
 - `:after_success` - Runs after getting successful response
 - `:after_fail` - Runs after getting failed response (non-2xx) status code
 - `:after_network_error` - Runs after getting network error
 
-Callbacks are registered on `client` object.
-
 Each callback receive `request` and `context` variables.
 `context` can be modified manually to save state between callbacks.
 
@@ -276,8 +291,10 @@ Arguments:
 - `:after_fail` - (request, context, response)
 - `:after_network_error` - (request, context, error)
 
-`Context` argument contains `retries_enabled` and `retries_count` and
-`retry_number` keys by default.
+`Context` argument contains `retries_enabled`, `retries_count` and
+`retry_number` options by default.
+On `:after_fail` and `:after_network_error` there are also the
+`:will_retry` boolean option.
 
 Examples:
 
@@ -381,201 +398,216 @@ end
 
 ## APIs
 
-All API endpoints accept this parameters:
+All API endpoints accept `query:`, `body:` and `headers:` **optional** **keyword**
+**Hash** parameters. So this parameters can be omitted in next docs.
 
-- `resource_id` - Resource ID (Unless `create`/`list` endpoint)
 - `query` - Hash with request query params
 - `body` - Hash with request body params
 - `headers` - Hash with request headers
 
-### Orders
+### Add tracking / Shipment Tracking [docs](https://developer.paypal.com/docs/api/tracking/v1/)
 
-- `PaypalAPI::Orders.create`
-- `PaypalAPI::Orders.show`
-- `PaypalAPI::Orders.update`
-- `PaypalAPI::Orders.confirm`
-- `PaypalAPI::Orders.authorize`
-- `PaypalAPI::Orders.capture`
-- `PaypalAPI::Orders.track`
-- `PaypalAPI::Orders.update_tracker`
-
-### Payment Tokens
+- `PaypalAPI::ShipmentTracking.add(body: body)`
+- `PaypalAPI::ShipmentTracking.update(id, body: body)`
+- `PaypalAPI::ShipmentTracking.show(id)`
 
-- `PaypalAPI::PaymentTokens.create`
-- `PaypalAPI::PaymentTokens.list`
-- `PaypalAPI::PaymentTokens.show`
-- `PaypalAPI::PaymentTokens.delete`
+### Catalog Products [docs](https://developer.paypal.com/docs/api/catalog-products/v1/)
 
-<!-- -->
+- `PaypalAPI::CatalogProducts.create(body: body)`
+- `PaypalAPI::CatalogProducts.list`
+- `PaypalAPI::CatalogProducts.show(product_id)`
+- `PaypalAPI::CatalogProducts.update(product_id, body: body)`
 
-- `PaypalAPI::SetupTokens.create`
-- `PaypalAPI::SetupTokens.show`
+### Disputes [docs](https://developer.paypal.com/docs/api/customer-disputes/v1/)
 
-### Payments
+- `PaypalAPI::Disputes.settle(id)`
+- `PaypalAPI::Disputes.update_status(id)`
+- `PaypalAPI::Disputes.escalate(id)`
+- `PaypalAPI::Disputes.accept_offer(id)`
+- `PaypalAPI::Disputes.list`
+- `PaypalAPI::Disputes.provide_supporting_info(id)`
+- `PaypalAPI::Disputes.show(id)`
+- `PaypalAPI::Disputes.update(id)`
+- `PaypalAPI::Disputes.deny_offer(id)`
+- `PaypalAPI::Disputes.make_offer(id)`
+- `PaypalAPI::Disputes.appeal(id)`
+- `PaypalAPI::Disputes.provide_evidence(id)`
+- `PaypalAPI::Disputes.acknowledge_return_item`
+- `PaypalAPI::Disputes.send_message(id)`
+- `PaypalAPI::Disputes.accept_claim`(id)
 
-- `PaypalAPI::AuthorizedPayments.show`
-- `PaypalAPI::AuthorizedPayments.capture`
-- `PaypalAPI::AuthorizedPayments.reauthorize`
-- `PaypalAPI::AuthorizedPayments.void`
+### Identity [docs](https://developer.paypal.com/docs/api/identity/v1/)
 
-<!-- -->
+#### User Info
 
-- `PaypalAPI::CapturedPayments.show`
-- `PaypalAPI::CapturedPayments.refund`
+- `PaypalAPI::UserInfo.show`
 
-<!-- -->
+#### User Management
 
-- `PaypalAPI::Refunds.show`
+- `PaypalAPI::Users.create`
+- `PaypalAPI::Users.list`
+- `PaypalAPI::Users.update(id)`
+- `PaypalAPI::Users.show(id)`
+- `PaypalAPI::Users.delete(id)`
 
-### Webhooks
+### Invoicing (Invoices & Invoice Templates) [docs](https://developer.paypal.com/docs/api/invoicing/v2/)
 
-- `PaypalAPI::Webhooks.create`
-- `PaypalAPI::Webhooks.list`
-- `PaypalAPI::Webhooks.show`
-- `PaypalAPI::Webhooks.update`
-- `PaypalAPI::Webhooks.delete`
-- `PaypalAPI::Webhooks.event_types`
-- `PaypalAPI::Webhooks.verify`
+- `PaypalAPI::Invoices.create`
+- `PaypalAPI::Invoices.list`
+- `PaypalAPI::Invoices.send_invoice(invoice_id)`
+- `PaypalAPI::Invoices.remind(invoice_id)`
+- `PaypalAPI::Invoices.cancel(invoice_id)`
+- `PaypalAPI::Invoices.record_payment(invoice_id)`
+- `PaypalAPI::Invoices.delete_payment(invoice_id)`
+- `PaypalAPI::Invoices.record_refund(invoice_id)`
+- `PaypalAPI::Invoices.delete_refund(invoice_id)`
+- `PaypalAPI::Invoices.generate_qr_code(invoice_id)`
+- `PaypalAPI::Invoices.generate_invoice_number`
+- `PaypalAPI::Invoices.show(invoice_id)`
+- `PaypalAPI::Invoices.update(invoice_id)`
+- `PaypalAPI::Invoices.delete(invoice_id)`
+- `PaypalAPI::Invoices.search`
 
 <!-- -->
 
-- `PaypalAPI::WebhookEvents.available`
-- `PaypalAPI::WebhookEvents.list`
-- `PaypalAPI::WebhookEvents.show`
-- `PaypalAPI::WebhookEvents.resend`
-- `PaypalAPI::WebhookEvents.simulate`
+- `PaypalAPI::InvoiceTemplates.create`
+- `PaypalAPI::InvoiceTemplates.list`
+- `PaypalAPI::InvoiceTemplates.show(template_id)`
+- `PaypalAPI::InvoiceTemplates.update(template_id)`
+- `PaypalAPI::InvoiceTemplates.delete(template_id)`
 
-<!-- -->
+### Orders [docs](https://developer.paypal.com/docs/api/orders/v2/)
 
-- `PaypalAPI::WebhookLookups.create`
-- `PaypalAPI::WebhookLookups.list`
-- `PaypalAPI::WebhookLookups.show`
-- `PaypalAPI::WebhookLookups.delete`
+- `PaypalAPI::Orders.create`
+- `PaypalAPI::Orders.show(order_id)`
+- `PaypalAPI::Orders.update(order_id)`
+- `PaypalAPI::Orders.confirm(order_id)`
+- `PaypalAPI::Orders.authorize(order_id)`
+- `PaypalAPI::Orders.capture(order_id)`
+- `PaypalAPI::Orders.track(order_id)`
+- `PaypalAPI::Orders.update_tracker(order_id, tracker_id)`
 
-### Subscriptions
+### Orders V1 (Deprecated on PayPal) [docs](https://developer.paypal.com/docs/api/orders/v1/)
 
-- `PaypalAPI::Subscriptions.create`
-- `PaypalAPI::Subscriptions.show`
-- `PaypalAPI::Subscriptions.update`
-- `PaypalAPI::Subscriptions.revise`
-- `PaypalAPI::Subscriptions.suspend`
-- `PaypalAPI::Subscriptions.cancel`
-- `PaypalAPI::Subscriptions.activate`
-- `PaypalAPI::Subscriptions.capture`
-- `PaypalAPI::Subscriptions.transactions`
+- `PaypalAPI::OrdersV1.create`
+- `PaypalAPI::OrdersV1.show(order_id)`
+- `PaypalAPI::OrdersV1.cancel(order_id)`
+- `PaypalAPI::OrdersV1.pay(order_id)`
 
-<!-- -->
+### PartnerReferrals [docs](https://developer.paypal.com/docs/api/partner-referrals/v2/)
 
-- `PaypalAPI::SubscriptionPlans.create`
-- `PaypalAPI::SubscriptionPlans.list`
-- `PaypalAPI::SubscriptionPlans.show`
-- `PaypalAPI::SubscriptionPlans.update`
-- `PaypalAPI::SubscriptionPlans.activate`
-- `PaypalAPI::SubscriptionPlans.deactivate`
-- `PaypalAPI::SubscriptionPlans.update_pricing`
+- `PaypalAPI::PartnerReferrals.create`
+- `PaypalAPI::PartnerReferrals.show(partner_referral_id)`
 
-### Shipment Tracking
+### Payment Experience Web Profiles [docs](https://developer.paypal.com/docs/api/payment-experience/v1/)
 
-- `PaypalAPI::ShipmentTracking.add`
-- `PaypalAPI::ShipmentTracking.update`
-- `PaypalAPI::ShipmentTracking.show`
+- `PaypalAPI::PaymentExperienceWebProfiles.create`
+- `PaypalAPI::PaymentExperienceWebProfiles.list`
+- `PaypalAPI::PaymentExperienceWebProfiles.show`
+- `PaypalAPI::PaymentExperienceWebProfiles.replace`
+- `PaypalAPI::PaymentExperienceWebProfiles.update`
+- `PaypalAPI::PaymentExperienceWebProfiles.delete`
 
-### Catalog Products
+### Payment Method Tokens / Setup Tokens [docs](https://developer.paypal.com/docs/api/payment-tokens/v3/)
 
-- `PaypalAPI::CatalogProducts.create`
-- `PaypalAPI::CatalogProducts.list`
-- `PaypalAPI::CatalogProducts.show`
-- `PaypalAPI::CatalogProducts.update`
-
-### Disputes
-
-- `PaypalAPI::Disputes.appeal`
-- `PaypalAPI::Disputes.make_offer`
-- `PaypalAPI::Disputes.show`
-- `PaypalAPI::Disputes.update`
-- `PaypalAPI::Disputes.send_message`
-- `PaypalAPI::Disputes.provide_supporting_info`
-- `PaypalAPI::Disputes.update_status`
-- `PaypalAPI::Disputes.deny_offer`
-- `PaypalAPI::Disputes.provide_evidence`
-- `PaypalAPI::Disputes.settle`
-- `PaypalAPI::Disputes.acknowledge_return_item`
-- `PaypalAPI::Disputes.accept_claim`
-- `PaypalAPI::Disputes.list`
-- `PaypalAPI::Disputes.escalate`
-- `PaypalAPI::Disputes.accept_offer`
+- `PaypalAPI::PaymentTokens.create`
+- `PaypalAPI::PaymentTokens.list`
+- `PaypalAPI::PaymentTokens.show(id)`
+- `PaypalAPI::PaymentTokens.delete(id)`
 
-### UserInfo
+<!-- -->
 
-- `PaypalAPI::UserInfo.show`
+- `PaypalAPI::SetupTokens.create`
+- `PaypalAPI::SetupTokens.show(setup_token_id)`
 
-### Users
+### Payments (Authorized Payments, Captured Payments, Refunds) [docs](https://developer.paypal.com/docs/api/payments/v2/)
 
-- `PaypalAPI::Users.create`
-- `PaypalAPI::Users.list`
-- `PaypalAPI::Users.show`
-- `PaypalAPI::Users.update`
-- `PaypalAPI::Users.delete`
+- `PaypalAPI::AuthorizedPayments.show(authorization_id)`
+- `PaypalAPI::AuthorizedPayments.capture(authorization_id)`
+- `PaypalAPI::AuthorizedPayments.reauthorize(authorization_id)`
+- `PaypalAPI::AuthorizedPayments.void(authorization_id)`
 
-### Invoices
+<!-- -->
 
-- `PaypalAPI::Invoices.create`
-- `PaypalAPI::Invoices.list`
-- `PaypalAPI::Invoices.show`
-- `PaypalAPI::Invoices.update`
-- `PaypalAPI::Invoices.delete`
-- `PaypalAPI::Invoices.search`
-- `PaypalAPI::Invoices.remind`
-- `PaypalAPI::Invoices.delete_refund`
-- `PaypalAPI::Invoices.delete_payment`
-- `PaypalAPI::Invoices.record_refund`
-- `PaypalAPI::Invoices.record_payment`
-- `PaypalAPI::Invoices.send_invoice`
-- `PaypalAPI::Invoices.cancel`
-- `PaypalAPI::Invoices.generate_qr_code`
-- `PaypalAPI::Invoices.generate_invoice_number`
+- `PaypalAPI::CapturedPayments.show(capture_id)`
+- `PaypalAPI::CapturedPayments.refund(capture_id)`
 
-### InvoiceTemplates
+<!-- -->
 
-- `PaypalAPI::InvoiceTemplates.create`
-- `PaypalAPI::InvoiceTemplates.list`
-- `PaypalAPI::InvoiceTemplates.show`
-- `PaypalAPI::InvoiceTemplates.update`
-- `PaypalAPI::InvoiceTemplates.delete`
+- `PaypalAPI::Refunds.show(refund_id)`
 
-### Payouts
+### Payouts / Payout Items [docs](https://developer.paypal.com/docs/api/payments.payouts-batch/v1/)
 
 - `PaypalAPI::Payouts.create`
-- `PaypalAPI::Payouts.show`
-- `PaypalAPI::PayoutItems.show`
-- `PaypalAPI::PayoutItems.cancel`
+- `PaypalAPI::Payouts.show(payout_id)`
+
+<!-- -->
+
+- `PaypalAPI::PayoutItems.show(payout_item_id)`
+- `PaypalAPI::PayoutItems.cancel(payout_item_id)`
 
-### ReferencedPayouts
+### Referenced Payouts / Referenced Payout Items [docs](https://developer.paypal.com/docs/api/referenced-payouts/v1/)
 
 - `PaypalAPI::ReferencedPayouts.create`
-- `PaypalAPI::ReferencedPayouts.show`
+- `PaypalAPI::ReferencedPayouts.show(payouts_batch_id)`
+
+<!-- -->
+
 - `PaypalAPI::ReferencedPayoutItems.create`
-- `PaypalAPI::ReferencedPayoutItems.show`
+- `PaypalAPI::ReferencedPayoutItems.show(payouts_item_id)`
 
-### PartnerReferrals
+### Subscriptions / Subscription Plans [docs](https://developer.paypal.com/docs/api/subscriptions/v1/)
 
-- `PaypalAPI::PartnerReferrals.create`
-- `PaypalAPI::PartnerReferrals.show`
+- `PaypalAPI::Subscriptions.create`
+- `PaypalAPI::Subscriptions.show(id)`
+- `PaypalAPI::Subscriptions.update(id)`
+- `PaypalAPI::Subscriptions.revise(id)`
+- `PaypalAPI::Subscriptions.suspend(id)`
+- `PaypalAPI::Subscriptions.cancel(id)`
+- `PaypalAPI::Subscriptions.activate(id)`
+- `PaypalAPI::Subscriptions.capture(id)`
+- `PaypalAPI::Subscriptions.transactions(id)`
 
-### PaymentExperienceWebProfiles
+<!-- -->
 
-- `PaypalAPI::PaymentExperienceWebProfiles.create`
-- `PaypalAPI::PaymentExperienceWebProfiles.list`
-- `PaypalAPI::PaymentExperienceWebProfiles.show`
-- `PaypalAPI::PaymentExperienceWebProfiles.replace`
-- `PaypalAPI::PaymentExperienceWebProfiles.update`
-- `PaypalAPI::PaymentExperienceWebProfiles.delete`
+- `PaypalAPI::SubscriptionPlans.create`
+- `PaypalAPI::SubscriptionPlans.list`
+- `PaypalAPI::SubscriptionPlans.show(plan_id)`
+- `PaypalAPI::SubscriptionPlans.update(plan_id)`
+- `PaypalAPI::SubscriptionPlans.activate(plan_id)`
+- `PaypalAPI::SubscriptionPlans.deactivate(plan_id)`
+- `PaypalAPI::SubscriptionPlans.update_pricing(plan_id)`
 
-### TransactionSearch
+### Transaction Search [docs](https://developer.paypal.com/docs/api/transaction-search/v1/)
 
 - `PaypalAPI::TransactionSearch.list_transactions`
 - `PaypalAPI::TransactionSearch.list_all_balances`
 
+### Webhooks Management [docs](https://developer.paypal.com/docs/api/webhooks/v1/)
+
+- `PaypalAPI::Webhooks.create`
+- `PaypalAPI::Webhooks.list`
+- `PaypalAPI::Webhooks.show(webhook_id)`
+- `PaypalAPI::Webhooks.update(webhook_id)`
+- `PaypalAPI::Webhooks.delete(webhook_id)`
+- `PaypalAPI::Webhooks.event_types(webhook_id)`
+- `PaypalAPI::Webhooks.verify`
+
+<!-- -->
+
+- `PaypalAPI::WebhookEvents.available`
+- `PaypalAPI::WebhookEvents.list`
+- `PaypalAPI::WebhookEvents.show(event_id)`
+- `PaypalAPI::WebhookEvents.resend(event_id)`
+- `PaypalAPI::WebhookEvents.simulate`
+
+<!-- -->
+
+- `PaypalAPI::WebhookLookups.create`
+- `PaypalAPI::WebhookLookups.list`
+- `PaypalAPI::WebhookLookups.show(webhook_lookup_id)`
+- `PaypalAPI::WebhookLookups.delete(webhook_lookup_id)`
+
 ## Development
 
 ```bash

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/paypal-api/api_collections/orders_v1.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # DEPRECATED: Orders V1
+  #
+  # @see https://developer.paypal.com/docs/api/orders/v1/
+  #
+  class OrdersV1 < APICollection
+    #
+    # Common methods for PaypalAPI::OrdersV1 class and client.orders_v1 instance
+    #
+    module APIs
+      # @!macro [new] request
+      #   @param query [Hash, nil] Request query parameters
+      #   @param body [Hash, nil] Request body parameters
+      #   @param headers [Hash, nil] Request headers
+      #   @return [Response] Response object
+
+      #
+      # Create Order
+      # @note This method is DEPRECATED on PayPal
+      #
+      # @see https://developer.paypal.com/docs/api/orders/v1/#orders_create
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v1/checkout/orders", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show order details
+      # @note This method is DEPRECATED on PayPal
+      #
+      # @see https://developer.paypal.com/docs/api/orders/v1/#orders_get
+      #
+      # @param id [String] Order ID
+      # @macro request
+      #
+      def show(id, query: nil, body: nil, headers: nil)
+        client.get("/v1/checkout/orders/#{encode(id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Cancel order
+      # @note This method is DEPRECATED on PayPal
+      #
+      # @see https://developer.paypal.com/docs/api/orders/v1/#orders_cancel
+      #
+      # @param id [String] Order ID
+      # @macro request
+      #
+      def cancel(id, query: nil, body: nil, headers: nil)
+        client.delete("/v1/checkout/orders/#{encode(id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Pay for order
+      #
+      # @see https://developer.paypal.com/docs/api/orders/v1/#orders_pay
+      #
+      # @param id [String] Order ID
+      # @macro request
+      #
+      def pay(id, query: nil, body: nil, headers: nil)
+        client.post("/v1/checkout/orders/#{encode(id)}/pay", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

data/lib/paypal-api/client/api_methods.rb

@@ -46,6 +46,11 @@ module PaypalAPI
         Orders.new(self)
       end
 
+      # @return [OrdersV1] DEPRECATED: Orders V1 APIs collection
+      def orders_v1
+        OrdersV1.new(self)
+      end
+
       # @return [PartnerReferrals] PartnerReferrals APIs collection
       def partner_referrals
         PartnerReferrals.new(self)

data/lib/paypal-api/network_error_builder.rb

@@ -7,14 +7,13 @@ module PaypalAPI
   class NetworkErrorBuilder
     # List of possible Network errors
     ERRORS = [
-      EOFError,
+      IOError,
       Errno::ECONNABORTED,
       Errno::ECONNREFUSED,
       Errno::ECONNRESET,
       Errno::EHOSTUNREACH,
       Errno::EPIPE,
       Errno::ETIMEDOUT,
-      IOError,
       OpenSSL::SSL::SSLError,
       SocketError,
       Timeout::Error # Net::OpenTimeout, Net::ReadTimeout

data/lib/paypal-api/request_executor.rb

@@ -30,6 +30,14 @@ module PaypalAPI
 
     private
 
+    def execute_request(retry_number: 0)
+      response = start_execution(retry_number)
+    rescue => error
+      unknown_network_error?(error) ? handle_unknown_error(error) : handle_network_error(error, retry_number)
+    else
+      response.success? ? handle_success_response(response) : handle_failed_response(response, retry_number)
+    end
+
     def start_execution(retry_number)
       callbacks_context[:retry_number] = retry_number
       run_callbacks(:before)
@@ -58,14 +66,6 @@ module PaypalAPI
       will_retry ? retry_request(retry_number) : response
     end
 
-    def execute_request(retry_number: 0)
-      response = start_execution(retry_number)
-    rescue => error
-      unknown_network_error?(error) ? handle_unknown_error(error) : handle_network_error(error, retry_number)
-    else
-      response.success? ? handle_success_response(response) : handle_failed_response(response, retry_number)
-    end
-
     def execute_net_http_request
       uri = request.uri
 

data/lib/paypal-api.rb

@@ -137,6 +137,10 @@ module PaypalAPI
     #   @macro api_collection
     #   @return [Orders]
     #
+    # @!method orders_v1
+    #   @macro api_collection
+    #   @return [OrdersV1]
+    #
     # @!method partner_referrals
     #   @macro api_collection
     #   @return [PartnerReferrals]
@@ -210,6 +214,7 @@ module PaypalAPI
       invoice_templates
       invoices
       orders
+      orders_v1
       partner_referrals
       payment_experience_web_profiles
       payment_tokens
@@ -272,6 +277,7 @@ require_relative "paypal-api/api_collections/disputes"
 require_relative "paypal-api/api_collections/invoice_templates"
 require_relative "paypal-api/api_collections/invoices"
 require_relative "paypal-api/api_collections/orders"
+require_relative "paypal-api/api_collections/orders_v1"
 require_relative "paypal-api/api_collections/partner_referrals"
 require_relative "paypal-api/api_collections/payment_experience_web_profiles"
 require_relative "paypal-api/api_collections/payment_tokens"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: paypal-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrey Glushkov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies: []
 description: PayPal REST API with no dependencies.
 email:
@@ -30,6 +29,7 @@ files:
 - lib/paypal-api/api_collections/invoice_templates.rb
 - lib/paypal-api/api_collections/invoices.rb
 - lib/paypal-api/api_collections/orders.rb
+- lib/paypal-api/api_collections/orders_v1.rb
 - lib/paypal-api/api_collections/partner_referrals.rb
 - lib/paypal-api/api_collections/payment_experience_web_profiles.rb
 - lib/paypal-api/api_collections/payment_tokens.rb
@@ -72,7 +72,6 @@ metadata:
   source_code_uri: https://github.com/aglushkov/paypal-rest-api
   documentation_uri: https://www.rubydoc.info/gems/paypal-rest-api
   changelog_uri: https://github.com/aglushkov/paypal-rest-api/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,8 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: PayPal REST API
 test_files: []