diff --git a/.gitignore b/.gitignore index 0bc7fdf..e3b5ffa 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,10 @@ dist build .idea .DS_Store +doc_src/.doctrees +doc_src/_sources/* +doc_src/_static/* +doc_src/*.html +doc_src/_build/* +.python-version +/venv diff --git a/CHANGES.rst b/CHANGES.rst index 8e827c7..51f7419 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,6 +1,34 @@ Change Log ========== +2.4.0 +----- + +* Pickup Service usingv11 WSDL (hornedbull) +* Added documentation and unit tests for Pickup Service. (radzhome) +* Update package data to include tools (noodlebreak) + +2.3.1 +----- + +* Set fedex logging to INFO for tests. (radzhome) +* Sphinx documentation (hosted on read the docs). (radzhome) +* Update Ship Service test to allow warnings. (radzhome) +* Added log warning for requests that yield a WARNING. (radzhome) + +2.3.0 +----- + +* Added Location Service using v3 WSDL. (radzhome) +* Added examples and unit tests for Location Service. (radzhome) +* Updated certification process scripts to work with latest WSDLs. (radzhome) +* Added warning logging for requests that come back with warning notes. (radzhome) +* Added PyPI, Travis, requires.io integration/badges. (radzhome) +* Organization change from gtaylor to python-fedex-devs. (gtaylor) +* Added deprecation message for movement service. (radzhome) +* Added conversion tools to convert suds xml object into python dict. (radzhome) +* Redirect logging to stdout for examples and tests when not ran via nose. (radzhome) + 2.2.0 ----- diff --git a/MANIFEST.in b/MANIFEST.in index feb9b2a..39bd3df 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,4 +2,5 @@ include LICENSE.txt include README.rst recursive-include examples *.txt *.py recursive-include docs * +recursive-include fedex/tools * recursive-include fedex/wsdl * \ No newline at end of file diff --git a/README.rst b/README.rst index 433bf82..034d5a2 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,22 @@ Python FedEx SOAP API Module ============================ -:Author: Greg Taylor +.. image:: https://badge.fury.io/py/fedex.svg + :target: https://badge.fury.io/py/fedex + +.. image:: https://travis-ci.org/python-fedex-devs/python-fedex.svg?branch=master + :target: https://travis-ci.org/python-fedex-devs/python-fedex + +.. image:: https://requires.io/github/python-fedex-devs/python-fedex/requirements.svg?branch=master + :target: https://requires.io/github/python-fedex-devs/python-fedex/requirements/?branch=master + :alt: Requirements Status + +.. image:: https://readthedocs.org/projects/python-fedex/badge/?version=latest + :target: http://python-fedex.readthedocs.org/en/latest/?badge=latest + :alt: Documentation Status + +:Author: Greg Taylor, Radek Wojcik +:Maintainer: Python FedEx Developers :License: BSD :Status: Stable @@ -22,13 +37,15 @@ The easiest way is via pip or easy_install:: Quick Start ----------- -Edit the example_config.py file in examples with your fedex credentials -and run any of the provided examples. +- Clone this repository. + +- Edit the `example_config.py` file in See `examples/ `_ with your fedex credentials and run any of the provided examples. Documentation ------------- -Refer to the documentation_ for more details on the project. +Refer to the documentation_ for more details on the project. Latest doc builds +are found in docs_ and doc build scripts in doc_source_. Sphinx documentation is in doc_src_. There are also a lot of useful examples under the examples directory within this directory. @@ -36,26 +53,49 @@ this directory. Support ------- -Head over to https://github.com/gtaylor/python-fedex/issues -and submit an issue if you have any problems or questions. Due to this -package's quasi-maintained state, most problems are going to require -investigation or a submitted pull request by someone other than -Greg Taylor. +Issues & Questions: https://github.com/gtaylor/python-fedex/issues + +Most problems are going to require investigation or a submitted +pull request by someone from the Python FedEx Developers organization. +To contribute a new feature or service, feel free to create a pull request. +We are always looking for new contributors to help maintain the project. Fedex Support and Documentation ------------------------------- Fedex Support Email: websupport@fedex.com + Developer Portal: http://www.fedex.com/us/developer/ +Updates To Services: https://www.fedex.com/us/developer/web-services/process.html (FedEx Web Services Announcements) + + +Related Projects +---------------- + +- FedEx Commercial Invoice Generation, see https://github.com/radzhome/fedex-commercial-invoice + +Todos +----- + +- Increase service specific request validation +- Remove deprecated services (package movement service) +- Pickup service unit tests + Legal ----- -Copyright (C) 2015 Gregory Taylor +Copyright (C) 2008-2015 Greg Taylor + +Copyright (C) 2015-2016 Python FedEx Developers This software is licensed under the BSD License. python-fedex is not authored by, endorsed by, or in any way affiliated with FedEx. -.. _documentation: https://pythonhosted.org/fedex/ +.. _documentation: https://readthedocs.org/projects/python-fedex/ +.. _documentation2: https://pythonhosted.org/fedex/ +.. _docs: docs/ +.. _doc_source: doc_source/ +.. _doc_src: doc_src/ diff --git a/doc_src/Makefile b/doc_src/Makefile new file mode 100644 index 0000000..baa9814 --- /dev/null +++ b/doc_src/Makefile @@ -0,0 +1,192 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-fedex.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-fedex.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/python-fedex" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-fedex" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/doc_src/_static/.GIT_FOO b/doc_src/_static/.GIT_FOO new file mode 100755 index 0000000..e69de29 diff --git a/doc_src/_templates/.GIT_FOO b/doc_src/_templates/.GIT_FOO new file mode 100755 index 0000000..e69de29 diff --git a/doc_src/base_service.rst b/doc_src/base_service.rst new file mode 100755 index 0000000..804ae46 --- /dev/null +++ b/doc_src/base_service.rst @@ -0,0 +1,9 @@ +.. _base_service: + +.. include:: global.txt + +Base Service Class +================== + +.. autoclass:: fedex.base_service.FedexBaseService + diff --git a/doc_src/conf.py b/doc_src/conf.py new file mode 100644 index 0000000..fb3e8ef --- /dev/null +++ b/doc_src/conf.py @@ -0,0 +1,298 @@ +# -*- coding: utf-8 -*- +# +# python-fedex documentation build configuration file, created by +# sphinx-quickstart on Sat Jan 30 21:51:05 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) +project_root = os.path.dirname(os.path.abspath('.')) +sys.path.insert(0, project_root) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'python-fedex' +copyright = u'2016, Python Fedex Devs' +author = u'2016, Python Fedex Devs' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '2.0' +# The full version, including alpha/beta/rc tags. +release = '2.3.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'classic' # 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'python-fedexdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'python-fedex.tex', u'python-fedex Documentation', + u'2015, Python Fedex Devs', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'python-fedex', u'python-fedex Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'python-fedex', u'python-fedex Documentation', + author, 'python-fedex', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} + +autoclass_content = "both" +autodoc_default_flags = ["members", "inherited-members", "show-inheritance"] +autodoc_member_order = "groupwise" \ No newline at end of file diff --git a/doc_src/config_object.rst b/doc_src/config_object.rst new file mode 100755 index 0000000..ea8e4e3 --- /dev/null +++ b/doc_src/config_object.rst @@ -0,0 +1,13 @@ +.. _config_object: + +.. include:: global.txt + +Config Object +============= + +A standardized configuration container object used +by python-fedex. + +.. autoclass:: fedex.config.FedexConfig + + diff --git a/doc_src/exceptions.rst b/doc_src/exceptions.rst new file mode 100755 index 0000000..302823c --- /dev/null +++ b/doc_src/exceptions.rst @@ -0,0 +1,27 @@ +.. _exceptions: + +.. include:: global.txt + +Exception Classes +================= + +python-fedex implements various custom exceptions. + +Fedex Base Service Exception +---------------------------- + +.. autoclass:: fedex.base_service.FedexBaseServiceException + + +Fedex Failure +------------- + +.. autoclass:: fedex.base_service.FedexFailure + + +Fedex Error +----------- + +.. autoclass:: fedex.base_service.FedexError + + diff --git a/doc_src/global.txt b/doc_src/global.txt new file mode 100755 index 0000000..959a154 --- /dev/null +++ b/doc_src/global.txt @@ -0,0 +1,10 @@ +.. _GitHub project: https://github.com/python-fedex-devs/python-fedex +.. _issue tracker: https://github.com/python-fedex-devs/python-fedex/issues +.. _suds_jurko: https://bitbucket.org/jurko/suds + +.. _FedEx Web Services: http://www.fedex.com/us/developer/web-services/ + +.. _Python: http://python.org +.. _GitHub: https://github.com/ + +.. _BSD License: http://opensource.org/licenses/bsd-license.php diff --git a/doc_src/index.rst b/doc_src/index.rst new file mode 100644 index 0000000..9c89db1 --- /dev/null +++ b/doc_src/index.rst @@ -0,0 +1,37 @@ +.. python-fedex documentation master file, created by + sphinx-quickstart on Sat Jan 30 21:51:05 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. include:: global.txt + +Python-Fedex: a suds fedex api wrapper +====================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + installation + quick_start + services + tools + config_object + base_service + exceptions + suds_plugin + + +.. toctree:: + :maxdepth: 1 + + release_notes + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + diff --git a/doc_src/installation.rst b/doc_src/installation.rst new file mode 100755 index 0000000..49d0f81 --- /dev/null +++ b/doc_src/installation.rst @@ -0,0 +1,15 @@ +.. _installation: + +.. include:: global.txt + +Installation +============ + +python-fedex is compatible with Python 2.7+. The only other +requirement is suds_jurko_ although the module is also compatible with the +original suds module. + +For those on Linux/Unix Mac OS, the easiest route will be :command:`pip` or +:command:`easy_install`:: + + pip install fedex diff --git a/doc_src/make.bat b/doc_src/make.bat new file mode 100644 index 0000000..9f24a0e --- /dev/null +++ b/doc_src/make.bat @@ -0,0 +1,263 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + echo. coverage to run coverage check of the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 2> nul +if errorlevel 9009 goto sphinx_python +goto sphinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +:sphinx_ok + + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\python-fedex.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\python-fedex.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "coverage" ( + %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage + if errorlevel 1 exit /b 1 + echo. + echo.Testing of coverage in the sources finished, look at the ^ +results in %BUILDDIR%/coverage/python.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/doc_src/quick_start.rst b/doc_src/quick_start.rst new file mode 100644 index 0000000..4839a84 --- /dev/null +++ b/doc_src/quick_start.rst @@ -0,0 +1,226 @@ +.. _quick_start: + +.. include:: global.txt + +Quick Start +=========== + +To get you started, a comprehensive set of examples and tests is included in +the examples and tests directory respectively. The examples below are +come from the included unit tests. + +Initialize Config Object +------------------------ + +.. code-block:: python + + from fedex.config import FedexConfig + CONFIG_OBJ = FedexConfig(key='', + password='', + account_number='', + meter_number='') + +Create and Delete a Shipment +---------------------------- + +.. code-block:: python + + shipment = FedexProcessShipmentRequest(CONFIG_OBJ) + + shipment.RequestedShipment.DropoffType = 'REGULAR_PICKUP' + shipment.RequestedShipment.ServiceType = 'FEDEX_GROUND' + shipment.RequestedShipment.PackagingType = 'YOUR_PACKAGING' + + shipment.RequestedShipment.Shipper.Contact.PersonName = 'Sender Name' + shipment.RequestedShipment.Shipper.Contact.PhoneNumber = '9012638716' + + shipment.RequestedShipment.Shipper.Address.StreetLines = ['Address Line 1'] + shipment.RequestedShipment.Shipper.Address.City = convert_to_utf8('Herndon') + shipment.RequestedShipment.Shipper.Address.StateOrProvinceCode = 'VA' + shipment.RequestedShipment.Shipper.Address.PostalCode = '20171' + shipment.RequestedShipment.Shipper.Address.CountryCode = 'US' + + shipment.RequestedShipment.Recipient.Contact.PersonName = 'Recipient Name' + shipment.RequestedShipment.Recipient.Contact.PhoneNumber = '9012637906' + + shipment.RequestedShipment.Recipient.Address.StreetLines = ['Address Line 1'] + shipment.RequestedShipment.Recipient.Address.City = convert_to_utf8('TorontoåæâèéHerndon') + shipment.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'VA' + shipment.RequestedShipment.Recipient.Address.PostalCode = '20171' + shipment.RequestedShipment.Recipient.Address.CountryCode = 'US' + shipment.RequestedShipment.EdtRequestType = 'NONE' + + shipment.RequestedShipment.ShippingChargesPayment.Payor.ResponsibleParty.AccountNumber \ + = CONFIG_OBJ.account_number + + shipment.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER' + + shipment.RequestedShipment.LabelSpecification.LabelFormatType = 'COMMON2D' + shipment.RequestedShipment.LabelSpecification.ImageType = 'PNG' + shipment.RequestedShipment.LabelSpecification.LabelStockType = 'PAPER_7X4.75' + shipment.RequestedShipment.LabelSpecification.LabelPrintingOrientation = 'BOTTOM_EDGE_OF_TEXT_FIRST' + + # Use order if setting multiple labels or delete + del shipment.RequestedShipment.LabelSpecification.LabelOrder + + package1_weight = shipment.create_wsdl_object_of_type('Weight') + package1_weight.Value = 2.0 + package1_weight.Units = "LB" + package1 = shipment.create_wsdl_object_of_type('RequestedPackageLineItem') + package1.PhysicalPackaging = 'ENVELOPE' + package1.Weight = package1_weight + shipment.add_package(package1) + + shipment.send_validation_request() + shipment.send_request() + + assert shipment.response + assert shipment.response.HighestSeverity == 'SUCCESS' + track_id = shipment.response.CompletedShipmentDetail.CompletedPackageDetails[0].TrackingIds[0].TrackingNumber + assert track_id + + del_shipment = FedexDeleteShipmentRequest(CONFIG_OBJ) + del_shipment.DeletionControlType = "DELETE_ALL_PACKAGES" + del_shipment.TrackingId.TrackingNumber = track_id + del_shipment.TrackingId.TrackingIdType = 'EXPRESS' + + del_shipment.send_request() + +Get the Response +---------------- + +Once you perform `send_request()`, you can access the `response` attribute +of the service request object. To access the response from the +above delete shipment example: + +.. code-block:: python + + request_response = del_shipment.response + +Validate an Address +------------------- + +.. code-block:: python + + avs_request = FedexAddressValidationRequest(CONFIG_OBJ) + address1 = avs_request.create_wsdl_object_of_type('AddressToValidate') + address1.Address.StreetLines = ['155 Old Greenville Hwy', 'Suite 103'] + address1.Address.City = 'Clemson' + address1.Address.StateOrProvinceCode = 'SC' + address1.Address.PostalCode = 29631 + address1.Address.CountryCode = 'US' + address1.Address.Residential = False + avs_request.add_address(address1) + + avs_request.send_request() + +Estimate Delivery Time +---------------------- + +.. code-block:: python + + avc_request = FedexAvailabilityCommitmentRequest(CONFIG_OBJ) + avc_request.Origin.PostalCode = 'M5V 3A4' + avc_request.Origin.CountryCode = 'CA' + avc_request.Destination.PostalCode = '27577' # 29631 + avc_request.Destination.CountryCode = 'US' + +Validate Postal Code +-------------------- + +.. code-block:: python + + inquiry = FedexValidatePostalRequest(CONFIG_OBJ) + inquiry.Address.PostalCode = '29631' + inquiry.Address.CountryCode = 'US' + + inquiry.send_request() + +FedEx Store Search +------------------ + +.. code-block:: python + + location_request = FedexSearchLocationRequest(CONFIG_OBJ) + location_request.Address.PostalCode = '38119' + location_request.Address.CountryCode = 'US' + + +Get Package Rate +---------------- + +.. code-block:: python + + rate = FedexRateServiceRequest(CONFIG_OBJ) + + rate.RequestedShipment.DropoffType = 'REGULAR_PICKUP' + rate.RequestedShipment.ServiceType = 'FEDEX_GROUND' + rate.RequestedShipment.PackagingType = 'YOUR_PACKAGING' + + rate.RequestedShipment.Shipper.Address.StateOrProvinceCode = 'SC' + rate.RequestedShipment.Shipper.Address.PostalCode = '29631' + rate.RequestedShipment.Shipper.Address.CountryCode = 'US' + + rate.RequestedShipment.Recipient.Address.StateOrProvinceCode = 'NC' + rate.RequestedShipment.Recipient.Address.PostalCode = '27577' + rate.RequestedShipment.Recipient.Address.CountryCode = 'US' + + rate.RequestedShipment.EdtRequestType = 'NONE' + rate.RequestedShipment.ShippingChargesPayment.PaymentType = 'SENDER' + + package1_weight = rate.create_wsdl_object_of_type('Weight') + package1_weight.Value = 1.0 + package1_weight.Units = "LB" + package1 = rate.create_wsdl_object_of_type('RequestedPackageLineItem') + package1.Weight = package1_weight + package1.PhysicalPackaging = 'BOX' + package1.GroupPackageCount = 1 + rate.add_package(package1) + + rate.send_request() + +Track a Package +--------------- + +.. code-block:: python + + track = FedexTrackRequest(CONFIG_OBJ) + tracking_num = '781820562774' + track.SelectionDetails.PackageIdentifier.Type = 'TRACKING_NUMBER_OR_DOORTAG' + track.SelectionDetails.PackageIdentifier.Value = tracking_num + track.send_request() + + +Get JSON and Dictionary Response +-------------------------------- + +.. code-block:: python + + from fedex.tools.conversion import sobject_to_dict + from fedex.tools.conversion import sobject_to_json + response_dict = sobject_to_dict(shipment.response) + response_json = sobject_to_json(shipment.response) + +Advanced Requests +----------------- + +Since this module is a suds wrapper, you can browse each service's WSDL +in ``fedex/wsdls`` and add any required objects to your request. + +For example, the `Ship Service` WSDL has a `simpleType` definition for `ServiceType` +with the following options: + +* ``'STANDARD_OVERNIGHT'`` +* ``'PRIORITY_OVERNIGHT'`` +* ``'FEDEX_GROUND'`` +* ``'FEDEX_EXPRESS_SAVER'`` +* ``'FEDEX_2_DAY'`` +* ``'INTERNATIONAL_PRIORITY'`` +* ``'SAME_DAY'`` +* ``'INTERNATIONAL_ECONOMY'`` + +You can see all what is available for a specific definition by +browsing a service's WSDL. It is possible to customize your request beyond what +is included in the examples but still within the confines of +this package. If it's something common enough, please bring it +forward so that it can be included along as an example. \ No newline at end of file diff --git a/doc_src/release_notes.rst b/doc_src/release_notes.rst new file mode 100755 index 0000000..cf88ac2 --- /dev/null +++ b/doc_src/release_notes.rst @@ -0,0 +1,139 @@ +.. _release_notes: + +.. include:: global.txt + +Change Log +========== + +2.4.0 +----- + +* Pickup Service usingv11 WSDL (hornedbull) +* Added documentation and unit tests for Pickup Service. (radzhome) +* Update package data to include tools (noodlebreak) + +2.3.0 +----- + +* Added Location Service using v3 WSDL. (radzhome) +* Added examples and unit tests for Location Service. (radzhome) +* Updated certification process scripts to work with latest WSDLs. (radzhome) +* Added warning logging for requests that come back with warning notes. (radzhome) +* Added PyPI, Travis, requires.io integration/badges. (radzhome) +* Organization change from gtaylor to python-fedex-devs. (gtaylor) +* Added deprecation message for movement service. (radzhome) +* Added conversion tools to convert suds xml object into python dict. (radzhome) +* Redirect logging to stdout for examples and tests when not ran via nose. (radzhome) + +2.2.0 +----- + +* Added Country Service / Postal Code Validation service. (radzhome) +* Added CountryService_v4.wsdl for Postal Code Validation. (radzhome) +* Added unit tests and examples for Country service. (radzhome) +* Added Signature Option to ship example. (radzhome) +* Fix base service logging request and response. (radzhome) + +2.1.0 +----- + +* Added Validation, Availability and Commitment (AVC) service. (radzhome) +* Added [Validation]AvailabilityAndCommitmentService_v4.wsdl for AVC service. (radzhome) +* Added examples and unit tests for AVC service. +* Refactored examples and documentation. (radzhome) +* A quick PEP8 pass using pycharm on most of the codebase (radzhome) +* Add travis yml (radzhome) + + +2.0.0 +----- + +* Bump ShipService WSDL to v17 for create and delete shipment. (radzhome) +* Bump AddressValidation WSDL to v4. (radzhome) +* Bump RateService WSDL to v18. (radzhome) +* Bump TrackService WSDL to v10. (radzhome) +* General improvements to base class. (radzhome) +* Refactoring and updates to examples. (radzhome) +* Added test classes. (radzhome) +* Remove old and unused WSDLs. (radzhome) +* Change dependency to suds-jurko to include python 3 support. (radzhome) + +1.1.1 +----- + +* Made RateService_v16.wsdl point at ws.fedex.com instead of + wsbeta.fedex.com. Fixes issues in production. (ikks) + +1.1.0 +----- + +* A quick PEP8 pass on most of the codebase. Yucky. (gtaylor) +* Changing recommended install method to use pip + PyPi. (radzhome) +* Updated rate_request and freight_rate_request examples for WSDL v16 + compatibility. (foxxyz) +* Updated rate service WSDL from v8 to v16. (foxxyz) +* Added a freight rate request example (mwcbrent) +* Bump ShipService WSDL to v13. (mwcbrent) +* Update rate example to show multiple ServiceTypes. (danielatdattrixdotcom) + +1.0.14 +------ + +* Re-licensed under BSD. + +1.0.12 and 1.0.13 +----------------- + +* Forget that these ever existed. + +1.0.11 +------ + +* Bug fix of a bug fix for regions config. (jcartmell) + +1.0.10 +------ + +* Bug fix regarding regions and when they are sent. (jcartmell) + +1.0.9 +----- + +* Various fixes to RateRequest() FedEx API call. (jcartmell) +* Added this changelog. (gtaylor) + +1.0.8 +----- + +* Fixed some problems with the unit tests. (gtaylor) + +1.0.7 +----- + +* Fixed a bug with international rate request example. (gtaylor) + +1.0.6 +----- + +* Lots of documentation improvements. (gtaylor) +* FedEx RateRequest call implemented. (yahtib) +* FedEx Postal Inquiry call implemented. (yahtib) + +1.0.4 +----- + +* Removal of unecessary files. (gtaylor) +* Documentation improvements. (gtaylor) + +1.0.3 +----- + +* Wrote some label certification modules that can help + with the label certification process. (gtaylor) + + +initial +^^^^^^^ + +* 1.0 + diff --git a/doc_src/services.rst b/doc_src/services.rst new file mode 100755 index 0000000..7fad30d --- /dev/null +++ b/doc_src/services.rst @@ -0,0 +1,87 @@ +.. _services: + +.. include:: global.txt + +Implemented Services +==================== + +python-fedex implements various `FedEx Web Services`_. These +services along with the implemented functionality is +described below. + +Ship Service +------------ + +Generates (FedEx Waybill) and deletes shipments. + +.. autoclass:: fedex.services.ship_service.FedexProcessShipmentRequest + +.. autoclass:: fedex.services.ship_service.FedexDeleteShipmentRequest + +Rate Service +------------ + +Calculates the cost of a shipment. + +.. autoclass:: fedex.services.rate_service.FedexRateServiceRequest + + +Validation Availability And Commitment Service +---------------------------------------------- + +Calculates the estimated arrival time of a shipment. + +.. autoclass:: fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest + + +Track Service +------------- + +Returns tracking information for a given tracking number. + +.. autoclass:: fedex.services.track_service.FedexTrackRequest + +Address Validation Service +-------------------------- + +Validates and cleans a given address. + +.. autoclass:: fedex.services.address_validation_service.FedexAddressValidationRequest + + +Location Service +---------------- + +Returns FedEx store locations based on a given location query. + +.. autoclass:: fedex.services.location_service.FedexSearchLocationRequest + + +Country Service +--------------- + +Validates the postal codes for a given address. + +.. autoclass:: fedex.services.country_service.FedexValidatePostalRequest + + +Pickup Service +-------------- + +Creates a FedEx pickup request. + +.. autoclass:: fedex.services.pickup_service.FedexCreatePickupRequest + +Queries pickup availability. + +.. autoclass:: fedex.services.pickup_service.FedexPickupAvailabilityRequest + + +Package Movement Service +------------------------ + +DEPRECATED service that was used to validate postal codes and +calculate shipment arrival times. Replaced with two distinct services: +Validation Availability And Commitment Service, and Country Service. + +.. autoclass:: fedex.services.country_service.FedexValidatePostalRequest diff --git a/doc_src/suds_plugin.rst b/doc_src/suds_plugin.rst new file mode 100755 index 0000000..2029012 --- /dev/null +++ b/doc_src/suds_plugin.rst @@ -0,0 +1,11 @@ +.. _suds_plugin: + +.. include:: global.txt + +General Suds Plugin +=================== + +python-fedex uses the following suds plugin for suds xml requests. + + +.. autoclass:: fedex.base_service.GeneralSudsPlugin diff --git a/doc_src/tools.rst b/doc_src/tools.rst new file mode 100755 index 0000000..62ef68f --- /dev/null +++ b/doc_src/tools.rst @@ -0,0 +1,24 @@ +.. _tools: + +.. include:: global.txt + +Format Conversion Tools +======================= + +Additional utility functions for converting suds xml +object into other formats. + +Basic Suds Object to Dictionary +------------------------------- + +.. autofunction:: fedex.tools.conversion.basic_sobject_to_dict + +Advanced Suds Object to Dictionary +---------------------------------- + +.. autofunction:: fedex.tools.conversion.sobject_to_dict + +Suds Object to JSON +------------------- + +.. autofunction:: fedex.tools.conversion.sobject_to_json diff --git a/epydoc_source/README.rst b/epydoc_source/README.rst new file mode 100644 index 0000000..e42f2b3 --- /dev/null +++ b/epydoc_source/README.rst @@ -0,0 +1,15 @@ +python-fedex legacy documentation +================================= + +This directory contains legacy build scripts for python-fedex documentation +using epydoc 3.0.1. The following was used to generate doc: + + cd python-fedex/docs + epydoc -v -o 2.X.X ../fedex/ + +The epydoc documentation is hosted at https://pythonhosted.org/fedex/. + +Latest documentation is now generated using Sphinx. Updates can be made to the +*.rst files in doc_src: + + cd python-fedex/doc_src diff --git a/doc_source/build_docs.sh b/epydoc_source/build_docs.sh similarity index 100% rename from doc_source/build_docs.sh rename to epydoc_source/build_docs.sh diff --git a/docs/1.0.0/api-objects.txt b/epydoc_source/docs/1.0.0/api-objects.txt similarity index 100% rename from docs/1.0.0/api-objects.txt rename to epydoc_source/docs/1.0.0/api-objects.txt diff --git a/docs/1.0.0/class-tree.html b/epydoc_source/docs/1.0.0/class-tree.html similarity index 100% rename from docs/1.0.0/class-tree.html rename to epydoc_source/docs/1.0.0/class-tree.html diff --git a/docs/1.0.0/crarr.png b/epydoc_source/docs/1.0.0/crarr.png similarity index 100% rename from docs/1.0.0/crarr.png rename to epydoc_source/docs/1.0.0/crarr.png diff --git a/docs/1.0.0/epydoc.css b/epydoc_source/docs/1.0.0/epydoc.css similarity index 100% rename from docs/1.0.0/epydoc.css rename to epydoc_source/docs/1.0.0/epydoc.css diff --git a/docs/1.0.0/epydoc.js b/epydoc_source/docs/1.0.0/epydoc.js similarity index 99% rename from docs/1.0.0/epydoc.js rename to epydoc_source/docs/1.0.0/epydoc.js index e787dbc..119e71e 100644 --- a/docs/1.0.0/epydoc.js +++ b/epydoc_source/docs/1.0.0/epydoc.js @@ -22,7 +22,7 @@ function toggle_private() { } } // Update all table rows containing private objects. Note, we - // use "" instead of "block" becaue IE & firefox disagree on what + // use "" instead of "block" because IE & firefox disagree on what // this should be (block vs table-row), and "" just gives the // default for both browsers. var elts = document.getElementsByTagName("tr"); diff --git a/docs/1.0.0/fedex-module.html b/epydoc_source/docs/1.0.0/fedex-module.html similarity index 100% rename from docs/1.0.0/fedex-module.html rename to epydoc_source/docs/1.0.0/fedex-module.html diff --git a/docs/1.0.0/fedex-pysrc.html b/epydoc_source/docs/1.0.0/fedex-pysrc.html similarity index 100% rename from docs/1.0.0/fedex-pysrc.html rename to epydoc_source/docs/1.0.0/fedex-pysrc.html diff --git a/docs/1.0.0/fedex.base_service-module.html b/epydoc_source/docs/1.0.0/fedex.base_service-module.html similarity index 100% rename from docs/1.0.0/fedex.base_service-module.html rename to epydoc_source/docs/1.0.0/fedex.base_service-module.html diff --git a/docs/1.0.0/fedex.base_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.base_service-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.base_service-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.base_service-pysrc.html diff --git a/docs/1.0.0/fedex.base_service.FedexBaseService-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.FedexBaseService-class.html similarity index 100% rename from docs/1.0.0/fedex.base_service.FedexBaseService-class.html rename to epydoc_source/docs/1.0.0/fedex.base_service.FedexBaseService-class.html diff --git a/docs/1.0.0/fedex.base_service.FedexBaseServiceException-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.FedexBaseServiceException-class.html similarity index 100% rename from docs/1.0.0/fedex.base_service.FedexBaseServiceException-class.html rename to epydoc_source/docs/1.0.0/fedex.base_service.FedexBaseServiceException-class.html diff --git a/docs/1.0.0/fedex.base_service.FedexError-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.FedexError-class.html similarity index 100% rename from docs/1.0.0/fedex.base_service.FedexError-class.html rename to epydoc_source/docs/1.0.0/fedex.base_service.FedexError-class.html diff --git a/docs/1.0.0/fedex.base_service.FedexFailure-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.FedexFailure-class.html similarity index 100% rename from docs/1.0.0/fedex.base_service.FedexFailure-class.html rename to epydoc_source/docs/1.0.0/fedex.base_service.FedexFailure-class.html diff --git a/docs/1.0.0/fedex.base_service.SchemaValidationError-class.html b/epydoc_source/docs/1.0.0/fedex.base_service.SchemaValidationError-class.html similarity index 100% rename from docs/1.0.0/fedex.base_service.SchemaValidationError-class.html rename to epydoc_source/docs/1.0.0/fedex.base_service.SchemaValidationError-class.html diff --git a/docs/1.0.0/fedex.config-module.html b/epydoc_source/docs/1.0.0/fedex.config-module.html similarity index 100% rename from docs/1.0.0/fedex.config-module.html rename to epydoc_source/docs/1.0.0/fedex.config-module.html diff --git a/docs/1.0.0/fedex.config-pysrc.html b/epydoc_source/docs/1.0.0/fedex.config-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.config-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.config-pysrc.html diff --git a/docs/1.0.0/fedex.config.FedexConfig-class.html b/epydoc_source/docs/1.0.0/fedex.config.FedexConfig-class.html similarity index 100% rename from docs/1.0.0/fedex.config.FedexConfig-class.html rename to epydoc_source/docs/1.0.0/fedex.config.FedexConfig-class.html diff --git a/docs/1.0.0/fedex.printers-module.html b/epydoc_source/docs/1.0.0/fedex.printers-module.html similarity index 100% rename from docs/1.0.0/fedex.printers-module.html rename to epydoc_source/docs/1.0.0/fedex.printers-module.html diff --git a/docs/1.0.0/fedex.printers-pysrc.html b/epydoc_source/docs/1.0.0/fedex.printers-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.printers-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.printers-pysrc.html diff --git a/docs/1.0.0/fedex.printers.unix-module.html b/epydoc_source/docs/1.0.0/fedex.printers.unix-module.html similarity index 100% rename from docs/1.0.0/fedex.printers.unix-module.html rename to epydoc_source/docs/1.0.0/fedex.printers.unix-module.html diff --git a/docs/1.0.0/fedex.printers.unix-pysrc.html b/epydoc_source/docs/1.0.0/fedex.printers.unix-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.printers.unix-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.printers.unix-pysrc.html diff --git a/docs/1.0.0/fedex.printers.unix.DirectDevicePrinter-class.html b/epydoc_source/docs/1.0.0/fedex.printers.unix.DirectDevicePrinter-class.html similarity index 100% rename from docs/1.0.0/fedex.printers.unix.DirectDevicePrinter-class.html rename to epydoc_source/docs/1.0.0/fedex.printers.unix.DirectDevicePrinter-class.html diff --git a/docs/1.0.0/fedex.services-module.html b/epydoc_source/docs/1.0.0/fedex.services-module.html similarity index 100% rename from docs/1.0.0/fedex.services-module.html rename to epydoc_source/docs/1.0.0/fedex.services-module.html diff --git a/docs/1.0.0/fedex.services-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.services-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.services-pysrc.html diff --git a/docs/1.0.0/fedex.services.address_validation_service-module.html b/epydoc_source/docs/1.0.0/fedex.services.address_validation_service-module.html similarity index 100% rename from docs/1.0.0/fedex.services.address_validation_service-module.html rename to epydoc_source/docs/1.0.0/fedex.services.address_validation_service-module.html diff --git a/docs/1.0.0/fedex.services.address_validation_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.address_validation_service-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.services.address_validation_service-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.services.address_validation_service-pysrc.html diff --git a/docs/1.0.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html similarity index 100% rename from docs/1.0.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html rename to epydoc_source/docs/1.0.0/fedex.services.address_validation_service.FedexAddressValidationRequest-class.html diff --git a/docs/1.0.0/fedex.services.package_movement-module.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement-module.html similarity index 100% rename from docs/1.0.0/fedex.services.package_movement-module.html rename to epydoc_source/docs/1.0.0/fedex.services.package_movement-module.html diff --git a/docs/1.0.0/fedex.services.package_movement-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.services.package_movement-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.services.package_movement-pysrc.html diff --git a/docs/1.0.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html similarity index 100% rename from docs/1.0.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html rename to epydoc_source/docs/1.0.0/fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html diff --git a/docs/1.0.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html similarity index 100% rename from docs/1.0.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html rename to epydoc_source/docs/1.0.0/fedex.services.package_movement.FedexPostalCodeNotFound-class.html diff --git a/docs/1.0.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html similarity index 100% rename from docs/1.0.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html rename to epydoc_source/docs/1.0.0/fedex.services.package_movement.PostalCodeInquiryRequest-class.html diff --git a/docs/1.0.0/fedex.services.rate_service-module.html b/epydoc_source/docs/1.0.0/fedex.services.rate_service-module.html similarity index 100% rename from docs/1.0.0/fedex.services.rate_service-module.html rename to epydoc_source/docs/1.0.0/fedex.services.rate_service-module.html diff --git a/docs/1.0.0/fedex.services.rate_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.rate_service-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.services.rate_service-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.services.rate_service-pysrc.html diff --git a/docs/1.0.0/fedex.services.rate_service.FedexRateServiceRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.rate_service.FedexRateServiceRequest-class.html similarity index 100% rename from docs/1.0.0/fedex.services.rate_service.FedexRateServiceRequest-class.html rename to epydoc_source/docs/1.0.0/fedex.services.rate_service.FedexRateServiceRequest-class.html diff --git a/docs/1.0.0/fedex.services.ship_service-module.html b/epydoc_source/docs/1.0.0/fedex.services.ship_service-module.html similarity index 100% rename from docs/1.0.0/fedex.services.ship_service-module.html rename to epydoc_source/docs/1.0.0/fedex.services.ship_service-module.html diff --git a/docs/1.0.0/fedex.services.ship_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.ship_service-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.services.ship_service-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.services.ship_service-pysrc.html diff --git a/docs/1.0.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html similarity index 100% rename from docs/1.0.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html rename to epydoc_source/docs/1.0.0/fedex.services.ship_service.FedexDeleteShipmentRequest-class.html diff --git a/docs/1.0.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html similarity index 100% rename from docs/1.0.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html rename to epydoc_source/docs/1.0.0/fedex.services.ship_service.FedexProcessShipmentRequest-class.html diff --git a/docs/1.0.0/fedex.services.track_service-module.html b/epydoc_source/docs/1.0.0/fedex.services.track_service-module.html similarity index 100% rename from docs/1.0.0/fedex.services.track_service-module.html rename to epydoc_source/docs/1.0.0/fedex.services.track_service-module.html diff --git a/docs/1.0.0/fedex.services.track_service-pysrc.html b/epydoc_source/docs/1.0.0/fedex.services.track_service-pysrc.html similarity index 100% rename from docs/1.0.0/fedex.services.track_service-pysrc.html rename to epydoc_source/docs/1.0.0/fedex.services.track_service-pysrc.html diff --git a/docs/1.0.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html b/epydoc_source/docs/1.0.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html similarity index 100% rename from docs/1.0.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html rename to epydoc_source/docs/1.0.0/fedex.services.track_service.FedexInvalidTrackingNumber-class.html diff --git a/docs/1.0.0/fedex.services.track_service.FedexTrackRequest-class.html b/epydoc_source/docs/1.0.0/fedex.services.track_service.FedexTrackRequest-class.html similarity index 100% rename from docs/1.0.0/fedex.services.track_service.FedexTrackRequest-class.html rename to epydoc_source/docs/1.0.0/fedex.services.track_service.FedexTrackRequest-class.html diff --git a/docs/1.0.0/frames.html b/epydoc_source/docs/1.0.0/frames.html similarity index 100% rename from docs/1.0.0/frames.html rename to epydoc_source/docs/1.0.0/frames.html diff --git a/docs/1.0.0/help.html b/epydoc_source/docs/1.0.0/help.html similarity index 100% rename from docs/1.0.0/help.html rename to epydoc_source/docs/1.0.0/help.html diff --git a/docs/1.0.0/identifier-index.html b/epydoc_source/docs/1.0.0/identifier-index.html similarity index 100% rename from docs/1.0.0/identifier-index.html rename to epydoc_source/docs/1.0.0/identifier-index.html diff --git a/docs/1.0.0/index.html b/epydoc_source/docs/1.0.0/index.html similarity index 100% rename from docs/1.0.0/index.html rename to epydoc_source/docs/1.0.0/index.html diff --git a/docs/1.0.0/module-tree.html b/epydoc_source/docs/1.0.0/module-tree.html similarity index 100% rename from docs/1.0.0/module-tree.html rename to epydoc_source/docs/1.0.0/module-tree.html diff --git a/docs/1.0.0/redirect.html b/epydoc_source/docs/1.0.0/redirect.html similarity index 100% rename from docs/1.0.0/redirect.html rename to epydoc_source/docs/1.0.0/redirect.html diff --git a/docs/1.0.0/toc-everything.html b/epydoc_source/docs/1.0.0/toc-everything.html similarity index 100% rename from docs/1.0.0/toc-everything.html rename to epydoc_source/docs/1.0.0/toc-everything.html diff --git a/docs/1.0.0/toc-fedex-module.html b/epydoc_source/docs/1.0.0/toc-fedex-module.html similarity index 100% rename from docs/1.0.0/toc-fedex-module.html rename to epydoc_source/docs/1.0.0/toc-fedex-module.html diff --git a/docs/1.0.0/toc-fedex.base_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.base_service-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.base_service-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.base_service-module.html diff --git a/docs/1.0.0/toc-fedex.config-module.html b/epydoc_source/docs/1.0.0/toc-fedex.config-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.config-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.config-module.html diff --git a/docs/1.0.0/toc-fedex.printers-module.html b/epydoc_source/docs/1.0.0/toc-fedex.printers-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.printers-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.printers-module.html diff --git a/docs/1.0.0/toc-fedex.printers.unix-module.html b/epydoc_source/docs/1.0.0/toc-fedex.printers.unix-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.printers.unix-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.printers.unix-module.html diff --git a/docs/1.0.0/toc-fedex.services-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.services-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.services-module.html diff --git a/docs/1.0.0/toc-fedex.services.address_validation_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.address_validation_service-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.services.address_validation_service-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.services.address_validation_service-module.html diff --git a/docs/1.0.0/toc-fedex.services.package_movement-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.package_movement-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.services.package_movement-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.services.package_movement-module.html diff --git a/docs/1.0.0/toc-fedex.services.rate_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.rate_service-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.services.rate_service-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.services.rate_service-module.html diff --git a/docs/1.0.0/toc-fedex.services.ship_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.ship_service-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.services.ship_service-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.services.ship_service-module.html diff --git a/docs/1.0.0/toc-fedex.services.track_service-module.html b/epydoc_source/docs/1.0.0/toc-fedex.services.track_service-module.html similarity index 100% rename from docs/1.0.0/toc-fedex.services.track_service-module.html rename to epydoc_source/docs/1.0.0/toc-fedex.services.track_service-module.html diff --git a/docs/1.0.0/toc.html b/epydoc_source/docs/1.0.0/toc.html similarity index 100% rename from docs/1.0.0/toc.html rename to epydoc_source/docs/1.0.0/toc.html diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_ba.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_ba.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_ba_2.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_2.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_ba_2.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_2.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_ba_3.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_3.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_ba_3.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_3.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_ba_4.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_4.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_ba_4.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_4.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_ba_5.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_5.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_ba_5.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_ba_5.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_co.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_co.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_co.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_co.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_pr.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_pr.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_pr.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_pr.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se_2.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_2.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se_2.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_2.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se_3.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_3.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se_3.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_3.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se_4.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_4.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se_4.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_4.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se_5.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_5.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se_5.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_5.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se_6.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_6.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se_6.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_6.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se_7.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_7.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se_7.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_7.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se_8.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_8.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se_8.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_8.gif diff --git a/docs/1.0.0/uml_class_diagram_for_fedex_se_9.gif b/epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_9.gif similarity index 100% rename from docs/1.0.0/uml_class_diagram_for_fedex_se_9.gif rename to epydoc_source/docs/1.0.0/uml_class_diagram_for_fedex_se_9.gif diff --git a/docs/2.2.0/api-objects.txt b/epydoc_source/docs/2.3.0/api-objects.txt similarity index 81% rename from docs/2.2.0/api-objects.txt rename to epydoc_source/docs/2.3.0/api-objects.txt index 481e5c8..59c36d7 100644 --- a/docs/2.2.0/api-objects.txt +++ b/epydoc_source/docs/2.3.0/api-objects.txt @@ -17,6 +17,8 @@ fedex.services.availability_commitment_service fedex.services.availability_commi fedex.services.availability_commitment_service.__package__ fedex.services.availability_commitment_service-module.html#__package__ fedex.services.country_service fedex.services.country_service-module.html fedex.services.country_service.__package__ fedex.services.country_service-module.html#__package__ +fedex.services.location_service fedex.services.location_service-module.html +fedex.services.location_service.__package__ fedex.services.location_service-module.html#__package__ fedex.services.package_movement fedex.services.package_movement-module.html fedex.services.package_movement.__package__ fedex.services.package_movement-module.html#__package__ fedex.services.rate_service fedex.services.rate_service-module.html @@ -25,10 +27,18 @@ fedex.services.ship_service fedex.services.ship_service-module.html fedex.services.ship_service.__package__ fedex.services.ship_service-module.html#__package__ fedex.services.track_service fedex.services.track_service-module.html fedex.services.track_service.__package__ fedex.services.track_service-module.html#__package__ +fedex.tools fedex.tools-module.html +fedex.tools.__package__ fedex.tools-module.html#__package__ +fedex.tools.conversion fedex.tools.conversion-module.html +fedex.tools.conversion.basic_sobject_to_dict fedex.tools.conversion-module.html#basic_sobject_to_dict +fedex.tools.conversion.sobject_to_json fedex.tools.conversion-module.html#sobject_to_json +fedex.tools.conversion.sobject_to_dict fedex.tools.conversion-module.html#sobject_to_dict +fedex.tools.conversion.__package__ fedex.tools.conversion-module.html#__package__ fedex.base_service.FedexBaseService fedex.base_service.FedexBaseService-class.html fedex.base_service.FedexBaseService.__check_response_for_fedex_error fedex.base_service.FedexBaseService-class.html#__check_response_for_fedex_error fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.base_service.FedexBaseService.__set_web_authentication_detail fedex.base_service.FedexBaseService-class.html#__set_web_authentication_detail fedex.base_service.FedexBaseService._prepare_wsdl_objects fedex.base_service.FedexBaseService-class.html#_prepare_wsdl_objects fedex.base_service.FedexBaseService.__init__ fedex.base_service.FedexBaseService-class.html#__init__ @@ -36,6 +46,7 @@ fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseServi fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail fedex.base_service.FedexBaseService._assemble_and_send_request fedex.base_service.FedexBaseService-class.html#_assemble_and_send_request fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response @@ -84,6 +95,7 @@ fedex.printers.unix.DirectDevicePrinter.__init__ fedex.printers.unix.DirectDevic fedex.services.address_validation_service.FedexAddressValidationRequest fedex.services.address_validation_service.FedexAddressValidationRequest-class.html fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.services.address_validation_service.FedexAddressValidationRequest._prepare_wsdl_objects fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#_prepare_wsdl_objects fedex.services.address_validation_service.FedexAddressValidationRequest.__init__ fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#__init__ fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj @@ -91,6 +103,7 @@ fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseSer fedex.services.address_validation_service.FedexAddressValidationRequest._assemble_and_send_request fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#_assemble_and_send_request fedex.services.address_validation_service.FedexAddressValidationRequest.AddressesToValidate fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#AddressesToValidate fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail fedex.services.address_validation_service.FedexAddressValidationRequest.add_address fedex.services.address_validation_service.FedexAddressValidationRequest-class.html#add_address fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type @@ -103,11 +116,13 @@ fedex.services.availability_commitment_service.FedexAvailabilityCommitmentReques fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.Destination fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#Destination fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.CarrierCode fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#CarrierCode +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest._prepare_wsdl_objects fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#_prepare_wsdl_objects fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.__init__ fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#__init__ fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest._assemble_and_send_request fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#_assemble_and_send_request fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest.ShipDate fedex.services.availability_commitment_service.FedexAvailabilityCommitmentRequest-class.html#ShipDate fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail @@ -121,6 +136,7 @@ fedex.services.country_service.FedexValidatePostalRequest fedex.services.country fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request fedex.services.country_service.FedexValidatePostalRequest.CarrierCode fedex.services.country_service.FedexValidatePostalRequest-class.html#CarrierCode +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.services.country_service.FedexValidatePostalRequest._prepare_wsdl_objects fedex.services.country_service.FedexValidatePostalRequest-class.html#_prepare_wsdl_objects fedex.services.country_service.FedexValidatePostalRequest.__init__ fedex.services.country_service.FedexValidatePostalRequest-class.html#__init__ fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj @@ -130,12 +146,35 @@ fedex.services.country_service.FedexValidatePostalRequest.RoutingCode fedex.serv fedex.services.country_service.FedexValidatePostalRequest.ShipDateTime fedex.services.country_service.FedexValidatePostalRequest-class.html#ShipDateTime fedex.services.country_service.FedexValidatePostalRequest.Address fedex.services.country_service.FedexValidatePostalRequest-class.html#Address fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response fedex.services.country_service.FedexValidatePostalRequest.CheckForMismatch fedex.services.country_service.FedexValidatePostalRequest-class.html#CheckForMismatch fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors +fedex.services.location_service.FedexSearchLocationRequest fedex.services.location_service.FedexSearchLocationRequest-class.html +fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail +fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info +fedex.services.location_service.FedexSearchLocationRequest._prepare_wsdl_objects fedex.services.location_service.FedexSearchLocationRequest-class.html#_prepare_wsdl_objects +fedex.services.location_service.FedexSearchLocationRequest.__init__ fedex.services.location_service.FedexSearchLocationRequest-class.html#__init__ +fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj +fedex.services.location_service.FedexSearchLocationRequest.MultipleMatchesAction fedex.services.location_service.FedexSearchLocationRequest-class.html#MultipleMatchesAction +fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail +fedex.services.location_service.FedexSearchLocationRequest._assemble_and_send_request fedex.services.location_service.FedexSearchLocationRequest-class.html#_assemble_and_send_request +fedex.services.location_service.FedexSearchLocationRequest.Address fedex.services.location_service.FedexSearchLocationRequest-class.html#Address +fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings +fedex.services.location_service.FedexSearchLocationRequest.LocationsSearchCriterion fedex.services.location_service.FedexSearchLocationRequest-class.html#LocationsSearchCriterion +fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail +fedex.services.location_service.FedexSearchLocationRequest.PhoneNumber fedex.services.location_service.FedexSearchLocationRequest-class.html#PhoneNumber +fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type +fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response +fedex.services.location_service.FedexSearchLocationRequest.Constraints fedex.services.location_service.FedexSearchLocationRequest-class.html#Constraints +fedex.base_service.FedexBaseService.VersionId fedex.base_service.FedexBaseService-class.html#VersionId +fedex.services.location_service.FedexSearchLocationRequest.SortDetail fedex.services.location_service.FedexSearchLocationRequest-class.html#SortDetail +fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.base_service.FedexBaseService-class.html#_check_response_for_request_errors fedex.services.package_movement.FedexInvalidPostalCodeFormat fedex.services.package_movement.FedexInvalidPostalCodeFormat-class.html fedex.base_service.FedexBaseServiceException.__str__ fedex.base_service.FedexBaseServiceException-class.html#__str__ fedex.base_service.FedexBaseServiceException.__unicode__ fedex.base_service.FedexBaseServiceException-class.html#__unicode__ @@ -147,12 +186,14 @@ fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBa fedex.services.package_movement.PostalCodeInquiryRequest fedex.services.package_movement.PostalCodeInquiryRequest-class.html fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.services.package_movement.PostalCodeInquiryRequest._prepare_wsdl_objects fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_prepare_wsdl_objects fedex.services.package_movement.PostalCodeInquiryRequest.__init__ fedex.services.package_movement.PostalCodeInquiryRequest-class.html#__init__ fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail fedex.services.package_movement.PostalCodeInquiryRequest._assemble_and_send_request fedex.services.package_movement.PostalCodeInquiryRequest-class.html#_assemble_and_send_request fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type fedex.base_service.FedexBaseService.response fedex.base_service.FedexBaseService-class.html#response @@ -161,12 +202,14 @@ fedex.services.package_movement.PostalCodeInquiryRequest._check_response_for_req fedex.services.rate_service.FedexRateServiceRequest fedex.services.rate_service.FedexRateServiceRequest-class.html fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.services.rate_service.FedexRateServiceRequest._prepare_wsdl_objects fedex.services.rate_service.FedexRateServiceRequest-class.html#_prepare_wsdl_objects fedex.services.rate_service.FedexRateServiceRequest.__init__ fedex.services.rate_service.FedexRateServiceRequest-class.html#__init__ fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail fedex.services.rate_service.FedexRateServiceRequest._assemble_and_send_request fedex.services.rate_service.FedexRateServiceRequest-class.html#_assemble_and_send_request fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail fedex.services.rate_service.FedexRateServiceRequest.RequestedShipment fedex.services.rate_service.FedexRateServiceRequest-class.html#RequestedShipment fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type @@ -177,12 +220,14 @@ fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.bas fedex.services.ship_service.FedexDeleteShipmentRequest fedex.services.ship_service.FedexDeleteShipmentRequest-class.html fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.services.ship_service.FedexDeleteShipmentRequest._prepare_wsdl_objects fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#_prepare_wsdl_objects fedex.services.ship_service.FedexDeleteShipmentRequest.__init__ fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#__init__ fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail fedex.services.ship_service.FedexDeleteShipmentRequest._assemble_and_send_request fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#_assemble_and_send_request fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.services.ship_service.FedexDeleteShipmentRequest.DeletionControlType fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#DeletionControlType fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail fedex.services.ship_service.FedexDeleteShipmentRequest.TrackingId fedex.services.ship_service.FedexDeleteShipmentRequest-class.html#TrackingId @@ -193,6 +238,7 @@ fedex.base_service.FedexBaseService._check_response_for_request_errors fedex.bas fedex.services.ship_service.FedexProcessShipmentRequest fedex.services.ship_service.FedexProcessShipmentRequest-class.html fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.services.ship_service.FedexProcessShipmentRequest._prepare_wsdl_objects fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_prepare_wsdl_objects fedex.services.ship_service.FedexProcessShipmentRequest.__init__ fedex.services.ship_service.FedexProcessShipmentRequest-class.html#__init__ fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj @@ -200,6 +246,7 @@ fedex.services.ship_service.FedexProcessShipmentRequest.send_validation_request fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseService-class.html#ClientDetail fedex.services.ship_service.FedexProcessShipmentRequest._assemble_and_send_request fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_assemble_and_send_request fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.services.ship_service.FedexProcessShipmentRequest._assemble_and_send_validation_request fedex.services.ship_service.FedexProcessShipmentRequest-class.html#_assemble_and_send_validation_request fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail fedex.services.ship_service.FedexProcessShipmentRequest.RequestedShipment fedex.services.ship_service.FedexProcessShipmentRequest-class.html#RequestedShipment @@ -215,6 +262,7 @@ fedex.base_service.FedexBaseServiceException.__init__ fedex.base_service.FedexBa fedex.services.track_service.FedexTrackRequest fedex.services.track_service.FedexTrackRequest-class.html fedex.base_service.FedexBaseService.TransactionDetail fedex.base_service.FedexBaseService-class.html#TransactionDetail fedex.base_service.FedexBaseService.send_request fedex.base_service.FedexBaseService-class.html#send_request +fedex.base_service.FedexBaseService._version_info fedex.base_service.FedexBaseService-class.html#_version_info fedex.services.track_service.FedexTrackRequest._prepare_wsdl_objects fedex.services.track_service.FedexTrackRequest-class.html#_prepare_wsdl_objects fedex.services.track_service.FedexTrackRequest.__init__ fedex.services.track_service.FedexTrackRequest-class.html#__init__ fedex.base_service.FedexBaseService.config_obj fedex.base_service.FedexBaseService-class.html#config_obj @@ -222,6 +270,7 @@ fedex.base_service.FedexBaseService.ClientDetail fedex.base_service.FedexBaseSer fedex.services.track_service.FedexTrackRequest._assemble_and_send_request fedex.services.track_service.FedexTrackRequest-class.html#_assemble_and_send_request fedex.base_service.FedexBaseService.logger fedex.base_service.FedexBaseService-class.html#logger fedex.services.track_service.FedexTrackRequest.SelectionDetails fedex.services.track_service.FedexTrackRequest-class.html#SelectionDetails +fedex.base_service.FedexBaseService._check_response_for_request_warnings fedex.base_service.FedexBaseService-class.html#_check_response_for_request_warnings fedex.services.track_service.FedexTrackRequest.ProcessingOptions fedex.services.track_service.FedexTrackRequest-class.html#ProcessingOptions fedex.base_service.FedexBaseService.WebAuthenticationDetail fedex.base_service.FedexBaseService-class.html#WebAuthenticationDetail fedex.base_service.FedexBaseService.create_wsdl_object_of_type fedex.base_service.FedexBaseService-class.html#create_wsdl_object_of_type diff --git a/docs/2.2.0/class-tree.html b/epydoc_source/docs/2.3.0/class-tree.html similarity index 95% rename from docs/2.2.0/class-tree.html rename to epydoc_source/docs/2.3.0/class-tree.html index eb3afb7..1fc76eb 100644 --- a/docs/2.2.0/class-tree.html +++ b/epydoc_source/docs/2.3.0/class-tree.html @@ -59,7 +59,7 @@

Class Hierarchy

Plugin base.
  • suds.plugin.MessagePlugin: - The base class for suds soap message plugins. + The base class for suds SOAP message plugins.
    • fedex.base_service.GeneralSudsPlugin
    • @@ -131,6 +131,10 @@

      Class Hierarchy

      This class allows you to get the shipping charges for a particular address. +
    • fedex.services.location_service.FedexSearchLocationRequest: + This class allows you to figure out a FedEx location closest to a + specified location criteria, based on location type. +
    • fedex.services.track_service.FedexTrackRequest: This class allows you to track shipments by providing a tracking number or other identifying features. @@ -177,7 +181,7 @@

      Class Hierarchy

      @@ -196,7 +203,7 @@

      Getting Support

        - VERSION = '2.2.0' + VERSION = '2.3.0' @@ -233,7 +240,7 @@

      Getting Support

      @@ -165,23 +171,24 @@

      Identifier Index

      (in fedex.services.availability_commitment_service) - + - + - +

      D

      +

      L

      + + + + + + + + + +

      M

      @@ -254,18 +273,25 @@

      Identifier Index

      - - + + - + + + + + + @@ -273,10 +299,11 @@

      Identifier Index

      + - @@ -311,106 +338,114 @@

      Identifier Index

      __check_response_for_fedex_error()
      (in FedexBaseService) -__package__
      -(in fedex.printers.unix) -_assemble_and_send_request()
      -(in PostalCodeInquiryRequest) - - -__init__()
      -(in FedexBaseService) -__package__
      -(in fedex.services) +__package__
      +(in fedex.services.address_validation_service) _assemble_and_send_request()
      (in FedexRateServiceRequest) -__init__()
      -(in FedexBaseServiceException) -__package__
      -(in fedex.services.address_validation_service) +__init__()
      +(in FedexBaseService) +__package__
      +(in fedex.services.availability_commitment_service) _assemble_and_send_request()
      (in FedexDeleteShipmentRequest) -__init__()
      -(in GeneralSudsPlugin) -__package__
      -(in fedex.services.availability_commitment_service) +__init__()
      +(in FedexBaseServiceException) +__package__
      +(in fedex.services.country_service) _assemble_and_send_request()
      (in FedexProcessShipmentRequest) -__init__()
      -(in SchemaValidationError) -__package__
      -(in fedex.services.country_service) +__init__()
      +(in GeneralSudsPlugin) +__package__
      +(in fedex.services.location_service) _assemble_and_send_request()
      (in FedexTrackRequest) -__init__()
      -(in FedexConfig) +__init__()
      +(in SchemaValidationError) __package__
      (in fedex.services.package_movement) _assemble_and_send_validation_request()
      (in FedexProcessShipmentRequest) -__init__()
      -(in DirectDevicePrinter) +__init__()
      +(in FedexConfig) __package__
      (in fedex.services.rate_service) _check_response_for_request_errors()
      (in FedexBaseService) -__init__()
      -(in FedexAddressValidationRequest) +__init__()
      +(in DirectDevicePrinter) __package__
      (in fedex.services.ship_service) _check_response_for_request_errors()
      (in PostalCodeInquiryRequest) -__init__()
      -(in FedexAvailabilityCommitmentRequest) +__init__()
      +(in FedexAddressValidationRequest) __package__
      (in fedex.services.track_service) _check_response_for_request_errors()
      (in FedexTrackRequest) +__init__()
      +(in FedexAvailabilityCommitmentRequest) +__package__
      +(in fedex.tools) +_check_response_for_request_warnings()
      +(in FedexBaseService) + + __init__()
      (in FedexValidatePostalRequest) -__set_client_detail()
      -(in FedexBaseService) +__package__
      +(in fedex.tools.conversion) _prepare_wsdl_objects()
      (in FedexBaseService) +__init__()
      +(in FedexSearchLocationRequest) +__set_client_detail()
      +(in FedexBaseService) +_prepare_wsdl_objects()
      +(in FedexAddressValidationRequest) + + __init__()
      (in PostalCodeInquiryRequest) __set_transaction_detail()
      (in FedexBaseService) -_prepare_wsdl_objects()
      -(in FedexAddressValidationRequest) +_prepare_wsdl_objects()
      +(in FedexAvailabilityCommitmentRequest) __init__()
      (in FedexRateServiceRequest) __set_version_id()
      (in FedexBaseService) -_prepare_wsdl_objects()
      -(in FedexAvailabilityCommitmentRequest) +_prepare_wsdl_objects()
      +(in FedexValidatePostalRequest) __init__()
      (in FedexDeleteShipmentRequest) __set_web_authentication_detail()
      (in FedexBaseService) -_prepare_wsdl_objects()
      -(in FedexValidatePostalRequest) +_prepare_wsdl_objects()
      +(in FedexSearchLocationRequest) __init__()
      @@ -460,6 +495,20 @@

      Identifier Index

      _print_base64()
      (in DirectDevicePrinter) + +__package__
      +(in fedex.printers.unix) +_assemble_and_send_request()
      +(in FedexSearchLocationRequest) +  + + +__package__
      +(in fedex.services) +_assemble_and_send_request()
      +(in PostalCodeInquiryRequest) +  + @@ -489,7 +538,7 @@

      Identifier Index