Sha256: c1556d8431a33500f11f1f0f207ad9711cfc750f213574c3aec949b56e78e359

Contents?: true

Size: 1.71 KB

Versions: 7

Compression:

Stored size: 1.71 KB

Contents

# frozen_string_literal: true

module PaypalAPI
  #
  # Manages tracking information
  #
  # @see https://developer.paypal.com/docs/api/tracking/v1/
  #
  class ShipmentTracking < 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

      #
      # Add tracking information for multiple PayPal transactions
      #
      # @see https://developer.paypal.com/docs/api/tracking/v1/#trackers-batch_post
      #
      # @macro request
      #
      def add(query: nil, body: nil, headers: nil)
        client.post("/v1/shipping/trackers-batch", query: query, body: body, headers: headers)
      end

      #
      # Update or cancel tracking information for PayPal transaction
      #
      # @see https://developer.paypal.com/docs/api/tracking/v1/#trackers_put
      #
      # @param id [String] Tracker ID
      # @macro request
      #
      def update(id, query: nil, body: nil, headers: nil)
        client.put("/v1/shipping/trackers/#{encode(id)}", query: query, body: body, headers: headers)
      end

      #
      # Shows tracking information, by tracker ID, for a PayPal transaction.
      #
      # @see https://developer.paypal.com/docs/api/tracking/v1/#trackers_get
      #
      # @param id [String] Order ID
      # @macro request
      #
      def show(id, query: nil, body: nil, headers: nil)
        client.get("/v1/shipping/trackers/#{encode(id)}", query: query, body: body, headers: headers)
      end
    end

    include APIs
    extend APIs
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
paypal-rest-api-0.3.1 lib/paypal-api/api_collections/shipment_tracking.rb
paypal-rest-api-0.3.0 lib/paypal-api/api_collections/shipment_tracking.rb
paypal-rest-api-0.2.1 lib/paypal-api/api_collections/shipment_tracking.rb
paypal-rest-api-0.2.0 lib/paypal-api/api_collections/shipment_tracking.rb
paypal-rest-api-0.1.1 lib/paypal-api/api_collections/shipment_tracking.rb
paypal-rest-api-0.1.0 lib/paypal-api/api_collections/shipment_tracking.rb
paypal-rest-api-0.0.4 lib/paypal-api/api_collections/shipment_tracking.rb