paypal-rest-api 0.0.3 → 0.0.4

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Manages invoice templates
+  #
+  # @see https://developer.paypal.com/docs/api/invoicing/v2/
+  #
+  class InvoiceTemplates < APICollection
+    #
+    # Common class and instance methods
+    #
+    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 invoice template
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_create
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/templates", query: query, body: body, headers: headers)
+      end
+
+      #
+      # List templates
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_list
+      #
+      # @macro request
+      #
+      def list(query: nil, body: nil, headers: nil)
+        client.get("/v2/invoicing/templates", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show template details
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_get
+      #
+      # @param template_id [String] Template ID
+      # @macro request
+      #
+      def show(template_id, query: nil, body: nil, headers: nil)
+        client.get("/v2/invoicing/templates/#{encode(template_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Fully update template
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_update
+      #
+      # @param template_id [String] Template ID
+      # @macro request
+      #
+      def update(template_id, query: nil, body: nil, headers: nil)
+        client.put("/v2/invoicing/templates/#{encode(template_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Fully update template
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#templates_delete
+      #
+      # @param template_id [String] Template ID
+      # @macro request
+      #
+      def delete(template_id, query: nil, body: nil, headers: nil)
+        client.delete("/v2/invoicing/templates/#{encode(template_id)}", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Manages invoice templates
+  #
+  # @see https://developer.paypal.com/docs/api/invoicing/v2/
+  #
+  class Invoices < APICollection
+    #
+    # Common class and instance methods
+    #
+    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 draft invoice
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_create
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/invoices", query: query, body: body, headers: headers)
+      end
+
+      #
+      # List invoices
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_list
+      #
+      # @macro request
+      #
+      def list(query: nil, body: nil, headers: nil)
+        client.get("/v2/invoicing/invoices", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show invoice details
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_get
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def show(invoice_id, query: nil, body: nil, headers: nil)
+        client.get("/v2/invoicing/invoices/#{encode(invoice_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Fully update invoice
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_update
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def update(invoice_id, query: nil, body: nil, headers: nil)
+        client.put("/v2/invoicing/invoices/#{encode(invoice_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Delete invoice
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_delete
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def delete(invoice_id, query: nil, body: nil, headers: nil)
+        client.delete("/v2/invoicing/invoices/#{encode(invoice_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Search for invoices
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_search-invoices
+      #
+      # @macro request
+      #
+      def search(query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/search-invoices", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Send invoice reminder
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_remind
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def remind(invoice_id, query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/invoices/#{encode(invoice_id)}/remind", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Delete external refund
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_refunds-delete
+      # @param invoice_id [String] Invoice ID
+      # @param transaction_id [String] The ID of the external refund transaction to delete.
+      # @macro request
+      #
+      def delete_refund(invoice_id, transaction_id, query: nil, body: nil, headers: nil)
+        client.delete(
+          "/v2/invoicing/invoices/#{encode(invoice_id)}/refunds/#{encode(transaction_id)}",
+          query: query, body: body, headers: headers
+        )
+      end
+
+      #
+      # Delete external payment
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_payment-delete
+      # @param invoice_id [String] Invoice ID
+      # @param transaction_id [String] The ID of the external payment transaction to delete.
+      # @macro request
+      #
+      def delete_payment(invoice_id, transaction_id, query: nil, body: nil, headers: nil)
+        client.delete(
+          "/v2/invoicing/invoices/#{encode(invoice_id)}/payments/#{encode(transaction_id)}",
+          query: query, body: body, headers: headers
+        )
+      end
+
+      #
+      # Record payment for invoice
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_payments
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def record_payment(invoice_id, query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/invoices/#{encode(invoice_id)}/payments", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Record refund for invoice
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_refunds
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def record_refund(invoice_id, query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/invoices/#{encode(invoice_id)}/refunds", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Send invoice
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_send
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def send_invoice(invoice_id, query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/invoices/#{encode(invoice_id)}/send", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Cancel sent invoice
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_cancel
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def cancel(invoice_id, query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/invoices/#{encode(invoice_id)}/cancel", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Generate QR code
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_generate-qr-code
+      # @param invoice_id [String] Invoice ID
+      # @macro request
+      #
+      def generate_qr_code(invoice_id, query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/invoices/#{encode(invoice_id)}/generate-qr-code", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Generate invoice number
+      #
+      # @see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_generate-next-invoice-number
+      # @macro request
+      #
+      def generate_invoice_number(query: nil, body: nil, headers: nil)
+        client.post("/v2/invoicing/generate-next-invoice-number", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -37,7 +37,7 @@ module PaypalAPI
       # @macro request
       #
       def show(id, query: nil, body: nil, headers: nil)
-        client.get("/v2/checkout/orders/#{id}", query: query, body: body, headers: headers)
+        client.get("/v2/checkout/orders/#{encode(id)}", query: query, body: body, headers: headers)
       end
 
       #
@@ -49,7 +49,7 @@ module PaypalAPI
       # @macro request
       #
       def update(id, query: nil, body: nil, headers: nil)
-        client.patch("/v2/checkout/orders/#{id}", query: query, body: body, headers: headers)
+        client.patch("/v2/checkout/orders/#{encode(id)}", query: query, body: body, headers: headers)
       end
 
       #
@@ -61,7 +61,7 @@ module PaypalAPI
       # @macro request
       #
       def confirm(id, query: nil, body: nil, headers: nil)
-        client.post("/v2/checkout/orders/#{id}/confirm-payment-source", query: query, body: body, headers: headers)
+        client.post("/v2/checkout/orders/#{encode(id)}/confirm-payment-source", query: query, body: body, headers: headers)
       end
 
       #
@@ -73,7 +73,7 @@ module PaypalAPI
       # @macro request
       #
       def authorize(id, query: nil, body: nil, headers: nil)
-        client.post("/v2/checkout/orders/#{id}/authorize", query: query, body: body, headers: headers)
+        client.post("/v2/checkout/orders/#{encode(id)}/authorize", query: query, body: body, headers: headers)
       end
 
       #
@@ -85,7 +85,7 @@ module PaypalAPI
       # @macro request
       #
       def capture(id, query: nil, body: nil, headers: nil)
-        client.post("/v2/checkout/orders/#{id}/capture", query: query, body: body, headers: headers)
+        client.post("/v2/checkout/orders/#{encode(id)}/capture", query: query, body: body, headers: headers)
       end
 
       #
@@ -97,7 +97,7 @@ module PaypalAPI
       # @macro request
       #
       def track(id, query: nil, body: nil, headers: nil)
-        client.post("/v2/checkout/orders/#{id}/track", query: query, body: body, headers: headers)
+        client.post("/v2/checkout/orders/#{encode(id)}/track", query: query, body: body, headers: headers)
       end
 
       #
@@ -110,7 +110,7 @@ module PaypalAPI
       # @macro request
       #
       def update_tracker(id, tracker_id, query: nil, body: nil, headers: nil)
-        client.patch("/v2/checkout/orders/#{id}/trackers/#{tracker_id}", query: query, body: body, headers: headers)
+        client.patch("/v2/checkout/orders/#{encode(id)}/trackers/#{encode(tracker_id)}", query: query, body: body, headers: headers)
       end
     end
 

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Makes payments to multiple PayPal or Venmo recipients
+  #
+  # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/
+  #
+  class PayoutItems < APICollection
+    #
+    # Common class and instance methods
+    #
+    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
+
+      #
+      # Cancel unclaimed payout item
+      #
+      # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts-item_cancel
+      # @param payout_item_id [String] The ID of the payout item to cancel
+      # @macro request
+      #
+      def cancel(payout_item_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/payments/payouts-item/#{encode(payout_item_id)}/cancel", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show payout item details
+      #
+      # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts-item_get
+      #
+      # @param payout_item_id [String] The ID of the payout item
+      # @macro request
+      #
+      def show(payout_item_id, query: nil, body: nil, headers: nil)
+        client.get("/v1/payments/payouts-item/#{encode(payout_item_id)}", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Makes payments to multiple PayPal or Venmo recipients
+  #
+  # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/
+  #
+  class Payouts < APICollection
+    #
+    # Common class and instance methods
+    #
+    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 batch payout
+      #
+      # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts_post
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v1/payments/payouts", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show payout batch details
+      #
+      # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts_get
+      #
+      # @param payout_batch_id [String] The ID of the payout for which to show details.
+      # @macro request
+      #
+      def show(payout_batch_id, query: nil, body: nil, headers: nil)
+        client.get("/v1/payments/payouts/#{encode(payout_batch_id)}", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Enables partner merchants and developers to process individual referenced payouts to recipients.
+  #
+  # @seehttps://developer.paypal.com/docs/api/referenced-payouts/v1/
+  #
+  class ReferencedPayoutItems < APICollection
+    #
+    # Common class and instance methods
+    #
+    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 referenced payout item
+      #
+      # @see https://developer.paypal.com/docs/api/referenced-payouts/v1/#referenced-payouts-items_create
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v1/payments/referenced-payouts-items", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show referenced payout item details
+      #
+      # @see https://developer.paypal.com/docs/api/referenced-payouts/v1/#referenced-payouts-items_get
+      #
+      # @param payouts_item_id [String] The ID of the referenced payout item for which to show details.
+      # @macro request
+      #
+      def show(payouts_item_id, query: nil, body: nil, headers: nil)
+        client.get("/v1/payments/referenced-payouts-items/#{encode(payouts_item_id)}", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # The Referenced Payouts API enables partner merchants and developers to process individual referenced payouts to recipients.
+  #
+  # @see https://developer.paypal.com/docs/api/referenced-payouts/v1/
+  #
+  class ReferencedPayouts < APICollection
+    #
+    # Common class and instance methods
+    #
+    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 referenced batch payout
+      #
+      # @see https://developer.paypal.com/docs/api/referenced-payouts/v1/#referenced-payouts_create_batch
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v1/payments/referenced-payouts", query: query, body: body, headers: headers)
+      end
+
+      #
+      # List items in referenced batch payout
+      #
+      # @see https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts_get
+      #
+      # @param payout_batch_id [String] The ID of the reference batch payout for which to list items.
+      # @macro request
+      #
+      def show(payout_batch_id, query: nil, body: nil, headers: nil)
+        client.get("/v1/payments/referenced-payouts/#{encode(payout_batch_id)}", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -20,7 +20,7 @@ module PaypalAPI
       # @macro request
       #
       def show(refund_id, query: nil, body: nil, headers: nil)
-        client.get("/v2/payments/refunds/#{refund_id}", query: query, body: body, headers: headers)
+        client.get("/v2/payments/refunds/#{encode(refund_id)}", query: query, body: body, headers: headers)
       end
     end
 

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

@@ -37,7 +37,7 @@ module PaypalAPI
       # @macro request
       #
       def update(id, query: nil, body: nil, headers: nil)
-        client.put("/v1/shipping/trackers/#{id}", query: query, body: body, headers: headers)
+        client.put("/v1/shipping/trackers/#{encode(id)}", query: query, body: body, headers: headers)
       end
 
       #
@@ -49,7 +49,7 @@ module PaypalAPI
       # @macro request
       #
       def show(id, query: nil, body: nil, headers: nil)
-        client.get("/v1/shipping/trackers/#{id}", query: query, body: body, headers: headers)
+        client.get("/v1/shipping/trackers/#{encode(id)}", query: query, body: body, headers: headers)
       end
     end
 

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Manages subscriptions for recurring PayPal payments
+  #
+  # @see https://developer.paypal.com/docs/api/subscriptions/v1/
+  #
+  class SubscriptionPlans < APICollection
+    #
+    # Common class and instance methods
+    #
+    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
+
+      #
+      # Creates a plan that defines pricing and billing cycle details for subscriptions.
+      #
+      # @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_create
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/plans", query: query, body: body, headers: headers)
+      end
+
+      #
+      # List plans
+      #
+      # @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_list
+      #
+      # @macro request
+      #
+      def list(query: nil, body: nil, headers: nil)
+        client.get("/v1/billing/plans", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show plan details
+      #
+      # @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_get
+      #
+      # @param plan_id [String] Plan ID
+      # @macro request
+      #
+      def show(plan_id, query: nil, body: nil, headers: nil)
+        client.get("/v1/billing/plans/#{encode(plan_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Update plan
+      #
+      # @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_patch
+      #
+      # @param plan_id [String] Plan ID
+      # @macro request
+      #
+      def update(plan_id, query: nil, body: nil, headers: nil)
+        client.patch("/v1/billing/plans/#{encode(plan_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Activate plan
+      #
+      # @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_activate
+      #
+      # @param plan_id [String] Plan ID
+      # @macro request
+      #
+      def activate(plan_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/plans/#{encode(plan_id)}/activate", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Deactivate plan
+      #
+      # @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_deactivate
+      #
+      # @param plan_id [String] Plan ID
+      # @macro request
+      #
+      def deactivate(plan_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/plans/#{encode(plan_id)}/deactivate", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Update pricing
+      #
+      # @see https://developer.paypal.com/docs/api/subscriptions/v1/#plans_deactivate
+      #
+      # @param plan_id [String] Plan ID
+      # @macro request
+      #
+      def update_pricing(plan_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/plans/#{encode(plan_id)}/update-pricing-schemes", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end