=====================
SheepAPI Self-service
=====================

.. toctree::
    :maxdepth: 2
    :caption: Contents:

    auth
    users
    documents
    donations
    events
    forms
    general
    interactions
    invoices
    membership
    messages
    payments
    privacy
    profile
    reservations
    teams
    vehicles
    venue-hire


.. still to do








    Membership
    ----------

    |    /api/v1/$FLOCK/user/hosted/membership/$', hosted.membership
    |    /api/v1/$FLOCK/user/hosted/membership/(?P<muid>[\w\-]+)/$',hosted.membership_instance


    Teams
    -----

    |    /api/v1/$FLOCK/user/hosted/teams/$', hosted.teams
    |    /api/v1/$FLOCK/user/hosted/teams/{vuid}/$', hosted.team_single




    |    /api/v1/$FLOCK/user/hosted/display-value/(?P<uid>[\w\-]+)/$',
            hosted.ref_display_value



    |    /api/v1/$FLOCK/user/evidence/$', evidence.anon_evidence
    	/api/v1/$FLOCK/user/hosted/interest_groups/$', hosted.interest_groups
    |    /api/v1/$FLOCK/user/hook/clearbit/$', hooks.clearbit_query


            pay for a something {ruid} = slugified sheep resource id
        ----------------------------------------
            url(r'^pay/(?P<ruid>[\w\-]+)/$', pay.pay_for_thing




            callback URL - GET will change state!
        ----------------------------------------
            url(r'^{uid}/pay/(?P<ruid>[\w\-]+)/by/(?P<plan>[\w\-]+)/then/(?P<action>[\w\-]+)/$',
            pay.complete_payment



            Used by SheepAuth
        ----------------------------------------
            url(r'^{uid}/token/$', user.token
    ]


    Member Self Service - App only access to other flocks
    -----------------------------------------------------

    p = '{uid}/flock/(?P<flock_context>[\w\-]+)/'

        url(r'^{}$'.format(p), flock_context.flock_home
    ]

    Mandate Self Service
    --------------------



        url(r'^{}$'.format(p),
            mandates.mandates

        url(r'^{}complete/$'.format(p),
            mandates.complete
        url(r'^{}(?P<uid>[\w\-]+)/$'.format(p),
            mandates.mandate_single
        url(r'^{}(?P<uid>[\w\-]+)/cancel/$'.format(p),
            mandates.mandate_cancel

    ]


    Member Self Service - event methods
    -----------------------------------

    p = '{uid}/events/'

        url(r'^{}$'.format(p), user.events
    ]


    Member Self Service - volunteering methods
    ------------------------------------------

    p = '{uid}/volunteering/'

        url(r'^{}$'.format(p),
            volunteering.volunteering_list
        url(r'^{}{vuid}/$'.format(p),
            volunteering.volunteering_single
        url(r'^{uid}/volunteering_summary/$',
            volunteering.volunteering_summary
    ]

    Member Self Service - evidence methods
    --------------------------------------

    p = '(?P<user_id>\w+)/evidence/'

        referee completion
        ----------------------------------------
        url(r'^evidence/(?P<evid>[\w\-]+)/$', evidence.anon_evidence_single

        url(r'^{}$'.format(p), evidence.evidence_list
        url(r'^{}(?P<uid>[\w\-]+)/$'.format(p),
            evidence.evidence_single
        url(r'^{}(?P<uid>[\w\-]+)/files/$'.format(p),
            evidence.evidence_single_file
    ]




    Member Self Service - health methods
    ------------------------------------

    p = '(?P<user_id>\w+)/health/'

        url(r'^{}$'.format(p), health.health_single
        url(r'^{}(?P<uid>[\w\-]+)/$'.format(p),
            health.health_single
        url(r'^{}check/(?P<uid>[\w\-]+)/$'.format(p),
            health.health_check
    ]