Class: PaypalAPI::APICollection

Inherits:

Object

• Object
• PaypalAPI::APICollection

Defined in:

lib/paypal-api/api_collection.rb

Overview

Base class for all PayPal API collections classes

Direct Known Subclasses

Authentication, AuthorizedPayments, CapturedPayments, CatalogProducts, Disputes, InvoiceTemplates, Invoices, Orders, OrdersV1, PartnerReferrals, PaymentExperienceWebProfiles, PaymentTokens, PayoutItems, Payouts, ReferencedPayoutItems, ReferencedPayouts, Refunds, SetupTokens, ShipmentTracking, SubscriptionPlans, Subscriptions, TransactionSearch, UserInfo, Users, WebhookEvents, WebhookLookups, Webhooks

Instance Attribute Summary

• #client ⇒ Object readonly

  Current client.

Class Method Summary

• .client ⇒ Object

  Global client.

• .encode(id) ⇒ String

  Encodes URI component.

Instance Method Summary

• #encode(id) ⇒ String

  Encodes URI component.

• #initialize(client) ⇒ Collection constructor

  Initializes API collection.

Constructor Details

#initialize(client) ⇒ Collection

Initializes API collection

Parameters:

• client (Client) —

  current client

# File 'lib/paypal-api/api_collection.rb', line 19

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns current client.

Returns:

• current client

# File 'lib/paypal-api/api_collection.rb', line 11

def client
  @client
end

Class Method Details

.client ⇒ Object

Returns global client.

Returns:

• global client

# File 'lib/paypal-api/api_collection.rb', line 24

def self.client
  PaypalAPI.client
end

.encode(id) ⇒ String

Encodes URI component

Parameters:

• id (String) —

  Unencoded URI component

Returns:

• (String) —

  Encoded URI component

# File 'lib/paypal-api/api_collection.rb', line 40

def self.encode(id)
  URI.encode_uri_component(id)
end

Instance Method Details

#encode(id) ⇒ String

Encodes URI component

Parameters:

• id (String) —

  Unencoded URI component

Returns:

• (String) —

  Encoded URI component

# File 'lib/paypal-api/api_collection.rb', line 31

def encode(id)
  self.class.encode(id)
end