Class: Io::Flow::V0::Models::AttributeIntent
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::AttributeIntent
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Instance Attribute Summary collapse
-
#value ⇒ Object
readonly
Returns the value of attribute value.
Class Method Summary collapse
- .ALL ⇒ Object
-
.apply(value) ⇒ Object
Returns the instance of AttributeIntent for this value, creating a new instance for an unknown value.
-
.barcode ⇒ Object
The barcode of this item.
-
.brand ⇒ Object
A brand name of the item (for retailers that sell multiple brands).
-
.color ⇒ Object
The color of the item.
-
.commercial_invoice_item_number ⇒ Object
Identifies the attribute is used as an item number in the commercial invoice.
-
.consumer_url ⇒ Object
A URL of the product detail page of the item.
-
.countries_of_origin ⇒ Object
A space separated list of the countries of origin for this item.
-
.eccn ⇒ Object
An Export Control Classification Number (ECCN) is a five-character alphanumeric key used in the Commerce Control List (CCL) to classify U.S.
-
.facet ⇒ Object
Identifies a facet.
-
.from_string(value) ⇒ Object
Returns the instance of AttributeIntent for this value, or nil if not found.
-
.fulfillment_method ⇒ Object
Identifies whether the item is a physical or digital good.
-
.gtin ⇒ Object
The Global Trade Item Number of this item.
-
.hazardous ⇒ Object
Identifies whether this item may contain hazardous materials.
-
.include_in_product_feeds ⇒ Object
Attribute to indicate whether an item should explicitly be included in a product feed.
-
.max_days_to_ship ⇒ Object
Indicates a lead time to prepare an item for shipment.
-
.min_days_to_ship ⇒ Object
Indicates a lead time to prepare an item for shipment.
-
.mpn ⇒ Object
The Manufacturer Part Number of this item.
-
.price ⇒ Object
A price for the item in the organization’s base currency (will be localized based on each Experience’s pricing policy).
-
.product_id ⇒ Object
An identifier used to group items that are variations of the same product, such as different sizes or colors of the same shirt.
-
.returnable ⇒ Object
Identifies whether the item can be returned.
-
.searchable ⇒ Object
Identifies whether the attribute can be used to search for an item.
-
.size ⇒ Object
A size label of the item.
-
.sku ⇒ Object
An SKU for the item.
-
.taxability ⇒ Object
Identifies whether taxes are applicable to an item.
Instance Method Summary collapse
-
#initialize(value) ⇒ AttributeIntent
constructor
A new instance of AttributeIntent.
- #to_hash ⇒ Object
Constructor Details
#initialize(value) ⇒ AttributeIntent
Returns a new instance of AttributeIntent.
16679 16680 16681 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16679 def initialize(value) @value = HttpClient::Preconditions.assert_class('value', value, String) end |
Instance Attribute Details
#value ⇒ Object (readonly)
Returns the value of attribute value.
16677 16678 16679 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16677 def value @value end |
Class Method Details
.ALL ⇒ Object
16699 16700 16701 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16699 def AttributeIntent.ALL @@all ||= [AttributeIntent.brand, AttributeIntent.color, AttributeIntent.countries_of_origin, AttributeIntent.product_id, AttributeIntent.fulfillment_method, AttributeIntent.hazardous, AttributeIntent.price, AttributeIntent.size, AttributeIntent.sku, AttributeIntent.taxability, AttributeIntent.consumer_url, AttributeIntent.gtin, AttributeIntent.mpn, AttributeIntent.facet, AttributeIntent.eccn, AttributeIntent.returnable, AttributeIntent.searchable, AttributeIntent., AttributeIntent.min_days_to_ship, AttributeIntent.max_days_to_ship, AttributeIntent.commercial_invoice_item_number, AttributeIntent.include_in_product_feeds] end |
.apply(value) ⇒ Object
Returns the instance of AttributeIntent for this value, creating a new instance for an unknown value
16684 16685 16686 16687 16688 16689 16690 16691 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16684 def AttributeIntent.apply(value) if value.instance_of?(AttributeIntent) value else HttpClient::Preconditions.assert_class_or_nil('value', value, String) value.nil? ? nil : (from_string(value) || AttributeIntent.new(value)) end end |
.barcode ⇒ Object
The barcode of this item.
16798 16799 16800 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16798 def AttributeIntent. @@_barcode ||= AttributeIntent.new('barcode') end |
.brand ⇒ Object
A brand name of the item (for retailers that sell multiple brands)
16704 16705 16706 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16704 def AttributeIntent.brand @@_brand ||= AttributeIntent.new('brand') end |
.color ⇒ Object
The color of the item
16709 16710 16711 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16709 def AttributeIntent.color @@_color ||= AttributeIntent.new('color') end |
.commercial_invoice_item_number ⇒ Object
Identifies the attribute is used as an item number in the commercial invoice.
16815 16816 16817 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16815 def AttributeIntent.commercial_invoice_item_number @@_commercial_invoice_item_number ||= AttributeIntent.new('commercial_invoice_item_number') end |
.consumer_url ⇒ Object
A URL of the product detail page of the item
16756 16757 16758 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16756 def AttributeIntent.consumer_url @@_consumer_url ||= AttributeIntent.new('consumer_url') end |
.countries_of_origin ⇒ Object
A space separated list of the countries of origin for this item
16714 16715 16716 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16714 def AttributeIntent.countries_of_origin @@_countries_of_origin ||= AttributeIntent.new('countries_of_origin') end |
.eccn ⇒ Object
An Export Control Classification Number (ECCN) is a five-character alphanumeric key used in the Commerce Control List (CCL) to classify U.S. exports and determine whether an export license is needed from the Department of Commerce. If exempt, then EAR99 is used as the item’s ECCN. EAR99 is a classification that indicates that an item is subject to the Export Administration Regulations (EAR), but not listed with a specific Export Control Classification Number (ECCN) on the Commerce Control List (CCL).
16782 16783 16784 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16782 def AttributeIntent.eccn @@_eccn ||= AttributeIntent.new('eccn') end |
.facet ⇒ Object
Identifies a facet.
16771 16772 16773 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16771 def AttributeIntent.facet @@_facet ||= AttributeIntent.new('facet') end |
.from_string(value) ⇒ Object
Returns the instance of AttributeIntent for this value, or nil if not found
16694 16695 16696 16697 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16694 def AttributeIntent.from_string(value) HttpClient::Preconditions.assert_class('value', value, String) AttributeIntent.ALL.find { |v| v.value == value } end |
.fulfillment_method ⇒ Object
Identifies whether the item is a physical or digital good
16725 16726 16727 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16725 def AttributeIntent.fulfillment_method @@_fulfillment_method ||= AttributeIntent.new('fulfillment_method') end |
.gtin ⇒ Object
The Global Trade Item Number of this item.
16761 16762 16763 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16761 def AttributeIntent.gtin @@_gtin ||= AttributeIntent.new('gtin') end |
.hazardous ⇒ Object
Identifies whether this item may contain hazardous materials
16730 16731 16732 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16730 def AttributeIntent.hazardous @@_hazardous ||= AttributeIntent.new('hazardous') end |
.include_in_product_feeds ⇒ Object
Attribute to indicate whether an item should explicitly be included in a product feed
16821 16822 16823 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16821 def AttributeIntent.include_in_product_feeds @@_include_in_product_feeds ||= AttributeIntent.new('include_in_product_feeds') end |
.max_days_to_ship ⇒ Object
Indicates a lead time to prepare an item for shipment. If specified, we will include this lead time in the delivery window calculation
16810 16811 16812 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16810 def AttributeIntent.max_days_to_ship @@_max_days_to_ship ||= AttributeIntent.new('max_days_to_ship') end |
.min_days_to_ship ⇒ Object
Indicates a lead time to prepare an item for shipment. If specified, we will include this lead time in the delivery window calculation
16804 16805 16806 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16804 def AttributeIntent.min_days_to_ship @@_min_days_to_ship ||= AttributeIntent.new('min_days_to_ship') end |
.mpn ⇒ Object
The Manufacturer Part Number of this item.
16766 16767 16768 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16766 def AttributeIntent.mpn @@_mpn ||= AttributeIntent.new('mpn') end |
.price ⇒ Object
A price for the item in the organization’s base currency (will be localized based on each Experience’s pricing policy)
16736 16737 16738 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16736 def AttributeIntent.price @@_price ||= AttributeIntent.new('price') end |
.product_id ⇒ Object
An identifier used to group items that are variations of the same product, such as different sizes or colors of the same shirt
16720 16721 16722 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16720 def AttributeIntent.product_id @@_product_id ||= AttributeIntent.new('product_id') end |
.returnable ⇒ Object
Identifies whether the item can be returned. If not present on an item, it is assumed to be returnable.
16788 16789 16790 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16788 def AttributeIntent.returnable @@_returnable ||= AttributeIntent.new('returnable') end |
.searchable ⇒ Object
Identifies whether the attribute can be used to search for an item.
16793 16794 16795 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16793 def AttributeIntent.searchable @@_searchable ||= AttributeIntent.new('searchable') end |
.size ⇒ Object
A size label of the item
16741 16742 16743 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16741 def AttributeIntent.size @@_size ||= AttributeIntent.new('size') end |
.sku ⇒ Object
An SKU for the item
16746 16747 16748 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16746 def AttributeIntent.sku @@_sku ||= AttributeIntent.new('sku') end |
.taxability ⇒ Object
Identifies whether taxes are applicable to an item
16751 16752 16753 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16751 def AttributeIntent.taxability @@_taxability ||= AttributeIntent.new('taxability') end |
Instance Method Details
#to_hash ⇒ Object
16825 16826 16827 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 16825 def to_hash value end |