life-code/primeira-mao

View on GitHub
src/Contracts/Credentials/Environment.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace PrimeiraMao\Contracts\Credentials;

/**
 * PrimeiraMao API
 * 
 * @type        library
 * @version     0.0.7
 * @package     life-code/primeira-mao
 * @copyright   Copyright (c) 2018 Vinicius Pugliesi (http://www.viniciuspugliesi.com)
 * @author      Vinicius Pugliesi <vinicius_pugliesi@outlook.com>
 * @license     MIT
 */
interface Environment
{
    /**
     * Get access key
     * 
     * @return string
     */
    public function getAccessKey() : string;
    
    /**
     * Get access secret
     * 
     * @throws \PrimeiraMao\Exceptions\PrimeiraMaoException
     * @return string
     */
    public function getAccessSecret() : string;
    
    /**
     * Get URL
     * 
     * @throws \PrimeiraMao\Exceptions\PrimeiraMaoException
     * @return string
     */
    public function getUrl() : string;
    
    /**
     * Get location
     * 
     * @throws \PrimeiraMao\Exceptions\PrimeiraMaoException
     * @return string
     */
    public function getLocation() : string;
}