Overview

Namespaces

  • Upwork
    • API
      • AuthTypes
      • Interfaces
      • Routers
        • Activities
        • Freelancers
        • Hr
          • Clients
          • Freelancers
        • Jobs
        • Organization
        • Reports
          • Finance

Classes

  • Upwork\API\AuthTypes\AbstractOAuth
  • Upwork\API\AuthTypes\OAuth1
  • Upwork\API\AuthTypes\OAuthPHPLib
  • Upwork\API\Client
  • Upwork\API\Config
  • Upwork\API\Debug
  • Upwork\API\Routers\Activities\Engagement
  • Upwork\API\Routers\Activities\Team
  • Upwork\API\Routers\Auth
  • Upwork\API\Routers\Freelancers\Profile
  • Upwork\API\Routers\Freelancers\Search
  • Upwork\API\Routers\Hr\Clients\Applications
  • Upwork\API\Routers\Hr\Clients\Offers
  • Upwork\API\Routers\Hr\Contracts
  • Upwork\API\Routers\Hr\Engagements
  • Upwork\API\Routers\Hr\Freelancers\Applications
  • Upwork\API\Routers\Hr\Freelancers\Offers
  • Upwork\API\Routers\Hr\Interviews
  • Upwork\API\Routers\Hr\Jobs
  • Upwork\API\Routers\Hr\Milestones
  • Upwork\API\Routers\Hr\Roles
  • Upwork\API\Routers\Hr\Submissions
  • Upwork\API\Routers\Jobs\Profile
  • Upwork\API\Routers\Jobs\Search
  • Upwork\API\Routers\Messages
  • Upwork\API\Routers\Metadata
  • Upwork\API\Routers\Organization\Companies
  • Upwork\API\Routers\Organization\Teams
  • Upwork\API\Routers\Organization\Users
  • Upwork\API\Routers\Payments
  • Upwork\API\Routers\Reports\Finance\Accounts
  • Upwork\API\Routers\Reports\Finance\Billings
  • Upwork\API\Routers\Reports\Finance\Earnings
  • Upwork\API\Routers\Reports\Time
  • Upwork\API\Routers\Snapshot
  • Upwork\API\Routers\Teams
  • Upwork\API\Routers\Workdays
  • Upwork\API\Routers\Workdiary
  • Upwork\API\Utils

Interfaces

  • Upwork\API\Interfaces\Client

Exceptions

  • Upwork\API\ApiException
  • Overview
  • Namespace
  • Class
 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 
<?php
/**
 * Upwork auth library for using with public API by OAuth
 *
 * @final
 * @package     UpworkAPI
 * @since       04/21/2014
 * @copyright   Copyright 2014(c) Upwork.com
 * @author      Maksym Novozhylov <mnovozhilov@upwork.com>
 * @license     Upwork's API Terms of Use {@link https://developers.upwork.com/api-tos.html}
 */

namespace Upwork\API\Interfaces;

/**
 * Client Interface for AuthTypes
 */
interface Client
{
    /**
     * Authentication
     *
     * @access  public
     */
    public function auth();

    /**
     * Request to API server
     *
     * @param   string $type Type of request, i.e. http method
     * @param   string $url URL
     * @param   array $params (Optional) List of additional parameters
     * @access  public
     */
    public function request($type, $url, $params = array());

    /**
     * Request token from server, i.e. setup it on server and return to client
     *
     * @access  public
     */
    public function setupRequestToken();
}
API documentation generated by ApiGen