Module: PaypalAPI::PartnerReferrals::APIs

Included in:

PaypalAPI::PartnerReferrals, PaypalAPI::PartnerReferrals

Defined in:

lib/paypal-api/api_collections/partner_referrals.rb

Overview

Common methods for PaypalAPI::PartnerReferrals class and client.partner_referrals instance

Instance Method Summary

• #create(query: nil, body: nil, headers: nil) ⇒ Response

  Create partner referral.

• #show(partner_referral_id, query: nil, body: nil, headers: nil) ⇒ Response

  Show referral data.

Instance Method Details

#create(query: nil, body: nil, headers: nil) ⇒ Response

Create partner referral

Parameters:

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/partner-referrals/v2/#partner-referrals_create

# File 'lib/paypal-api/api_collections/partner_referrals.rb', line 28

def create(query: nil, body: nil, headers: nil)
  client.post("/v2/customer/partner-referrals", query: query, body: body, headers: headers)
end

#show(partner_referral_id, query: nil, body: nil, headers: nil) ⇒ Response

Show referral data

Parameters:

• id (String) —

  The ID of the partner-referrals data for which to show details

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/partner-referrals/v2/#partner-referrals_read

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

def show(partner_referral_id, query: nil, body: nil, headers: nil)
  client.get("/v2/customer/partner-referrals/#{encode(partner_referral_id)}", query: query, body: body, headers: headers)
end