1: <?php
 2: /**
 3:  * This file is part of the Pipeliner API client library for PHP
 4:  *
 5:  * Copyright 2014 Pipelinersales, Inc. All Rights Reserved.
 6:  * For the full license information, see the attached LICENSE file.
 7:  */
 8: 
 9: namespace PipelinerSales\ApiClient;
10: 
11: /**
12:  * Methods for retrieving information describing data and configuration on the server.
13:  *
14:  * See the <i>Miscellaneous REST methods</i> section at
15:  * {@link http://workspace.pipelinersales.com/community/api/data/Methods_rest.html} for details.
16:  */
17: interface InfoMethodsInterface
18: {
19: 
20:     /**
21:      * @return string
22:      */
23:     public function fetchTeamPipelineUrl();
24: 
25:     /**
26:      * @return integer
27:      */
28:     public function fetchTeamPipelineVersion();
29: 
30:     /**
31:      * @return string
32:      */
33:     public function fetchServerAPIUtcDateTime();
34: 
35:     /**
36:      * Returns a list of possible error codes along with their messages
37:      *
38:      * @return array
39:      */
40:     public function fetchErrorCodes();
41: 
42:     /**
43:      * Returns a list of existing types of collections
44:      *
45:      * @return string[]
46:      */
47:     public function fetchCollections();
48: 
49:     /**
50:      * Returns a list of existing types of entities
51:      *
52:      * @return string[]
53:      */
54:     public function fetchEntityPublic();
55: 
56:     /**
57:      * Returns a list of fields that exist for a specified entity
58:      *
59:      * @param Entity|string $entity an entity object or a string with the entity's type (e.g. Account)
60:      * @return array
61:      */
62:     public function fetchEntityFields($entity);
63: }
64: