################################################################################
# File: ................... <module_root>/eBay/API/XML/Tools/CodeGen/XSD/README
# Original Author: ........ Milenko Milanovic
# Last Modified By: ....... Robert Bradley / Jeff Nokes
# Last Modifed: ........... 03/30/2007 @ 21:49
#
# Description:  Genearl information about the manual execution of the eBay
#               API class auto-generation tool.
################################################################################




This directory contains a script needed to auto-generate eBay API Perl SDK Data
Types. The following types of files (classes) will be generated:

  a) Core DataTypes
  b) API Call Request DataTypes
  c) API Call Response DataTypes
  d) API Calls

The script generates classes based on eBay API XSD schema file. 
These files can be read either from file system or from the web.

XSD schema files can be found on the following URLs:

1. XML schema

 public:
    url: http://developer.ebay.com/webservices/latest/eBaySvc.xsd

Note:  This link should always contain the latest xsd document available from
       eBay.





STEPS FOR AUTO-GENERATION:
--------------------------------------------------------------------------------
1.   Execute

        perl genEBayApiDataTypes.pl --help

     ... to get all available options


2.   Execute the following to autogenerate all classes at the default location
     using the latest XSD:

        perl genEBayApiDataTypes.pl \
                --url=http://developer.ebay.com/webservices/latest/eBaySvc.xsd


3.   You should see screen output similar to the following:

    S T A R T

 1. F E T C H I N G input document from
        http://developer.ebay.com/webservices/latest/eBaySvc.xsd
 2. F E T C H I N G   - DONE, DATA saved to eBaySvc.xsd!
 3. P A R S I N G        input document
 4. G A T H E R I N G    'xs:complexType' metadata
 5. G A T H E R I N G    'xs:simpleType' metadata
 6. G E N E R A T I N G   Core, Request, and Response DataTypes
 7. G E N E R A T I N G   API calls

    D O N E !


4.  This execution will have done the two following things for you:
    a.  It will have copied the eBaySvc.xsd file to the current directory '.'
    b.  It will have autogenerated all classes for you, at the first
        occurrance of the path 'eBay/API/XML' up from the current
        directory '.', which should be the default location of this
        module in your PERLLIB|PERL5LIB|@INC tree anyway.





NOTES:
--------------------------------------------------------------------------------
- This auto-generation tool not only helps you install the eBay API Perl SDK
  for the first time, but it can also be used as a class updating mechanism
  for future XSD releases by eBay.

- Currently this tool _DOES_NOT_ support the parsing of the eBay WSDL file to
  auto-generate the classes, you must use the XSD file.

