paypal-rest-api 0.0.3 → 0.1.0

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

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

@@ -17,88 +17,6 @@ module PaypalAPI
       #   @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_plan(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_plans(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(plan_id, query: nil, body: nil, headers: nil)
-        client.get("/v1/billing/plans/#{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(plan_id, query: nil, body: nil, headers: nil)
-        client.patch("/v1/billing/plans/#{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(plan_id, query: nil, body: nil, headers: nil)
-        client.post("/v1/billing/plans/#{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(plan_id, query: nil, body: nil, headers: nil)
-        client.post("/v1/billing/plans/#{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_plan_pricing(plan_id, query: nil, body: nil, headers: nil)
-        client.post("/v1/billing/plans/#{plan_id}/update-pricing-schemes", query: query, body: body, headers: headers)
-      end
-
       #
       # Create subscription
       #
@@ -106,7 +24,7 @@ module PaypalAPI
       #
       # @macro request
       #
-      def create_subscription(query: nil, body: nil, headers: nil)
+      def create(query: nil, body: nil, headers: nil)
         client.post("/v1/billing/subscriptions", query: query, body: body, headers: headers)
       end
 
@@ -118,8 +36,8 @@ module PaypalAPI
       # @param subscription_id [String] Subscripton ID
       # @macro request
       #
-      def show_subscription(subscription_id, query: nil, body: nil, headers: nil)
-        client.get("/v1/billing/subscriptions/#{subscription_id}", query: query, body: body, headers: headers)
+      def show(subscription_id, query: nil, body: nil, headers: nil)
+        client.get("/v1/billing/subscriptions/#{encode(subscription_id)}", query: query, body: body, headers: headers)
       end
 
       #
@@ -130,8 +48,8 @@ module PaypalAPI
       # @param subscription_id [String] Subscripton ID
       # @macro request
       #
-      def update_subscription(subscription_id, query: nil, body: nil, headers: nil)
-        client.patch("/v1/billing/subscriptions/#{subscription_id}", query: query, body: body, headers: headers)
+      def update(subscription_id, query: nil, body: nil, headers: nil)
+        client.patch("/v1/billing/subscriptions/#{encode(subscription_id)}", query: query, body: body, headers: headers)
       end
 
       #
@@ -142,8 +60,8 @@ module PaypalAPI
       # @param subscription_id [String] Subscripton ID
       # @macro request
       #
-      def revise_subscription(subscription_id, query: nil, body: nil, headers: nil)
-        client.post("/v1/billing/subscriptions/#{subscription_id}/revise", query: query, body: body, headers: headers)
+      def revise(subscription_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/revise", query: query, body: body, headers: headers)
       end
 
       #
@@ -154,8 +72,8 @@ module PaypalAPI
       # @param subscription_id [String] Subscripton ID
       # @macro request
       #
-      def suspend_subscription(subscription_id, query: nil, body: nil, headers: nil)
-        client.post("/v1/billing/subscriptions/#{subscription_id}/suspend", query: query, body: body, headers: headers)
+      def suspend(subscription_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/suspend", query: query, body: body, headers: headers)
       end
 
       #
@@ -166,8 +84,8 @@ module PaypalAPI
       # @param subscription_id [String] Subscripton ID
       # @macro request
       #
-      def cancel_subscription(subscription_id, query: nil, body: nil, headers: nil)
-        client.post("/v1/billing/subscriptions/#{subscription_id}/cancel", query: query, body: body, headers: headers)
+      def cancel(subscription_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/cancel", query: query, body: body, headers: headers)
       end
 
       #
@@ -178,8 +96,8 @@ module PaypalAPI
       # @param subscription_id [String] Subscripton ID
       # @macro request
       #
-      def activate_subscription(subscription_id, query: nil, body: nil, headers: nil)
-        client.post("/v1/billing/subscriptions/#{subscription_id}/activate", query: query, body: body, headers: headers)
+      def activate(subscription_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/activate", query: query, body: body, headers: headers)
       end
 
       #
@@ -190,8 +108,8 @@ module PaypalAPI
       # @param subscription_id [String] Subscripton ID
       # @macro request
       #
-      def capture_subscription(subscription_id, query: nil, body: nil, headers: nil)
-        client.post("/v1/billing/subscriptions/#{subscription_id}/capture", query: query, body: body, headers: headers)
+      def capture(subscription_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/billing/subscriptions/#{encode(subscription_id)}/capture", query: query, body: body, headers: headers)
       end
 
       #
@@ -203,7 +121,7 @@ module PaypalAPI
       # @macro request
       #
       def transactions(subscription_id, query: nil, body: nil, headers: nil)
-        client.get("/v1/billing/subscriptions/#{subscription_id}/transactions", query: query, body: body, headers: headers)
+        client.get("/v1/billing/subscriptions/#{encode(subscription_id)}/transactions", query: query, body: body, headers: headers)
       end
     end
 

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Shows OpenID Connect user profile information
+  #
+  # @see https://developer.paypal.com/docs/api/identity/v1/
+  #
+  class UserInfo < APICollection
+    #
+    # Common class and instance methods
+    #
+    module APIs
+      # @!macro [new] request
+
+      #
+      # Show user profile details
+      #
+      # @see https://developer.paypal.com/docs/api/identity/v1/#userinfo_get
+      #
+      # @param query [Hash, nil] Request query parameters
+      # @param body [Hash, nil] Request body parameters
+      # @param headers [Hash, nil] Request headers
+      # @return [Response] Response object
+      #
+      def show(query: nil, body: nil, headers: nil)
+        query = add_schema_param(query)
+
+        client.get("/v1/identity/openidconnect/userinfo", query: query, body: body, headers: headers)
+      end
+
+      private
+
+      def add_schema_param(query)
+        return query if query.is_a?(Hash) && (query.key?(:schema) || query.key?("schema"))
+
+        defaults = {schema: "openid"}
+        return defaults unless query
+
+        query.merge(defaults)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # Managing users APIs
+  #
+  # https://developer.paypal.com/docs/api/identity/v2/
+  #
+  class Users < 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 user
+      #
+      # @see https://developer.paypal.com/docs/api/identity/v2/#users_create
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        headers = add_scim_content_type(headers)
+        client.post("/v2/scim/Users", query: query, body: body, headers: headers)
+      end
+
+      #
+      # List users
+      #
+      # @see https://developer.paypal.com/docs/api/identity/v2/#users_list
+      #
+      # @macro request
+      #
+      def list(query: nil, body: nil, headers: nil)
+        headers = add_scim_content_type(headers)
+        client.get("/v2/scim/Users", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show user details
+      #
+      # @see https://developer.paypal.com/docs/api/identity/v2/#users_get
+      #
+      # @param user_id [String] User ID
+      # @macro request
+      #
+      def show(user_id, query: nil, body: nil, headers: nil)
+        headers = add_scim_content_type(headers)
+        client.get("/v2/scim/Users/#{encode(user_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Update user
+      #
+      # @see https://developer.paypal.com/docs/api/identity/v2/#users_update
+      #
+      # @param user_id [String] User ID
+      # @macro request
+      #
+      def update(user_id, query: nil, body: nil, headers: nil)
+        headers = add_scim_content_type(headers)
+        client.patch("/v2/scim/Users/#{encode(user_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Delete user
+      #
+      # @see https://developer.paypal.com/docs/api/identity/v2/#users_delete
+      #
+      # @param user_id [String] User ID
+      # @macro request
+      #
+      def delete(user_id, query: nil, body: nil, headers: nil)
+        headers = add_scim_content_type(headers)
+        client.delete("/v2/scim/Users/#{encode(user_id)}", query: query, body: body, headers: headers)
+      end
+
+      private
+
+      def add_scim_content_type(headers)
+        headers ||= {}
+        headers = headers.transform_keys { |key| (key.to_s.downcase == "content-type") ? "content-type" : key }
+        headers["content-type"] ||= "application/scim+json"
+        headers
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # https://developer.paypal.com/docs/api/webhooks/v1/
+  #
+  class WebhookEvents < 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
+
+      # Lists available events to which any webhook can subscribe
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-event-types_list
+      #
+      # @macro request
+      #
+      def available(query: nil, body: nil, headers: nil)
+        client.get("/v1/notifications/webhooks-event-types", query: query, body: body, headers: headers)
+      end
+
+      #
+      # List event notifications
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-events_list
+      #
+      # @macro request
+      #
+      def list(query: nil, body: nil, headers: nil)
+        client.get("/v1/notifications/webhooks-events", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show event notification details
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-events_get
+      #
+      # @param event_id [String] Event ID
+      # @macro request
+      #
+      def show(event_id, query: nil, body: nil, headers: nil)
+        client.get("/v1/notifications/webhooks-events/#{encode(event_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Resend event notification
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-events_resend
+      #
+      # @param event_id [String] Event ID
+      # @macro request
+      #
+      def resend(event_id, query: nil, body: nil, headers: nil)
+        client.post("/v1/notifications/webhooks-events/#{encode(event_id)}/resend", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Simulate webhook event
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#simulate-event_post
+      #
+      # @macro request
+      #
+      def simulate(query: nil, body: nil, headers: nil)
+        client.post("/v1/notifications/simulate-event", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module PaypalAPI
+  #
+  # https://developer.paypal.com/docs/api/webhooks/v1/
+  #
+  class WebhookLookups < 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 webhook lookup
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-lookup_post
+      #
+      # @macro request
+      #
+      def create(query: nil, body: nil, headers: nil)
+        client.post("/v1/notifications/webhooks-lookup", query: query, body: body, headers: headers)
+      end
+
+      #
+      # List webhook lookups
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-lookup_list
+      #
+      # @macro request
+      #
+      def list(query: nil, body: nil, headers: nil)
+        client.get("/v1/notifications/webhooks-lookup", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Show webhook lookup details
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-lookup_get
+      #
+      # @param webhook_lookup_id [String] Webhook lookup ID
+      # @macro request
+      #
+      def show(webhook_lookup_id, query: nil, body: nil, headers: nil)
+        client.get("/v1/notifications/webhooks-lookup/#{encode(webhook_lookup_id)}", query: query, body: body, headers: headers)
+      end
+
+      #
+      # Delete webhook lookup
+      #
+      # @see https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-lookup_delete
+      #
+      # @param webhook_lookup_id [String] Webhook lookup ID
+      # @macro request
+      #
+      def delete(webhook_lookup_id, query: nil, body: nil, headers: nil)
+        client.delete("/v1/notifications/webhooks-lookup/#{encode(webhook_lookup_id)}", query: query, body: body, headers: headers)
+      end
+    end
+
+    include APIs
+    extend APIs
+  end
+end