paypal-rest-api 0.0.3 → 0.0.4

data/lib/paypal-api/client.rb

@@ -8,6 +8,7 @@ module PaypalAPI
     attr_reader :config
 
     # Initializes Client
+    # @api public
     #
     # @param client_id [String] PayPal client id
     # @param client_secret [String] PayPal client secret
@@ -127,16 +128,51 @@ module PaypalAPI
       CatalogProducts.new(self)
     end
 
+    # @return [Disputes] Disputes APIs collection
+    def disputes
+      Disputes.new(self)
+    end
+
+    # @return [InvoiceTemplates] InvoiceTemplates APIs collection
+    def invoice_templates
+      InvoiceTemplates.new(self)
+    end
+
+    # @return [Invoices] Invoices APIs collection
+    def invoices
+      Invoices.new(self)
+    end
+
     # @return [Orders] Orders APIs collection
     def orders
       Orders.new(self)
     end
 
+    # @return [PayoutItems] PayoutItems APIs collection
+    def payout_items
+      PayoutItems.new(self)
+    end
+
+    # @return [Payouts] Payouts APIs collection
+    def payouts
+      Payouts.new(self)
+    end
+
     # @return [Redunds] Refunds APIs collection
     def refunds
       Refunds.new(self)
     end
 
+    # @return [ReferencedPayoutItems] ReferencedPayoutItems APIs collection
+    def referenced_payout_items
+      ReferencedPayoutItems.new(self)
+    end
+
+    # @return [ReferencedPayouts] ReferencedPayouts APIs collection
+    def referenced_payouts
+      ReferencedPayouts.new(self)
+    end
+
     # @return [ShipmentTracking] Shipment Tracking APIs collection
     def shipment_tracking
       ShipmentTracking.new(self)
@@ -147,11 +183,36 @@ module PaypalAPI
       Subscriptions.new(self)
     end
 
+    # @return [SubscriptionPlans] Subscription Plans APIs collection
+    def subscription_plans
+      SubscriptionPlans.new(self)
+    end
+
+    # @return [UserInfo] User Info APIs collection
+    def user_info
+      UserInfo.new(self)
+    end
+
+    # @return [Users] Users Management APIs collection
+    def users
+      Users.new(self)
+    end
+
     # @return [Webhooks] Webhooks APIs collection
     def webhooks
       Webhooks.new(self)
     end
 
+    # @return [WebhookEvents] Webhook Events APIs collection
+    def webhook_lookups
+      WebhookLookups.new(self)
+    end
+
+    # @return [WebhookEvents] Webhook Lookups APIs collection
+    def webhook_events
+      WebhookEvents.new(self)
+    end
+
     private
 
     def execute_request(http_method, path, query: nil, body: nil, headers: nil)

data/lib/paypal-api.rb

@@ -3,25 +3,26 @@
 #
 # PaypalAPI is a main gem module.
 #
-# It can store global PaypalAPI::Client for easier access to APIs.
-#
-# @example Initializing new global client
-#   PaypalAPI.client = PaypalAPI::Client.new(
-#     client_id: ENV.fetch('PAYPAL_CLIENT_ID'),
-#     client_secret: ENV.fetch('PAYPAL_CLIENT_SECRET'),
-#     live: false
-#   )
-#
-#   # And then call any APIs without mentioning the client
-#   PaypalAPI::Webhooks.list # or PaypalAPI.webhooks.list
-#
 module PaypalAPI
   class << self
     # Sets client
+    # @api public
+    #
+    # @example Initializing new global client
+    #   PaypalAPI.client = PaypalAPI::Client.new(
+    #     client_id: ENV.fetch('PAYPAL_CLIENT_ID'),
+    #     client_secret: ENV.fetch('PAYPAL_CLIENT_SECRET'),
+    #     live: false
+    #   )
+    #
+    # @return [Client] PaypalAPI client
     attr_writer :client
 
     # @!macro [new] request
     #
+    #   @api public
+    #   @example
+    #     PaypalAPI.$0("/path1/path2", query: query, body: body, headers: headers)
     #   @param path [String] Request path
     #   @param query [Hash, nil] Request query parameters
     #   @param body [Hash, nil] Request body parameters
@@ -61,44 +62,121 @@ module PaypalAPI
       end
     end
 
+    #
+    # @!macro [new] api_collection
+    #   $0 APIs collection
+    #   @api public
+    #   @example
+    #     PaypalAPI.$0
+    #
+
     #
     # @!method authentication
+    #   @macro api_collection
     #   @return [Authentication]
     #
     # @!method authorized_payments
+    #   @macro api_collection
     #   @return [AuthorizedPayments]
     #
     # @!method captured_payments
+    #   @macro api_collection
     #   @return [CapturedPayments]
     #
     # @!method catalog_products
+    #   @macro api_collection
     #   @return [CatalogProducts]
     #
