Module: ProductVersions

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

Instance Method Summary collapse

Instance Method Details

#create_product_version(data, options = nil) ⇒ Object

Create product version.

Create a product version with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Product Version',
  slug: 'new-product-version',
  product_id: 1
}
@data = @cxf_user.create_product_version(data)



59
60
61
 
# File 'lib/user/ecommerce/product_versions.rb', line 59

def create_product_version(data, options = nil)
  @client.raw('post', '/ecommerce/product-versions', options, data_transform(data))
end

#delete_product_version(id) ⇒ Object

Delete product version.

Delete a product version.

Parameters

id

(Integer) – Product version id.



87
88
89
 
# File 'lib/user/ecommerce/product_versions.rb', line 87

def delete_product_version(id)
  @client.raw('delete', "/ecommerce/product-versions/#{id}")
end

#get_product_version(slug, options = nil) ⇒ Object

Get Product version.

Get a single product version.

Parameters

slug

(String) – It’s the string identifier generated by Cxf.

options

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

First Example

@data = @cxf_user.get_product_version("product_slug")

Second Example

options = {
  fields: 'id, slug'
}
@data = @cxf_user.get_product_version("lego-set", options)



42
43
44
 
# File 'lib/user/ecommerce/product_versions.rb', line 42

def get_product_version(slug, options = nil)
  @client.raw('get', "/ecommerce/product-versions/#{slug}", options)
end

#get_product_versions(options = nil, use_post = true) ⇒ Object

Get Product versions.

Get a collection of product versions.

Parameters

options

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

use_post

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

First Example

@data = @cxf_user.get_product_versions

Second Example

options = { fields: "title" }
@data = @cxf_user.get_product_versions(options)

Third Example

options = { fields: "title" }
@data = @cxf_user.get_product_versions(options, false)



22
23
24
 
# File 'lib/user/ecommerce/product_versions.rb', line 22

def get_product_versions(options = nil, use_post = true)
  get_query_results('/ecommerce/product-versions', options, use_post)
end

#publish_product_version(id, data) ⇒ Object

Publish product version.

Publish a product version.

Parameters

id

(Integer) – Product version id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Publish'
}
@data = @cxf_user.publish_product_version(2, data)



103
104
105
 
# File 'lib/user/ecommerce/product_versions.rb', line 103

def publish_product_version(id, data)
  @client.raw('put', "/ecommerce/product-versions/#{id}/publish", nil, data_transform(data))
end

#update_product_version(id, data, options = nil) ⇒ Object

Update product version.

Update a product version info.

Parameters

id

(Integer) – Product version id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Product Version Modified',
  slug: 'new-product-version',
  product_id: 1
}
@data = @cxf_user.update_product_version(9, data)



77
78
79
 
# File 'lib/user/ecommerce/product_versions.rb', line 77

def update_product_version(id, data, options = nil)
  @client.raw('put', "/ecommerce/product-versions/#{id}", options, data_transform(data))
end