Module: PaypalAPI::InvoiceTemplates::APIs

Included in:

PaypalAPI::InvoiceTemplates, PaypalAPI::InvoiceTemplates

Defined in:

lib/paypal-api/api_collections/invoice_templates.rb

Overview

Common methods for PaypalAPI::InvoiceTemplates class and client.invoice_templates instance

Instance Method Summary

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

  Create invoice template.

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

  Fully update template.

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

  List templates.

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

  Show template details.

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

  Fully update template.

Instance Method Details

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

Create invoice template

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/invoicing/v2/#templates_create

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

def create(query: nil, body: nil, headers: nil)
  client.post("/v2/invoicing/templates", query: query, body: body, headers: headers)
end

#delete(template_id, query: nil, body: nil, headers: nil) ⇒ Response

Fully update template

Parameters:

• template_id (String) —

  Template 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/invoicing/v2/#templates_delete

# File 'lib/paypal-api/api_collections/invoice_templates.rb', line 74

def delete(template_id, query: nil, body: nil, headers: nil)
  client.delete("/v2/invoicing/templates/#{encode(template_id)}", query: query, body: body, headers: headers)
end

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

List templates

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/invoicing/v2/#templates_list

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

def list(query: nil, body: nil, headers: nil)
  client.get("/v2/invoicing/templates", query: query, body: body, headers: headers)
end

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

Show template details

Parameters:

• template_id (String) —

  Template 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/invoicing/v2/#templates_get

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

def show(template_id, query: nil, body: nil, headers: nil)
  client.get("/v2/invoicing/templates/#{encode(template_id)}", query: query, body: body, headers: headers)
end

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

Fully update template

Parameters:

• template_id (String) —

  Template 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/invoicing/v2/#templates_update

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

def update(template_id, query: nil, body: nil, headers: nil)
  client.put("/v2/invoicing/templates/#{encode(template_id)}", query: query, body: body, headers: headers)
end