Module: Taxes

Included in:
Ecommerce
Defined in:
lib/user/ecommerce/taxes.rb

Instance Method Summary collapse

Instance Method Details

#create_tax(data) ⇒ Object

Create tax.

Create a tax with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Tax',
  tax_percentage: 100
}
@data = @mints_user.create_tax(data)


53
54
55
# File 'lib/user/ecommerce/taxes.rb', line 53

def create_tax(data)
  @client.raw('post', '/ecommerce/taxes', nil, data_transform(data))
end

#delete_tax(id) ⇒ Object

Delete tax.

Delete a tax.

Parameters

id

(Integer) – Tax id.

Example

@data = @mints_user.delete_tax(11)


81
82
83
# File 'lib/user/ecommerce/taxes.rb', line 81

def delete_tax(id)
  @client.raw('delete', "/ecommerce/taxes/#{id}")
end

#get_tax(id, options = nil) ⇒ Object

Get tax.

Get a tax info.

Parameters

id

(Integer) – Tax id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_tax(1)

Second Example

options = { fields: 'title' }
@data = @mints_user.get_tax(1, options)


37
38
39
# File 'lib/user/ecommerce/taxes.rb', line 37

def get_tax(id, options = nil)
  @client.raw('get', "/ecommerce/taxes/#{id}", options)
end

#get_taxes(options = nil) ⇒ Object

Get taxes.

Get a collection of taxes.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_taxes

Second Example

options = { fields: 'title' }
@data = @mints_user.get_taxes(options)


20
21
22
# File 'lib/user/ecommerce/taxes.rb', line 20

def get_taxes(options = nil)
  @client.raw('get', '/ecommerce/taxes', options)
end

#update_tax(id, data) ⇒ Object

Update tax.

Update a tax info.

Parameters

id

(Integer) – Tax id.

data

(Hash) – Data to be submitted.

Example

data = {
  tax_percentage: 10
}
@data = @mints_user.update_tax(11, data)


69
70
71
# File 'lib/user/ecommerce/taxes.rb', line 69

def update_tax(id, data)
  @client.raw('put', "/ecommerce/taxes/#{id}", nil, data_transform(data))
end