Module: PaypalAPI::CatalogProducts::APIs

Included in:

PaypalAPI::CatalogProducts, PaypalAPI::CatalogProducts

Defined in:

lib/paypal-api/api_collections/catalog_products.rb

Overview

Common methods for PaypalAPI::CatalogProducts class and client.catalog_products instance

Instance Method Summary

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

  Create product.

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

  List products.

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

  Show product details.

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

  Update product.

Instance Method Details

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

Create product

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/catalog-products/v1/#products_create

# File 'lib/paypal-api/api_collections/catalog_products.rb', line 27

def create(query: nil, body: nil, headers: nil)
  client.post("/v1/catalogs/products", query: query, body: body, headers: headers)
end

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

List products

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/catalog-products/v1/#products_list

# File 'lib/paypal-api/api_collections/catalog_products.rb', line 38

def list(query: nil, body: nil, headers: nil)
  client.get("/v1/catalogs/products", query: query, body: body, headers: headers)
end

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

Show product details

Parameters:

• product_id (String) —

  Product ID

• 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/catalog-products/v1/#products_get

# File 'lib/paypal-api/api_collections/catalog_products.rb', line 50

def show(product_id, query: nil, body: nil, headers: nil)
  client.get("/v1/catalogs/products/#{encode(product_id)}", query: query, body: body, headers: headers)
end

#update(product_id, query: nil, body: nil, headers: nil) ⇒ Response

Update product

Parameters:

• product_id (String) —

  Product ID

• 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/catalog-products/v1/#products_patch

# File 'lib/paypal-api/api_collections/catalog_products.rb', line 62

def update(product_id, query: nil, body: nil, headers: nil)
  client.patch("/v1/catalogs/products/#{encode(product_id)}", query: query, body: body, headers: headers)
end