ebayapi 0.9.4 → 0.10.0

data/lib/ebay/types/context_search_asset.rb

@@ -2,6 +2,10 @@ require 'ebay/types/category'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :keyword, 'Keyword', :optional => true
+    #  object_node :category, 'Category', :class => Category, :optional => true
+    #  numeric_node :ranking, 'Ranking', :optional => true
     class ContextSearchAsset
       include XML::Mapping
       include Initializer

data/lib/ebay/types/country_details.rb

@@ -1,6 +1,9 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :country, 'Country', :optional => true
+    #  text_node :description, 'Description', :optional => true
     class CountryDetails
       include XML::Mapping
       include Initializer

data/lib/ebay/types/cross_promotion_preferences.rb

@@ -1,6 +1,14 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  boolean_node :cross_promotion_enabled, 'CrossPromotionEnabled', 'true', 'false', :optional => true
+    #  text_node :cross_sell_item_format_sort_filter, 'CrossSellItemFormatSortFilter', :optional => true
+    #  text_node :cross_sell_gallery_sort_filter, 'CrossSellGallerySortFilter', :optional => true
+    #  text_node :cross_sell_item_sort_filter, 'CrossSellItemSortFilter', :optional => true
+    #  text_node :up_sell_item_format_sort_filter, 'UpSellItemFormatSortFilter', :optional => true
+    #  text_node :up_sell_gallery_sort_filter, 'UpSellGallerySortFilter', :optional => true
+    #  text_node :up_sell_item_sort_filter, 'UpSellItemSortFilter', :optional => true
     class CrossPromotionPreferences
       include XML::Mapping
       include Initializer

data/lib/ebay/types/cross_promotions.rb

@@ -2,6 +2,14 @@ require 'ebay/types/promoted_item'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :item_id, 'ItemID', :optional => true
+    #  text_node :primary_scheme, 'PrimaryScheme', :optional => true
+    #  text_node :promotion_method, 'PromotionMethod', :optional => true
+    #  text_node :seller_id, 'SellerID', :optional => true
+    #  boolean_node :shipping_discount, 'ShippingDiscount', 'true', 'false'
+    #  text_node :store_name, 'StoreName', :optional => true
+    #  array_node :promoted_items, 'PromotedItem', :class => PromotedItem, :default_value => []
     class CrossPromotions
       include XML::Mapping
       include Initializer
@@ -11,7 +19,6 @@ module Ebay # :nodoc:
       text_node :promotion_method, 'PromotionMethod', :optional => true
       text_node :seller_id, 'SellerID', :optional => true
       boolean_node :shipping_discount, 'ShippingDiscount', 'true', 'false'
-      text_node :seller_key, 'SellerKey', :optional => true
       text_node :store_name, 'StoreName', :optional => true
       array_node :promoted_items, 'PromotedItem', :class => PromotedItem, :default_value => []
     end

data/lib/ebay/types/currency_details.rb

@@ -1,6 +1,9 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :currency, 'Currency', :optional => true
+    #  text_node :description, 'Description', :optional => true
     class CurrencyDetails
       include XML::Mapping
       include Initializer

data/lib/ebay/types/custom_security_header.rb

@@ -2,6 +2,11 @@ require 'ebay/types/user_id_password'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :ebay_auth_token, 'eBayAuthToken', :optional => true
+    #  text_node :hard_expiration_warning, 'HardExpirationWarning', :optional => true
+    #  object_node :credentials, 'Credentials', :class => UserIdPassword, :optional => true
+    #  text_node :notification_signature, 'NotificationSignature', :optional => true
     class CustomSecurityHeader
       include XML::Mapping
       include Initializer

data/lib/ebay/types/data_element_set.rb

@@ -1,6 +1,10 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :data_element, 'DataElement', :optional => true
+    #  numeric_node :data_element_id, 'DataElementID', :optional => true
+    #  numeric_node :attribute_set_id, '@attributeSetID', :optional => true
     class DataElementSet
       include XML::Mapping
       include Initializer

data/lib/ebay/types/days_code.rb

@@ -0,0 +1,13 @@
+module Ebay # :nodoc:
+  module Types # :nodoc:
+    class DaysCode
+      extend Enumerable
+      extend Enumeration
+      None = 'None'
+      EveryDay = 'EveryDay'
+      Weekdays = 'Weekdays'
+      Weekends = 'Weekends'
+    end
+  end
+end
+

