Module: Vindi::Rest::Discount

Included in:

Vindi::Rest

Defined in:

lib/vindi/rest/discount.rb

Overview

Methods for the discount API

See Also:

• https://vindi.github.io/api-docs/dist/#!/discounts

Instance Method Summary

• #create_discount(options = {}) ⇒ Hash

  Create a discount for a merchant vindi.

• #delete_discount(discount_id, options = {}) ⇒ Object

  Delete a discount from merchant vindi.

• #discount(discount_id, options = {}) ⇒ Hash

  Get a single discount from a merchant.

Instance Method Details

#create_discount(options = {}) ⇒ Hash

Create a discount for a merchant vindi

Examples:

Create a discount for a merchant vindi

client.create_discount(product_item_id: 118,
                       discount_type: "percentage", percentage: 10,
                       amount: 1, quantity: 1, cycles: 1)

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :options (Hash) —

  discount attributes

Returns:

• (Hash) —

  The discount created

See Also:

• https://vindi.github.io/api-docs/dist/#!/discounts/POST_version_discounts_format

# File 'lib/vindi/rest/discount.rb', line 28

def create_discount(options = {})
  post('discounts', options)[:discount]
end

#delete_discount(discount_id, options = {}) ⇒ Object

Delete a discount from merchant vindi

Examples:

Delete discount #2

client.delete_discount(2)

Parameters:

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :options (Hash) —

  discount attributes

See Also:

• https://vindi.github.io/api-docs/dist/#!/discounts/DELETE_version_discounts_id_format

# File 'lib/vindi/rest/discount.rb', line 40

def delete_discount(discount_id, options = {})
  delete("discounts/#{discount_id}", options)[:discount]
end

#discount(discount_id, options = {}) ⇒ Hash

Get a single discount from a merchant

Examples:

Get discount #2 from vindi

client.discount(2)

Parameters:

• discount_id (Integer) —

  ID of the discount

Returns:

• (Hash) —

  The discount you requested, if it exists

See Also:

• https://vindi.github.io/api-docs/dist/#!/discounts/GET_version_discounts_id_format

# File 'lib/vindi/rest/discount.rb', line 15

def discount(discount_id, options = {})
  get("discounts/#{discount_id}", options)[:discount]
end