Module: Locations

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

Instance Method Summary collapse

Instance Method Details

#create_location(data) ⇒ Object

Create location.

Create a location with data.

Parameters

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Location",
  "location_template_id": 1
}
@data = @mints_user.create_location(data)



45
46
47
 
# File 'lib/user/ecommerce/locations.rb', line 45

def create_location(data)
    return @client.raw("post", "/ecommerce/locations", nil, data_transform(data))
end

#create_location_template(data) ⇒ Object

Create location template.

Create a location template with data.

Parameters

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Location Template",
  "slug": "new-location-template"
}
@data = @mints_user.create_location_template(data)



147
148
149
 
# File 'lib/user/ecommerce/locations.rb', line 147

def create_location_template(data)
    return @client.raw("post", "/ecommerce/location-templates", nil, data_transform(data))
end

#delete_location(id) ⇒ Object

Delete location.

Delete a location.

Parameters

id

(Integer) – Location id.

Example

@data = @mints_user.delete_location(5)



73
74
75
 
# File 'lib/user/ecommerce/locations.rb', line 73

def delete_location(id)
    return @client.raw("delete", "/ecommerce/locations/#{id}")
end

#get_location(id) ⇒ Object

Get location.

Get a location info.

Parameters

id

(Integer) – Location id.

Example

@data = @mints_user.get_location(2)



29
30
31
 
# File 'lib/user/ecommerce/locations.rb', line 29

def get_location(id)
    return @client.raw("get", "/ecommerce/locations/#{id}")
end

#get_location_template(id, options = nil) ⇒ Object

Get location template.

Get a location template info.

Parameters

id

(Integer) – Location template id.

options

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

First Example

@data = @mints_user.get_location_template(1)

Second Example

options = { "fields": "title" }
@data = @mints_user.get_location_template(1, options)



131
132
133
 
# File 'lib/user/ecommerce/locations.rb', line 131

def get_location_template(id, options = nil)
    return @client.raw("get", "/ecommerce/location-templates/#{id}", options)
end

#get_location_template_support_data(id) ⇒ Object

Get location template support data.

Get support data used in a location template.

Parameters

id

(Integer) – Location template id.

Example

@data = @mints_user.get_location_template_support_data(1)



89
90
91
 
# File 'lib/user/ecommerce/locations.rb', line 89

def get_location_template_support_data(id)
    return @client.raw("get", "/ecommerce/location-templates/#{id}/support-data")
end

#get_location_templates(options = nil) ⇒ Object

Get location templates.

Get a collection of location templates.

Parameters

options

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

First Example

@data = @mints_user.get_location_templates

Second Example

options = { "fields": "title" }
@data = @mints_user.get_location_templates(options)



114
115
116
 
# File 'lib/user/ecommerce/locations.rb', line 114

def get_location_templates(options = nil)
    return @client.raw("get", "/ecommerce/location-templates", options)
end

#get_location_templates_support_data ⇒ Object

Get location templates support data.

Get support data used in location templates.

Example

@data = @mints_user.get_location_templates_support_data



98
99
100
 
# File 'lib/user/ecommerce/locations.rb', line 98

def get_location_templates_support_data
    return @client.raw("get", "/ecommerce/location-templates/support-data")
end

#get_locations(use_post = true) ⇒ Object

Get locations.

Get a collection of locations.

Parameters

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

First Example

@data = @mints_user.get_locations

Second Example

@data = @mints_user.get_locations(false)



17
18
19
 
# File 'lib/user/ecommerce/locations.rb', line 17

def get_locations(use_post = true)
    return get_query_results("/ecommerce/locations", nil, use_post)
end

#update_location(id, data) ⇒ Object

Update location.

Update a location info.

Parameters

id

(Integer) – Location id.

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Location Modified"
}
@data = @mints_user.update_location(5, data.to_json)



61
62
63
 
# File 'lib/user/ecommerce/locations.rb', line 61

def update_location(id, data)
    return @client.raw("put", "/ecommerce/locations/#{id}", nil, data)
end

#update_location_template(id, data) ⇒ Object

Update location template.

Update a location template info.

Parameters

id

(Integer) – Location template id.

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Location Template Modified"
}
@data = @mints_user.update_location_template(3, data)



163
164
165
 
# File 'lib/user/ecommerce/locations.rb', line 163

def update_location_template(id, data)
    return @client.raw("put", "/ecommerce/location-templates/#{id}", nil, data_transform(data))
end