data/lib/ebay/types/description_template.rb

@@ -1,6 +1,17 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  numeric_node :group_id, 'GroupID', :optional => true
+    #  numeric_node :id, 'ID', :optional => true
+    #  text_node :image_url, 'ImageURL', :optional => true
+    #  text_node :name, 'Name', :optional => true
+    #  text_node :template_xml, 'TemplateXML', :optional => true
+    #  text_node :type, 'Type', :optional => true
+def type
+  @type
+end
+
     class DescriptionTemplate
       include XML::Mapping
       include Initializer

data/lib/ebay/types/detail_name_code.rb

@@ -12,6 +12,7 @@ module Ebay # :nodoc:
       SiteDetails = 'SiteDetails'
       TaxJurisdiction = 'TaxJurisdiction'
       URLDetails = 'URLDetails'
+      TimeZoneDetails = 'TimeZoneDetails'
       DispatchTimeMaxDetails = 'DispatchTimeMaxDetails'
     end
   end

data/lib/ebay/types/digital_delivery_details.rb

@@ -1,6 +1,11 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :requirements, 'Requirements', :optional => true
+    #  text_node :method, 'Method', :optional => true
+    #  text_node :url, 'URL', :optional => true
+    #  text_node :instructions, 'Instructions', :optional => true
     class DigitalDeliveryDetails
       include XML::Mapping
       include Initializer

data/lib/ebay/types/digital_delivery_enabled_definition.rb

@@ -1,6 +1,7 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
     class DigitalDeliveryEnabledDefinition
       include XML::Mapping
       include Initializer

data/lib/ebay/types/{modify_code.rb → discount_code.rb}

@@ -1,10 +1,10 @@
 module Ebay # :nodoc:
   module Types # :nodoc:
-    class ModifyCode
+    class DiscountCode
       extend Enumerable
       extend Enumeration
-      Dropped = 'Dropped'
-      Modify = 'Modify'
+      Percentage = 'Percentage'
+      Price = 'Price'
     end
   end
 end

data/lib/ebay/types/discount_name_code.rb

@@ -0,0 +1,18 @@
+module Ebay # :nodoc:
+  module Types # :nodoc:
+    class DiscountNameCode
+      extend Enumerable
+      extend Enumeration
+      EachAdditionalAmount = 'EachAdditionalAmount'
+      EachAdditionalAmountOff = 'EachAdditionalAmountOff'
+      EachAdditionalPercentOff = 'EachAdditionalPercentOff'
+      IndividualItemWeight = 'IndividualItemWeight'
+      CombinedItemWeight = 'CombinedItemWeight'
+      WeightOff = 'WeightOff'
+      ShippingCostXForAmountY = 'ShippingCostXForAmountY'
+      ShippingCostXForItemCountN = 'ShippingCostXForItemCountN'
+      MaximumShippingCostPerOrder = 'MaximumShippingCostPerOrder'
+    end
+  end
+end
+

data/lib/ebay/types/discount_profile.rb

@@ -0,0 +1,28 @@
+require 'ebay/types/measure'
+
+module Ebay # :nodoc:
+  module Types # :nodoc:
+    # == Attributes
+    #  text_node :discount_profile_id, 'DiscountProfileID', :optional => true
+    #  text_node :discount_profile_name, 'DiscountProfileName', :optional => true
+    #  money_node :each_additional_amount, 'EachAdditionalAmount', :optional => true
+    #  money_node :each_additional_amount_off, 'EachAdditionalAmountOff', :optional => true
+    #  numeric_node :each_additional_percent_off, 'EachAdditionalPercentOff', :optional => true
+    #  object_node :weight_off, 'WeightOff', :class => Measure, :optional => true
+    #  text_node :mapped_discount_profile_id, 'MappedDiscountProfileID', :optional => true
+    class DiscountProfile
+      include XML::Mapping
+      include Initializer
+      root_element_name 'DiscountProfile'
+      text_node :discount_profile_id, 'DiscountProfileID', :optional => true
+      text_node :discount_profile_name, 'DiscountProfileName', :optional => true
+      money_node :each_additional_amount, 'EachAdditionalAmount', :optional => true
+      money_node :each_additional_amount_off, 'EachAdditionalAmountOff', :optional => true
+      numeric_node :each_additional_percent_off, 'EachAdditionalPercentOff', :optional => true
+      object_node :weight_off, 'WeightOff', :class => Measure, :optional => true
+      text_node :mapped_discount_profile_id, 'MappedDiscountProfileID', :optional => true
+    end
+  end
+end
+
+