+    # @!method disputes
+    #   @macro api_collection
+    #   @return [Disputes]
+    #
+    # @!method invoice_templates
+    #   @macro api_collection
+    #   @return [InvoiceTemplates]
+    #
+    # @!method invoices
+    #   @macro api_collection
+    #   @return [Invoices]
+    #
     # @!method orders
+    #   @macro api_collection
     #   @return [Orders]
     #
+    # @!method payout_items
+    #   @macro api_collection
+    #   @return [PayoutItems]
+    #
+    # @!method payouts
+    #   @macro api_collection
+    #   @return [Payouts]
+    #
     # @!method refunds
+    #   @macro api_collection
     #   @return [Refunds]
     #
+    # @!method referenced_payout_items
+    #   @macro api_collection
+    #   @return [ReferencedPayoutItems]
+    #
+    # @!method referenced_payouts
+    #   @macro api_collection
+    #   @return [ReferencedPayouts]
+    #
     # @!method shipment_tracking
+    #   @macro api_collection
     #   @return [ShipmentTracking]
     #
     # @!method subscriptions
+    #   @macro api_collection
     #   @return [Subscriptions]
     #
+    # @!method subscription_plans
+    #   @macro api_collection
+    #   @return [SubscriptionPlans]
+    #
+    # @!method user_info
+    #   @macro api_collection
+    #   @return [UserInfo]
+    #
+    # @!method users
+    #   @macro api_collection
+    #   @return [Users]
+    #
     # @!method webhooks
+    #   @macro api_collection
     #   @return [Webhooks]
     #
+    # @!method webhook_events
+    #   @macro api_collection
+    #   @return [WebhookEvents]
+    #
+    # @!method webhook_lookups
+    #   @macro api_collection
+    #   @return [WebhookLookups]
+    #
     %i[
       authentication
       authorized_payments
       captured_payments
       catalog_products
+      disputes
+      invoice_templates
+      invoices
       orders
+      payout_items
+      payouts
       refunds
+      referenced_payout_items
+      referenced_payouts
       shipment_tracking
       subscriptions
+      subscription_plans
+      user_info
+      users
       webhooks
+      webhook_events
+      webhook_lookups
     ].each do |method_name|
       define_method(method_name) do
         client.public_send(method_name)
@@ -106,6 +184,10 @@ module PaypalAPI
     end
 
     # Globally set Client object
+    # @api public
+    # @example
+    #   PaypalAPI.client
+    # @return [Client]
     def client
       raise "#{name}.client must be set" unless @client
 
@@ -128,8 +210,20 @@ require_relative "paypal-api/api_collections/authentication"
 require_relative "paypal-api/api_collections/authorized_payments"
 require_relative "paypal-api/api_collections/captured_payments"
 require_relative "paypal-api/api_collections/catalog_products"
+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/payout_items"
+require_relative "paypal-api/api_collections/payouts"
 require_relative "paypal-api/api_collections/refunds"
+require_relative "paypal-api/api_collections/referenced_payout_items"
+require_relative "paypal-api/api_collections/referenced_payouts"
 require_relative "paypal-api/api_collections/shipment_tracking"
 require_relative "paypal-api/api_collections/subscriptions"
+require_relative "paypal-api/api_collections/subscription_plans"
+require_relative "paypal-api/api_collections/user_info"
+require_relative "paypal-api/api_collections/users"
 require_relative "paypal-api/api_collections/webhooks"
+require_relative "paypal-api/api_collections/webhook_events"
+require_relative "paypal-api/api_collections/webhook_lookups"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypal-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2024-08-25 00:00:00.000000000 Z
 dependencies: []
 description: PayPal REST API with no dependencies.
 email:
@@ -26,10 +26,22 @@ files:
 - lib/paypal-api/api_collections/authorized_payments.rb
 - lib/paypal-api/api_collections/captured_payments.rb
 - lib/paypal-api/api_collections/catalog_products.rb
+- lib/paypal-api/api_collections/disputes.rb
+- 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/payout_items.rb
+- lib/paypal-api/api_collections/payouts.rb
+- lib/paypal-api/api_collections/referenced_payout_items.rb
+- lib/paypal-api/api_collections/referenced_payouts.rb
 - lib/paypal-api/api_collections/refunds.rb
 - lib/paypal-api/api_collections/shipment_tracking.rb
+- lib/paypal-api/api_collections/subscription_plans.rb
 - lib/paypal-api/api_collections/subscriptions.rb
+- lib/paypal-api/api_collections/user_info.rb
+- lib/paypal-api/api_collections/users.rb
+- lib/paypal-api/api_collections/webhook_events.rb
+- lib/paypal-api/api_collections/webhook_lookups.rb
 - lib/paypal-api/api_collections/webhooks.rb
 - lib/paypal-api/client.rb
 - lib/paypal-api/config.rb