data/lib/ebay/types/dispatch_time_max_details.rb

@@ -1,6 +1,9 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  numeric_node :dispatch_time_max, 'DispatchTimeMax', :optional => true
+    #  text_node :description, 'Description', :optional => true
     class DispatchTimeMaxDetails
       include XML::Mapping
       include Initializer

data/lib/ebay/types/dispute.rb

@@ -4,6 +4,27 @@ require 'ebay/types/dispute_message'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :dispute_id, 'DisputeID', :optional => true
+    #  text_node :dispute_record_type, 'DisputeRecordType', :optional => true
+    #  text_node :dispute_state, 'DisputeState', :optional => true
+    #  text_node :dispute_status, 'DisputeStatus', :optional => true
+    #  text_node :other_party_role, 'OtherPartyRole', :optional => true
+    #  text_node :other_party_name, 'OtherPartyName', :optional => true
+    #  text_node :user_role, 'UserRole', :optional => true
+    #  text_node :buyer_user_id, 'BuyerUserID', :optional => true
+    #  text_node :seller_user_id, 'SellerUserID', :optional => true
+    #  text_node :transaction_id, 'TransactionID', :optional => true
+    #  object_node :item, 'Item', :class => Item, :optional => true
+    #  text_node :dispute_reason, 'DisputeReason', :optional => true
+    #  text_node :dispute_explanation, 'DisputeExplanation', :optional => true
+    #  text_node :dispute_credit_eligibility, 'DisputeCreditEligibility', :optional => true
+    #  time_node :dispute_created_time, 'DisputeCreatedTime', :optional => true
+    #  time_node :dispute_modified_time, 'DisputeModifiedTime', :optional => true
+    #  array_node :dispute_resolutions, 'DisputeResolution', :class => DisputeResolution, :default_value => []
+    #  array_node :dispute_messages, 'DisputeMessage', :class => DisputeMessage, :default_value => []
+    #  boolean_node :escalation, 'Escalation', 'true', 'false', :optional => true
+    #  boolean_node :purchase_protection, 'PurchaseProtection', 'true', 'false', :optional => true
     class Dispute
       include XML::Mapping
       include Initializer

data/lib/ebay/types/dispute_filter_count.rb

@@ -1,6 +1,9 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :dispute_filter_type, 'DisputeFilterType', :optional => true
+    #  numeric_node :total_available, 'TotalAvailable', :optional => true
     class DisputeFilterCount
       include XML::Mapping
       include Initializer

data/lib/ebay/types/dispute_message.rb

@@ -1,6 +1,11 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  numeric_node :message_id, 'MessageID', :optional => true
+    #  text_node :message_source, 'MessageSource', :optional => true
+    #  time_node :message_creation_time, 'MessageCreationTime', :optional => true
+    #  text_node :message_text, 'MessageText', :optional => true
     class DisputeMessage
       include XML::Mapping
       include Initializer

data/lib/ebay/types/dispute_resolution.rb

@@ -1,6 +1,10 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :dispute_resolution_record_type, 'DisputeResolutionRecordType', :optional => true
+    #  text_node :dispute_resolution_reason, 'DisputeResolutionReason', :optional => true
+    #  time_node :resolution_time, 'ResolutionTime', :optional => true
     class DisputeResolution
       include XML::Mapping
       include Initializer

data/lib/ebay/types/distance.rb

@@ -1,6 +1,9 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  numeric_node :distance_measurement, 'DistanceMeasurement'
+    #  text_node :distance_unit, 'DistanceUnit', :optional => true
     class Distance
       include XML::Mapping
       include Initializer

data/lib/ebay/types/domain_histogram.rb

@@ -2,6 +2,8 @@ require 'ebay/types/express_histogram_department'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  array_node :departments, 'Department', :class => ExpressHistogramDepartment, :default_value => []
     class DomainHistogram
       include XML::Mapping
       include Initializer

data/lib/ebay/types/duplicate_invocation_details.rb

@@ -1,6 +1,10 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :duplicate_invocation_id, 'DuplicateInvocationID', :optional => true
+    #  text_node :status, 'Status', :optional => true
+    #  text_node :invocation_tracking_id, 'InvocationTrackingID', :optional => true
     class DuplicateInvocationDetails
       include XML::Mapping
       include Initializer

data/lib/ebay/types/dutch_bin_enabled_definition.rb

@@ -1,6 +1,7 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
     class DutchBINEnabledDefinition
       include XML::Mapping
       include Initializer

data/lib/ebay/types/end_of_auction_email_preferences.rb

@@ -1,6 +1,14 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :template_text, 'TemplateText', :optional => true
+    #  text_node :logo_url, 'LogoURL', :optional => true
+    #  text_node :logo_type, 'LogoType', :optional => true
+    #  boolean_node :email_customized, 'EmailCustomized', 'true', 'false', :optional => true
+    #  boolean_node :text_customized, 'TextCustomized', 'true', 'false', :optional => true
+    #  boolean_node :logo_customized, 'LogoCustomized', 'true', 'false', :optional => true
+    #  boolean_node :copy_email, 'CopyEmail', 'true', 'false', :optional => true
     class EndOfAuctionEmailPreferences
       include XML::Mapping
       include Initializer

data/lib/ebay/types/error.rb

@@ -2,6 +2,14 @@ require 'ebay/types/error_parameter'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :short_message, 'ShortMessage', :optional => true
+    #  text_node :long_message, 'LongMessage', :optional => true
+    #  text_node :error_code, 'ErrorCode', :optional => true
+    #  boolean_node :user_display_hint, 'UserDisplayHint', 'true', 'false', :optional => true
+    #  text_node :severity_code, 'SeverityCode', :optional => true
+    #  array_node :error_parameters, 'ErrorParameters', :class => ErrorParameter, :default_value => []
+    #  text_node :error_classification, 'ErrorClassification', :optional => true
     class Error
       include XML::Mapping
       include Initializer

data/lib/ebay/types/error_parameter.rb

@@ -1,6 +1,9 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :value, 'Value', :optional => true
+    #  text_node :param_id, '@ParamID', :optional => true
     class ErrorParameter
       include XML::Mapping
       include Initializer

data/lib/ebay/types/expansion_array.rb

@@ -2,6 +2,9 @@ require 'ebay/types/search_result_item'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  array_node :expansion_items, 'ExpansionItem', :class => SearchResultItem, :default_value => []
+    #  numeric_node :total_available, 'TotalAvailable', :optional => true
     class ExpansionArray
       include XML::Mapping
       include Initializer

data/lib/ebay/types/express_condition_required_definition.rb

@@ -1,6 +1,7 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
     class ExpressConditionRequiredDefinition
       include XML::Mapping
       include Initializer

data/lib/ebay/types/express_details.rb

@@ -1,6 +1,10 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  text_node :express_large_image, 'ExpressLargeImage', :optional => true
+    #  text_node :express_small_image, 'ExpressSmallImage', :optional => true
+    #  text_node :condition, 'Condition', :optional => true
     class ExpressDetails
       include XML::Mapping
       include Initializer

data/lib/ebay/types/express_enabled_definition.rb

@@ -1,6 +1,7 @@
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
     class ExpressEnabledDefinition
       include XML::Mapping
       include Initializer

data/lib/ebay/types/express_histogram_aisle.rb

@@ -3,6 +3,9 @@ require 'ebay/types/express_histogram_product'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  object_node :domain_details, 'DomainDetails', :class => ExpressHistogramDomainDetails, :optional => true
+    #  array_node :product_types, 'ProductType', :class => ExpressHistogramProduct, :default_value => []
     class ExpressHistogramAisle
       include XML::Mapping
       include Initializer

data/lib/ebay/types/express_histogram_department.rb

@@ -3,6 +3,9 @@ require 'ebay/types/express_histogram_aisle'
 
 module Ebay # :nodoc:
   module Types # :nodoc:
+    # == Attributes
+    #  object_node :domain_details, 'DomainDetails', :class => ExpressHistogramDomainDetails, :optional => true
+    #  array_node :aisles, 'Aisle', :class => ExpressHistogramAisle, :default_value => []
     class ExpressHistogramDepartment
       include XML::Mapping
       include Initializer